@seamapi/types 1.469.0 → 1.470.0

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

@@ -85528,324 +85528,6 @@ export type Routes = {
           }
     }
   }
-  '/unstable_access_grants/create': {
-    route: '/unstable_access_grants/create'
-    method: 'POST'
-    queryParams: {}
-    jsonBody: {}
-    commonParams: (
-      | {
-          /** ID of user identity for whom you want to grant access. */
-          user_identity_id: string
-        }
-      | {
-          /** User identity. When used, creates a new user identity with the specified details and grants them access. */
-          user_identity: {
-            /** Unique email address for the user identity. */
-            email_address?: (string | null) | undefined
-            /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
-            phone_number?: (string | null) | undefined
-            full_name?: (string | null) | undefined
-          }
-        }
-    ) & {
-      /**
-       * @deprecated Use `space_ids`.*/
-      location_ids?: string[] | undefined
-      /** IDs of the existing spaces to which you want to grant access. */
-      space_ids?: string[] | undefined
-      /** Location. When used, creates a new location with the specified entrances and devices, and gives the user access to this location. */
-      location?:
-        | {
-            /** Name of the location. */
-            name?: string | undefined
-            /**
-             * @deprecated Use `acs_entrance_ids` at the top level.*/
-            acs_entrance_ids?: string[]
-            /**
-             * @deprecated Use `device_ids` at the top level.*/
-            device_ids?: string[]
-          }
-        | undefined
-      /** IDs of the [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to which you want to grant access. */
-      acs_entrance_ids?: string[]
-      /** IDs of the devices to which you want to grant access. */
-      device_ids?: string[]
-      requested_access_methods: {
-        /** Access method mode. */
-        mode: 'code' | 'card' | 'mobile_key'
-      }[]
-      /** Date and time at which the validity of the new grant 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 validity of the new grant 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
-    }
-    formData: {}
-    jsonResponse: {
-      /** Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant. */
-      access_grant: {
-        /** ID of the Seam workspace associated with the Access Grant. */
-        workspace_id: string
-        /** ID of the Access Grant. */
-        access_grant_id: string
-        /** Unique key for the access grant within the workspace. */
-        access_grant_key?: string | undefined
-        /** ID of user identity to which the Access Grant gives access. */
-        user_identity_id: string
-        /**
-         * @deprecated Use `space_ids`.*/
-        location_ids: string[]
-        /** IDs of the spaces to which the Access Grant gives access. */
-        space_ids: string[]
-        /** Access methods that the user requested for the Access Grant. */
-        requested_access_methods: {
-          /** 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 requested access method was added to the Access Grant. */
-          created_at: string
-          /** IDs of the access methods created for the requested access method. */
-          created_access_method_ids: string[]
-        }[]
-        /** IDs of the access methods created for the Access Grant. */
-        access_method_ids: string[]
-        /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
-        client_session_token?: string | undefined
-        /** Name of the Access Grant. If not provided, the display name will be computed. */
-        name: string | null
-        /** Display name of the Access Grant. */
-        display_name: string
-        /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method.  */
-        instant_key_url?: string | undefined
-        /** Date and time at which the Access Grant was created. */
-        created_at: string
-        /** Date and time at which the Access Grant starts. */
-        starts_at: string
-        /** Date and time at which the Access Grant ends. */
-        ends_at: string | null
-      }
-    }
-  }
-  '/unstable_access_grants/delete': {
-    route: '/unstable_access_grants/delete'
-    method: 'DELETE' | 'POST'
-    queryParams: {}
-    jsonBody: {}
-    commonParams: {
-      /** ID of access grant that you want to delete. */
-      access_grant_id: string
-    }
-    formData: {}
-    jsonResponse: {}
-  }
-  '/unstable_access_grants/get': {
-    route: '/unstable_access_grants/get'
-    method: 'GET' | 'POST'
-    queryParams: {}
-    jsonBody: {}
-    commonParams: {
-      /** ID of access grant that you want to get. */
-      access_grant_id: string
-    }
-    formData: {}
-    jsonResponse: {
-      /** Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant. */
-      access_grant: {
-        /** ID of the Seam workspace associated with the Access Grant. */
-        workspace_id: string
-        /** ID of the Access Grant. */
-        access_grant_id: string
-        /** Unique key for the access grant within the workspace. */
-        access_grant_key?: string | undefined
-        /** ID of user identity to which the Access Grant gives access. */
-        user_identity_id: string
-        /**
-         * @deprecated Use `space_ids`.*/
-        location_ids: string[]
-        /** IDs of the spaces to which the Access Grant gives access. */
-        space_ids: string[]
-        /** Access methods that the user requested for the Access Grant. */
-        requested_access_methods: {
-          /** 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 requested access method was added to the Access Grant. */
-          created_at: string
-          /** IDs of the access methods created for the requested access method. */
-          created_access_method_ids: string[]
-        }[]
-        /** IDs of the access methods created for the Access Grant. */
-        access_method_ids: string[]
-        /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
-        client_session_token?: string | undefined
-        /** Name of the Access Grant. If not provided, the display name will be computed. */
-        name: string | null
-        /** Display name of the Access Grant. */
-        display_name: string
-        /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method.  */
-        instant_key_url?: string | undefined
-        /** Date and time at which the Access Grant was created. */
-        created_at: string
-        /** Date and time at which the Access Grant starts. */
-        starts_at: string
-        /** Date and time at which the Access Grant ends. */
-        ends_at: string | null
-      }
-    }
-  }
-  '/unstable_access_grants/list': {
-    route: '/unstable_access_grants/list'
-    method: 'GET' | 'POST'
-    queryParams: {}
-    jsonBody: {}
-    commonParams: {
-      /** ID of the user identity by which you want to filter the list of access grants. */
-      user_identity_id?: string | undefined
-      /** ID of the access system by which you want to filter the list of access grants. */
-      acs_system_id?: string | undefined
-      /** ID of the entrance by which you want to filter the list of access grants. */
-      acs_entrance_id?: string | undefined
-      /**
-       * @deprecated Use `space_id`.*/
-      location_id?: string | undefined
-      /** ID of the space by which you want to filter the list of access grants. */
-      space_id?: string | undefined
-    }
-    formData: {}
-    jsonResponse: {
-      access_grants: {
-        /** ID of the Seam workspace associated with the Access Grant. */
-        workspace_id: string
-        /** ID of the Access Grant. */
-        access_grant_id: string
-        /** Unique key for the access grant within the workspace. */
-        access_grant_key?: string | undefined
-        /** ID of user identity to which the Access Grant gives access. */
-        user_identity_id: string
-        /**
-         * @deprecated Use `space_ids`.*/
-        location_ids: string[]
-        /** IDs of the spaces to which the Access Grant gives access. */
-        space_ids: string[]
-        /** Access methods that the user requested for the Access Grant. */
-        requested_access_methods: {
-          /** 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 requested access method was added to the Access Grant. */
-          created_at: string
-          /** IDs of the access methods created for the requested access method. */
-          created_access_method_ids: string[]
-        }[]
-        /** IDs of the access methods created for the Access Grant. */
-        access_method_ids: string[]
-        /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
-        client_session_token?: string | undefined
-        /** Name of the Access Grant. If not provided, the display name will be computed. */
-        name: string | null
-        /** Display name of the Access Grant. */
-        display_name: string
-        /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method.  */
-        instant_key_url?: string | undefined
-        /** Date and time at which the Access Grant was created. */
-        created_at: string
-        /** Date and time at which the Access Grant starts. */
-        starts_at: string
-        /** Date and time at which the Access Grant ends. */
-        ends_at: string | null
-      }[]
-    }
-  }
-  '/unstable_access_methods/delete': {
-    route: '/unstable_access_methods/delete'
-    method: 'DELETE' | 'POST'
-    queryParams: {}
-    jsonBody: {}
-    commonParams: {
-      /** ID of the access method that you want to delete. */
-      access_method_id: string
-    }
-    formData: {}
-    jsonResponse: {}
-  }
-  '/unstable_access_methods/get': {
-    route: '/unstable_access_methods/get'
-    method: 'GET' | 'POST'
-    queryParams: {}
-    jsonBody: {}
-    commonParams: {
-      /** ID of the access method that you want to get. */
-      access_method_id: string
-    }
-    formData: {}
-    jsonResponse: {
-      /** 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. */
-      access_method: {
-        /** 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 | undefined
-      }
-    }
-  }
-  '/unstable_access_methods/list': {
-    route: '/unstable_access_methods/list'
-    method: 'GET' | 'POST'
-    queryParams: {}
-    jsonBody: {}
-    commonParams: {
-      /** ID of the access grant by which to filter the list of access methods. */
-      access_grant_id: string
-    }
-    formData: {}
-    jsonResponse: {
-      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 | undefined
-      }[]
-    }
-  }
   '/unstable_locations/add_acs_entrances': {
     route: '/unstable_locations/add_acs_entrances'
     method: 'POST' | 'PUT'