@seamapi/types 1.593.0 → 1.595.0

package/dist/connect.d.cts

@@ -69806,6 +69806,108 @@ declare const _default: {
                 'x-title': string;
             };
         };
+        '/access_grants/request_access_methods': {
+            post: {
+                description: string;
+                operationId: string;
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                properties: {
+                                    access_grant_id: {
+                                        description: string;
+                                        format: string;
+                                        type: string;
+                                    };
+                                    requested_access_methods: {
+                                        description: string;
+                                        items: {
+                                            properties: {
+                                                code: {
+                                                    description: string;
+                                                    maxLength: number;
+                                                    minLength: number;
+                                                    pattern: string;
+                                                    type: string;
+                                                };
+                                                mode: {
+                                                    description: string;
+                                                    enum: string[];
+                                                    type: string;
+                                                };
+                                            };
+                                            required: string[];
+                                            type: string;
+                                        };
+                                        minItems: number;
+                                        type: string;
+                                    };
+                                };
+                                required: string[];
+                                type: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        access_grant: {
+                                            $ref: string;
+                                        };
+                                        ok: {
+                                            type: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: ({
+                    pat_with_workspace: never[];
+                    console_session_with_workspace?: never;
+                    api_key?: never;
+                    client_session_with_customer?: never;
+                } | {
+                    console_session_with_workspace: never[];
+                    pat_with_workspace?: never;
+                    api_key?: never;
+                    client_session_with_customer?: never;
+                } | {
+                    api_key: never[];
+                    pat_with_workspace?: never;
+                    console_session_with_workspace?: never;
+                    client_session_with_customer?: never;
+                } | {
+                    client_session_with_customer: never[];
+                    pat_with_workspace?: never;
+                    console_session_with_workspace?: never;
+                    api_key?: never;
+                })[];
+                summary: string;
+                tags: never[];
+                'x-draft': string;
+                'x-fern-sdk-group-name': string[];
+                'x-fern-sdk-method-name': string;
+                'x-fern-sdk-return-value': string;
+                'x-response-key': string;
+                'x-title': string;
+            };
+        };
         '/access_grants/unmanaged/get': {
             get: {
                 description: string;
@@ -70682,7 +70784,7 @@ declare const _default: {
                 'x-title': string;
             };
         };
-        '/access_grants/update': {
+        '/access_grants/unmanaged/update': {
             patch: {
                 description: string;
                 operationId: string;
@@ -70696,20 +70798,13 @@ declare const _default: {
                                         format: string;
                                         type: string;
                                     };
-                                    ends_at: {
-                                        description: string;
-                                        format: string;
-                                        nullable: boolean;
-                                        type: string;
-                                    };
-                                    name: {
+                                    access_grant_key: {
                                         description: string;
-                                        nullable: boolean;
                                         type: string;
                                     };
-                                    starts_at: {
+                                    is_managed: {
                                         description: string;
-                                        format: string;
+                                        enum: boolean[];
                                         type: string;
                                     };
                                 };
@@ -70785,20 +70880,13 @@ declare const _default: {
                                         format: string;
                                         type: string;
                                     };
-                                    ends_at: {
-                                        description: string;
-                                        format: string;
-                                        nullable: boolean;
-                                        type: string;
-                                    };
-                                    name: {
+                                    access_grant_key: {
                                         description: string;
-                                        nullable: boolean;
                                         type: string;
                                     };
-                                    starts_at: {
+                                    is_managed: {
                                         description: string;
-                                        format: string;
+                                        enum: boolean[];
                                         type: string;
                                     };
                                 };
@@ -70862,66 +70950,8 @@ declare const _default: {
                 'x-title': string;
             };
         };
-        '/access_methods/delete': {
-            delete: {
-                description: string;
-                operationId: string;
-                parameters: {
-                    in: string;
-                    name: string;
-                    required: boolean;
-                    schema: {
-                        description: string;
-                        format: string;
-                        type: string;
-                    };
-                }[];
-                responses: {
-                    200: {
-                        content: {
-                            'application/json': {
-                                schema: {
-                                    properties: {
-                                        ok: {
-                                            type: string;
-                                        };
-                                    };
-                                    required: string[];
-                                    type: string;
-                                };
-                            };
-                        };
-                        description: string;
-                    };
-                    400: {
-                        description: string;
-                    };
-                    401: {
-                        description: string;
-                    };
-                };
-                security: ({
-                    pat_with_workspace: never[];
-                    console_session_with_workspace?: never;
-                    api_key?: never;
-                } | {
-                    console_session_with_workspace: never[];
-                    pat_with_workspace?: never;
-                    api_key?: never;
-                } | {
-                    api_key: never[];
-                    pat_with_workspace?: never;
-                    console_session_with_workspace?: never;
-                })[];
-                summary: string;
-                tags: never[];
-                'x-draft': string;
-                'x-fern-sdk-group-name': string[];
-                'x-fern-sdk-method-name': string;
-                'x-response-key': null;
-                'x-title': string;
-            };
-            post: {
+        '/access_grants/update': {
+            patch: {
                 description: string;
                 operationId: string;
                 requestBody: {
@@ -70929,7 +70959,23 @@ declare const _default: {
                         'application/json': {
                             schema: {
                                 properties: {
-                                    access_method_id: {
+                                    access_grant_id: {
+                                        description: string;
+                                        format: string;
+                                        type: string;
+                                    };
+                                    ends_at: {
+                                        description: string;
+                                        format: string;
+                                        nullable: boolean;
+                                        type: string;
+                                    };
+                                    name: {
+                                        description: string;
+                                        nullable: boolean;
+                                        type: string;
+                                    };
+                                    starts_at: {
                                         description: string;
                                         format: string;
                                         type: string;
@@ -70969,14 +71015,22 @@ declare const _default: {
                     pat_with_workspace: never[];
                     console_session_with_workspace?: never;
                     api_key?: never;
+                    client_session_with_customer?: never;
                 } | {
                     console_session_with_workspace: never[];
                     pat_with_workspace?: never;
                     api_key?: never;
+                    client_session_with_customer?: never;
                 } | {
                     api_key: never[];
                     pat_with_workspace?: never;
                     console_session_with_workspace?: never;
+                    client_session_with_customer?: never;
+                } | {
+                    client_session_with_customer: never[];
+                    pat_with_workspace?: never;
+                    console_session_with_workspace?: never;
+                    api_key?: never;
                 })[];
                 summary: string;
                 tags: never[];
@@ -70986,8 +71040,6 @@ declare const _default: {
                 'x-response-key': null;
                 'x-title': string;
             };
-        };
-        '/access_methods/encode': {
             post: {
                 description: string;
                 operationId: string;
@@ -70996,12 +71048,23 @@ declare const _default: {
                         'application/json': {
                             schema: {
                                 properties: {
-                                    access_method_id: {
+                                    access_grant_id: {
                                         description: string;
                                         format: string;
                                         type: string;
                                     };
-                                    acs_encoder_id: {
+                                    ends_at: {
+                                        description: string;
+                                        format: string;
+                                        nullable: boolean;
+                                        type: string;
+                                    };
+                                    name: {
+                                        description: string;
+                                        nullable: boolean;
+                                        type: string;
+                                    };
+                                    starts_at: {
                                         description: string;
                                         format: string;
                                         type: string;
@@ -71019,9 +71082,6 @@ declare const _default: {
                             'application/json': {
                                 schema: {
                                     properties: {
-                                        action_attempt: {
-                                            $ref: string;
-                                        };
                                         ok: {
                                             type: string;
                                         };
@@ -71044,27 +71104,34 @@ declare const _default: {
                     pat_with_workspace: never[];
                     console_session_with_workspace?: never;
                     api_key?: never;
+                    client_session_with_customer?: never;
                 } | {
                     console_session_with_workspace: never[];
                     pat_with_workspace?: never;
                     api_key?: never;
+                    client_session_with_customer?: never;
                 } | {
                     api_key: never[];
                     pat_with_workspace?: never;
                     console_session_with_workspace?: never;
+                    client_session_with_customer?: never;
+                } | {
+                    client_session_with_customer: never[];
+                    pat_with_workspace?: never;
+                    console_session_with_workspace?: never;
+                    api_key?: never;
                 })[];
                 summary: string;
                 tags: never[];
-                'x-action-attempt-type': string;
+                'x-draft': string;
                 'x-fern-sdk-group-name': string[];
                 'x-fern-sdk-method-name': string;
-                'x-fern-sdk-return-value': string;
-                'x-response-key': string;
+                'x-response-key': null;
                 'x-title': string;
             };
         };
-        '/access_methods/get': {
-            get: {
+        '/access_methods/delete': {
+            delete: {
                 description: string;
                 operationId: string;
                 parameters: {
@@ -71083,9 +71150,6 @@ declare const _default: {
                             'application/json': {
                                 schema: {
                                     properties: {
-                                        access_method: {
-                                            $ref: string;
-                                        };
                                         ok: {
                                             type: string;
                                         };
@@ -71122,8 +71186,212 @@ declare const _default: {
                 'x-draft': string;
                 'x-fern-sdk-group-name': string[];
                 'x-fern-sdk-method-name': string;
-                'x-fern-sdk-return-value': string;
-                'x-response-key': string;
+                'x-response-key': null;
+                'x-title': string;
+            };
+            post: {
+                description: string;
+                operationId: string;
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                properties: {
+                                    access_method_id: {
+                                        description: string;
+                                        format: string;
+                                        type: string;
+                                    };
+                                };
+                                required: string[];
+                                type: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        ok: {
+                                            type: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: ({
+                    pat_with_workspace: never[];
+                    console_session_with_workspace?: never;
+                    api_key?: never;
+                } | {
+                    console_session_with_workspace: never[];
+                    pat_with_workspace?: never;
+                    api_key?: never;
+                } | {
+                    api_key: never[];
+                    pat_with_workspace?: never;
+                    console_session_with_workspace?: never;
+                })[];
+                summary: string;
+                tags: never[];
+                'x-draft': string;
+                'x-fern-sdk-group-name': string[];
+                'x-fern-sdk-method-name': string;
+                'x-response-key': null;
+                'x-title': string;
+            };
+        };
+        '/access_methods/encode': {
+            post: {
+                description: string;
+                operationId: string;
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                properties: {
+                                    access_method_id: {
+                                        description: string;
+                                        format: string;
+                                        type: string;
+                                    };
+                                    acs_encoder_id: {
+                                        description: string;
+                                        format: string;
+                                        type: string;
+                                    };
+                                };
+                                required: string[];
+                                type: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        action_attempt: {
+                                            $ref: string;
+                                        };
+                                        ok: {
+                                            type: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: ({
+                    pat_with_workspace: never[];
+                    console_session_with_workspace?: never;
+                    api_key?: never;
+                } | {
+                    console_session_with_workspace: never[];
+                    pat_with_workspace?: never;
+                    api_key?: never;
+                } | {
+                    api_key: never[];
+                    pat_with_workspace?: never;
+                    console_session_with_workspace?: never;
+                })[];
+                summary: string;
+                tags: never[];
+                'x-action-attempt-type': string;
+                'x-fern-sdk-group-name': string[];
+                'x-fern-sdk-method-name': string;
+                'x-fern-sdk-return-value': string;
+                'x-response-key': string;
+                'x-title': string;
+            };
+        };
+        '/access_methods/get': {
+            get: {
+                description: string;
+                operationId: string;
+                parameters: {
+                    in: string;
+                    name: string;
+                    required: boolean;
+                    schema: {
+                        description: string;
+                        format: string;
+                        type: string;
+                    };
+                }[];
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        access_method: {
+                                            $ref: string;
+                                        };
+                                        ok: {
+                                            type: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: ({
+                    pat_with_workspace: never[];
+                    console_session_with_workspace?: never;
+                    api_key?: never;
+                } | {
+                    console_session_with_workspace: never[];
+                    pat_with_workspace?: never;
+                    api_key?: never;
+                } | {
+                    api_key: never[];
+                    pat_with_workspace?: never;
+                    console_session_with_workspace?: never;
+                })[];
+                summary: string;
+                tags: never[];
+                'x-draft': string;
+                'x-fern-sdk-group-name': string[];
+                'x-fern-sdk-method-name': string;
+                'x-fern-sdk-return-value': string;
+                'x-response-key': string;
                 'x-title': string;
             };
             post: {
@@ -104655,6 +104923,170 @@ declare const _default: {
                 'x-title': string;
             };
         };
+        '/user_identities/unmanaged/update': {
+            patch: {
+                description: string;
+                operationId: string;
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                properties: {
+                                    is_managed: {
+                                        description: string;
+                                        enum: boolean[];
+                                        type: string;
+                                    };
+                                    user_identity_id: {
+                                        description: string;
+                                        format: string;
+                                        type: string;
+                                    };
+                                    user_identity_key: {
+                                        description: string;
+                                        type: string;
+                                    };
+                                };
+                                required: string[];
+                                type: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        ok: {
+                                            type: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: ({
+                    api_key: never[];
+                    client_session?: never;
+                    pat_with_workspace?: never;
+                    console_session_with_workspace?: never;
+                } | {
+                    client_session: never[];
+                    api_key?: never;
+                    pat_with_workspace?: never;
+                    console_session_with_workspace?: never;
+                } | {
+                    pat_with_workspace: never[];
+                    api_key?: never;
+                    client_session?: never;
+                    console_session_with_workspace?: never;
+                } | {
+                    console_session_with_workspace: never[];
+                    api_key?: never;
+                    client_session?: never;
+                    pat_with_workspace?: never;
+                })[];
+                summary: string;
+                tags: string[];
+                'x-fern-sdk-group-name': string[];
+                'x-fern-sdk-method-name': string;
+                'x-response-key': null;
+                'x-title': string;
+            };
+            post: {
+                description: string;
+                operationId: string;
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                properties: {
+                                    is_managed: {
+                                        description: string;
+                                        enum: boolean[];
+                                        type: string;
+                                    };
+                                    user_identity_id: {
+                                        description: string;
+                                        format: string;
+                                        type: string;
+                                    };
+                                    user_identity_key: {
+                                        description: string;
+                                        type: string;
+                                    };
+                                };
+                                required: string[];
+                                type: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        ok: {
+                                            type: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: ({
+                    api_key: never[];
+                    client_session?: never;
+                    pat_with_workspace?: never;
+                    console_session_with_workspace?: never;
+                } | {
+                    client_session: never[];
+                    api_key?: never;
+                    pat_with_workspace?: never;
+                    console_session_with_workspace?: never;
+                } | {
+                    pat_with_workspace: never[];
+                    api_key?: never;
+                    client_session?: never;
+                    console_session_with_workspace?: never;
+                } | {
+                    console_session_with_workspace: never[];
+                    api_key?: never;
+                    client_session?: never;
+                    pat_with_workspace?: never;
+                })[];
+                summary: string;
+                tags: string[];
+                'x-fern-sdk-group-name': string[];
+                'x-fern-sdk-method-name': string;
+                'x-response-key': null;
+                'x-title': string;
+            };
+        };
         '/user_identities/update': {
             patch: {
                 description: string;
@@ -119001,6 +119433,82 @@ type Routes = {
             }[];
         };
     };
+    '/access_grants/request_access_methods': {
+        route: '/access_grants/request_access_methods';
+        method: 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            /** ID of the Access Grant to add access methods to. */
+            access_grant_id: string;
+            /** Array of requested access methods to add to the access grant. */
+            requested_access_methods: {
+                /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
+                mode: 'code' | 'card' | 'mobile_key';
+                /** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
+                code?: 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';
+                    /** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
+                    code?: string | undefined;
+                    /** 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;
+                /** Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
+                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';
+                }[];
+                /** ID of the customization profile associated with the Access Grant. */
+                customization_profile_id?: string | undefined;
+            };
+        };
+    };
     '/access_grants/unmanaged/get': {
         route: '/access_grants/unmanaged/get';
         method: 'GET' | 'POST';
@@ -119126,6 +119634,22 @@ type Routes = {
             }[];
         };
     };
+    '/access_grants/unmanaged/update': {
+        route: '/access_grants/unmanaged/update';
+        method: 'PATCH' | 'POST';
+        queryParams: {};
+        jsonBody: {
+            /** ID of the unmanaged Access Grant to update. */
+            access_grant_id: string;
+            /** Must be set to true to convert the unmanaged access grant to managed. */
+            is_managed: true;
+            /** Unique key for the access grant. If not provided, the existing key will be preserved. */
+            access_grant_key?: string | undefined;
+        };
+        commonParams: {};
+        formData: {};
+        jsonResponse: {};
+    };
     '/access_grants/update': {
         route: '/access_grants/update';
         method: 'POST' | 'PATCH';
@@ -187296,6 +187820,22 @@ type Routes = {
             }[];
         };
     };
+    '/user_identities/unmanaged/update': {
+        route: '/user_identities/unmanaged/update';
+        method: 'PATCH' | 'POST';
+        queryParams: {};
+        jsonBody: {
+            /** ID of the unmanaged user identity that you want to update. */
+            user_identity_id: string;
+            /** Must be set to true to convert the unmanaged user identity to managed. */
+            is_managed: true;
+            /** Unique key for the user identity. If not provided, the existing key will be preserved. */
+            user_identity_key?: string | undefined;
+        };
+        commonParams: {};
+        formData: {};
+        jsonResponse: {};
+    };
     '/user_identities/update': {
         route: '/user_identities/update';
         method: 'PATCH' | 'POST';