seam 2.132.0 → 2.133.0

data/lib/seam/resources/user_identity.rb

@@ -2,9 +2,26 @@
 
 module Seam
   module Resources
+    # Represents a [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account.
     class UserIdentity < BaseResource
-      attr_accessor :acs_user_ids, :display_name, :email_address, :full_name, :phone_number, :user_identity_id, :user_identity_key, :workspace_id
+      # Array of access system user IDs associated with the user identity.
+      attr_accessor :acs_user_ids
+      # Display name for the user identity.
+      attr_accessor :display_name
+      # Unique email address for the user identity.
+      attr_accessor :email_address
+      # Full name of the user associated with the user identity.
+      attr_accessor :full_name
+      # Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).
+      attr_accessor :phone_number
+      # ID of the user identity.
+      attr_accessor :user_identity_id
+      # Unique key for the user identity.
+      attr_accessor :user_identity_key
+      # ID of the workspace that contains the user identity.
+      attr_accessor :workspace_id
 
+      # Date and time at which the user identity was created.
       date_accessor :created_at
 
       include Seam::Resources::ResourceErrorsSupport

data/lib/seam/resources/webhook.rb

@@ -2,8 +2,16 @@
 
 module Seam
   module Resources
+    # Represents a [webhook](https://docs.seam.co/developer-tools/webhooks) that enables you to receive notifications of events. When you create a webhook, specify the endpoint URL at which you want to receive events and the set of event types that you want to receive.
     class Webhook < BaseResource
-      attr_accessor :event_types, :secret, :url, :webhook_id
+      # Types of events that the [webhook](https://docs.seam.co/developer-tools/webhooks) should receive.
+      attr_accessor :event_types
+      # Secret associated with the [webhook](https://docs.seam.co/developer-tools/webhooks).
+      attr_accessor :secret
+      # URL for the [webhook](https://docs.seam.co/developer-tools/webhooks).
+      attr_accessor :url
+      # ID of the webhook.
+      attr_accessor :webhook_id
     end
   end
 end

data/lib/seam/resources/workspace.rb

@@ -2,8 +2,27 @@
 
 module Seam
   module Resources
+    # Represents a Seam [workspace](https://docs.seam.co/core-concepts/workspaces). A workspace is a top-level entity that encompasses all other resources below it, such as devices, connected accounts, and Connect Webviews. Seam provides two types of workspaces. A [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces) is a special type of workspace designed for testing code. Sandbox workspaces offer test device accounts and virtual devices that you can connect and control. This ability to work with virtual devices is quite handy because it removes the need to own physical devices from multiple brands. To connect real devices and systems to Seam, use a [production workspace](https://docs.seam.co/core-concepts/workspaces#production-workspaces).
     class Workspace < BaseResource
-      attr_accessor :company_name, :connect_partner_name, :connect_webview_customization, :is_publishable_key_auth_enabled, :is_sandbox, :is_suspended, :name, :organization_id, :publishable_key, :workspace_id
+      # Company name associated with the [workspace](https://docs.seam.co/core-concepts/workspaces).
+      attr_accessor :company_name
+      # @deprecated Use `company_name` instead.
+      attr_accessor :connect_partner_name
+      attr_accessor :connect_webview_customization
+      # Indicates whether publishable key authentication is enabled for this workspace.
+      attr_accessor :is_publishable_key_auth_enabled
+      # Indicates whether the workspace is a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
+      attr_accessor :is_sandbox
+      # Indicates whether the [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces) is suspended. Seam suspends sandbox workspaces that have not been accessed in 14 days.
+      attr_accessor :is_suspended
+      # Name of the [workspace](https://docs.seam.co/core-concepts/workspaces).
+      attr_accessor :name
+      # ID of the organization to which the workspace belongs, or `null` if the workspace is not assigned to an organization.
+      attr_accessor :organization_id
+      # Publishable key for the [workspace](https://docs.seam.co/core-concepts/workspaces). This key is used to identify the workspace in client-side applications.
+      attr_accessor :publishable_key
+      # ID of the workspace.
+      attr_accessor :workspace_id
     end
   end
 end

data/lib/seam/routes/access_codes.rb

@@ -16,60 +16,207 @@ module Seam
         @unmanaged ||= Seam::Clients::AccessCodesUnmanaged.new(client: @client, defaults: @defaults)
       end
 
+      # Creates a new [access code](https://docs.seam.co/low-level-apis/access-codes). For granting access, we recommend [Access Grants](https://docs.seam.co/use-cases/granting-access) 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.
+      # @param device_id ID of the device for which you want to create the new access code.
+      # @param allow_external_modification Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
+      # @param attempt_for_offline_device
+      # @param code Code to be used for access.
+      # @param common_code_key Key to identify access codes that should have the same code. Any two access codes with the same `common_code_key` are guaranteed to have the same `code`. See also [Creating and Updating Multiple Linked Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).
+      # @param ends_at Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
+      # @param is_external_modification_allowed Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
+      # @param is_offline_access_code Indicates whether the access code is an [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes).
+      # @param is_one_time_use Indicates whether the [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) is a single-use access code.
+      # @param max_time_rounding Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.
+      # @param name Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
+      #
+      # Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
+      #
+      # To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
+      #
+      # To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).
+      # @param prefer_native_scheduling Indicates whether [native scheduling](https://docs.seam.co/low-level-apis/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.
+      # @param preferred_code_length Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.
+      # @param starts_at Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+      # @param use_backup_access_code_pool Indicates whether to use a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/api/access_codes/pull_backup_access_code).
+      # @param use_offline_access_code
+      # @deprecated use_offline_access_code: Use `is_offline_access_code` instead.
+      # @return [Seam::Resources::AccessCode] OK
       def create(device_id:, allow_external_modification: nil, attempt_for_offline_device: nil, code: nil, common_code_key: nil, ends_at: nil, is_external_modification_allowed: nil, is_offline_access_code: nil, is_one_time_use: nil, max_time_rounding: nil, name: nil, prefer_native_scheduling: nil, preferred_code_length: nil, starts_at: nil, use_backup_access_code_pool: nil, use_offline_access_code: nil)
         res = @client.post("/access_codes/create", {device_id: device_id, allow_external_modification: allow_external_modification, attempt_for_offline_device: attempt_for_offline_device, code: code, common_code_key: common_code_key, ends_at: ends_at, is_external_modification_allowed: is_external_modification_allowed, is_offline_access_code: is_offline_access_code, is_one_time_use: is_one_time_use, max_time_rounding: max_time_rounding, name: name, prefer_native_scheduling: prefer_native_scheduling, preferred_code_length: preferred_code_length, starts_at: starts_at, use_backup_access_code_pool: use_backup_access_code_pool, use_offline_access_code: use_offline_access_code}.compact)
 
         Seam::Resources::AccessCode.load_from_response(res.body["access_code"])
       end
 
+      # Creates new [access codes](https://docs.seam.co/low-level-apis/smart-locks/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](https://docs.seam.co/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).
+      #
+      # For granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) 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.
+      # @param device_ids IDs of the devices for which you want to create the new access codes.
+      # @param allow_external_modification Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
+      # @param attempt_for_offline_device
+      # @param behavior_when_code_cannot_be_shared Desired behavior if any device cannot share a code. If `throw` (default), no access codes will be created if any device cannot share a code. If `create_random_code`, a random code will be created on devices that cannot share a code.
+      # @param code Code to be used for access.
+      # @param ends_at Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
+      # @param is_external_modification_allowed Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
+      # @param name Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
+      #
+      # Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
+      #
+      # To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
+      #
+      # To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).
+      # @param prefer_native_scheduling Indicates whether [native scheduling](https://docs.seam.co/low-level-apis/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.
+      # @param preferred_code_length Preferred code length. If the affected devices do not support the preferred code length, Seam reverts to using the shortest supported code length.
+      # @param starts_at Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+      # @param use_backup_access_code_pool Indicates whether to use a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/api/access_codes/pull_backup_access_code).
+      # @return [Seam::Resources::AccessCode] OK
       def create_multiple(device_ids:, allow_external_modification: nil, attempt_for_offline_device: nil, behavior_when_code_cannot_be_shared: nil, code: nil, ends_at: nil, is_external_modification_allowed: nil, name: nil, prefer_native_scheduling: nil, preferred_code_length: nil, starts_at: nil, use_backup_access_code_pool: nil)
         res = @client.post("/access_codes/create_multiple", {device_ids: device_ids, allow_external_modification: allow_external_modification, attempt_for_offline_device: attempt_for_offline_device, behavior_when_code_cannot_be_shared: behavior_when_code_cannot_be_shared, code: code, ends_at: ends_at, is_external_modification_allowed: is_external_modification_allowed, name: name, prefer_native_scheduling: prefer_native_scheduling, preferred_code_length: preferred_code_length, starts_at: starts_at, use_backup_access_code_pool: use_backup_access_code_pool}.compact)
 
         Seam::Resources::AccessCode.load_from_response(res.body["access_codes"])
       end
 
+      # Deletes an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes).
+      # @param access_code_id ID of the access code that you want to delete.
+      # @param device_id ID of the device for which you want to delete the access code.
+      # @return [nil] OK
       def delete(access_code_id:, device_id: nil)
         @client.post("/access_codes/delete", {access_code_id: access_code_id, device_id: device_id}.compact)
 
         nil
       end
 
+      # Generates a code for an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes), given a device ID.
+      # @param device_id ID of the device for which you want to generate a code.
+      # @return [Seam::Resources::AccessCode] OK
       def generate_code(device_id:)
         res = @client.post("/access_codes/generate_code", {device_id: device_id}.compact)
 
         Seam::Resources::AccessCode.load_from_response(res.body["generated_code"])
       end
 
+      # Returns a specified [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes).
+      #
+      # You must specify either `access_code_id` or both `device_id` and `code`.
+      # @param access_code_id ID of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.
+      # @param code Code of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.
+      # @param device_id ID of the device containing the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.
+      # @return [Seam::Resources::AccessCode] OK
       def get(access_code_id: nil, code: nil, device_id: nil)
         res = @client.post("/access_codes/get", {access_code_id: access_code_id, code: code, device_id: device_id}.compact)
 
         Seam::Resources::AccessCode.load_from_response(res.body["access_code"])
       end
 
+      # Returns a list of all [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes).
+      #
+      # Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.
+      # @param access_code_ids IDs of the access codes that you want to retrieve. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.
+      # @param access_grant_id ID of the access grant for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.
+      # @param access_grant_key Key of the access grant for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.
+      # @param access_method_id ID of the access method for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.
+      # @param customer_key Customer key for which you want to list access codes.
+      # @param device_id ID of the device for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.
+      # @param limit Numerical limit on the number of access codes to return.
+      # @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 codes to include all records that satisfy a partial match using `name`, `code` or `access_code_id`.
+      # @param user_identifier_key Your user ID for the user by which to filter access codes.
+      # @return [Seam::Resources::AccessCode] OK
       def list(access_code_ids: nil, access_grant_id: nil, access_grant_key: nil, access_method_id: nil, customer_key: nil, device_id: nil, limit: nil, page_cursor: nil, search: nil, user_identifier_key: nil)
         res = @client.post("/access_codes/list", {access_code_ids: access_code_ids, access_grant_id: access_grant_id, access_grant_key: access_grant_key, access_method_id: access_method_id, customer_key: customer_key, device_id: device_id, limit: limit, page_cursor: page_cursor, search: search, user_identifier_key: user_identifier_key}.compact)
 
         Seam::Resources::AccessCode.load_from_response(res.body["access_codes"])
       end
 
+      # Retrieves a backup access code for an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). See also [Managing Backup Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/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.
+      # @param access_code_id ID of the access code for which you want to pull a backup access code.
+      # @return [Seam::Resources::AccessCode] OK
       def pull_backup_access_code(access_code_id:)
         res = @client.post("/access_codes/pull_backup_access_code", {access_code_id: access_code_id}.compact)
 
         Seam::Resources::AccessCode.load_from_response(res.body["access_code"])
       end
 
+      # 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`.
+      # @param device_id ID of the device for which you want to report constraints.
+      # @param max_code_length Maximum supported code length as an integer between 4 and 20, inclusive. You can specify either `min_code_length`/`max_code_length` or `supported_code_lengths`.
+      # @param min_code_length Minimum supported code length as an integer between 4 and 20, inclusive. You can specify either `min_code_length`/`max_code_length` or `supported_code_lengths`.
+      # @param supported_code_lengths Array of supported code lengths as integers between 4 and 20, inclusive. You can specify either `supported_code_lengths` or `min_code_length`/`max_code_length`.
+      # @return [nil] OK
       def report_device_constraints(device_id:, max_code_length: nil, min_code_length: nil, supported_code_lengths: nil)
         @client.post("/access_codes/report_device_constraints", {device_id: device_id, max_code_length: max_code_length, min_code_length: min_code_length, supported_code_lengths: supported_code_lengths}.compact)
 
         nil
       end
 
+      # Updates a specified active or upcoming [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes).
+      #
+      # See also [Modifying Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/modifying-access-codes).
+      # @param access_code_id ID of the access code that you want to update.
+      # @param allow_external_modification Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
+      # @param attempt_for_offline_device
+      # @param code Code to be used for access.
+      # @param device_id ID of the device containing the access code that you want to update.
+      # @param ends_at Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
+      # @param is_external_modification_allowed Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
+      # @param is_managed Indicates whether the access code is managed through Seam. Note that to convert an unmanaged access code into a managed access code, use `/access_codes/unmanaged/convert_to_managed`.
+      # @param is_offline_access_code Indicates whether the access code is an [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes).
+      # @param is_one_time_use Indicates whether the [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) is a single-use access code.
+      # @param max_time_rounding Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.
+      # @param name Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
+      #
+      # Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
+      #
+      # To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
+      #
+      # To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).
+      # @param prefer_native_scheduling Indicates whether [native scheduling](https://docs.seam.co/low-level-apis/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.
+      # @param preferred_code_length Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.
+      # @param starts_at Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+      # @param type Type to which you want to convert the access code. To convert a time-bound access code to an ongoing access code, set `type` to `ongoing`. See also [Changing a time-bound access code to permanent access](https://docs.seam.co/low-level-apis/smart-locks/access-codes/modifying-access-codes#special-case-2-changing-a-time-bound-access-code-to-permanent-access).
+      # @param use_backup_access_code_pool Indicates whether to use a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/api/access_codes/pull_backup_access_code).
+      # @param use_offline_access_code
+      # @deprecated use_offline_access_code: Use `is_offline_access_code` instead.
+      # @return [nil] OK
       def update(access_code_id:, allow_external_modification: nil, attempt_for_offline_device: nil, code: nil, device_id: nil, ends_at: nil, is_external_modification_allowed: nil, is_managed: nil, is_offline_access_code: nil, is_one_time_use: nil, max_time_rounding: nil, name: nil, prefer_native_scheduling: nil, preferred_code_length: nil, starts_at: nil, type: nil, use_backup_access_code_pool: nil, use_offline_access_code: nil)
         @client.post("/access_codes/update", {access_code_id: access_code_id, allow_external_modification: allow_external_modification, attempt_for_offline_device: attempt_for_offline_device, code: code, device_id: device_id, ends_at: ends_at, is_external_modification_allowed: is_external_modification_allowed, is_managed: is_managed, is_offline_access_code: is_offline_access_code, is_one_time_use: is_one_time_use, max_time_rounding: max_time_rounding, name: name, prefer_native_scheduling: prefer_native_scheduling, preferred_code_length: preferred_code_length, starts_at: starts_at, type: type, use_backup_access_code_pool: use_backup_access_code_pool, use_offline_access_code: use_offline_access_code}.compact)
 
         nil
       end
 
+      # Updates [access codes](https://docs.seam.co/low-level-apis/smart-locks/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](https://docs.seam.co/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes#update-linked-access-codes).
+      # @param common_code_key Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`.
+      # @param ends_at Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
+      # @param name Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
+      #
+      # Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
+      #
+      # To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
+      #
+      # To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).
+      # @param starts_at Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+      # @return [nil] OK
       def update_multiple(common_code_key:, ends_at: nil, name: nil, starts_at: nil)
         @client.post("/access_codes/update_multiple", {common_code_key: common_code_key, ends_at: ends_at, name: name, starts_at: starts_at}.compact)
 

data/lib/seam/routes/access_codes_simulate.rb

@@ -8,6 +8,11 @@ module Seam
         @defaults = defaults
       end
 
+      # Simulates the creation of an [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) in a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
+      # @param code Code of the simulated unmanaged access code.
+      # @param device_id ID of the device for which you want to simulate the creation of an unmanaged access code.
+      # @param name Name of the simulated unmanaged access code.
+      # @return [Seam::Resources::UnmanagedAccessCode] OK
       def create_unmanaged_access_code(code:, device_id:, name:)
         res = @client.post("/access_codes/simulate/create_unmanaged_access_code", {code: code, device_id: device_id, name: name}.compact)
 

data/lib/seam/routes/access_codes_unmanaged.rb

@@ -8,30 +8,64 @@ module Seam
         @defaults = defaults
       end
 
+      # Converts an [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) to an [access code managed through Seam](https://docs.seam.co/low-level-apis/smart-locks/access-codes).
+      #
+      # 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.
+      # @param access_code_id ID of the unmanaged access code that you want to convert to a managed access code.
+      # @param allow_external_modification Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the access code is allowed.
+      # @param force Indicates whether to force the access code conversion. To switch management of an access code from one Seam workspace to another, set `force` to `true`.
+      # @param is_external_modification_allowed Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the access code is allowed.
+      # @return [nil] OK
       def convert_to_managed(access_code_id:, allow_external_modification: nil, force: nil, is_external_modification_allowed: nil)
         @client.post("/access_codes/unmanaged/convert_to_managed", {access_code_id: access_code_id, allow_external_modification: allow_external_modification, force: force, is_external_modification_allowed: is_external_modification_allowed}.compact)
 
         nil
       end
 
+      # Deletes an [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
+      # @param access_code_id ID of the unmanaged access code that you want to delete.
+      # @return [nil] OK
       def delete(access_code_id:)
         @client.post("/access_codes/unmanaged/delete", {access_code_id: access_code_id}.compact)
 
         nil
       end
 
+      # Returns a specified [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
+      #
+      # You must specify either `access_code_id` or both `device_id` and `code`.
+      # @param access_code_id ID of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.
+      # @param code Code of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.
+      # @param device_id ID of the device containing the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.
+      # @return [Seam::Resources::UnmanagedAccessCode] OK
       def get(access_code_id: nil, code: nil, device_id: nil)
         res = @client.post("/access_codes/unmanaged/get", {access_code_id: access_code_id, code: code, device_id: device_id}.compact)
 
         Seam::Resources::UnmanagedAccessCode.load_from_response(res.body["access_code"])
       end
 
+      # Returns a list of all [unmanaged access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
+      # @param device_id ID of the device for which you want to list unmanaged access codes.
+      # @param limit Numerical limit on the number of unmanaged access codes to return.
+      # @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 codes to include all records that satisfy a partial match using `name`, `code` or `access_code_id`.
+      # @param user_identifier_key Your user ID for the user by which to filter unmanaged access codes.
+      # @return [Seam::Resources::UnmanagedAccessCode] OK
       def list(device_id:, limit: nil, page_cursor: nil, search: nil, user_identifier_key: nil)
         res = @client.post("/access_codes/unmanaged/list", {device_id: device_id, limit: limit, page_cursor: page_cursor, search: search, user_identifier_key: user_identifier_key}.compact)
 
         Seam::Resources::UnmanagedAccessCode.load_from_response(res.body["access_codes"])
       end
 
+      # Updates a specified [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
+      # @param access_code_id ID of the unmanaged access code that you want to update.
+      # @param is_managed
+      # @param allow_external_modification Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed.
+      # @param force Indicates whether to force the unmanaged access code update.
+      # @param is_external_modification_allowed Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed.
+      # @return [nil] OK
       def update(access_code_id:, is_managed:, allow_external_modification: nil, force: nil, is_external_modification_allowed: nil)
         @client.post("/access_codes/unmanaged/update", {access_code_id: access_code_id, is_managed: is_managed, allow_external_modification: allow_external_modification, force: force, is_external_modification_allowed: is_external_modification_allowed}.compact)
 

data/lib/seam/routes/access_grants.rb

@@ -12,42 +12,101 @@ module Seam
         @unmanaged ||= Seam::Clients::AccessGrantsUnmanaged.new(client: @client, defaults: @defaults)
       end
 
+      # Creates a new [Access Grant](https://docs.seam.co/use-cases/granting-access/access-grants). 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.
+      # @param requested_access_methods
+      # @param user_identity_id ID of user identity for whom access is being granted.
+      # @param user_identity When used, creates a new user identity with the given details, and grants them access.
+      # @param access_grant_key Unique key for the access grant within the workspace.
+      # @param acs_entrance_ids Set of IDs of the [entrances](https://docs.seam.co/api/acs/systems/list) to which access is being granted.
+      # @param customization_profile_id ID of the customization profile to apply to the Access Grant and its access methods.
+      # @param device_ids Set of IDs of the [devices](https://docs.seam.co/api/devices/list) to which access is being granted.
+      # @param ends_at Date and time at which the validity of the new grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
+      # @param location
+      # @deprecated location: Create a space first, then reference it using `space_ids`.
+      # @param location_ids
+      # @deprecated location_ids: Use `space_ids`.
+      # @param name Name for the access grant.
+      # @param reservation_key Reservation key for the access grant.
+      # @param space_ids Set of IDs of existing spaces to which access is being granted.
+      # @param space_keys Set of keys of existing spaces to which access is being granted.
+      # @param starts_at Date and time at which the validity of the new grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+      # @return [Seam::Resources::AccessGrant] OK
       def create(requested_access_methods:, user_identity_id: nil, user_identity: nil, access_grant_key: nil, acs_entrance_ids: nil, customization_profile_id: nil, device_ids: nil, ends_at: nil, location: nil, location_ids: nil, name: nil, reservation_key: nil, space_ids: nil, space_keys: nil, starts_at: nil)
         res = @client.post("/access_grants/create", {requested_access_methods: requested_access_methods, user_identity_id: user_identity_id, user_identity: user_identity, access_grant_key: access_grant_key, acs_entrance_ids: acs_entrance_ids, customization_profile_id: customization_profile_id, device_ids: device_ids, ends_at: ends_at, location: location, location_ids: location_ids, name: name, reservation_key: reservation_key, space_ids: space_ids, space_keys: space_keys, starts_at: starts_at}.compact)
 
         Seam::Resources::AccessGrant.load_from_response(res.body["access_grant"])
       end
 
+      # Delete an Access Grant.
+      # @param access_grant_id ID of Access Grant to delete.
+      # @return [nil] OK
       def delete(access_grant_id:)
         @client.post("/access_grants/delete", {access_grant_id: access_grant_id}.compact)
 
         nil
       end
 
+      # Get an Access Grant.
+      # @param access_grant_id ID of Access Grant to get.
+      # @param access_grant_key Unique key of Access Grant to get.
+      # @return [Seam::Resources::AccessGrant] OK
       def get(access_grant_id: nil, access_grant_key: nil)
         res = @client.post("/access_grants/get", {access_grant_id: access_grant_id, access_grant_key: access_grant_key}.compact)
 
         Seam::Resources::AccessGrant.load_from_response(res.body["access_grant"])
       end
 
+      # Gets all related resources for one or more Access Grants.
+      # @param access_grant_ids IDs of the access grants that you want to get along with their related resources.
+      # @param access_grant_keys Keys of the access grants that you want to get along with their related resources.
+      # @param exclude
+      # @param include
+      # @return [Seam::Resources::Batch] OK
       def get_related(access_grant_ids: nil, access_grant_keys: nil, exclude: nil, include: nil)
         res = @client.post("/access_grants/get_related", {access_grant_ids: access_grant_ids, access_grant_keys: access_grant_keys, exclude: exclude, include: include}.compact)
 
         Seam::Resources::Batch.load_from_response(res.body["batch"])
       end
 
+      # Gets an Access Grant.
+      # @param access_code_id ID of the access code by which you want to filter the list of Access Grants.
+      # @param access_grant_ids IDs of the access grants to retrieve.
+      # @param access_grant_key Filter Access Grants by access_grant_key. Use null to filter for Access Grants without an access_grant_key.
+      # @param acs_entrance_id ID of the entrance by which you want to filter the list of Access Grants.
+      # @param acs_system_id ID of the access system by which you want to filter the list of Access Grants.
+      # @param customer_key Customer key for which you want to list access grants.
+      # @param device_id ID of the device by which you want to filter the list of Access Grants.
+      # @param limit Numerical limit on the number of access grants to return.
+      # @param location_id
+      # @deprecated location_id: Use `space_id`.
+      # @param page_cursor Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+      # @param reservation_key Filter Access Grants by reservation_key.
+      # @param space_id ID of the space by which you want to filter the list of Access Grants.
+      # @param user_identity_id ID of user identity by which you want to filter the list of Access Grants.
+      # @return [Seam::Resources::AccessGrant] OK
       def list(access_code_id: nil, access_grant_ids: nil, access_grant_key: nil, acs_entrance_id: nil, acs_system_id: nil, customer_key: nil, device_id: nil, limit: nil, location_id: nil, page_cursor: nil, reservation_key: nil, space_id: nil, user_identity_id: nil)
         res = @client.post("/access_grants/list", {access_code_id: access_code_id, access_grant_ids: access_grant_ids, access_grant_key: access_grant_key, acs_entrance_id: acs_entrance_id, acs_system_id: acs_system_id, customer_key: customer_key, device_id: device_id, limit: limit, location_id: location_id, page_cursor: page_cursor, reservation_key: reservation_key, space_id: space_id, user_identity_id: user_identity_id}.compact)
 
         Seam::Resources::AccessGrant.load_from_response(res.body["access_grants"])
       end
 
+      # Adds additional requested access methods to an existing Access Grant.
+      # @param access_grant_id ID of the Access Grant to add access methods to.
+      # @param requested_access_methods Array of requested access methods to add to the access grant.
+      # @return [Seam::Resources::AccessGrant] OK
       def request_access_methods(access_grant_id:, requested_access_methods:)
         res = @client.post("/access_grants/request_access_methods", {access_grant_id: access_grant_id, requested_access_methods: requested_access_methods}.compact)
 
         Seam::Resources::AccessGrant.load_from_response(res.body["access_grant"])
       end
 
+      # Updates an existing Access Grant's time window.
+      # @param access_grant_id ID of the Access Grant to update. Provide either `access_grant_id` or `access_grant_key`.
+      # @param access_grant_key Key of the Access Grant to update. Provide either `access_grant_id` or `access_grant_key`.
+      # @param ends_at Date and time at which the validity of the grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
+      # @param name Display name for the access grant.
+      # @param starts_at Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+      # @return [nil] OK
       def update(access_grant_id: nil, access_grant_key: nil, ends_at: nil, name: nil, starts_at: nil)
         @client.post("/access_grants/update", {access_grant_id: access_grant_id, access_grant_key: access_grant_key, ends_at: ends_at, name: name, starts_at: starts_at}.compact)
 

data/lib/seam/routes/access_grants_unmanaged.rb

@@ -8,18 +8,38 @@ module Seam
         @defaults = defaults
       end
 
+      # Get an unmanaged Access Grant (where is_managed = false).
+      # @param access_grant_id ID of unmanaged Access Grant to get.
+      # @return [Seam::Resources::UnmanagedAccessGrant] OK
       def get(access_grant_id:)
         res = @client.post("/access_grants/unmanaged/get", {access_grant_id: access_grant_id}.compact)
 
         Seam::Resources::UnmanagedAccessGrant.load_from_response(res.body["access_grant"])
       end
 
+      # Gets unmanaged Access Grants (where is_managed = false).
+      # @param acs_entrance_id ID of the entrance by which you want to filter the list of unmanaged Access Grants.
+      # @param acs_system_id ID of the access system by which you want to filter the list of unmanaged Access Grants.
+      # @param limit Numerical limit on the number of unmanaged access grants to return.
+      # @param page_cursor Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+      # @param reservation_key Filter unmanaged Access Grants by reservation_key.
+      # @param user_identity_id ID of user identity by which you want to filter the list of unmanaged Access Grants.
+      # @return [Seam::Resources::UnmanagedAccessGrant] OK
       def list(acs_entrance_id: nil, acs_system_id: nil, limit: nil, page_cursor: nil, reservation_key: nil, user_identity_id: nil)
         res = @client.post("/access_grants/unmanaged/list", {acs_entrance_id: acs_entrance_id, acs_system_id: acs_system_id, limit: limit, page_cursor: page_cursor, reservation_key: reservation_key, user_identity_id: user_identity_id}.compact)
 
         Seam::Resources::UnmanagedAccessGrant.load_from_response(res.body["access_grants"])
       end
 
+      # 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.
+      # @param access_grant_id ID of the unmanaged Access Grant to update.
+      # @param is_managed Must be set to true to convert the unmanaged access grant to managed.
+      # @param access_grant_key Unique key for the access grant. If not provided, the existing key will be preserved.
+      # @return [nil] OK
       def update(access_grant_id:, is_managed:, access_grant_key: nil)
         @client.post("/access_grants/unmanaged/update", {access_grant_id: access_grant_id, is_managed: is_managed, access_grant_key: access_grant_key}.compact)
 

data/lib/seam/routes/access_methods.rb

@@ -14,6 +14,10 @@ module Seam
         @unmanaged ||= Seam::Clients::AccessMethodsUnmanaged.new(client: @client, defaults: @defaults)
       end
 
+      # 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.
+      # @param access_method_id ID of the `access_method` to assign the credential to.
+      # @param card_number Card number of the credential to assign.
+      # @return [Seam::Resources::ActionAttempt] OK
       def assign_card(access_method_id:, card_number:, wait_for_action_attempt: nil)
         res = @client.post("/access_methods/assign_card", {access_method_id: access_method_id, card_number: card_number}.compact)
 
@@ -22,12 +26,21 @@ module Seam
         Helpers::ActionAttempt.decide_and_wait(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
       end
 
+      # Deletes an access method.
+      # @param access_method_id ID of access method to delete.
+      # @param access_grant_id ID of access grant whose access methods should be deleted.
+      # @param reservation_key Reservation key of the access grant whose access methods should be deleted.
+      # @return [nil] OK
       def delete(access_method_id: nil, access_grant_id: nil, reservation_key: nil)
         @client.post("/access_methods/delete", {access_method_id: access_method_id, access_grant_id: access_grant_id, reservation_key: reservation_key}.compact)
 
         nil
       end
 
+      # Encodes an existing access method onto a plastic card placed on the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
+      # @param access_method_id ID of the `access_method` to encode onto a card.
+      # @param acs_encoder_id ID of the `acs_encoder` to use to encode the `access_method`.
+      # @return [Seam::Resources::ActionAttempt] OK
       def encode(access_method_id:, acs_encoder_id:, wait_for_action_attempt: nil)
         res = @client.post("/access_methods/encode", {access_method_id: access_method_id, acs_encoder_id: acs_encoder_id}.compact)
 
@@ -36,24 +49,46 @@ module Seam
         Helpers::ActionAttempt.decide_and_wait(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
       end
 
+      # Gets an access method.
+      # @param access_method_id ID of access method to get.
+      # @return [Seam::Resources::AccessMethod] OK
       def get(access_method_id:)
         res = @client.post("/access_methods/get", {access_method_id: access_method_id}.compact)
 
         Seam::Resources::AccessMethod.load_from_response(res.body["access_method"])
       end
 
+      # Gets all related resources for one or more Access Methods.
+      # @param access_method_ids IDs of the access methods that you want to get along with their related resources.
+      # @param exclude
+      # @param include
+      # @return [Seam::Resources::Batch] OK
       def get_related(access_method_ids:, exclude: nil, include: nil)
         res = @client.post("/access_methods/get_related", {access_method_ids: access_method_ids, exclude: exclude, include: include}.compact)
 
         Seam::Resources::Batch.load_from_response(res.body["batch"])
       end
 
+      # Lists all access methods, usually filtered by Access Grant.
+      # @param access_code_id ID of the access code by which to filter the returned access methods. Must be combined with `access_grant_id`, `access_grant_key`, or `acs_entrance_id`.
+      # @param access_grant_id ID of Access Grant to list access methods for.
+      # @param access_grant_key Key of Access Grant to list access methods for.
+      # @param acs_entrance_id ID of the entrance for which you want to retrieve all access methods that grant access to it.
+      # @param device_id ID of the device by which to filter the returned access methods. Must be combined with `access_grant_id`, `access_grant_key`, or `acs_entrance_id`.
+      # @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 space_id ID of the space by which to filter the returned access methods. Must be combined with `access_grant_id`, `access_grant_key`, or `acs_entrance_id`.
+      # @return [Seam::Resources::AccessMethod] OK
       def list(access_code_id: nil, access_grant_id: nil, access_grant_key: nil, acs_entrance_id: nil, device_id: nil, limit: nil, page_cursor: nil, space_id: nil)
         res = @client.post("/access_methods/list", {access_code_id: access_code_id, access_grant_id: access_grant_id, access_grant_key: access_grant_key, acs_entrance_id: acs_entrance_id, device_id: device_id, limit: limit, page_cursor: page_cursor, space_id: space_id}.compact)
 
         Seam::Resources::AccessMethod.load_from_response(res.body["access_methods"])
       end
 
+      # Remotely unlocks a specified [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) using the cloud key credential associated with an access method. Returns an action attempt that tracks the progress of the unlock operation.
+      # @param access_method_id ID of the cloud_key `access_method` to use for the unlock operation.
+      # @param acs_entrance_id ID of the entrance to unlock.
+      # @return [Seam::Resources::ActionAttempt] OK
       def unlock_door(access_method_id:, acs_entrance_id:, wait_for_action_attempt: nil)
         res = @client.post("/access_methods/unlock_door", {access_method_id: access_method_id, acs_entrance_id: acs_entrance_id}.compact)