@seamapi/types 1.623.0 → 1.625.0

package/dist/connect.d.cts

@@ -95409,9 +95409,19 @@ declare const _default: {
                         description: string;
                     };
                 };
-                security: {
+                security: ({
                     api_key: never[];
-                }[];
+                    client_session_with_customer?: never;
+                    console_session_with_workspace?: never;
+                } | {
+                    client_session_with_customer: never[];
+                    api_key?: never;
+                    console_session_with_workspace?: never;
+                } | {
+                    console_session_with_workspace: never[];
+                    api_key?: never;
+                    client_session_with_customer?: never;
+                })[];
                 summary: string;
                 tags: never[];
                 'x-fern-sdk-group-name': string[];
@@ -95419,6 +95429,169 @@ declare const _default: {
                 'x-fern-sdk-return-value': string;
                 'x-response-key': string;
                 'x-title': string;
+                'x-undocumented': string;
+            };
+        };
+        '/seam/customer/v1/connectors/list': {
+            get: {
+                description: string;
+                operationId: string;
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        connectors: {
+                                            items: {
+                                                properties: {
+                                                    config: {
+                                                        additionalProperties: {
+                                                            $ref: string;
+                                                        };
+                                                        type: string;
+                                                    };
+                                                    connector_id: {
+                                                        type: string;
+                                                    };
+                                                    connector_type: {
+                                                        type: string;
+                                                    };
+                                                    created_at: {
+                                                        type: string;
+                                                    };
+                                                    status: {
+                                                        enum: string[];
+                                                        type: string;
+                                                    };
+                                                    updated_at: {
+                                                        type: string;
+                                                    };
+                                                };
+                                                required: string[];
+                                                type: string;
+                                            };
+                                            type: string;
+                                        };
+                                        ok: {
+                                            type: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: ({
+                    api_key: never[];
+                    client_session_with_customer?: never;
+                    console_session_with_workspace?: never;
+                } | {
+                    client_session_with_customer: never[];
+                    api_key?: never;
+                    console_session_with_workspace?: never;
+                } | {
+                    console_session_with_workspace: never[];
+                    api_key?: never;
+                    client_session_with_customer?: never;
+                })[];
+                summary: string;
+                tags: never[];
+                '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;
+                'x-undocumented': string;
+            };
+            post: {
+                description: string;
+                operationId: string;
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        connectors: {
+                                            items: {
+                                                properties: {
+                                                    config: {
+                                                        additionalProperties: {
+                                                            $ref: string;
+                                                        };
+                                                        type: string;
+                                                    };
+                                                    connector_id: {
+                                                        type: string;
+                                                    };
+                                                    connector_type: {
+                                                        type: string;
+                                                    };
+                                                    created_at: {
+                                                        type: string;
+                                                    };
+                                                    status: {
+                                                        enum: string[];
+                                                        type: string;
+                                                    };
+                                                    updated_at: {
+                                                        type: string;
+                                                    };
+                                                };
+                                                required: string[];
+                                                type: string;
+                                            };
+                                            type: string;
+                                        };
+                                        ok: {
+                                            type: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: ({
+                    api_key: never[];
+                    client_session_with_customer?: never;
+                    console_session_with_workspace?: never;
+                } | {
+                    client_session_with_customer: never[];
+                    api_key?: never;
+                    console_session_with_workspace?: never;
+                } | {
+                    console_session_with_workspace: never[];
+                    api_key?: never;
+                    client_session_with_customer?: never;
+                })[];
+                summary: string;
+                tags: never[];
+                '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;
+                'x-undocumented': string;
             };
         };
         '/seam/customer/v1/connectors/sync': {
@@ -97586,6 +97759,223 @@ declare const _default: {
                 'x-title': string;
             };
         };
+        '/seam/customer/v1/staff_members/get': {
+            get: {
+                description: string;
+                operationId: string;
+                parameters: {
+                    in: string;
+                    name: string;
+                    required: boolean;
+                    schema: {
+                        description: string;
+                        type: string;
+                    };
+                }[];
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        access_grant: {
+                                            $ref: string;
+                                        };
+                                        ok: {
+                                            type: string;
+                                        };
+                                        spaces: {
+                                            items: {
+                                                properties: {
+                                                    child_space_keys: {
+                                                        items: {
+                                                            type: string;
+                                                        };
+                                                        type: string;
+                                                    };
+                                                    space_key: {
+                                                        type: string;
+                                                    };
+                                                };
+                                                required: string[];
+                                                type: string;
+                                            };
+                                            type: string;
+                                        };
+                                        staff_member: {
+                                            description: string;
+                                            properties: {
+                                                email_address: {
+                                                    description: string;
+                                                    type: string;
+                                                };
+                                                name: {
+                                                    description: string;
+                                                    type: string;
+                                                };
+                                                phone_number: {
+                                                    description: string;
+                                                    type: string;
+                                                };
+                                                space_keys: {
+                                                    description: string;
+                                                    items: {
+                                                        type: string;
+                                                    };
+                                                    type: string;
+                                                };
+                                                staff_member_key: {
+                                                    description: string;
+                                                    type: string;
+                                                };
+                                                user_identity_id: {
+                                                    format: string;
+                                                    type: string;
+                                                };
+                                            };
+                                            required: string[];
+                                            type: string;
+                                            'x-route-path': string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: {
+                    client_session_with_customer: never[];
+                }[];
+                summary: string;
+                tags: never[];
+                '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;
+                'x-undocumented': string;
+            };
+            post: {
+                description: string;
+                operationId: string;
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                properties: {
+                                    staff_member_key: {
+                                        description: string;
+                                        type: string;
+                                    };
+                                };
+                                required: string[];
+                                type: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        access_grant: {
+                                            $ref: string;
+                                        };
+                                        ok: {
+                                            type: string;
+                                        };
+                                        spaces: {
+                                            items: {
+                                                properties: {
+                                                    child_space_keys: {
+                                                        items: {
+                                                            type: string;
+                                                        };
+                                                        type: string;
+                                                    };
+                                                    space_key: {
+                                                        type: string;
+                                                    };
+                                                };
+                                                required: string[];
+                                                type: string;
+                                            };
+                                            type: string;
+                                        };
+                                        staff_member: {
+                                            description: string;
+                                            properties: {
+                                                email_address: {
+                                                    description: string;
+                                                    type: string;
+                                                };
+                                                name: {
+                                                    description: string;
+                                                    type: string;
+                                                };
+                                                phone_number: {
+                                                    description: string;
+                                                    type: string;
+                                                };
+                                                space_keys: {
+                                                    description: string;
+                                                    items: {
+                                                        type: string;
+                                                    };
+                                                    type: string;
+                                                };
+                                                staff_member_key: {
+                                                    description: string;
+                                                    type: string;
+                                                };
+                                                user_identity_id: {
+                                                    format: string;
+                                                    type: string;
+                                                };
+                                            };
+                                            required: string[];
+                                            type: string;
+                                            'x-route-path': string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: {
+                    client_session_with_customer: never[];
+                }[];
+                summary: string;
+                tags: never[];
+                '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;
+                'x-undocumented': string;
+            };
+        };
         '/seam/customer/v1/staff_members/list': {
             get: {
                 description: string;
@@ -167528,7 +167918,7 @@ type Routes = {
             /** Type of connector to create */
             connector_type: 'mews' | 'mock';
             /** Key identifying the customer */
-            customer_key: string;
+            customer_key?: string | undefined;
             /** Instance-specific configuration for the connector */
             config: {
                 client_token?: string | undefined;
@@ -167555,6 +167945,26 @@ type Routes = {
             };
         };
     };
+    '/seam/customer/v1/connectors/list': {
+        route: '/seam/customer/v1/connectors/list';
+        method: 'GET' | 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {};
+        formData: {};
+        jsonResponse: {
+            connectors: {
+                connector_id: string;
+                connector_type: string;
+                status: 'active' | 'inactive' | 'error';
+                config: {
+                    [x: string]: any;
+                };
+                created_at: string;
+                updated_at: string;
+            }[];
+        };
+    };
     '/seam/customer/v1/connectors/sync': {
         route: '/seam/customer/v1/connectors/sync';
         method: 'POST';
@@ -169798,6 +170208,95 @@ type Routes = {
             }[];
         };
     };
+    '/seam/customer/v1/staff_members/get': {
+        route: '/seam/customer/v1/staff_members/get';
+        method: 'GET' | 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            /** Key of staff member to get. */
+            staff_member_key: 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;
+                /** Reservation key for the access grant. */
+                reservation_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;
+            };
+            spaces: {
+                space_key: string;
+                child_space_keys?: string[] | undefined;
+            }[];
+            /** Represents a staff member for a specific customer. */
+            staff_member: {
+                /** Your unique identifier for the staff. */
+                staff_member_key: string;
+                /** Phone number associated with the user identity. */
+                phone_number?: string | undefined;
+                /** Email address associated with the user identity. */
+                email_address?: string | undefined;
+                /** Your display name for this user identity resource. */
+                name: string;
+                /** List of unique identifiers for the spaces the staff member is associated with. */
+                space_keys?: string[] | undefined;
+                user_identity_id?: string | undefined;
+            };
+        };
+    };
     '/seam/customer/v1/staff_members/list': {
         route: '/seam/customer/v1/staff_members/list';
         method: 'GET' | 'POST';