@seamapi/types 1.725.0 → 1.727.0

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

@@ -11786,6 +11786,7 @@ export type Routes = {
             | 'acs_systems'
             | 'user_identities'
             | 'acs_access_groups'
+            | 'access_methods'
           )[]
         | undefined
       exclude?:
@@ -11797,6 +11798,7 @@ export type Routes = {
             | 'acs_systems'
             | 'user_identities'
             | 'acs_access_groups'
+            | 'access_methods'
           )[]
         | undefined
     }
@@ -14064,6 +14066,114 @@ export type Routes = {
               is_managed: true
             }[]
           | undefined
+        access_methods?:
+          | {
+              /** ID of the Seam workspace associated with the access method. */
+              workspace_id: string
+              /** ID of the access method. */
+              access_method_id: string
+              /** Display name of the access method. */
+              display_name: string
+              /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
+              mode: 'code' | 'card' | 'mobile_key'
+              /** Date and time at which the access method was created. */
+              created_at: string
+              /** Date and time at which the access method was issued. */
+              issued_at: string | null
+              /** Indicates whether the access method has been issued. */
+              is_issued: boolean
+              /** URL of the Instant Key for mobile key access methods. */
+              instant_key_url?: string | undefined
+              /** Token of the client session associated with the access method. */
+              client_session_token?: string | 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
+              /** The actual PIN code for code access methods. */
+              code?: (string | null) | undefined
+              /** Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). */
+              warnings: (
+                | {
+                    /** 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: 'updating_access_times'
+                  }
+              )[]
+              /** Pending mutations for the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). Indicates operations that are in progress. */
+              pending_mutations: (
+                | {
+                    /** Date and time at which the mutation was created. */
+                    created_at: 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'
+                    /** Previous device configuration. */
+                    from: {
+                      /** Previous device IDs where access was provisioned. */
+                      device_ids: string[]
+                    }
+                    /** New device configuration. */
+                    to: {
+                      /** New device IDs where access is being provisioned. */
+                      device_ids: string[]
+                    }
+                  }
+                | {
+                    /** Date and time at which the mutation was created. */
+                    created_at: 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'
+                    /** Previous device configuration. */
+                    from: {
+                      /** Previous device IDs where access existed. */
+                      device_ids: string[]
+                    }
+                    /** New device configuration. */
+                    to: {
+                      /** New device IDs where access should remain. */
+                      device_ids: string[]
+                    }
+                  }
+                | {
+                    /** Date and time at which the mutation was created. */
+                    created_at: string
+                    /** 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'
+                    /** Previous access time configuration. */
+                    from: {
+                      /** Previous start time for access. */
+                      starts_at: string | null
+                      /** Previous end time for access. */
+                      ends_at: string | null
+                    }
+                    /** New access time configuration. */
+                    to: {
+                      /** New start time for access. */
+                      starts_at: string | null
+                      /** New end time for access. */
+                      ends_at: string | null
+                    }
+                  }
+              )[]
+              /** ID of the customization profile associated with the access method. */
+              customization_profile_id?: string | undefined
+            }[]
+          | undefined
       }
     }
     maxDuration: undefined
@@ -71966,6 +72076,7 @@ export type Routes = {
         /** Business vertical of the customer portal. */
         business_vertical?:
           | (
+              | 'neutral'
               | 'short_term_rental'
               | 'hospitality'
               | 'multi_family'
@@ -72089,6 +72200,25 @@ export type Routes = {
     }
     maxDuration: undefined
   }
+  '/seam/customer/v1/settings/business_verticals/list': {
+    route: '/seam/customer/v1/settings/business_verticals/list'
+    method: 'GET' | 'POST'
+    queryParams: {}
+    jsonBody: {}
+    commonParams: {}
+    formData: {}
+    jsonResponse: {
+      business_verticals: (
+        | 'neutral'
+        | 'short_term_rental'
+        | 'hospitality'
+        | 'multi_family'
+        | 'gym_management'
+        | 'property_tours'
+      )[]
+    }
+    maxDuration: undefined
+  }
   '/seam/customer/v1/settings/get': {
     route: '/seam/customer/v1/settings/get'
     method: 'GET' | 'POST'
@@ -72100,6 +72230,7 @@ export type Routes = {
       /** Business vertical of the customer portal. */
       business_vertical?:
         | (
+            | 'neutral'
             | 'short_term_rental'
             | 'hospitality'
             | 'multi_family'
@@ -72119,6 +72250,7 @@ export type Routes = {
       /** Business vertical to set on the workspace. */
       business_vertical?:
         | (
+            | 'neutral'
             | 'short_term_rental'
             | 'hospitality'
             | 'multi_family'
@@ -72134,6 +72266,63 @@ export type Routes = {
     jsonResponse: {}
     maxDuration: undefined
   }
+  '/seam/customer/v1/settings/vertical_resource_aliases/get': {
+    route: '/seam/customer/v1/settings/vertical_resource_aliases/get'
+    method: 'GET' | 'POST'
+    queryParams: {}
+    jsonBody: {}
+    commonParams: {}
+    formData: {}
+    jsonResponse: {
+      vertical_resource_aliases: {
+        /** Primary space alias for this vertical. */
+        space: {
+          /** The key alias for a single resource. */
+          resource_key: string
+          /** Human-readable label for a single resource. */
+          resource_label: string
+          /** The key alias for a collection of resources. */
+          collection_key: string
+          /** Human-readable label for a collection of resources. */
+          collection_label: string
+        }
+        /** Additional space aliases relevant to this vertical. */
+        additional_spaces: {
+          /** The key alias for a single resource. */
+          resource_key: string
+          /** Human-readable label for a single resource. */
+          resource_label: string
+          /** The key alias for a collection of resources. */
+          collection_key: string
+          /** Human-readable label for a collection of resources. */
+          collection_label: string
+        }[]
+        /** Primary user identity alias for this vertical. */
+        user_identity: {
+          /** The key alias for a single resource. */
+          resource_key: string
+          /** Human-readable label for a single resource. */
+          resource_label: string
+          /** The key alias for a collection of resources. */
+          collection_key: string
+          /** Human-readable label for a collection of resources. */
+          collection_label: string
+        }
+        /** Primary access grant alias for this vertical. */
+        access_grant: {
+          /** The key alias for a single resource. */
+          resource_key: string
+          /** Human-readable label for a single resource. */
+          resource_label: string
+          /** The key alias for a collection of resources. */
+          collection_key: string
+          /** Human-readable label for a collection of resources. */
+          collection_label: string
+        }
+      }
+    }
+    maxDuration: undefined
+  }
   '/seam/customer/v1/spaces/create': {
     route: '/seam/customer/v1/spaces/create'
     method: 'POST'