@seamapi/http 2.1.0 → 2.2.0

package/src/lib/seam/connect/resources/access-method.ts

@@ -3,115 +3,310 @@
  * Do not edit this file.
  */
 
+/**
+ * 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.
+ */
 export type AccessMethod = {
+  /**
+   * ID of the access method.
+   */
   access_method_id: string
 
+  /**
+   * Token of the client session associated with the access method.
+   */
   client_session_token?: string | undefined
+  /**
+   * The actual PIN code for code access methods.
+   */
   code?: string | null | undefined
+  /**
+   * Date and time at which the access method was created.
+   */
   created_at: string
 
+  /**
+   * ID of the customization profile associated with the access method.
+   */
   customization_profile_id?: string | undefined
+  /**
+   * Display name of the access method.
+   */
   display_name: string
 
-  errors: Array<{
-    created_at: string
+  /**
+   * Errors associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).
+   */
+  errors: Array<
+    /**
+     * 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.
+     */
+    {
+      /**
+       * Date and time at which Seam created the error.
+       */
+      created_at: string
 
-    error_code: 'failed_to_issue'
+      /**
+       * Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+       */
+      error_code: 'failed_to_issue'
 
-    message: string
-  }>
+      /**
+       * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+       */
+      message: string
+    }
+  >
 
+  /**
+   * URL of the Instant Key for mobile key access methods.
+   */
   instant_key_url?: string | undefined
+  /**
+   * Indicates whether an existing card credential must be assigned to this access method before it can be issued. Only applies to card-mode access methods on systems that support credential assignment.
+   */
   is_assignment_required?: boolean | undefined
+  /**
+   * Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method.
+   */
   is_encoding_required?: boolean | undefined
+  /**
+   * Indicates whether the access method has been issued.
+   */
   is_issued: boolean
 
+  /**
+   * Indicates whether the access method is ready for card assignment. This is true when the access method is in card mode, has not yet been issued, and the system supports credential assignment.
+   */
   is_ready_for_assignment?: boolean | undefined
+  /**
+   * Indicates whether the access method is ready to be encoded. This is true when the credential has been created and the card has not yet been issued.
+   */
   is_ready_for_encoding?: boolean | undefined
+  /**
+   * Date and time at which the access method was issued.
+   */
   issued_at: string | null
+  /**
+   * Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.
+   */
   mode: 'code' | 'card' | 'mobile_key' | 'cloud_key'
 
+  /**
+   * Pending mutations for the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant). Indicates operations that are in progress.
+   */
   pending_mutations: Array<
+    /**
+     * Seam is in the process of provisioning access for this access method on new devices.
+     */
     | {
+        /**
+         * Date and time at which the mutation was created.
+         */
         created_at: string
 
+        /**
+         * Previous device configuration.
+         */
         from: {
+          /**
+           * Previous device IDs where access was provisioned.
+           */
           device_ids: Array<string>
         }
 
+        /**
+         * Detailed description of the mutation.
+         */
         message: string
 
+        /**
+         * Mutation code to indicate that Seam is in the process of provisioning access for this access method on new devices.
+         */
         mutation_code: 'provisioning_access'
 
+        /**
+         * New device configuration.
+         */
         to: {
+          /**
+           * New device IDs where access is being provisioned.
+           */
           device_ids: Array<string>
         }
-      }
+      } /**
+     * Seam is in the process of revoking access for this access method from devices.
+     */
     | {
+        /**
+         * Date and time at which the mutation was created.
+         */
         created_at: string
 
+        /**
+         * Previous device configuration.
+         */
         from: {
+          /**
+           * Previous device IDs where access existed.
+           */
           device_ids: Array<string>
         }
 
+        /**
+         * Detailed description of the mutation.
+         */
         message: string
 
+        /**
+         * Mutation code to indicate that Seam is in the process of revoking access for this access method from devices.
+         */
         mutation_code: 'revoking_access'
 
+        /**
+         * New device configuration.
+         */
         to: {
+          /**
+           * New device IDs where access should remain.
+           */
           device_ids: Array<string>
         }
-      }
+      } /**
+     * Seam is in the process of updating the access times for this access method.
+     */
     | {
+        /**
+         * Date and time at which the mutation was created.
+         */
         created_at: string
 
+        /**
+         * Previous access time configuration.
+         */
         from: {
+          /**
+           * Previous end time for access.
+           */
           ends_at: string | null
+          /**
+           * Previous start time for access.
+           */
           starts_at: string | null
         }
 
+        /**
+         * Detailed description of the mutation.
+         */
         message: string
 
+        /**
+         * Mutation code to indicate that Seam is in the process of updating the access times for this access method.
+         */
         mutation_code: 'updating_access_times'
 
+        /**
+         * New access time configuration.
+         */
         to: {
+          /**
+           * New end time for access.
+           */
           ends_at: string | null
+          /**
+           * New start time for access.
+           */
           starts_at: string | null
         }
       }
   >
 
+  /**
+   * Warnings associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).
+   */
   warnings: Array<
+    /**
+     * Indicates that the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) is being deleted.
+     */
     | {
+        /**
+         * Date and time at which Seam created the warning.
+         */
         created_at: string
 
+        /**
+         * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+         */
         message: string
 
+        /**
+         * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+         */
         warning_code: 'being_deleted'
-      }
+      } /**
+     * Indicates that the access times for this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) are being updated.
+     */
     | {
+        /**
+         * Date and time at which Seam created the warning.
+         */
         created_at: string
 
+        /**
+         * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+         */
         message: string
 
+        /**
+         * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+         */
         warning_code: 'updating_access_times'
-      }
+      } /**
+     * 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.
+     */
     | {
+        /**
+         * Date and time at which Seam created the warning.
+         */
         created_at: string
 
+        /**
+         * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+         */
         message: string
 
+        /**
+         * ID of the original access method from which this backup access method was split, if applicable.
+         */
         original_access_method_id?: string | undefined
+        /**
+         * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+         */
         warning_code: 'pulled_backup_access_code'
-      }
+      } /**
+     * 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.
+     */
     | {
+        /**
+         * Date and time at which Seam created the warning.
+         */
         created_at: string
 
+        /**
+         * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+         */
         message: string
 
+        /**
+         * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+         */
         warning_code: 'delay_in_issuing'
       }
   >
 
+  /**
+   * ID of the Seam workspace associated with the access method.
+   */
   workspace_id: string
 }