@seamapi/types 1.592.0 → 1.594.0

package/lib/seam/connect/openapi.d.ts

@@ -18487,6 +18487,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;
@@ -43587,6 +43689,159 @@ declare const _default: {
                 'x-title': string;
             };
         };
+        '/seam/customer/v1/spaces/list': {
+            get: {
+                description: string;
+                operationId: string;
+                parameters: ({
+                    in: string;
+                    name: string;
+                    schema: {
+                        description: string;
+                        minLength: number;
+                        type: string;
+                        format?: never;
+                        'x-draft'?: never;
+                        'x-undocumented'?: never;
+                    };
+                } | {
+                    in: string;
+                    name: string;
+                    schema: {
+                        description: string;
+                        format: string;
+                        type: string;
+                        'x-draft': string;
+                        'x-undocumented': string;
+                        minLength?: never;
+                    };
+                } | {
+                    in: string;
+                    name: string;
+                    schema: {
+                        description: string;
+                        type: string;
+                        minLength?: never;
+                        format?: never;
+                        'x-draft'?: never;
+                        'x-undocumented'?: never;
+                    };
+                })[];
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        ok: {
+                                            type: string;
+                                        };
+                                        spaces: {
+                                            items: {
+                                                $ref: string;
+                                            };
+                                            type: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: {
+                    client_session_with_customer: 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: {
+                description: string;
+                operationId: string;
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                properties: {
+                                    connected_account_id: {
+                                        description: string;
+                                        format: string;
+                                        type: string;
+                                        'x-draft': string;
+                                        'x-undocumented': string;
+                                    };
+                                    search: {
+                                        description: string;
+                                        minLength: number;
+                                        type: string;
+                                    };
+                                    space_key: {
+                                        description: string;
+                                        type: string;
+                                    };
+                                };
+                                type: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        ok: {
+                                            type: string;
+                                        };
+                                        spaces: {
+                                            items: {
+                                                $ref: string;
+                                            };
+                                            type: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: {
+                    client_session_with_customer: 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;
+            };
+        };
         '/seam/instant_key/v1/client_sessions/exchange_short_code': {
             post: {
                 description: string;

package/lib/seam/connect/openapi.js

@@ -26209,6 +26209,85 @@ export default {
                 'x-title': 'List Access Grants',
             },
         },
+        '/access_grants/request_access_methods': {
+            post: {
+                description: 'Adds additional requested access methods to an existing Access Grant.',
+                operationId: 'accessGrantsRequestAccessMethodsPost',
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                properties: {
+                                    access_grant_id: {
+                                        description: 'ID of the Access Grant to add access methods to.',
+                                        format: 'uuid',
+                                        type: 'string',
+                                    },
+                                    requested_access_methods: {
+                                        description: 'Array of requested access methods to add to the access grant.',
+                                        items: {
+                                            properties: {
+                                                code: {
+                                                    description: "Specific PIN code to use for this access method. Only applicable when mode is 'code'.",
+                                                    maxLength: 9,
+                                                    minLength: 4,
+                                                    pattern: '^\\d+$',
+                                                    type: 'string',
+                                                },
+                                                mode: {
+                                                    description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
+                                                    enum: ['code', 'card', 'mobile_key'],
+                                                    type: 'string',
+                                                },
+                                            },
+                                            required: ['mode'],
+                                            type: 'object',
+                                        },
+                                        minItems: 1,
+                                        type: 'array',
+                                    },
+                                },
+                                required: ['access_grant_id', 'requested_access_methods'],
+                                type: 'object',
+                            },
+                        },
+                    },
+                },
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        access_grant: { $ref: '#/components/schemas/access_grant' },
+                                        ok: { type: 'boolean' },
+                                    },
+                                    required: ['access_grant', 'ok'],
+                                    type: 'object',
+                                },
+                            },
+                        },
+                        description: 'OK',
+                    },
+                    400: { description: 'Bad Request' },
+                    401: { description: 'Unauthorized' },
+                },
+                security: [
+                    { pat_with_workspace: [] },
+                    { console_session_with_workspace: [] },
+                    { api_key: [] },
+                    { client_session_with_customer: [] },
+                ],
+                summary: '/access_grants/request_access_methods',
+                tags: [],
+                'x-draft': 'Early access.',
+                'x-fern-sdk-group-name': ['access_grants'],
+                'x-fern-sdk-method-name': 'request_access_methods',
+                'x-fern-sdk-return-value': 'access_grant',
+                'x-response-key': 'access_grant',
+                'x-title': 'Add Requested Access Methods to Access Grant',
+            },
+        },
         '/access_grants/unmanaged/get': {
             get: {
                 description: 'Get an unmanaged Access Grant (where is_managed = false).',
@@ -48739,6 +48818,135 @@ export default {
                 'x-title': 'Create a Space',
             },
         },
+        '/seam/customer/v1/spaces/list': {
+            get: {
+                description: 'Returns a list of all spaces.',
+                operationId: 'seamCustomerV1SpacesListGet',
+                parameters: [
+                    {
+                        in: 'query',
+                        name: 'search',
+                        schema: {
+                            description: 'String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`.',
+                            minLength: 1,
+                            type: 'string',
+                        },
+                    },
+                    {
+                        in: 'query',
+                        name: 'connected_account_id',
+                        schema: {
+                            description: 'Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account.',
+                            format: 'uuid',
+                            type: 'string',
+                            'x-draft': 'Needs review.',
+                            'x-undocumented': 'Only used internally.',
+                        },
+                    },
+                    {
+                        in: 'query',
+                        name: 'space_key',
+                        schema: {
+                            description: 'Filter spaces by space_key.',
+                            type: 'string',
+                        },
+                    },
+                ],
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        ok: { type: 'boolean' },
+                                        spaces: {
+                                            items: { $ref: '#/components/schemas/space' },
+                                            type: 'array',
+                                        },
+                                    },
+                                    required: ['spaces', 'ok'],
+                                    type: 'object',
+                                },
+                            },
+                        },
+                        description: 'OK',
+                    },
+                    400: { description: 'Bad Request' },
+                    401: { description: 'Unauthorized' },
+                },
+                security: [{ client_session_with_customer: [] }],
+                summary: '/seam/customer/v1/spaces/list',
+                tags: [],
+                'x-draft': 'Early access.',
+                'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'spaces'],
+                'x-fern-sdk-method-name': 'list',
+                'x-fern-sdk-return-value': 'spaces',
+                'x-response-key': 'spaces',
+                'x-title': 'List Spaces',
+            },
+            post: {
+                description: 'Returns a list of all spaces.',
+                operationId: 'seamCustomerV1SpacesListPost',
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                properties: {
+                                    connected_account_id: {
+                                        description: 'Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account.',
+                                        format: 'uuid',
+                                        type: 'string',
+                                        'x-draft': 'Needs review.',
+                                        'x-undocumented': 'Only used internally.',
+                                    },
+                                    search: {
+                                        description: 'String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`.',
+                                        minLength: 1,
+                                        type: 'string',
+                                    },
+                                    space_key: {
+                                        description: 'Filter spaces by space_key.',
+                                        type: 'string',
+                                    },
+                                },
+                                type: 'object',
+                            },
+                        },
+                    },
+                },
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        ok: { type: 'boolean' },
+                                        spaces: {
+                                            items: { $ref: '#/components/schemas/space' },
+                                            type: 'array',
+                                        },
+                                    },
+                                    required: ['spaces', 'ok'],
+                                    type: 'object',
+                                },
+                            },
+                        },
+                        description: 'OK',
+                    },
+                    400: { description: 'Bad Request' },
+                    401: { description: 'Unauthorized' },
+                },
+                security: [{ client_session_with_customer: [] }],
+                summary: '/seam/customer/v1/spaces/list',
+                tags: [],
+                'x-draft': 'Early access.',
+                'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'spaces'],
+                'x-fern-sdk-method-name': 'list',
+                'x-fern-sdk-return-value': 'spaces',
+                'x-response-key': 'spaces',
+                'x-title': 'List Spaces',
+            },
+        },
         '/seam/instant_key/v1/client_sessions/exchange_short_code': {
             post: {
                 description: 'Exchanges a short code for a client session token. Mobile apps use this endpoint to retrieve a client session token securely using a short code obtained from an Instant Key URL.',