@seamapi/types 1.438.0 → 1.440.0

package/lib/seam/connect/models/batches/spaces.js

@@ -0,0 +1,13 @@
+import { z } from 'zod';
+import { acs_entrance } from '../acs/index.js';
+import { device } from '../devices/index.js';
+import { space } from '../spaces/index.js';
+export const spaces_batch = z
+    .object({
+    batch_type: z.literal('spaces'),
+    spaces: space.array().optional(),
+    devices: device.array().optional(),
+    acs_entrances: acs_entrance.array().optional(),
+})
+    .describe('ID of the affected access system user.');
+//# sourceMappingURL=spaces.js.map

package/lib/seam/connect/models/batches/spaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spaces.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/batches/spaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AAC5C,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAA;AAE1C,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC;KAC1B,MAAM,CAAC;IACN,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;IAC/B,MAAM,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE;IAChC,OAAO,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE;IAClC,aAAa,EAAE,YAAY,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE;CAC/C,CAAC;KACD,QAAQ,CAAC,wCAAwC,CAAC,CAAA"}

package/lib/seam/connect/models/events/seam-event.js

@@ -27,7 +27,7 @@ export const seam_event = z.discriminatedUnion('event_type', [
   route_path: /events
   ---
   Represents an event. Events let you know when something interesting happens in your workspace. For example, when a lock is unlocked, Seam creates a \`lock.unlocked\` event. When a device's battery level is low, Seam creates a \`device.battery_low\` event.
-  
+
   As with other API resources, you can retrieve an individual event or a list of events. Seam also provides a separate [webhook](https://docs.seam.co/latest/developer-tools/webhooks) system for sending the event objects directly to an endpoint on your sever. Manage webhooks through [Seam Console](https://console.seam.co). You can also use the webhooks sandbox in Seam Console to see the different payloads for each event and test them against your own endpoints.
 `);
 const event_types = seam_event.options.map((schema) => schema.shape.event_type.value);

package/lib/seam/connect/models/index.d.ts

@@ -2,6 +2,7 @@ export * from './access-codes/index.js';
 export * from './access-grants/index.js';
 export * from './acs/index.js';
 export * from './action-attempts/index.js';
+export * from './batches/index.js';
 export * from './bridges/index.js';
 export * from './bridges/index.js';
 export * from './client-sessions/index.js';

package/lib/seam/connect/models/index.js

@@ -2,6 +2,7 @@ export * from './access-codes/index.js';
 export * from './access-grants/index.js';
 export * from './acs/index.js';
 export * from './action-attempts/index.js';
+export * from './batches/index.js';
 export * from './bridges/index.js';
 export * from './bridges/index.js';
 export * from './client-sessions/index.js';

package/lib/seam/connect/models/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/lib/seam/connect/models/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAA;AACvC,cAAc,0BAA0B,CAAA;AACxC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,4BAA4B,CAAA;AAC1C,cAAc,oBAAoB,CAAA;AAClC,cAAc,oBAAoB,CAAA;AAClC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,6BAA6B,CAAA;AAC3C,cAAc,+BAA+B,CAAA;AAC7C,cAAc,sBAAsB,CAAA;AACpC,cAAc,sCAAsC,CAAA;AACpD,cAAc,qBAAqB,CAAA;AACnC,cAAc,kCAAkC,CAAA;AAChD,cAAc,uCAAuC,CAAA;AACrD,cAAc,oBAAoB,CAAA;AAClC,cAAc,mBAAmB,CAAA;AACjC,cAAc,yBAAyB,CAAA;AACvC,cAAc,sBAAsB,CAAA;AACpC,cAAc,0BAA0B,CAAA;AACxC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,oBAAoB,CAAA;AAClC,cAAc,mBAAmB,CAAA;AACjC,cAAc,mBAAmB,CAAA;AACjC,cAAc,0BAA0B,CAAA;AACxC,cAAc,mBAAmB,CAAA;AACjC,cAAc,wBAAwB,CAAA;AACtC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,qBAAqB,CAAA;AACnC,cAAc,uBAAuB,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/lib/seam/connect/models/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAA;AACvC,cAAc,0BAA0B,CAAA;AACxC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,4BAA4B,CAAA;AAC1C,cAAc,oBAAoB,CAAA;AAClC,cAAc,oBAAoB,CAAA;AAClC,cAAc,oBAAoB,CAAA;AAClC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,6BAA6B,CAAA;AAC3C,cAAc,+BAA+B,CAAA;AAC7C,cAAc,sBAAsB,CAAA;AACpC,cAAc,sCAAsC,CAAA;AACpD,cAAc,qBAAqB,CAAA;AACnC,cAAc,kCAAkC,CAAA;AAChD,cAAc,uCAAuC,CAAA;AACrD,cAAc,oBAAoB,CAAA;AAClC,cAAc,mBAAmB,CAAA;AACjC,cAAc,yBAAyB,CAAA;AACvC,cAAc,sBAAsB,CAAA;AACpC,cAAc,0BAA0B,CAAA;AACxC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,oBAAoB,CAAA;AAClC,cAAc,mBAAmB,CAAA;AACjC,cAAc,mBAAmB,CAAA;AACjC,cAAc,0BAA0B,CAAA;AACxC,cAAc,mBAAmB,CAAA;AACjC,cAAc,wBAAwB,CAAA;AACtC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,qBAAqB,CAAA;AACnC,cAAc,uBAAuB,CAAA"}

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

@@ -37797,6 +37797,229 @@ declare const _default: {
                 'x-title': string;
             };
         };
+        '/spaces/get_related': {
+            get: {
+                description: string;
+                operationId: string;
+                parameters: ({
+                    in: string;
+                    name: string;
+                    required: boolean;
+                    schema: {
+                        description: string;
+                        items: {
+                            format: string;
+                            type: string;
+                            enum?: never;
+                        };
+                        type: string;
+                    };
+                } | {
+                    in: string;
+                    name: string;
+                    required: boolean;
+                    schema: {
+                        items: {
+                            enum: string[];
+                            type: string;
+                            format?: never;
+                        };
+                        type: string;
+                        description?: never;
+                    };
+                })[];
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        batch: {
+                                            description: string;
+                                            properties: {
+                                                acs_entrances: {
+                                                    items: {
+                                                        $ref: string;
+                                                    };
+                                                    type: string;
+                                                };
+                                                batch_type: {
+                                                    enum: string[];
+                                                    type: string;
+                                                };
+                                                devices: {
+                                                    items: {
+                                                        $ref: string;
+                                                    };
+                                                    type: string;
+                                                };
+                                                spaces: {
+                                                    items: {
+                                                        $ref: string;
+                                                    };
+                                                    type: string;
+                                                };
+                                            };
+                                            required: string[];
+                                            type: string;
+                                            'x-route-path': 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-batch-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-title': string;
+            };
+            post: {
+                description: string;
+                operationId: string;
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                properties: {
+                                    exclude: {
+                                        items: {
+                                            enum: string[];
+                                            type: string;
+                                        };
+                                        type: string;
+                                    };
+                                    include: {
+                                        items: {
+                                            enum: string[];
+                                            type: string;
+                                        };
+                                        type: string;
+                                    };
+                                    space_ids: {
+                                        description: string;
+                                        items: {
+                                            format: string;
+                                            type: string;
+                                        };
+                                        type: string;
+                                    };
+                                };
+                                required: string[];
+                                type: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        batch: {
+                                            description: string;
+                                            properties: {
+                                                acs_entrances: {
+                                                    items: {
+                                                        $ref: string;
+                                                    };
+                                                    type: string;
+                                                };
+                                                batch_type: {
+                                                    enum: string[];
+                                                    type: string;
+                                                };
+                                                devices: {
+                                                    items: {
+                                                        $ref: string;
+                                                    };
+                                                    type: string;
+                                                };
+                                                spaces: {
+                                                    items: {
+                                                        $ref: string;
+                                                    };
+                                                    type: string;
+                                                };
+                                            };
+                                            required: string[];
+                                            type: string;
+                                            'x-route-path': 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-batch-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-title': string;
+            };
+        };
         '/spaces/list': {
             get: {
                 description: string;

package/lib/seam/connect/openapi.js

@@ -43310,6 +43310,189 @@ export default {
                 'x-title': 'Get a Space',
             },
         },
+        '/spaces/get_related': {
+            get: {
+                description: 'Gets all related resources for one or more Spaces.',
+                operationId: 'spacesGetRelatedGet',
+                parameters: [
+                    {
+                        in: 'query',
+                        name: 'space_ids',
+                        required: true,
+                        schema: {
+                            description: 'IDs of the spaces that you want to get along with their related resources.',
+                            items: { format: 'uuid', type: 'string' },
+                            type: 'array',
+                        },
+                    },
+                    {
+                        in: 'query',
+                        name: 'include',
+                        required: false,
+                        schema: {
+                            items: {
+                                enum: ['spaces', 'devices', 'acs_entrances'],
+                                type: 'string',
+                            },
+                            type: 'array',
+                        },
+                    },
+                    {
+                        in: 'query',
+                        name: 'exclude',
+                        required: false,
+                        schema: {
+                            items: {
+                                enum: ['spaces', 'devices', 'acs_entrances'],
+                                type: 'string',
+                            },
+                            type: 'array',
+                        },
+                    },
+                ],
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        batch: {
+                                            description: 'Represents a resource batch.',
+                                            properties: {
+                                                acs_entrances: {
+                                                    items: { $ref: '#/components/schemas/acs_entrance' },
+                                                    type: 'array',
+                                                },
+                                                batch_type: { enum: ['spaces'], type: 'string' },
+                                                devices: {
+                                                    items: { $ref: '#/components/schemas/device' },
+                                                    type: 'array',
+                                                },
+                                                spaces: {
+                                                    items: { $ref: '#/components/schemas/space' },
+                                                    type: 'array',
+                                                },
+                                            },
+                                            required: ['batch_type'],
+                                            type: 'object',
+                                            'x-route-path': '/',
+                                        },
+                                        ok: { type: 'boolean' },
+                                    },
+                                    required: ['batch', 'ok'],
+                                    type: 'object',
+                                },
+                            },
+                        },
+                        description: 'OK',
+                    },
+                    400: { description: 'Bad Request' },
+                    401: { description: 'Unauthorized' },
+                },
+                security: [
+                    { pat_with_workspace: [] },
+                    { console_session_with_workspace: [] },
+                    { api_key: [] },
+                ],
+                summary: '/spaces/get_related',
+                tags: [],
+                'x-batch-type': 'spaces',
+                'x-draft': 'Early access.',
+                'x-fern-sdk-group-name': ['spaces'],
+                'x-fern-sdk-method-name': 'get_related',
+                'x-fern-sdk-return-value': 'batch',
+                'x-response-key': 'batch',
+                'x-title': 'Get related Space resources',
+            },
+            post: {
+                description: 'Gets all related resources for one or more Spaces.',
+                operationId: 'spacesGetRelatedPost',
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                properties: {
+                                    exclude: {
+                                        items: {
+                                            enum: ['spaces', 'devices', 'acs_entrances'],
+                                            type: 'string',
+                                        },
+                                        type: 'array',
+                                    },
+                                    include: {
+                                        items: {
+                                            enum: ['spaces', 'devices', 'acs_entrances'],
+                                            type: 'string',
+                                        },
+                                        type: 'array',
+                                    },
+                                    space_ids: {
+                                        description: 'IDs of the spaces that you want to get along with their related resources.',
+                                        items: { format: 'uuid', type: 'string' },
+                                        type: 'array',
+                                    },
+                                },
+                                required: ['space_ids'],
+                                type: 'object',
+                            },
+                        },
+                    },
+                },
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        batch: {
+                                            description: 'Represents a resource batch.',
+                                            properties: {
+                                                acs_entrances: {
+                                                    items: { $ref: '#/components/schemas/acs_entrance' },
+                                                    type: 'array',
+                                                },
+                                                batch_type: { enum: ['spaces'], type: 'string' },
+                                                devices: {
+                                                    items: { $ref: '#/components/schemas/device' },
+                                                    type: 'array',
+                                                },
+                                                spaces: {
+                                                    items: { $ref: '#/components/schemas/space' },
+                                                    type: 'array',
+                                                },
+                                            },
+                                            required: ['batch_type'],
+                                            type: 'object',
+                                            'x-route-path': '/',
+                                        },
+                                        ok: { type: 'boolean' },
+                                    },
+                                    required: ['batch', 'ok'],
+                                    type: 'object',
+                                },
+                            },
+                        },
+                        description: 'OK',
+                    },
+                    400: { description: 'Bad Request' },
+                    401: { description: 'Unauthorized' },
+                },
+                security: [
+                    { pat_with_workspace: [] },
+                    { console_session_with_workspace: [] },
+                    { api_key: [] },
+                ],
+                summary: '/spaces/get_related',
+                tags: [],
+                'x-batch-type': 'spaces',
+                'x-draft': 'Early access.',
+                'x-fern-sdk-group-name': ['spaces'],
+                'x-fern-sdk-method-name': 'get_related',
+                'x-fern-sdk-return-value': 'batch',
+                'x-response-key': 'batch',
+                'x-title': 'Get related Space resources',
+            },
+        },
         '/spaces/list': {
             get: {
                 description: 'Returns a list of all spaces.',