@seamapi/types 1.455.0 → 1.457.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.455.0",
+  "version": "1.457.0",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",

package/src/lib/seam/connect/models/access-grants/access-method.ts

@@ -19,8 +19,11 @@ export const access_method = z.object({
   issued_at: z
     .string()
     .datetime()
-    .optional()
+    .nullable()
     .describe('Date and time at which the access method was issued.'),
+  is_issued: z
+    .boolean()
+    .describe('Indicates whether the access method has been issued.'),
   instant_key_url: z
     .string()
     .url()

package/src/lib/seam/connect/models/batches/access_methods.ts

@@ -0,0 +1,14 @@
+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 access_methods_batch = z.object({
+  batch_type: z.literal('access_methods'),
+  spaces: space.array().optional(),
+  devices: device.array().optional(),
+  acs_entrances: acs_entrance.array().optional(),
+})
+
+export type AccessMethodsBundle = z.infer<typeof access_methods_batch>

package/src/lib/seam/connect/models/batches/batch.ts

@@ -1,9 +1,14 @@
 import { z } from 'zod'
 
 import { access_grants_batch } from './access_grants.js'
+import { access_methods_batch } from './access_methods.js'
 import { spaces_batch } from './spaces.js'
 
-export const batch = z.union([spaces_batch, access_grants_batch]).describe(`
+export const batch = z.union([
+  spaces_batch,
+  access_grants_batch,
+  access_methods_batch,
+]).describe(`
   ---
   route_path: /
   ---

package/src/lib/seam/connect/models/batches/index.ts

@@ -1,3 +1,4 @@
 export * from './access_grants.js'
+export * from './access_methods.js'
 export * from './batch.js'
 export * from './spaces.js'

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

@@ -1987,9 +1987,14 @@ export default {
               'Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method.',
             type: 'boolean',
           },
+          is_issued: {
+            description: 'Indicates whether the access method has been issued.',
+            type: 'boolean',
+          },
           issued_at: {
             description: 'Date and time at which the access method was issued.',
             format: 'date-time',
+            nullable: true,
             type: 'string',
           },
           mode: {
@@ -2011,6 +2016,8 @@ export default {
           'display_name',
           'mode',
           'created_at',
+          'issued_at',
+          'is_issued',
         ],
         type: 'object',
         'x-draft': 'Early access.',
@@ -28056,6 +28063,30 @@ export default {
                           required: ['batch_type'],
                           type: 'object',
                         },
+                        {
+                          properties: {
+                            acs_entrances: {
+                              items: {
+                                $ref: '#/components/schemas/acs_entrance',
+                              },
+                              type: 'array',
+                            },
+                            batch_type: {
+                              enum: ['access_methods'],
+                              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': '/',
                     },
@@ -28177,6 +28208,30 @@ export default {
                           required: ['batch_type'],
                           type: 'object',
                         },
+                        {
+                          properties: {
+                            acs_entrances: {
+                              items: {
+                                $ref: '#/components/schemas/acs_entrance',
+                              },
+                              type: 'array',
+                            },
+                            batch_type: {
+                              enum: ['access_methods'],
+                              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': '/',
                     },
@@ -28802,6 +28857,303 @@ export default {
         'x-title': 'Get an Access Method',
       },
     },
+    '/access_methods/get_related': {
+      get: {
+        description:
+          'Gets all related resources for one or more Access Methods.',
+        operationId: 'accessMethodsGetRelatedGet',
+        parameters: [
+          {
+            in: 'query',
+            name: 'access_method_ids',
+            required: true,
+            schema: {
+              description:
+                'IDs of the access methods 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.',
+                      oneOf: [
+                        {
+                          description: 'ID of the affected access system user.',
+                          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',
+                        },
+                        {
+                          properties: {
+                            acs_entrances: {
+                              items: {
+                                $ref: '#/components/schemas/acs_entrance',
+                              },
+                              type: 'array',
+                            },
+                            batch_type: {
+                              enum: ['access_grants'],
+                              type: 'string',
+                            },
+                            devices: {
+                              items: { $ref: '#/components/schemas/device' },
+                              type: 'array',
+                            },
+                            spaces: {
+                              items: { $ref: '#/components/schemas/space' },
+                              type: 'array',
+                            },
+                          },
+                          required: ['batch_type'],
+                          type: 'object',
+                        },
+                        {
+                          properties: {
+                            acs_entrances: {
+                              items: {
+                                $ref: '#/components/schemas/acs_entrance',
+                              },
+                              type: 'array',
+                            },
+                            batch_type: {
+                              enum: ['access_methods'],
+                              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: '/access_methods/get_related',
+        tags: [],
+        'x-batch-type': 'access_methods',
+        'x-draft': 'Early access.',
+        'x-fern-sdk-group-name': ['access_methods'],
+        'x-fern-sdk-method-name': 'get_related',
+        'x-fern-sdk-return-value': 'batch',
+        'x-response-key': 'batch',
+        'x-title': 'Get related Access Method resources',
+      },
+      post: {
+        description:
+          'Gets all related resources for one or more Access Methods.',
+        operationId: 'accessMethodsGetRelatedPost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  access_method_ids: {
+                    description:
+                      'IDs of the access methods that you want to get along with their related resources.',
+                    items: { format: 'uuid', type: 'string' },
+                    type: 'array',
+                  },
+                  exclude: {
+                    items: {
+                      enum: ['spaces', 'devices', 'acs_entrances'],
+                      type: 'string',
+                    },
+                    type: 'array',
+                  },
+                  include: {
+                    items: {
+                      enum: ['spaces', 'devices', 'acs_entrances'],
+                      type: 'string',
+                    },
+                    type: 'array',
+                  },
+                },
+                required: ['access_method_ids'],
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    batch: {
+                      description: 'Represents a resource batch.',
+                      oneOf: [
+                        {
+                          description: 'ID of the affected access system user.',
+                          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',
+                        },
+                        {
+                          properties: {
+                            acs_entrances: {
+                              items: {
+                                $ref: '#/components/schemas/acs_entrance',
+                              },
+                              type: 'array',
+                            },
+                            batch_type: {
+                              enum: ['access_grants'],
+                              type: 'string',
+                            },
+                            devices: {
+                              items: { $ref: '#/components/schemas/device' },
+                              type: 'array',
+                            },
+                            spaces: {
+                              items: { $ref: '#/components/schemas/space' },
+                              type: 'array',
+                            },
+                          },
+                          required: ['batch_type'],
+                          type: 'object',
+                        },
+                        {
+                          properties: {
+                            acs_entrances: {
+                              items: {
+                                $ref: '#/components/schemas/acs_entrance',
+                              },
+                              type: 'array',
+                            },
+                            batch_type: {
+                              enum: ['access_methods'],
+                              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: '/access_methods/get_related',
+        tags: [],
+        'x-batch-type': 'access_methods',
+        'x-draft': 'Early access.',
+        'x-fern-sdk-group-name': ['access_methods'],
+        'x-fern-sdk-method-name': 'get_related',
+        'x-fern-sdk-return-value': 'batch',
+        'x-response-key': 'batch',
+        'x-title': 'Get related Access Method resources',
+      },
+    },
     '/access_methods/list': {
       get: {
         description:
@@ -47747,6 +48099,30 @@ export default {
                           required: ['batch_type'],
                           type: 'object',
                         },
+                        {
+                          properties: {
+                            acs_entrances: {
+                              items: {
+                                $ref: '#/components/schemas/acs_entrance',
+                              },
+                              type: 'array',
+                            },
+                            batch_type: {
+                              enum: ['access_methods'],
+                              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': '/',
                     },
@@ -47867,6 +48243,30 @@ export default {
                           required: ['batch_type'],
                           type: 'object',
                         },
+                        {
+                          properties: {
+                            acs_entrances: {
+                              items: {
+                                $ref: '#/components/schemas/acs_entrance',
+                              },
+                              type: 'array',
+                            },
+                            batch_type: {
+                              enum: ['access_methods'],
+                              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': '/',
                     },