@seamapi/types 1.392.0 → 1.393.0

package/src/lib/seam/connect/route-types.ts

@@ -10314,6 +10314,13 @@ export interface Routes {
               message: string
               error_code: 'failed_to_delete_on_acs_system'
             }
+          | {
+              /** Date and time at which Seam created the error. */
+              created_at: string
+              /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              error_code: 'latch_conflict_with_resident_user'
+            }
         >
         /** Pending mutations associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Seam is in the process of pushing these mutations to the integrated access system. */
         pending_mutations?:
@@ -11309,6 +11316,7 @@ export interface Routes {
           /** ID of the user identity for which you want to retrieve all credentials. */
           user_identity_id: string
         }
+      | {}
     ) & {
       /** Number of credentials to return. */
       limit?: number
@@ -17404,6 +17412,13 @@ export interface Routes {
               message: string
               error_code: 'failed_to_delete_on_acs_system'
             }
+          | {
+              /** Date and time at which Seam created the error. */
+              created_at: string
+              /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              error_code: 'latch_conflict_with_resident_user'
+            }
         >
         /** Pending mutations associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Seam is in the process of pushing these mutations to the integrated access system. */
         pending_mutations?:
@@ -17640,6 +17655,13 @@ export interface Routes {
               message: string
               error_code: 'failed_to_delete_on_acs_system'
             }
+          | {
+              /** Date and time at which Seam created the error. */
+              created_at: string
+              /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              error_code: 'latch_conflict_with_resident_user'
+            }
         >
         /** Pending mutations associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Seam is in the process of pushing these mutations to the integrated access system. */
         pending_mutations?:
@@ -17872,6 +17894,13 @@ export interface Routes {
               message: string
               error_code: 'failed_to_delete_on_acs_system'
             }
+          | {
+              /** Date and time at which Seam created the error. */
+              created_at: string
+              /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              error_code: 'latch_conflict_with_resident_user'
+            }
         >
         /** Pending mutations associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Seam is in the process of pushing these mutations to the integrated access system. */
         pending_mutations?:
@@ -18236,6 +18265,13 @@ export interface Routes {
               message: string
               error_code: 'failed_to_delete_on_acs_system'
             }
+          | {
+              /** Date and time at which Seam created the error. */
+              created_at: string
+              /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              error_code: 'latch_conflict_with_resident_user'
+            }
         >
         /** Pending mutations associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Seam is in the process of pushing these mutations to the integrated access system. */
         pending_mutations?:
@@ -18458,6 +18494,13 @@ export interface Routes {
               message: string
               error_code: 'failed_to_delete_on_acs_system'
             }
+          | {
+              /** Date and time at which Seam created the error. */
+              created_at: string
+              /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              error_code: 'latch_conflict_with_resident_user'
+            }
         >
         /** Pending mutations associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Seam is in the process of pushing these mutations to the integrated access system. */
         pending_mutations?:
@@ -44203,6 +44246,155 @@ export interface Routes {
       }
     }
   }
+  '/seam/mobile_sdk/v1/acs/credentials/list': {
+    route: '/seam/mobile_sdk/v1/acs/credentials/list'
+    method: 'GET' | 'POST'
+    queryParams: {}
+    jsonBody: {}
+    commonParams: {}
+    formData: {}
+    jsonResponse: {
+      acs_credentials: Array<{
+        /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+        acs_credential_id: string
+        /** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
+        acs_user_id?: string | undefined
+        acs_credential_pool_id?: string | undefined
+        /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+        acs_system_id: string
+        /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+        parent_acs_credential_id?: string | undefined
+        /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
+        display_name: string
+        /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+        code?: (string | undefined) | null
+        /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
+        is_one_time_use?: boolean | undefined
+        /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+        card_number?: (string | undefined) | null
+        /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
+        is_issued?: boolean | undefined
+        /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
+        issued_at?: (string | undefined) | null
+        /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
+        access_method: 'code' | 'card' | 'mobile_key'
+        /** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
+        external_type?:
+          | (
+              | 'pti_card'
+              | 'brivo_credential'
+              | 'hid_credential'
+              | 'visionline_card'
+              | 'salto_ks_credential'
+              | 'assa_abloy_vostio_key'
+              | 'salto_space_key'
+              | 'latch_access'
+            )
+          | undefined
+        /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
+        external_type_display_name?: string | undefined
+        /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
+        created_at: string
+        /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+        workspace_id: string
+        /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
+        starts_at?: string | undefined
+        /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity 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`. */
+        ends_at?: string | undefined
+        /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+        errors: Array<{
+          error_code: string
+          message: string
+        }>
+        /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+        warnings: Array<
+          | {
+              /** 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: 'waiting_to_be_issued'
+            }
+          | {
+              /** 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: 'schedule_externally_modified'
+            }
+          | {
+              /** 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: 'schedule_modified'
+            }
+          | {
+              /** 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'
+            }
+          | {
+              /** 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: 'unknown_issue_with_acs_credential'
+            }
+          | {
+              /** 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: 'needs_to_be_reissued'
+            }
+        >
+        /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
+        is_multi_phone_sync_credential?: boolean | undefined
+        /** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
+        is_latest_desired_state_synced_with_provider?:
+          | (boolean | null)
+          | undefined
+        /** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
+        latest_desired_state_synced_with_provider_at?:
+          | (string | null)
+          | undefined
+        /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+        visionline_metadata?:
+          | {
+              card_function_type: 'guest' | 'staff'
+              joiner_acs_credential_ids?: string[] | undefined
+              guest_acs_entrance_ids?: string[] | undefined
+              common_acs_entrance_ids?: string[] | undefined
+              is_valid?: boolean | undefined
+              auto_join?: boolean | undefined
+              card_id?: string | undefined
+              credential_id?: string | undefined
+            }
+          | undefined
+        /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+        assa_abloy_vostio_metadata?:
+          | {
+              auto_join?: boolean | undefined
+              override_guest_acs_entrance_ids?: string[] | undefined
+              key_id?: string | undefined
+              key_issuing_request_id?: string | undefined
+              door_names?: string[] | undefined
+              endpoint_id?: string | undefined
+            }
+          | undefined
+        is_managed: true
+      }>
+    }
+  }
   '/thermostats/activate_climate_preset': {
     route: '/thermostats/activate_climate_preset'
     method: 'POST'
@@ -45790,6 +45982,7 @@ export interface Routes {
                         /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
                         assa_abloy_vostio_metadata?:
                           | {
+                              auto_join?: boolean | undefined
                               override_guest_acs_entrance_ids?:
                                 | string[]
                                 | undefined
@@ -45930,6 +46123,7 @@ export interface Routes {
                         /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
                         assa_abloy_vostio_metadata?:
                           | {
+                              auto_join?: boolean | undefined
                               override_guest_acs_entrance_ids?:
                                 | string[]
                                 | undefined
@@ -46199,6 +46393,7 @@ export interface Routes {
                   /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
                   assa_abloy_vostio_metadata?:
                     | {
+                        auto_join?: boolean | undefined
                         override_guest_acs_entrance_ids?: string[] | undefined
                         key_id?: string | undefined
                         key_issuing_request_id?: string | undefined
@@ -46337,6 +46532,7 @@ export interface Routes {
                   /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
                   assa_abloy_vostio_metadata?:
                     | {
+                        auto_join?: boolean | undefined
                         override_guest_acs_entrance_ids?: string[] | undefined
                         key_id?: string | undefined
                         key_issuing_request_id?: string | undefined
@@ -47091,6 +47287,7 @@ export interface Routes {
                         /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
                         assa_abloy_vostio_metadata?:
                           | {
+                              auto_join?: boolean | undefined
                               override_guest_acs_entrance_ids?:
                                 | string[]
                                 | undefined
@@ -47231,6 +47428,7 @@ export interface Routes {
                         /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
                         assa_abloy_vostio_metadata?:
                           | {
+                              auto_join?: boolean | undefined
                               override_guest_acs_entrance_ids?:
                                 | string[]
                                 | undefined
@@ -47500,6 +47698,7 @@ export interface Routes {
                   /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
                   assa_abloy_vostio_metadata?:
                     | {
+                        auto_join?: boolean | undefined
                         override_guest_acs_entrance_ids?: string[] | undefined
                         key_id?: string | undefined
                         key_issuing_request_id?: string | undefined
@@ -47638,6 +47837,7 @@ export interface Routes {
                   /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
                   assa_abloy_vostio_metadata?:
                     | {
+                        auto_join?: boolean | undefined
                         override_guest_acs_entrance_ids?: string[] | undefined
                         key_id?: string | undefined
                         key_issuing_request_id?: string | undefined
@@ -49794,6 +49994,7 @@ export interface Routes {
                         /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
                         assa_abloy_vostio_metadata?:
                           | {
+                              auto_join?: boolean | undefined
                               override_guest_acs_entrance_ids?:
                                 | string[]
                                 | undefined
@@ -49934,6 +50135,7 @@ export interface Routes {
                         /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
                         assa_abloy_vostio_metadata?:
                           | {
+                              auto_join?: boolean | undefined
                               override_guest_acs_entrance_ids?:
                                 | string[]
                                 | undefined
@@ -50203,6 +50405,7 @@ export interface Routes {
                   /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
                   assa_abloy_vostio_metadata?:
                     | {
+                        auto_join?: boolean | undefined
                         override_guest_acs_entrance_ids?: string[] | undefined
                         key_id?: string | undefined
                         key_issuing_request_id?: string | undefined
@@ -50341,6 +50544,7 @@ export interface Routes {
                   /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
                   assa_abloy_vostio_metadata?:
                     | {
+                        auto_join?: boolean | undefined
                         override_guest_acs_entrance_ids?: string[] | undefined
                         key_id?: string | undefined
                         key_issuing_request_id?: string | undefined
@@ -63735,6 +63939,13 @@ export interface Routes {
               message: string
               error_code: 'failed_to_delete_on_acs_system'
             }
+          | {
+              /** Date and time at which Seam created the error. */
+              created_at: string
+              /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              error_code: 'latch_conflict_with_resident_user'
+            }
         >
         /** Pending mutations associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Seam is in the process of pushing these mutations to the integrated access system. */
         pending_mutations?: