seam 2.139.0 → 2.140.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b94008b86b31b1f480fc2c3276075bc61d83a74dd09ea0af2b7831f39e603c3
-  data.tar.gz: 1f4a039c2309d9b31c82cb9c295c09fb925161150f64eede25fcad60e35c89c0
+  metadata.gz: 564fdfd341da5fc43c859ba3a1bb7d013b40845ffbab7e0e05f917493b974821
+  data.tar.gz: a9ce5bded784a3153d98b85d6fcaaa1625837f84e9078c94a6c372e9a4a2eb24
 SHA512:
-  metadata.gz: c23cbe8e1da6b13568c3cdb1676d7e19c68068aaa99b651ae1915ce4ec04eb776def06af72e3b592381e200e9dd85dbc20e7d568ebe60ea5092e17b27151b67c
-  data.tar.gz: 23f38b1e3c55349694570c17aa70a1d3e6696336d04ec0506ba4758360fdc2a651f9229263efb2c5168f95903f3525c85163ebb1b92de1856f18775e30d830df
+  metadata.gz: 1cbe2df337d9004d747493a81330ccceda4caa1476e38d0907670b9f47d16bd4e5036a2745c958ca203ff0154e773ef91339769881da525a30ef2839f4d93761
+  data.tar.gz: 0d69f48f2499b5f2275e44ddce95be1ffa50a417e8430374197f6a976fef7691facf1fdf80f247a8dfe0f166f2a32a966b79e74c7c851252e3df5fb502e46332

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    seam (2.139.0)
+    seam (2.140.0)
       faraday (~> 2.7)
       faraday-retry (~> 2.2)
       svix (~> 1.30)
@@ -9,106 +9,109 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.7)
-      public_suffix (>= 2.0.2, < 7.0)
-    ansi (1.5.0)
-    ast (2.4.2)
-    bigdecimal (3.1.8)
-    crack (1.0.0)
+    addressable (2.9.0)
+      public_suffix (>= 2.0.2, < 8.0)
+    ansi (1.6.0)
+    ast (2.4.3)
+    base64 (0.3.0)
+    bigdecimal (4.1.2)
+    crack (1.0.1)
       bigdecimal
       rexml
-    diff-lcs (1.5.1)
-    docile (1.4.1)
-    faraday (2.12.0)
-      faraday-net_http (>= 2.0, < 3.4)
+    diff-lcs (1.6.2)
+    faraday (2.14.3)
+      faraday-net_http (>= 2.0, < 3.5)
       json
       logger
-    faraday-net_http (3.3.0)
-      net-http
-    faraday-retry (2.2.1)
+    faraday-net_http (3.4.4)
+      net-http (~> 0.5)
+    faraday-retry (2.4.0)
       faraday (~> 2.0)
-    gem-release (2.2.2)
-    hashdiff (1.1.2)
-    json (2.8.1)
-    language_server-protocol (3.17.0.3)
+    gem-release (2.2.4)
+    hashdiff (1.2.1)
+    json (2.21.2)
+    language_server-protocol (3.17.0.6)
     lint_roller (1.1.0)
-    logger (1.6.1)
-    multi_json (1.15.0)
-    net-http (0.5.0)
-      uri
-    parallel (1.26.3)
+    logger (1.7.0)
+    multi_json (1.21.1)
+    net-http (0.9.1)
+      uri (>= 0.11.1)
+    parallel (2.1.0)
     parse_gemspec (1.0.0)
     parse_gemspec-cli (1.0.0)
       multi_json
       parse_gemspec
       thor
-    parser (3.3.6.0)
+    parser (3.3.12.0)
       ast (~> 2.4.1)
       racc
-    public_suffix (6.0.1)
+    prism (1.9.0)
+    public_suffix (7.0.5)
     racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.2.1)
-    regexp_parser (2.9.2)
-    rexml (3.3.9)
-    rspec (3.13.0)
+    rake (13.4.2)
+    regexp_parser (2.12.0)
+    rexml (3.4.4)
+    rspec (3.13.2)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.2)
+    rspec-core (3.13.6)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.3)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.2)
+    rspec-mocks (3.13.8)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.1)
-    rubocop (1.66.1)
+    rspec-support (3.13.7)
+    rubocop (1.88.2)
       json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
-      parallel (~> 1.10)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (>= 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 2.4, < 3.0)
-      rubocop-ast (>= 1.32.2, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.49.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.35.0)
-      parser (>= 3.3.1.0)
-    rubocop-performance (1.22.1)
-      rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.50.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
+    rubocop-performance (1.26.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
     ruby-progressbar (1.13.0)
-    simplecov (0.22.0)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-console (0.9.2)
+    simplecov (1.1.1)
+    simplecov-console (0.9.5)
       ansi
       simplecov
       terminal-table
-    simplecov-html (0.13.1)
-    simplecov_json_formatter (0.1.4)
-    standard (1.41.1)
+    standard (1.56.0)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
-      rubocop (~> 1.66.0)
+      rubocop (~> 1.88.0)
       standard-custom (~> 1.0.0)
-      standard-performance (~> 1.5)
+      standard-performance (~> 1.8)
     standard-custom (1.0.2)
       lint_roller (~> 1.0)
       rubocop (~> 1.50)
-    standard-performance (1.5.0)
+    standard-performance (1.9.0)
       lint_roller (~> 1.1)
-      rubocop-performance (~> 1.22.0)
-    svix (1.40.0)
-    terminal-table (3.0.2)
-      unicode-display_width (>= 1.1.1, < 3)
-    thor (1.3.2)
-    unicode-display_width (2.6.0)
-    uri (1.0.1)
-    webmock (3.24.0)
+      rubocop-performance (~> 1.26.0)
+    svix (1.99.1)
+      base64 (~> 0.3.0)
+      logger (~> 1.0)
+    terminal-table (4.0.0)
+      unicode-display_width (>= 1.1.1, < 4)
+    thor (1.5.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
+    uri (1.1.1)
+    webmock (3.26.2)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -124,10 +127,10 @@ DEPENDENCIES
   rake (~> 13.0)
   rspec (~> 3.0)
   seam!
-  simplecov (~> 0.21)
+  simplecov (~> 1.1)
   simplecov-console (~> 0.9)
   standard (~> 1.3)
-  webmock (~> 3.24.0)
+  webmock (~> 3.26.2)
 
 BUNDLED WITH
-   2.5.16
+   2.5.22

data/lib/seam/http_without_workspace.rb

@@ -78,12 +78,12 @@ module Seam
         @workspaces = workspaces
       end
 
-      def list(**kwargs)
-        @workspaces.list(**kwargs)
+      def list(**)
+        @workspaces.list(**)
       end
 
-      def create(**kwargs)
-        @workspaces.create(**kwargs)
+      def create(**)
+        @workspaces.create(**)
       end
     end
 

data/lib/seam/paginator.rb

@@ -11,6 +11,9 @@ module Seam
     def initialize(request, params = {})
       raise ArgumentError, "request must be a Method" unless request.is_a?(Method)
       raise ArgumentError, "params must be a Hash" unless params.is_a?(Hash)
+      unless request.parameters.any? { |_, name| name == :page_cursor }
+        raise ArgumentError, "request does not support pagination"
+      end
 
       @request = request
       @params = params.transform_keys(&:to_sym)
@@ -71,7 +74,7 @@ module Seam
     end
   end
 
-  Pagination = Struct.new(:has_next_page, :next_page_cursor, :next_page_url, keyword_init: true) do
+  Pagination = Struct.new(:has_next_page, :next_page_cursor, :next_page_url) do
     def self.from_hash(hash)
       return nil unless hash.is_a?(Hash) && !hash.empty?
 

data/lib/seam/resources/access_code.rb

@@ -14,155 +14,229 @@ module Seam
     class AccessCode < BaseResource
       class DormakabaOracodeMetadata < BaseResource
         # Indicates whether the stay can be cancelled via the Dormakaba Oracode API.
+        # @return [Boolean, nil]
         attr_accessor :is_cancellable
         # Indicates whether early check-in is available for this stay.
+        # @return [Boolean, nil]
         attr_accessor :is_early_checkin_able
         # Indicates whether the stay can be extended via the Dormakaba Oracode API.
+        # @return [Boolean, nil]
         attr_accessor :is_extendable
         # Indicates whether the access code can be overridden. When false, the maximum number of overrides has been reached.
+        # @return [Boolean, nil]
         attr_accessor :is_overridable
         # Dormakaba Oracode site name associated with this access code.
+        # @return [String, nil]
         attr_accessor :site_name
         # Dormakaba Oracode stay ID associated with this access code.
+        # @return [Float, nil]
         attr_accessor :stay_id
         # Dormakaba Oracode user level ID associated with this access code.
+        # @return [String, nil]
         attr_accessor :user_level_id
         # Dormakaba Oracode user level name associated with this access code.
+        # @return [String, nil]
         attr_accessor :user_level_name
       end
 
       class Errors < BaseResource
         class ModifiedFields < BaseResource
           # The name of the field that was changed (e.g. `code`, `starts_at`, `ends_at`).
+          # @return [String]
           attr_accessor :field
           # The previous value of the field.
+          # @return [String, nil]
           attr_accessor :from
           # The new value of the field.
+          # @return [String, nil]
           attr_accessor :to
         end
 
+        # List of fields that were changed externally, with their previous and new values.
+        # @return [Array<ModifiedFields>]
         resource_list_accessor :modified_fields, ModifiedFields
         # Indicates the type of external modification. `modified` means the code's PIN or schedule was changed. `removed` means the code was deleted from the device.
+        # @return [String, nil]
         attr_accessor :change_type
         # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+        # @return [String]
         attr_accessor :error_code
         # Indicates that this is an access code error.
+        # @return [Boolean]
         attr_accessor :is_access_code_error
         # Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).
+        # @return [Boolean, nil]
         attr_accessor :is_bridge_error
+        # @return [Boolean, nil]
         attr_accessor :is_connected_account_error
+        # @return [Boolean]
         attr_accessor :is_device_error
         # ID of the managed access code that conflicts with this managed access code, when Seam can identify it.
+        # @return [String, nil]
         attr_accessor :managed_access_code_id
         # Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+        # @return [String]
         attr_accessor :message
         # ID of the unmanaged access code that conflicts with this managed access code, when Seam can identify it.
+        # @return [String, nil]
         attr_accessor :unmanaged_access_code_id
         # Date and time at which Seam created the error.
+        # @return [Time, nil]
         date_accessor :created_at
       end
 
       class PendingMutations < BaseResource
         class From < BaseResource
           # Previous PIN code.
+          # @return [String, nil]
           attr_accessor :code
           # Previous access code name.
+          # @return [String, nil]
           attr_accessor :name
           # Previous end time for the access code.
+          # @return [Time, nil]
           date_accessor :ends_at
           # Previous start time for the access code.
+          # @return [Time, nil]
           date_accessor :starts_at
         end
 
         class To < BaseResource
           # New PIN code.
+          # @return [String, nil]
           attr_accessor :code
           # New access code name.
+          # @return [String, nil]
           attr_accessor :name
           # New end time for the access code.
+          # @return [Time, nil]
           date_accessor :ends_at
           # New start time for the access code.
+          # @return [Time, nil]
           date_accessor :starts_at
         end
 
+        # @return [From]
         resource_accessor :from, From
+        # @return [To]
         resource_accessor :to, To
         # Detailed description of the mutation.
+        # @return [String]
         attr_accessor :message
+        # @return [String]
         attr_accessor :mutation_code
         # Date and time at which the mutation was created.
+        # @return [Time]
         date_accessor :created_at
         # Date and time at which Seam will attempt to program this access code on the device.
+        # @return [Time]
         date_accessor :scheduled_at
       end
 
       class Warnings < BaseResource
         class ModifiedFields < BaseResource
           # The name of the field that was changed (e.g. `code`, `starts_at`, `ends_at`).
+          # @return [String]
           attr_accessor :field
           # The previous value of the field.
+          # @return [String, nil]
           attr_accessor :from
           # The new value of the field.
+          # @return [String, nil]
           attr_accessor :to
         end
 
+        # List of fields that were changed externally, with their previous and new values.
+        # @return [Array<ModifiedFields>]
         resource_list_accessor :modified_fields, ModifiedFields
         # Indicates the type of external modification. `modified` means the code's PIN or schedule was changed. `removed` means the code was deleted from the device.
+        # @return [String, nil]
         attr_accessor :change_type
         # 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]
         attr_accessor :warning_code
         # Date and time at which Seam created the warning.
+        # @return [Time, nil]
         date_accessor :created_at
       end
 
+      # Metadata for a dormakaba Oracode managed access code. Only present for access codes from dormakaba Oracode devices.
+      # @return [DormakabaOracodeMetadata, nil]
       resource_accessor :dormakaba_oracode_metadata, DormakabaOracodeMetadata
+      # Errors associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes).
+      # @return [Array<Errors>]
       resource_list_accessor :errors, Errors
+      # Collection of pending mutations for the access code. Indicates changes that Seam is in the process of pushing to the device.
+      # @return [Array<PendingMutations>]
       resource_list_accessor :pending_mutations, PendingMutations
+      # Warnings associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes).
+      # @return [Array<Warnings>]
       resource_list_accessor :warnings, Warnings
       # Unique identifier for the access code.
+      # @return [String]
       attr_accessor :access_code_id
       # Code used for access. Typically, a numeric or alphanumeric string.
+      # @return [String, nil]
       attr_accessor :code
       # Unique identifier for a group of access codes that share the same code.
+      # @return [String, nil]
       attr_accessor :common_code_key
       # Unique identifier for the device associated with the access code.
+      # @return [String]
       attr_accessor :device_id
       # Indicates whether the access code is a backup code.
+      # @return [Boolean, nil]
       attr_accessor :is_backup
       # Indicates whether a backup access code is available for use if the primary access code is lost or compromised.
+      # @return [Boolean]
       attr_accessor :is_backup_access_code_available
       # Indicates whether changes to the access code from external sources are permitted.
+      # @return [Boolean]
       attr_accessor :is_external_modification_allowed
       # Indicates whether Seam manages the access code.
+      # @return [Boolean]
       attr_accessor :is_managed
       # Indicates whether the access code is intended for use in offline scenarios. If `true`, this code can be created on a device without a network connection.
+      # @return [Boolean]
       attr_accessor :is_offline_access_code
       # Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use.
+      # @return [Boolean]
       attr_accessor :is_one_time_use
       # Indicates whether the code is set on the device according to a preconfigured schedule.
+      # @return [Boolean, nil]
       attr_accessor :is_scheduled_on_device
       # Indicates whether the access code is waiting for a code assignment.
+      # @return [Boolean, nil]
       attr_accessor :is_waiting_for_code_assignment
       # Name of the 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).
+      # @return [String, nil]
       attr_accessor :name
       # Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code.
+      # @return [String, nil]
       attr_accessor :pulled_backup_access_code_id
       # Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes).
+      # @return [String]
       attr_accessor :status
       # Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration.
+      # @return [String]
       attr_accessor :type
       # Unique identifier for the Seam workspace associated with the access code.
+      # @return [String]
       attr_accessor :workspace_id
 
       # Date and time at which the access code was created.
+      # @return [Time]
       date_accessor :created_at
 
       # Date and time after which the time-bound access code becomes inactive.
+      # @return [Time, nil]
       date_accessor :ends_at
 
       # Date and time at which the time-bound access code becomes active.
+      # @return [Time, nil]
       date_accessor :starts_at
     end
   end

data/lib/seam/resources/access_grant.rb

@@ -6,128 +6,188 @@ module Seam
     class AccessGrant < BaseResource
       class Errors < BaseResource
         # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+        # @return [String]
         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
 
       class PendingMutations < BaseResource
         class From < BaseResource
           # Previous device IDs where access codes existed.
+          # @return [Array<String>]
           attr_accessor :device_ids
           # Previous end time for access.
+          # @return [Time, nil]
           date_accessor :ends_at
           # Previous start time for access.
+          # @return [Time, nil]
           date_accessor :starts_at
         end
 
         class To < BaseResource
           # Common code key to ensure PIN code reuse across devices.
+          # @return [String, nil]
           attr_accessor :common_code_key
           # New device IDs where access codes should be created.
+          # @return [Array<String>]
           attr_accessor :device_ids
           # New end time for access.
+          # @return [Time, nil]
           date_accessor :ends_at
           # New start time for access.
+          # @return [Time, nil]
           date_accessor :starts_at
         end
 
+        # @return [From]
         resource_accessor :from, From
+        # @return [To]
         resource_accessor :to, To
         # IDs of the access methods being updated.
+        # @return [Array<String>]
         attr_accessor :access_method_ids
         # Detailed description of the mutation.
+        # @return [String]
         attr_accessor :message
+        # @return [String]
         attr_accessor :mutation_code
         # Date and time at which the mutation was created.
+        # @return [Time]
         date_accessor :created_at
       end
 
       class RequestedAccessMethods < BaseResource
         # Specific PIN code to use for this access method. Only applicable when mode is 'code'.
+        # @return [String, nil]
         attr_accessor :code
         # IDs of the access methods created for the requested access method.
+        # @return [Array<String>]
         attr_accessor :created_access_method_ids
         # Display name of the access method.
+        # @return [String]
         attr_accessor :display_name
         # Maximum number of times the instant key can be used. Only applicable when mode is 'mobile_key'. Defaults to 1 if not specified.
+        # @return [Integer, nil]
         attr_accessor :instant_key_max_use_count
         # Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.
+        # @return [String]
         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
 
       class Warnings < BaseResource
         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
         # 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]
         attr_accessor :warning_code
         # Date and time at which Seam created the warning.
+        # @return [Time]
         date_accessor :created_at
       end
 
+      # Errors associated with the [access grant](https://docs.seam.co/use-cases/granting-access).
+      # @return [Array<Errors>]
       resource_list_accessor :errors, Errors
+      # List of pending mutations for the access grant. This shows updates that are in progress.
+      # @return [Array<PendingMutations>]
       resource_list_accessor :pending_mutations, PendingMutations
+      # Access methods that the user requested for the Access Grant.
+      # @return [Array<RequestedAccessMethods>]
       resource_list_accessor :requested_access_methods, RequestedAccessMethods
+      # Warnings associated with the [access grant](https://docs.seam.co/use-cases/granting-access).
+      # @return [Array<Warnings>]
       resource_list_accessor :warnings, Warnings
       # ID of the Access Grant.
+      # @return [String]
       attr_accessor :access_grant_id
       # Unique key for the access grant within the workspace.
+      # @return [String, nil]
       attr_accessor :access_grant_key
       # IDs of the access methods created for the Access Grant.
+      # @return [Array<String>]
       attr_accessor :access_method_ids
       # Client Session Token. Only returned if the Access Grant has a mobile_key access method.
+      # @return [String, nil]
       attr_accessor :client_session_token
       # ID of the customization profile associated with the Access Grant.
+      # @return [String, nil]
       attr_accessor :customization_profile_id
       # Display name of the Access Grant.
+      # @return [String]
       attr_accessor :display_name
       # Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method.
+      # @return [String, nil]
       attr_accessor :instant_key_url
+      # @return [Array<String>]
       # @deprecated Use `space_ids`.
       attr_accessor :location_ids
       # Name of the Access Grant. If not provided, the display name will be computed.
+      # @return [String, nil]
       attr_accessor :name
       # Reservation key for the access grant.
+      # @return [String, nil]
       attr_accessor :reservation_key
       # IDs of the spaces to which the Access Grant gives access.
+      # @return [Array<String>]
       attr_accessor :space_ids
       # ID of user identity to which the Access Grant gives access.
+      # @return [String]
       attr_accessor :user_identity_id
       # ID of the Seam workspace associated with the Access Grant.
+      # @return [String]
       attr_accessor :workspace_id
 
       # Date and time at which the Access Grant was created.
+      # @return [Time]
       date_accessor :created_at
 
       # Date and time at which the Access Grant ends.
+      # @return [Time, nil]
       date_accessor :ends_at
 
       # Date and time at which the Access Grant starts.
+      # @return [Time]
       date_accessor :starts_at
     end
   end