seam 2.142.0 → 2.145.0

data/lib/seam/resources/acs_user.rb

@@ -17,8 +17,100 @@ 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 system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was deleted from the [access system](https://docs.seam.co/low-level-apis/access-systems) outside of Seam.
+        class DeletedExternally < Errors
+          # @return [String]
+          # Known values:
+          # - `deleted_externally`
+          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
+
+        # Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded.
+        class SaltoKsSubscriptionLimitExceeded < Errors
+          # @return [String]
+          # Known values:
+          # - `salto_ks_subscription_limit_exceeded`
+          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
+
+        # Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) 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
+          # @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
+
+        # Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was not updated 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 FailedToUpdateOnAcsSystem < Errors
+          # @return [String]
+          # Known values:
+          # - `failed_to_update_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
+
+        # Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was not deleted 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 FailedToDeleteOnAcsSystem < Errors
+          # @return [String]
+          # Known values:
+          # - `failed_to_delete_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
+
+        # Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was created from the Seam API but also exists on Mission Control. This is unsupported. Contact Seam [support](mailto:support@seam.co).
+        class LatchConflictWithResidentUser < Errors
+          # @return [String]
+          # Known values:
+          # - `latch_conflict_with_resident_user`
+          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
+
         # @return [String]
+        # Known values:
+        # - `deleted_externally`
+        # - `salto_ks_subscription_limit_exceeded`
+        # - `failed_to_create_on_acs_system`
+        # - `failed_to_update_on_acs_system`
+        # - `failed_to_delete_on_acs_system`
+        # - `latch_conflict_with_resident_user`
         attr_accessor :error_code
         # Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
         # @return [String]
@@ -26,6 +118,15 @@ module Seam
         # Date and time at which Seam created the error.
         # @return [Time]
         date_accessor :created_at
+
+        discriminated_by :error_code, {
+          "deleted_externally" => DeletedExternally,
+          "salto_ks_subscription_limit_exceeded" => SaltoKsSubscriptionLimitExceeded,
+          "failed_to_create_on_acs_system" => FailedToCreateOnAcsSystem,
+          "failed_to_update_on_acs_system" => FailedToUpdateOnAcsSystem,
+          "failed_to_delete_on_acs_system" => FailedToDeleteOnAcsSystem,
+          "latch_conflict_with_resident_user" => LatchConflictWithResidentUser
+        }.freeze
       end
 
       class PendingMutations < BaseResource
@@ -92,9 +193,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 the access group.
         # @return [String]
+        # Known values:
+        # - `adding`
+        # - `removing`
         attr_accessor :variant
         # Date and time at which the mutation was created.
         # @return [Time]
@@ -119,15 +225,100 @@ module Seam
         attr_accessor :user_id
       end
 
+      # Known `warning_code` values load as subclasses; unknown values remain Warnings instances for forward compatibility.
       class Warnings < BaseResource
+        # Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) is being deleted from the [access system](https://docs.seam.co/low-level-apis/access-systems). This is a temporary state, and the access system user will be deleted shortly.
+        class BeingDeleted < Warnings
+          # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+          # @return [String]
+          attr_accessor :message
+          # @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 system user](https://docs.seam.co/low-level-apis/access-systems/user-management) is not subscribed on Salto KS, so they cannot unlock doors or perform any actions. This occurs when the their access schedule hasn’t started yet, if their access schedule has ended, if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed.
+        class SaltoKsUserNotSubscribed < Warnings
+          # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+          # @return [String]
+          attr_accessor :message
+          # @return [String]
+          # Known values:
+          # - `salto_ks_user_not_subscribed`
+          attr_accessor :warning_code
+          # Date and time at which Seam created the warning.
+          # @return [Time]
+          date_accessor :created_at
+        end
+
+        # Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) exists but is not currently able to gain access—for example, because their access schedule has not started yet or has ended, the access system has reached its limit for active users, or they have been unsubscribed or deactivated. Refer to the warning message for the provider-specific reason. This is distinct from `is_suspended`, which indicates the user has been explicitly blocked.
+        class AcsUserInactive < Warnings
+          # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+          # @return [String]
+          attr_accessor :message
+          # @return [String]
+          # Known values:
+          # - `acs_user_inactive`
+          attr_accessor :warning_code
+          # Date and time at which Seam created the warning.
+          # @return [Time]
+          date_accessor :created_at
+        end
+
+        # An unknown issue occurred while syncing the state of this [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) with the provider. This issue may affect the proper functioning of this user.
+        class UnknownIssueWithAcsUser < Warnings
+          # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+          # @return [String]
+          attr_accessor :message
+          # @return [String]
+          # Known values:
+          # - `unknown_issue_with_acs_user`
+          attr_accessor :warning_code
+          # Date and time at which Seam created the warning.
+          # @return [Time]
+          date_accessor :created_at
+        end
+
+        # Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was created on Latch Mission Control. Please use the Latch Mission Control to manage this user.
+        class LatchResidentUser < Warnings
+          # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+          # @return [String]
+          attr_accessor :message
+          # @return [String]
+          # Known values:
+          # - `latch_resident_user`
+          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
         # @return [String]
+        # Known values:
+        # - `being_deleted`
+        # - `salto_ks_user_not_subscribed`
+        # - `acs_user_inactive`
+        # - `unknown_issue_with_acs_user`
+        # - `latch_resident_user`
         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,
+          "salto_ks_user_not_subscribed" => SaltoKsUserNotSubscribed,
+          "acs_user_inactive" => AcsUserInactive,
+          "unknown_issue_with_acs_user" => UnknownIssueWithAcsUser,
+          "latch_resident_user" => LatchResidentUser
+        }.freeze
       end
 
       # `starts_at` and `ends_at` timestamps for the [access system user's](https://docs.seam.co/low-level-apis/access-systems/user-management) access.
@@ -168,6 +359,16 @@ module Seam
       attr_accessor :email_address
       # Brand-specific terminology for the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) type.
       # @return [String, nil]
+      # Known values:
+      # - `pti_user`
+      # - `brivo_user`
+      # - `hid_credential_manager_user`
+      # - `salto_site_user`
+      # - `latch_user`
+      # - `dormakaba_community_user`
+      # - `salto_space_user`
+      # - `avigilon_alta_user`
+      # - `kisi_user`
       attr_accessor :external_type
       # Display name that corresponds to the brand-specific terminology for the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) type.
       # @return [String, nil]