seam 2.139.0 → 2.141.0

data/lib/seam/routes/access_grants_unmanaged.rb

@@ -9,24 +9,24 @@ module Seam
       end
 
       # Get an unmanaged Access Grant (where is_managed = false).
-      # @param access_grant_id ID of unmanaged Access Grant to get.
+      # @param access_grant_id [String] 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)
+        res = @client.get("/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.
+      # @param acs_entrance_id [String, nil] ID of the entrance by which you want to filter the list of unmanaged Access Grants.
+      # @param acs_system_id [String, nil] ID of the access system by which you want to filter the list of unmanaged Access Grants.
+      # @param limit [Float, nil] Numerical limit on the number of unmanaged access grants to return.
+      # @param page_cursor [String, Seam::Null, nil] Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+      # @param reservation_key [String, nil] Filter unmanaged Access Grants by reservation_key.
+      # @param user_identity_id [String, nil] 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)
+        res = @client.get("/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
@@ -36,12 +36,12 @@ module Seam
       # 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.
+      # @param access_grant_id [String] ID of the unmanaged Access Grant to update.
+      # @param is_managed [Boolean] Must be set to true to convert the unmanaged access grant to managed.
+      # @param access_grant_key [String, nil] 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)
+        @client.patch("/access_grants/unmanaged/update", {access_grant_id: access_grant_id, is_managed: is_managed, access_grant_key: access_grant_key}.compact)
 
         nil
       end

data/lib/seam/routes/access_methods.rb

@@ -15,8 +15,8 @@ module Seam
       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.
+      # @param access_method_id [String] ID of the `access_method` to assign the credential to.
+      # @param card_number [String] 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)
@@ -27,19 +27,23 @@ module Seam
       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.
+      # @param access_method_id [String, nil] ID of access method to delete.
+      # @param access_grant_id [String, nil] ID of access grant whose access methods should be deleted.
+      # @param reservation_key [String, nil] 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)
+        if access_method_id.nil? && access_grant_id.nil? && reservation_key.nil?
+          raise TypeError, "At least one parameter is required for /access_methods/delete"
+        end
+
+        @client.delete("/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`.
+      # @param access_method_id [String] ID of the `access_method` to encode onto a card.
+      # @param acs_encoder_id [String] 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)
@@ -50,18 +54,18 @@ module Seam
       end
 
       # Gets an access method.
-      # @param access_method_id ID of access method to get.
+      # @param access_method_id [String] 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)
+        res = @client.get("/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
+      # @param access_method_ids [Array<String>] IDs of the access methods that you want to get along with their related resources.
+      # @param exclude [Array<String>, nil]
+      # @param include [Array<String>, nil]
       # @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)
@@ -70,24 +74,28 @@ module Seam
       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`.
+      # @param access_code_id [String, nil] 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 [String, nil] ID of Access Grant to list access methods for.
+      # @param access_grant_key [String, nil] Key of Access Grant to list access methods for.
+      # @param acs_entrance_id [String, nil] ID of the entrance for which you want to retrieve all access methods that grant access to it.
+      # @param device_id [String, nil] 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 [Integer, nil] Maximum number of records to return per page.
+      # @param page_cursor [String, Seam::Null, nil] Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+      # @param space_id [String, nil] 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)
+        if 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?
+          raise TypeError, "At least one parameter is required for /access_methods/list"
+        end
+
+        res = @client.get("/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.
+      # @param access_method_id [String] ID of the cloud_key `access_method` to use for the unlock operation.
+      # @param acs_entrance_id [String] 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)

data/lib/seam/routes/access_methods_unmanaged.rb

@@ -9,22 +9,22 @@ module Seam
       end
 
       # Gets an unmanaged access method (where is_managed = false).
-      # @param access_method_id ID of unmanaged access method to get.
+      # @param access_method_id [String] ID of unmanaged access method to get.
       # @return [Seam::Resources::UnmanagedAccessMethod] OK
       def get(access_method_id:)
-        res = @client.post("/access_methods/unmanaged/get", {access_method_id: access_method_id}.compact)
+        res = @client.get("/access_methods/unmanaged/get", {access_method_id: access_method_id}.compact)
 
         Seam::Resources::UnmanagedAccessMethod.load_from_response(res.body["access_method"])
       end
 
       # Lists all unmanaged access methods (where is_managed = false), usually filtered by Access Grant.
-      # @param access_grant_id ID of Access Grant to list unmanaged access methods for.
-      # @param acs_entrance_id ID of the entrance for which you want to retrieve all unmanaged access methods.
-      # @param device_id ID of the device for which you want to retrieve all unmanaged access methods.
-      # @param space_id ID of the space for which you want to retrieve all unmanaged access methods.
+      # @param access_grant_id [String] ID of Access Grant to list unmanaged access methods for.
+      # @param acs_entrance_id [String, nil] ID of the entrance for which you want to retrieve all unmanaged access methods.
+      # @param device_id [String, nil] ID of the device for which you want to retrieve all unmanaged access methods.
+      # @param space_id [String, nil] ID of the space for which you want to retrieve all unmanaged access methods.
       # @return [Seam::Resources::UnmanagedAccessMethod] OK
       def list(access_grant_id:, acs_entrance_id: nil, device_id: nil, space_id: nil)
-        res = @client.post("/access_methods/unmanaged/list", {access_grant_id: access_grant_id, acs_entrance_id: acs_entrance_id, device_id: device_id, space_id: space_id}.compact)
+        res = @client.get("/access_methods/unmanaged/list", {access_grant_id: access_grant_id, acs_entrance_id: acs_entrance_id, device_id: device_id, space_id: space_id}.compact)
 
         Seam::Resources::UnmanagedAccessMethod.load_from_response(res.body["access_methods"])
       end

data/lib/seam/routes/acs_access_groups.rb

@@ -9,71 +9,71 @@ module Seam
       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. You can only provide one of acs_user_id or user_identity_id.
-      # @param user_identity_id ID of the desired user identity that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.
+      # @param acs_access_group_id [String] ID of the access group to which you want to add an access system user.
+      # @param acs_user_id [String, nil] ID of the access system user that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id.
+      # @param user_identity_id [String, nil] ID of the desired user identity that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.
       # @return [nil] OK
       def add_user(acs_access_group_id:, acs_user_id: nil, user_identity_id: nil)
-        @client.post("/acs/access_groups/add_user", {acs_access_group_id: acs_access_group_id, acs_user_id: acs_user_id, user_identity_id: user_identity_id}.compact)
+        @client.put("/acs/access_groups/add_user", {acs_access_group_id: acs_access_group_id, acs_user_id: acs_user_id, user_identity_id: user_identity_id}.compact)
 
         nil
       end
 
       # Deletes 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 that you want to delete.
+      # @param acs_access_group_id [String] ID of the access group that you want to delete.
       # @return [nil] OK
       def delete(acs_access_group_id:)
-        @client.post("/acs/access_groups/delete", {acs_access_group_id: acs_access_group_id}.compact)
+        @client.delete("/acs/access_groups/delete", {acs_access_group_id: acs_access_group_id}.compact)
 
         nil
       end
 
       # Returns 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 that you want to get.
+      # @param acs_access_group_id [String] ID of the access group that you want to get.
       # @return [Seam::Resources::AcsAccessGroup] OK
       def get(acs_access_group_id:)
-        res = @client.post("/acs/access_groups/get", {acs_access_group_id: acs_access_group_id}.compact)
+        res = @client.get("/acs/access_groups/get", {acs_access_group_id: acs_access_group_id}.compact)
 
         Seam::Resources::AcsAccessGroup.load_from_response(res.body["acs_access_group"])
       end
 
       # Returns a list of all [access groups](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
-      # @param acs_system_id ID of the access system for which you want to retrieve all access groups.
-      # @param acs_user_id ID of the access system user for which you want to retrieve all access groups.
-      # @param search String for which to search. Filters returned access groups to include all records that satisfy a partial match using `name` or `acs_access_group_id`.
-      # @param user_identity_id ID of the user identity for which you want to retrieve all access groups.
+      # @param acs_system_id [String, nil] ID of the access system for which you want to retrieve all access groups.
+      # @param acs_user_id [String, nil] ID of the access system user for which you want to retrieve all access groups.
+      # @param search [String, nil] String for which to search. Filters returned access groups to include all records that satisfy a partial match using `name` or `acs_access_group_id`.
+      # @param user_identity_id [String, nil] ID of the user identity for which you want to retrieve all access groups.
       # @return [Seam::Resources::AcsAccessGroup] OK
       def list(acs_system_id: nil, acs_user_id: nil, search: nil, user_identity_id: nil)
-        res = @client.post("/acs/access_groups/list", {acs_system_id: acs_system_id, acs_user_id: acs_user_id, search: search, user_identity_id: user_identity_id}.compact)
+        res = @client.get("/acs/access_groups/list", {acs_system_id: acs_system_id, acs_user_id: acs_user_id, search: search, user_identity_id: user_identity_id}.compact)
 
         Seam::Resources::AcsAccessGroup.load_from_response(res.body["acs_access_groups"])
       end
 
       # Returns a list of all accessible entrances for 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 for which you want to retrieve all accessible entrances.
+      # @param acs_access_group_id [String] ID of the access group for which you want to retrieve all accessible entrances.
       # @return [Seam::Resources::AcsEntrance] OK
       def list_accessible_entrances(acs_access_group_id:)
-        res = @client.post("/acs/access_groups/list_accessible_entrances", {acs_access_group_id: acs_access_group_id}.compact)
+        res = @client.get("/acs/access_groups/list_accessible_entrances", {acs_access_group_id: acs_access_group_id}.compact)
 
         Seam::Resources::AcsEntrance.load_from_response(res.body["acs_entrances"])
       end
 
       # Returns a list of all [access system users](https://docs.seam.co/low-level-apis/access-systems/user-management) in an [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 for which you want to retrieve all access system users.
+      # @param acs_access_group_id [String] ID of the access group for which you want to retrieve all access system users.
       # @return [Seam::Resources::AcsUser] OK
       def list_users(acs_access_group_id:)
-        res = @client.post("/acs/access_groups/list_users", {acs_access_group_id: acs_access_group_id}.compact)
+        res = @client.get("/acs/access_groups/list_users", {acs_access_group_id: acs_access_group_id}.compact)
 
         Seam::Resources::AcsUser.load_from_response(res.body["acs_users"])
       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.
-      # @param user_identity_id ID of the user identity associated with the user that you want to remove from an access group.
+      # @param acs_access_group_id [String] ID of the access group from which you want to remove an access system user.
+      # @param acs_user_id [String, nil] ID of the access system user that you want to remove from an access group.
+      # @param user_identity_id [String, nil] ID of the user identity associated with the user that you want to remove from an access group.
       # @return [nil] OK
       def remove_user(acs_access_group_id:, acs_user_id: nil, user_identity_id: nil)
-        @client.post("/acs/access_groups/remove_user", {acs_access_group_id: acs_access_group_id, acs_user_id: acs_user_id, user_identity_id: user_identity_id}.compact)
+        @client.delete("/acs/access_groups/remove_user", {acs_access_group_id: acs_access_group_id, acs_user_id: acs_user_id, user_identity_id: user_identity_id}.compact)
 
         nil
       end

data/lib/seam/routes/acs_credentials.rb

@@ -9,30 +9,30 @@ module Seam
       end
 
       # Assigns a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) to a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
-      # @param acs_credential_id ID of the credential that you want to assign to an access system user.
-      # @param acs_user_id ID of the access system user to whom you want to assign a credential. You can only provide one of acs_user_id or user_identity_id.
-      # @param user_identity_id ID of the user identity to whom you want to assign a credential. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the credential belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.
+      # @param acs_credential_id [String] ID of the credential that you want to assign to an access system user.
+      # @param acs_user_id [String, nil] ID of the access system user to whom you want to assign a credential. You can only provide one of acs_user_id or user_identity_id.
+      # @param user_identity_id [String, nil] ID of the user identity to whom you want to assign a credential. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the credential belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.
       # @return [nil] OK
       def assign(acs_credential_id:, acs_user_id: nil, user_identity_id: nil)
-        @client.post("/acs/credentials/assign", {acs_credential_id: acs_credential_id, acs_user_id: acs_user_id, user_identity_id: user_identity_id}.compact)
+        @client.patch("/acs/credentials/assign", {acs_credential_id: acs_credential_id, acs_user_id: acs_user_id, user_identity_id: user_identity_id}.compact)
 
         nil
       end
 
       # Creates a new [credential](https://docs.seam.co/low-level-apis/managing-credentials) for a specified [ACS user](https://docs.seam.co/low-level-apis/access-systems/user-management). For granting access, we recommend [Access Grants](https://docs.seam.co/use-cases/granting-access) instead: they create and manage the underlying credentials for you, across access systems and standalone smart locks alike. Use this low-level endpoint only when you need direct control over an individual ACS credential.
-      # @param access_method Access method for the new credential. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.
-      # @param acs_system_id ID of the access system to which the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`.
-      # @param acs_user_id ID of the access system user to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`.
-      # @param allowed_acs_entrance_ids Set of IDs of the [entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) for which the new credential grants access.
-      # @param assa_abloy_vostio_metadata Vostio-specific metadata for the new credential.
-      # @param code Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](https://docs.seam.co/device-and-system-integration-guides).
-      # @param credential_manager_acs_system_id ACS system ID of the credential manager for the new credential.
-      # @param ends_at Date and time at which the validity of the new credential 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_multi_phone_sync_credential Indicates whether the new credential is a [multi-phone sync credential](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
-      # @param salto_space_metadata Salto Space-specific metadata for the new credential.
-      # @param starts_at Date and time at which the validity of the new credential starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
-      # @param user_identity_id ID of the user identity to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. If the access system contains a user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the credential belongs to the access system user. If the access system does not have a corresponding user, one is created.
-      # @param visionline_metadata Visionline-specific metadata for the new credential.
+      # @param access_method [String] Access method for the new credential. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.
+      # @param acs_system_id [String, nil] ID of the access system to which the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`.
+      # @param acs_user_id [String, nil] ID of the access system user to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`.
+      # @param allowed_acs_entrance_ids [Array<String>, nil] Set of IDs of the [entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) for which the new credential grants access.
+      # @param assa_abloy_vostio_metadata [Hash, nil] Vostio-specific metadata for the new credential.
+      # @param code [String, nil] Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](https://docs.seam.co/device-and-system-integration-guides).
+      # @param credential_manager_acs_system_id [String, nil] ACS system ID of the credential manager for the new credential.
+      # @param ends_at [Time, nil] Date and time at which the validity of the new credential 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_multi_phone_sync_credential [Boolean, nil] Indicates whether the new credential is a [multi-phone sync credential](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
+      # @param salto_space_metadata [Hash, nil] Salto Space-specific metadata for the new credential.
+      # @param starts_at [Time, nil] Date and time at which the validity of the new credential starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+      # @param user_identity_id [String, nil] ID of the user identity to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. If the access system contains a user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the credential belongs to the access system user. If the access system does not have a corresponding user, one is created.
+      # @param visionline_metadata [Hash, nil] Visionline-specific metadata for the new credential.
       # @return [Seam::Resources::AcsCredential] OK
       def create(access_method:, acs_system_id: nil, acs_user_id: nil, allowed_acs_entrance_ids: nil, assa_abloy_vostio_metadata: nil, code: nil, credential_manager_acs_system_id: nil, ends_at: nil, is_multi_phone_sync_credential: nil, salto_space_metadata: nil, starts_at: nil, user_identity_id: nil, visionline_metadata: nil)
         res = @client.post("/acs/credentials/create", {access_method: access_method, acs_system_id: acs_system_id, acs_user_id: acs_user_id, allowed_acs_entrance_ids: allowed_acs_entrance_ids, assa_abloy_vostio_metadata: assa_abloy_vostio_metadata, code: code, credential_manager_acs_system_id: credential_manager_acs_system_id, ends_at: ends_at, is_multi_phone_sync_credential: is_multi_phone_sync_credential, salto_space_metadata: salto_space_metadata, starts_at: starts_at, user_identity_id: user_identity_id, visionline_metadata: visionline_metadata}.compact)
@@ -41,66 +41,66 @@ module Seam
       end
 
       # Deletes a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
-      # @param acs_credential_id ID of the credential that you want to delete.
+      # @param acs_credential_id [String] ID of the credential that you want to delete.
       # @return [nil] OK
       def delete(acs_credential_id:)
-        @client.post("/acs/credentials/delete", {acs_credential_id: acs_credential_id}.compact)
+        @client.delete("/acs/credentials/delete", {acs_credential_id: acs_credential_id}.compact)
 
         nil
       end
 
       # Returns a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
-      # @param acs_credential_id ID of the credential that you want to get.
+      # @param acs_credential_id [String] ID of the credential that you want to get.
       # @return [Seam::Resources::AcsCredential] OK
       def get(acs_credential_id:)
-        res = @client.post("/acs/credentials/get", {acs_credential_id: acs_credential_id}.compact)
+        res = @client.get("/acs/credentials/get", {acs_credential_id: acs_credential_id}.compact)
 
         Seam::Resources::AcsCredential.load_from_response(res.body["acs_credential"])
       end
 
       # Returns a list of all [credentials](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
-      # @param acs_user_id ID of the access system user for which you want to retrieve all credentials.
-      # @param acs_system_id ID of the access system for which you want to retrieve all credentials.
-      # @param user_identity_id ID of the user identity for which you want to retrieve all credentials.
-      # @param created_before Date and time, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format, before which events to return were created.
-      # @param is_multi_phone_sync_credential Indicates whether you want to retrieve only multi-phone sync credentials or non-multi-phone sync credentials.
-      # @param limit Number of credentials 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 credentials to include all records that satisfy a partial match using `display_name`, `code`, `card_number`, `acs_user_id` or `acs_credential_id`.
+      # @param acs_user_id [String, nil] ID of the access system user for which you want to retrieve all credentials.
+      # @param acs_system_id [String, nil] ID of the access system for which you want to retrieve all credentials.
+      # @param user_identity_id [String, nil] ID of the user identity for which you want to retrieve all credentials.
+      # @param created_before [Time, nil] Date and time, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format, before which events to return were created.
+      # @param is_multi_phone_sync_credential [Boolean, nil] Indicates whether you want to retrieve only multi-phone sync credentials or non-multi-phone sync credentials.
+      # @param limit [Float, nil] Number of credentials to return.
+      # @param page_cursor [String, Seam::Null, nil] Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+      # @param search [String, nil] String for which to search. Filters returned credentials to include all records that satisfy a partial match using `display_name`, `code`, `card_number`, `acs_user_id` or `acs_credential_id`.
       # @return [Seam::Resources::AcsCredential] OK
       def list(acs_user_id: nil, acs_system_id: nil, user_identity_id: nil, created_before: nil, is_multi_phone_sync_credential: nil, limit: nil, page_cursor: nil, search: nil)
-        res = @client.post("/acs/credentials/list", {acs_user_id: acs_user_id, acs_system_id: acs_system_id, user_identity_id: user_identity_id, created_before: created_before, is_multi_phone_sync_credential: is_multi_phone_sync_credential, limit: limit, page_cursor: page_cursor, search: search}.compact)
+        res = @client.get("/acs/credentials/list", {acs_user_id: acs_user_id, acs_system_id: acs_system_id, user_identity_id: user_identity_id, created_before: created_before, is_multi_phone_sync_credential: is_multi_phone_sync_credential, limit: limit, page_cursor: page_cursor, search: search}.compact)
 
         Seam::Resources::AcsCredential.load_from_response(res.body["acs_credentials"])
       end
 
       # Returns a list of all [entrances](https://docs.seam.co/api/acs/entrances) to which a [credential](https://docs.seam.co/api/acs/credentials) grants access.
-      # @param acs_credential_id ID of the credential for which you want to retrieve all entrances to which the credential grants access.
+      # @param acs_credential_id [String] ID of the credential for which you want to retrieve all entrances to which the credential grants access.
       # @return [Seam::Resources::AcsEntrance] OK
       def list_accessible_entrances(acs_credential_id:)
-        res = @client.post("/acs/credentials/list_accessible_entrances", {acs_credential_id: acs_credential_id}.compact)
+        res = @client.get("/acs/credentials/list_accessible_entrances", {acs_credential_id: acs_credential_id}.compact)
 
         Seam::Resources::AcsEntrance.load_from_response(res.body["acs_entrances"])
       end
 
       # Unassigns a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) from a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
-      # @param acs_credential_id ID of the credential that you want to unassign from an access system user.
-      # @param acs_user_id ID of the access system user from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id.
-      # @param user_identity_id ID of the user identity from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id.
+      # @param acs_credential_id [String] ID of the credential that you want to unassign from an access system user.
+      # @param acs_user_id [String, nil] ID of the access system user from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id.
+      # @param user_identity_id [String, nil] ID of the user identity from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id.
       # @return [nil] OK
       def unassign(acs_credential_id:, acs_user_id: nil, user_identity_id: nil)
-        @client.post("/acs/credentials/unassign", {acs_credential_id: acs_credential_id, acs_user_id: acs_user_id, user_identity_id: user_identity_id}.compact)
+        @client.patch("/acs/credentials/unassign", {acs_credential_id: acs_credential_id, acs_user_id: acs_user_id, user_identity_id: user_identity_id}.compact)
 
         nil
       end
 
       # Updates the code and ends at date and time for a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
-      # @param acs_credential_id ID of the credential that you want to update.
-      # @param code Replacement access (PIN) code for the credential that you want to update.
-      # @param ends_at Replacement date and time at which the validity of the credential 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 the `starts_at` value that you set when creating the credential.
+      # @param acs_credential_id [String] ID of the credential that you want to update.
+      # @param code [String, nil] Replacement access (PIN) code for the credential that you want to update.
+      # @param ends_at [Time, nil] Replacement date and time at which the validity of the credential 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 the `starts_at` value that you set when creating the credential.
       # @return [nil] OK
       def update(acs_credential_id:, code: nil, ends_at: nil)
-        @client.post("/acs/credentials/update", {acs_credential_id: acs_credential_id, code: code, ends_at: ends_at}.compact)
+        @client.patch("/acs/credentials/update", {acs_credential_id: acs_credential_id, code: code, ends_at: ends_at}.compact)
 
         nil
       end

data/lib/seam/routes/acs_encoders.rb

@@ -15,9 +15,9 @@ module Seam
       end
 
       # Encodes an existing [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) onto a plastic card placed on the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). Either provide an `acs_credential_id` or an `access_method_id`
-      # @param acs_encoder_id ID of the `acs_encoder` to use to encode the `acs_credential`.
-      # @param access_method_id ID of the `access_method` to encode onto a card.
-      # @param acs_credential_id ID of the `acs_credential` to encode onto a card.
+      # @param acs_encoder_id [String] ID of the `acs_encoder` to use to encode the `acs_credential`.
+      # @param access_method_id [String, nil] ID of the `access_method` to encode onto a card.
+      # @param acs_credential_id [String, nil] ID of the `acs_credential` to encode onto a card.
       # @return [Seam::Resources::ActionAttempt] OK
       def encode_credential(acs_encoder_id:, access_method_id: nil, acs_credential_id: nil, wait_for_action_attempt: nil)
         res = @client.post("/acs/encoders/encode_credential", {acs_encoder_id: acs_encoder_id, access_method_id: access_method_id, acs_credential_id: acs_credential_id}.compact)
@@ -28,20 +28,20 @@ module Seam
       end
 
       # Returns a specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
-      # @param acs_encoder_id ID of the encoder that you want to get.
+      # @param acs_encoder_id [String] ID of the encoder that you want to get.
       # @return [Seam::Resources::AcsEncoder] OK
       def get(acs_encoder_id:)
-        res = @client.post("/acs/encoders/get", {acs_encoder_id: acs_encoder_id}.compact)
+        res = @client.get("/acs/encoders/get", {acs_encoder_id: acs_encoder_id}.compact)
 
         Seam::Resources::AcsEncoder.load_from_response(res.body["acs_encoder"])
       end
 
       # Returns a list of all [encoders](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
-      # @param acs_system_id ID of the access system for which you want to retrieve all encoders.
-      # @param acs_system_ids IDs of the access systems for which you want to retrieve all encoders.
-      # @param acs_encoder_ids IDs of the encoders that you want to retrieve.
-      # @param limit Number of encoders to return.
-      # @param page_cursor Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+      # @param acs_system_id [String, nil] ID of the access system for which you want to retrieve all encoders.
+      # @param acs_system_ids [Array<String>, nil] IDs of the access systems for which you want to retrieve all encoders.
+      # @param acs_encoder_ids [Array<String>, nil] IDs of the encoders that you want to retrieve.
+      # @param limit [Float, nil] Number of encoders to return.
+      # @param page_cursor [String, Seam::Null, nil] Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
       # @return [Seam::Resources::AcsEncoder] OK
       def list(acs_system_id: nil, acs_system_ids: nil, acs_encoder_ids: nil, limit: nil, page_cursor: nil)
         res = @client.post("/acs/encoders/list", {acs_system_id: acs_system_id, acs_system_ids: acs_system_ids, acs_encoder_ids: acs_encoder_ids, limit: limit, page_cursor: page_cursor}.compact)
@@ -50,8 +50,8 @@ module Seam
       end
 
       # Scans an encoded [acs_credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) from a plastic card placed on the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
-      # @param acs_encoder_id ID of the encoder to use for the scan.
-      # @param salto_ks_metadata Salto KS-specific metadata for the scan action.
+      # @param acs_encoder_id [String] ID of the encoder to use for the scan.
+      # @param salto_ks_metadata [Hash, nil] Salto KS-specific metadata for the scan action.
       # @return [Seam::Resources::ActionAttempt] OK
       def scan_credential(acs_encoder_id:, salto_ks_metadata: nil, wait_for_action_attempt: nil)
         res = @client.post("/acs/encoders/scan_credential", {acs_encoder_id: acs_encoder_id, salto_ks_metadata: salto_ks_metadata}.compact)
@@ -62,10 +62,10 @@ module Seam
       end
 
       # Scans a physical card placed on the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) and assigns the scanned credential to an ACS user. Provide either an `acs_user_id` or a `user_identity_id`.
-      # @param acs_encoder_id ID of the `acs_encoder` to use to scan the credential.
-      # @param acs_user_id ID of the `acs_user` to assign the scanned credential to.
-      # @param salto_ks_metadata Salto KS-specific metadata for the scan action.
-      # @param user_identity_id ID of the `user_identity` to assign the scanned credential to. If the ACS system contains an ACS user linked to this user identity, it is used. Otherwise, one is created.
+      # @param acs_encoder_id [String] ID of the `acs_encoder` to use to scan the credential.
+      # @param acs_user_id [String, nil] ID of the `acs_user` to assign the scanned credential to.
+      # @param salto_ks_metadata [Hash, nil] Salto KS-specific metadata for the scan action.
+      # @param user_identity_id [String, nil] ID of the `user_identity` to assign the scanned credential to. If the ACS system contains an ACS user linked to this user identity, it is used. Otherwise, one is created.
       # @return [Seam::Resources::ActionAttempt] OK
       def scan_to_assign_credential(acs_encoder_id:, acs_user_id: nil, salto_ks_metadata: nil, user_identity_id: nil, wait_for_action_attempt: nil)
         res = @client.post("/acs/encoders/scan_to_assign_credential", {acs_encoder_id: acs_encoder_id, acs_user_id: acs_user_id, salto_ks_metadata: salto_ks_metadata, user_identity_id: user_identity_id}.compact)

data/lib/seam/routes/acs_encoders_simulate.rb

@@ -9,9 +9,9 @@ module Seam
       end
 
       # Simulates that the next attempt to encode a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
-      # @param acs_encoder_id ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`.
-      # @param error_code Code of the error to simulate.
-      # @param acs_credential_id ID of the `acs_credential` that will fail to be encoded onto a card in the next request.
+      # @param acs_encoder_id [String] ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`.
+      # @param error_code [String, nil] Code of the error to simulate.
+      # @param acs_credential_id [String, nil] ID of the `acs_credential` that will fail to be encoded onto a card in the next request.
       # @return [nil] OK
       def next_credential_encode_will_fail(acs_encoder_id:, error_code: nil, acs_credential_id: nil)
         @client.post("/acs/encoders/simulate/next_credential_encode_will_fail", {acs_encoder_id: acs_encoder_id, error_code: error_code, acs_credential_id: acs_credential_id}.compact)
@@ -20,8 +20,8 @@ module Seam
       end
 
       # Simulates that the next attempt to encode a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
-      # @param acs_encoder_id ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`.
-      # @param scenario Scenario to simulate.
+      # @param acs_encoder_id [String] ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`.
+      # @param scenario [String, nil] Scenario to simulate.
       # @return [nil] OK
       def next_credential_encode_will_succeed(acs_encoder_id:, scenario: nil)
         @client.post("/acs/encoders/simulate/next_credential_encode_will_succeed", {acs_encoder_id: acs_encoder_id, scenario: scenario}.compact)
@@ -30,9 +30,9 @@ module Seam
       end
 
       # Simulates that the next attempt to scan a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
-      # @param acs_encoder_id ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next request.
-      # @param error_code
-      # @param acs_credential_id_on_seam
+      # @param acs_encoder_id [String] ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next request.
+      # @param error_code [String, nil]
+      # @param acs_credential_id_on_seam [String, nil]
       # @return [nil] OK
       def next_credential_scan_will_fail(acs_encoder_id:, error_code: nil, acs_credential_id_on_seam: nil)
         @client.post("/acs/encoders/simulate/next_credential_scan_will_fail", {acs_encoder_id: acs_encoder_id, error_code: error_code, acs_credential_id_on_seam: acs_credential_id_on_seam}.compact)
@@ -41,9 +41,9 @@ module Seam
       end
 
       # Simulates that the next attempt to scan a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
-      # @param acs_encoder_id ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`.
-      # @param acs_credential_id_on_seam ID of the Seam `acs_credential` that matches the `acs_credential` on the encoder in this simulation.
-      # @param scenario Scenario to simulate.
+      # @param acs_encoder_id [String] ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`.
+      # @param acs_credential_id_on_seam [String, nil] ID of the Seam `acs_credential` that matches the `acs_credential` on the encoder in this simulation.
+      # @param scenario [String, nil] Scenario to simulate.
       # @return [nil] OK
       def next_credential_scan_will_succeed(acs_encoder_id:, acs_credential_id_on_seam: nil, scenario: nil)
         @client.post("/acs/encoders/simulate/next_credential_scan_will_succeed", {acs_encoder_id: acs_encoder_id, acs_credential_id_on_seam: acs_credential_id_on_seam, scenario: scenario}.compact)