seam 2.142.0 → 2.145.0

data/lib/seam/resources/access_grant.rb

@@ -4,19 +4,41 @@ module Seam
   module Resources
     # Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant.
     class AccessGrant < BaseResource
+      # Known `error_code` values load as subclasses; unknown values remain Errors instances for forward compatibility.
       class Errors < BaseResource
+        # Indicates that Seam could not create one or more of the requested access methods for the access grant.
+        class CannotCreateRequestedAccessMethods < Errors
+          # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+          # @return [String]
+          # Known values:
+          # - `cannot_create_requested_access_methods`
+          attr_accessor :error_code
+          # Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+          # @return [String]
+          attr_accessor :message
+          # IDs of the devices that did not receive an access code at grant creation. Use these to identify which specific devices failed when the message reports a partial failure.
+          # @return [Array<String>]
+          attr_accessor :missing_device_ids
+          # Date and time at which Seam created the error.
+          # @return [Time]
+          date_accessor :created_at
+        end
+
         # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
         # @return [String]
+        # Known values:
+        # - `cannot_create_requested_access_methods`
         attr_accessor :error_code
         # Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
         # @return [String]
         attr_accessor :message
-        # IDs of the devices that did not receive an access code at grant creation. Use these to identify which specific devices failed when the message reports a partial failure.
-        # @return [Array<String>]
-        attr_accessor :missing_device_ids
         # Date and time at which Seam created the error.
         # @return [Time]
         date_accessor :created_at
+
+        discriminated_by :error_code, {
+          "cannot_create_requested_access_methods" => CannotCreateRequestedAccessMethods
+        }.freeze
       end
 
       class PendingMutations < BaseResource
@@ -58,6 +80,8 @@ module Seam
         # @return [String]
         attr_accessor :message
         # @return [String]
+        # Known values:
+        # - `updating_spaces`
         attr_accessor :mutation_code
         # Date and time at which the mutation was created.
         # @return [Time]
@@ -79,51 +103,191 @@ module Seam
         attr_accessor :instant_key_max_use_count
         # Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.
         # @return [String]
+        # Known values:
+        # - `code`
+        # - `card`
+        # - `mobile_key`
+        # - `cloud_key`
         attr_accessor :mode
         # Date and time at which the requested access method was added to the Access Grant.
         # @return [Time]
         date_accessor :created_at
       end
 
+      # Known `warning_code` values load as subclasses; unknown values remain Warnings instances for forward compatibility.
       class Warnings < BaseResource
-        class FailedDevices < BaseResource
-          # Device whose access code could not be revoked.
+        # Indicates that the [access grant](https://docs.seam.co/use-cases/granting-access) is being deleted.
+        class BeingDeleted < Warnings
+          # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+          # @return [String]
+          attr_accessor :message
+          # Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+          # @return [String]
+          # Known values:
+          # - `being_deleted`
+          attr_accessor :warning_code
+          # Date and time at which Seam created the warning.
+          # @return [Time]
+          date_accessor :created_at
+        end
+
+        # Indicates that the access grant should have access to more locations than it currently does. Access methods are being created for the missing locations.
+        class UnderprovisionedAccess < Warnings
+          # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+          # @return [String]
+          attr_accessor :message
+          # Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+          # @return [String]
+          # Known values:
+          # - `underprovisioned_access`
+          attr_accessor :warning_code
+          # Date and time at which Seam created the warning.
+          # @return [Time]
+          date_accessor :created_at
+        end
+
+        # Indicates that the access grant has access to locations it should not have. Access methods are being removed from the extra locations.
+        class OverprovisionedAccess < Warnings
+          class FailedDevices < BaseResource
+            # Device whose access code could not be revoked.
+            # @return [String]
+            attr_accessor :device_id
+            # Reason the access code could not be revoked (e.g. `offline_access_code_not_revocable`).
+            # @return [String]
+            attr_accessor :error_code
+            # Human-readable description of why revocation failed.
+            # @return [String]
+            attr_accessor :message
+          end
+
+          # Devices whose access codes could not be revoked during reconciliation. Present when the provider does not support revoking an offline access code (e.g. Dormakaba oracode with exhausted override budget).
+          # @return [Array<FailedDevices>]
+          resource_list_accessor :failed_devices, FailedDevices
+          # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+          # @return [String]
+          attr_accessor :message
+          # Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+          # @return [String]
+          # Known values:
+          # - `overprovisioned_access`
+          attr_accessor :warning_code
+          # Date and time at which Seam created the warning.
+          # @return [Time]
+          date_accessor :created_at
+        end
+
+        # Indicates that the access times for this [access grant](https://docs.seam.co/use-cases/granting-access) are being updated.
+        class UpdatingAccessTimes < Warnings
+          # IDs of the access methods being updated.
+          # @return [Array<String>]
+          attr_accessor :access_method_ids
+          # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+          # @return [String]
+          attr_accessor :message
+          # Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+          # @return [String]
+          # Known values:
+          # - `updating_access_times`
+          attr_accessor :warning_code
+          # Date and time at which Seam created the warning.
+          # @return [Time]
+          date_accessor :created_at
+        end
+
+        # Indicates that the requested PIN code was already in use on a device, so a different code was assigned.
+        class RequestedCodeUnavailable < Warnings
+          # ID of the device where the requested code was unavailable.
           # @return [String]
           attr_accessor :device_id
-          # Reason the access code could not be revoked (e.g. `offline_access_code_not_revocable`).
+          # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
           # @return [String]
-          attr_accessor :error_code
-          # Human-readable description of why revocation failed.
+          attr_accessor :message
+          # The new PIN code that was assigned instead.
+          # @return [String]
+          attr_accessor :new_code
+          # The originally requested PIN code that was unavailable.
+          # @return [String]
+          attr_accessor :original_code
+          # Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+          # @return [String]
+          # Known values:
+          # - `requested_code_unavailable`
+          attr_accessor :warning_code
+          # Date and time at which Seam created the warning.
+          # @return [Time]
+          date_accessor :created_at
+        end
+
+        # Indicates that a device in the access grant does not support access codes and was excluded from code materialization.
+        class DeviceDoesNotSupportAccessCodes < Warnings
+          # ID of the device that does not support access codes.
+          # @return [String]
+          attr_accessor :device_id
+          # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
           # @return [String]
           attr_accessor :message
+          # Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+          # @return [String]
+          # Known values:
+          # - `device_does_not_support_access_codes`
+          attr_accessor :warning_code
+          # Date and time at which Seam created the warning.
+          # @return [Time]
+          date_accessor :created_at
+        end
+
+        # Indicates that a device in the access grant cannot program an access code for the grant's time range because of device-specific time constraints.
+        class DeviceTimeConstraintsViolated < Warnings
+          # ID of the device whose time constraints the access grant violates.
+          # @return [String]
+          attr_accessor :device_id
+          # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+          # @return [String]
+          attr_accessor :message
+          # Specific reason why the grant's times are not programmable on the device.
+          # @return [String]
+          # Known values:
+          # - `duration_exceeds_max`
+          # - `times_do_not_match_slots`
+          # - `ongoing_not_supported`
+          attr_accessor :reason
+          # Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+          # @return [String]
+          # Known values:
+          # - `device_time_constraints_violated`
+          attr_accessor :warning_code
+          # Date and time at which Seam created the warning.
+          # @return [Time]
+          date_accessor :created_at
         end
 
-        # Devices whose access codes could not be revoked during reconciliation. Present when the provider does not support revoking an offline access code (e.g. Dormakaba oracode with exhausted override budget).
-        # @return [Array<FailedDevices>]
-        resource_list_accessor :failed_devices, FailedDevices
-        # IDs of the access methods being updated.
-        # @return [Array<String>]
-        attr_accessor :access_method_ids
-        # @return [String]
-        attr_accessor :device_id
         # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
         # @return [String]
         attr_accessor :message
-        # The new PIN code that was assigned instead.
-        # @return [String]
-        attr_accessor :new_code
-        # The originally requested PIN code that was unavailable.
-        # @return [String]
-        attr_accessor :original_code
-        # Specific reason why the grant's times are not programmable on the device.
-        # @return [String]
-        attr_accessor :reason
         # Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
         # @return [String]
+        # Known values:
+        # - `being_deleted`
+        # - `underprovisioned_access`
+        # - `overprovisioned_access`
+        # - `updating_access_times`
+        # - `requested_code_unavailable`
+        # - `device_does_not_support_access_codes`
+        # - `device_time_constraints_violated`
         attr_accessor :warning_code
         # Date and time at which Seam created the warning.
         # @return [Time]
         date_accessor :created_at
+
+        discriminated_by :warning_code, {
+          "being_deleted" => BeingDeleted,
+          "underprovisioned_access" => UnderprovisionedAccess,
+          "overprovisioned_access" => OverprovisionedAccess,
+          "updating_access_times" => UpdatingAccessTimes,
+          "requested_code_unavailable" => RequestedCodeUnavailable,
+          "device_does_not_support_access_codes" => DeviceDoesNotSupportAccessCodes,
+          "device_time_constraints_violated" => DeviceTimeConstraintsViolated
+        }.freeze
       end
 
       # Errors associated with the [access grant](https://docs.seam.co/use-cases/granting-access).

data/lib/seam/resources/access_method.rb

@@ -4,9 +4,27 @@ module Seam
   module Resources
     # Represents an access method for an Access Grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key.
     class AccessMethod < BaseResource
+      # Known `error_code` values load as subclasses; unknown values remain Errors instances for forward compatibility.
       class Errors < BaseResource
+        # Indicates that Seam was unable to issue this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) before its access grant started, so the recipient may be unable to access the space. This usually points to a problem that needs attention, such as an offline or disconnected device. Seam keeps retrying, and this error clears automatically if the access method is eventually issued.
+        class FailedToIssue < Errors
+          # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+          # @return [String]
+          # Known values:
+          # - `failed_to_issue`
+          attr_accessor :error_code
+          # Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+          # @return [String]
+          attr_accessor :message
+          # Date and time at which Seam created the error.
+          # @return [Time]
+          date_accessor :created_at
+        end
+
         # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
         # @return [String]
+        # Known values:
+        # - `failed_to_issue`
         attr_accessor :error_code
         # Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
         # @return [String]
@@ -14,6 +32,10 @@ module Seam
         # Date and time at which Seam created the error.
         # @return [Time]
         date_accessor :created_at
+
+        discriminated_by :error_code, {
+          "failed_to_issue" => FailedToIssue
+        }.freeze
       end
 
       class PendingMutations < BaseResource
@@ -47,25 +69,100 @@ module Seam
         # @return [String]
         attr_accessor :message
         # @return [String]
+        # Known values:
+        # - `provisioning_access`
         attr_accessor :mutation_code
         # Date and time at which the mutation was created.
         # @return [Time]
         date_accessor :created_at
       end
 
+      # Known `warning_code` values load as subclasses; unknown values remain Warnings instances for forward compatibility.
       class Warnings < BaseResource
+        # Indicates that the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) is being deleted.
+        class BeingDeleted < Warnings
+          # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+          # @return [String]
+          attr_accessor :message
+          # Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+          # @return [String]
+          # Known values:
+          # - `being_deleted`
+          attr_accessor :warning_code
+          # Date and time at which Seam created the warning.
+          # @return [Time]
+          date_accessor :created_at
+        end
+
+        # Indicates that the access times for this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) are being updated.
+        class UpdatingAccessTimes < Warnings
+          # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+          # @return [String]
+          attr_accessor :message
+          # Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+          # @return [String]
+          # Known values:
+          # - `updating_access_times`
+          attr_accessor :warning_code
+          # Date and time at which Seam created the warning.
+          # @return [Time]
+          date_accessor :created_at
+        end
+
+        # Indicates that all attempts to create an access code on this device before the start time failed and a backup access code was used to ensure access was provided in time.
+        class PulledBackupAccessCode < Warnings
+          # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+          # @return [String]
+          attr_accessor :message
+          # ID of the original access method from which this backup access method was split, if applicable.
+          # @return [String, nil]
+          attr_accessor :original_access_method_id
+          # Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+          # @return [String]
+          # Known values:
+          # - `pulled_backup_access_code`
+          attr_accessor :warning_code
+          # Date and time at which Seam created the warning.
+          # @return [Time]
+          date_accessor :created_at
+        end
+
+        # Indicates that Seam has not yet issued this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant), even though its access grant is about to begin, so access may not be ready when the recipient arrives. Seam is still attempting to issue it, and this warning clears automatically once issuance succeeds.
+        class DelayInIssuing < Warnings
+          # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+          # @return [String]
+          attr_accessor :message
+          # Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+          # @return [String]
+          # Known values:
+          # - `delay_in_issuing`
+          attr_accessor :warning_code
+          # Date and time at which Seam created the warning.
+          # @return [Time]
+          date_accessor :created_at
+        end
+
         # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
         # @return [String]
         attr_accessor :message
-        # ID of the original access method from which this backup access method was split, if applicable.
-        # @return [String, nil]
-        attr_accessor :original_access_method_id
         # Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
         # @return [String]
+        # Known values:
+        # - `being_deleted`
+        # - `updating_access_times`
+        # - `pulled_backup_access_code`
+        # - `delay_in_issuing`
         attr_accessor :warning_code
         # Date and time at which Seam created the warning.
         # @return [Time]
         date_accessor :created_at
+
+        discriminated_by :warning_code, {
+          "being_deleted" => BeingDeleted,
+          "updating_access_times" => UpdatingAccessTimes,
+          "pulled_backup_access_code" => PulledBackupAccessCode,
+          "delay_in_issuing" => DelayInIssuing
+        }.freeze
       end
 
       # Errors associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).
@@ -112,6 +209,11 @@ module Seam
       attr_accessor :is_ready_for_encoding
       # Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.
       # @return [String]
+      # Known values:
+      # - `code`
+      # - `card`
+      # - `mobile_key`
+      # - `cloud_key`
       attr_accessor :mode
       # ID of the Seam workspace associated with the access method.
       # @return [String]

data/lib/seam/resources/acs_access_group.rb

@@ -17,9 +17,27 @@ module Seam
         date_accessor :starts_at
       end
 
+      # Known `error_code` values load as subclasses; unknown values remain Errors instances for forward compatibility.
       class Errors < BaseResource
+        # Indicates that the [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).
+        class FailedToCreateOnAcsSystem < Errors
+          # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+          # @return [String]
+          # Known values:
+          # - `failed_to_create_on_acs_system`
+          attr_accessor :error_code
+          # Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+          # @return [String]
+          attr_accessor :message
+          # Date and time at which Seam created the error.
+          # @return [Time]
+          date_accessor :created_at
+        end
+
         # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
         # @return [String]
+        # Known values:
+        # - `failed_to_create_on_acs_system`
         attr_accessor :error_code
         # Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
         # @return [String]
@@ -27,6 +45,10 @@ module Seam
         # Date and time at which Seam created the error.
         # @return [Time]
         date_accessor :created_at
+
+        discriminated_by :error_code, {
+          "failed_to_create_on_acs_system" => FailedToCreateOnAcsSystem
+        }.freeze
       end
 
       class PendingMutations < BaseResource
@@ -77,9 +99,14 @@ module Seam
         # @return [String]
         attr_accessor :message
         # @return [String]
+        # Known values:
+        # - `creating`
         attr_accessor :mutation_code
         # Whether the user is scheduled to be added to or removed from this access group.
         # @return [String]
+        # Known values:
+        # - `adding`
+        # - `removing`
         attr_accessor :variant
         # Date and time at which the mutation was created.
         # @return [Time]
@@ -92,6 +119,9 @@ module Seam
         attr_accessor :message
         # Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
         # @return [String]
+        # Known values:
+        # - `unknown_issue_with_acs_access_group`
+        # - `being_deleted`
         attr_accessor :warning_code
         # Date and time at which Seam created the warning.
         # @return [Time]
@@ -111,6 +141,17 @@ module Seam
       # @return [Array<Warnings>]
       resource_list_accessor :warnings, Warnings
       # @return [String]
+      # Known values:
+      # - `pti_unit`
+      # - `pti_access_level`
+      # - `salto_ks_access_group`
+      # - `brivo_group`
+      # - `salto_space_group`
+      # - `dormakaba_community_access_group`
+      # - `dormakaba_ambiance_access_group`
+      # - `avigilon_alta_group`
+      # - `kisi_access_group`
+      # - `akiles_member_group`
       # @deprecated Use `external_type`.
       attr_accessor :access_group_type
       # @return [String]
@@ -130,6 +171,17 @@ module Seam
       attr_accessor :display_name
       # Brand-specific terminology for the access group type.
       # @return [String]
+      # Known values:
+      # - `pti_unit`
+      # - `pti_access_level`
+      # - `salto_ks_access_group`
+      # - `brivo_group`
+      # - `salto_space_group`
+      # - `dormakaba_community_access_group`
+      # - `dormakaba_ambiance_access_group`
+      # - `avigilon_alta_group`
+      # - `kisi_access_group`
+      # - `akiles_member_group`
       attr_accessor :external_type
       # Display name that corresponds to the brand-specific terminology for the access group type.
       # @return [String]