@seamapi/types 1.451.0 → 1.453.0

package/lib/seam/connect/route-types.d.ts

@@ -8080,6 +8080,10 @@ export interface Routes {
             device_id: string;
             /** Your user ID for the user by which to filter unmanaged access codes. */
             user_identifier_key?: string | undefined;
+            /** Numerical limit on the number of unmanaged access codes to return. */
+            limit?: number;
+            /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
+            page_cursor?: (string | undefined) | null;
         };
         formData: {};
         jsonResponse: {
@@ -8570,6 +8574,15 @@ export interface Routes {
                 /** Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational. */
                 status: 'set';
             }>;
+            /** Information about the current page of results. */
+            pagination: {
+                /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
+                next_page_cursor: string | null;
+                /** Indicates whether there is another page of results after this one. */
+                has_next_page: boolean;
+                /** URL to get the next page of results. */
+                next_page_url: string | null;
+            };
         };
     };
     '/access_codes/unmanaged/update': {
@@ -9933,6 +9946,8 @@ export interface Routes {
                 full_name?: (string | null) | undefined;
             };
         }) & {
+            /** Name for the access grant. */
+            name?: (string | undefined) | null;
             /** Unique key for the access grant within the workspace. */
             access_grant_key?: string | undefined;
             /**
@@ -9996,6 +10011,8 @@ export interface Routes {
                 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.  */
@@ -10065,6 +10082,8 @@ export interface Routes {
                 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.  */
@@ -10129,6 +10148,8 @@ export interface Routes {
                 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.  */
@@ -10148,6 +10169,8 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** Display name for the access grant. */
+            name?: (string | null) | undefined;
             /** ID of the Access Grant to update. */
             access_grant_id: string;
             /** Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
@@ -48040,10 +48063,16 @@ export interface Routes {
         method: 'POST' | 'PATCH';
         queryParams: {};
         jsonBody: {
-            /** ID of the space that you want to update. */
-            space_id: string;
             /** Name of the space. */
             name?: string | undefined;
+            /** ID of the space that you want to update. */
+            space_id?: string | undefined;
+            /** Unique key of the space that you want to update. */
+            space_key?: string | undefined;
+            /** IDs of the devices that you want to set for the space. If specified, this will replace all existing devices. */
+            device_ids?: string[] | undefined;
+            /** IDs of the entrances that you want to set for the space. If specified, this will replace all existing entrances. */
+            acs_entrance_ids?: string[] | undefined;
         };
         commonParams: {};
         formData: {};
@@ -63533,6 +63562,8 @@ export interface Routes {
                 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.  */
@@ -63599,6 +63630,8 @@ export interface Routes {
                 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.  */
@@ -63661,6 +63694,8 @@ export interface Routes {
                 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.  */

package/package.json

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

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

@@ -36,6 +36,12 @@ export const access_grant = z.object({
     .describe(
       'Client Session Token. Only returned if the Access Grant has a mobile_key access method.',
     ),
+  name: z
+    .string()
+    .nullable()
+    .describe(
+      'Name of the Access Grant. If not provided, the display name will be computed.',
+    ),
   display_name: z.string().describe('Display name of the Access Grant.'),
   instant_key_url: z
     .string()

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

@@ -1864,6 +1864,12 @@ export default {
             type: 'array',
             'x-deprecated': 'Use `space_ids`.',
           },
+          name: {
+            description:
+              'Name of the Access Grant. If not provided, the display name will be computed.',
+            nullable: true,
+            type: 'string',
+          },
           requested_access_methods: {
             description:
               'Access methods that the user requested for the Access Grant.',
@@ -1934,6 +1940,7 @@ export default {
           'space_ids',
           'requested_access_methods',
           'access_method_ids',
+          'name',
           'display_name',
           'created_at',
         ],
@@ -26683,6 +26690,29 @@ export default {
               type: 'string',
             },
           },
+          {
+            in: 'query',
+            name: 'limit',
+            required: false,
+            schema: {
+              default: 300_000,
+              description:
+                'Numerical limit on the number of unmanaged access codes to return.',
+              format: 'float',
+              type: 'number',
+            },
+          },
+          {
+            in: 'query',
+            name: 'page_cursor',
+            required: false,
+            schema: {
+              description:
+                "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
+              nullable: true,
+              type: 'string',
+            },
+          },
         ],
         responses: {
           200: {
@@ -26697,8 +26727,9 @@ export default {
                       type: 'array',
                     },
                     ok: { type: 'boolean' },
+                    pagination: { $ref: '#/components/schemas/pagination' },
                   },
-                  required: ['access_codes', 'ok'],
+                  required: ['access_codes', 'pagination', 'ok'],
                   type: 'object',
                 },
               },
@@ -26737,6 +26768,19 @@ export default {
                     format: 'uuid',
                     type: 'string',
                   },
+                  limit: {
+                    default: 300_000,
+                    description:
+                      'Numerical limit on the number of unmanaged access codes to return.',
+                    format: 'float',
+                    type: 'number',
+                  },
+                  page_cursor: {
+                    description:
+                      "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
+                    nullable: true,
+                    type: 'string',
+                  },
                   user_identifier_key: {
                     description:
                       'Your user ID for the user by which to filter unmanaged access codes.',
@@ -26762,8 +26806,9 @@ export default {
                       type: 'array',
                     },
                     ok: { type: 'boolean' },
+                    pagination: { $ref: '#/components/schemas/pagination' },
                   },
-                  required: ['access_codes', 'ok'],
+                  required: ['access_codes', 'pagination', 'ok'],
                   type: 'object',
                 },
               },
@@ -27635,6 +27680,11 @@ export default {
                         type: 'array',
                         'x-deprecated': 'Use `space_ids`.',
                       },
+                      name: {
+                        description: 'Name for the access grant.',
+                        nullable: true,
+                        type: 'string',
+                      },
                       requested_access_methods: {
                         items: {
                           properties: {
@@ -28117,6 +28167,11 @@ export default {
                     nullable: true,
                     type: 'string',
                   },
+                  name: {
+                    description: 'Display name for the access grant.',
+                    nullable: true,
+                    type: 'string',
+                  },
                   starts_at: {
                     description:
                       'Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
@@ -28181,6 +28236,11 @@ export default {
                     nullable: true,
                     type: 'string',
                   },
+                  name: {
+                    description: 'Display name for the access grant.',
+                    nullable: true,
+                    type: 'string',
+                  },
                   starts_at: {
                     description:
                       'Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
@@ -32268,6 +32328,7 @@ export default {
           { client_session: [] },
           { pat_with_workspace: [] },
           { console_session_with_workspace: [] },
+          { client_session_with_customer: [] },
         ],
         summary: '/acs/entrances/list',
         tags: ['/acs'],
@@ -32374,6 +32435,7 @@ export default {
           { client_session: [] },
           { pat_with_workspace: [] },
           { console_session_with_workspace: [] },
+          { client_session_with_customer: [] },
         ],
         summary: '/acs/entrances/list',
         tags: ['/acs'],
@@ -47717,6 +47779,7 @@ export default {
           { pat_with_workspace: [] },
           { console_session_with_workspace: [] },
           { api_key: [] },
+          { client_session_with_customer: [] },
         ],
         summary: '/spaces/remove_acs_entrances',
         tags: [],
@@ -47774,6 +47837,7 @@ export default {
           { pat_with_workspace: [] },
           { console_session_with_workspace: [] },
           { api_key: [] },
+          { client_session_with_customer: [] },
         ],
         summary: '/spaces/remove_acs_entrances',
         tags: [],
@@ -47832,6 +47896,7 @@ export default {
           { pat_with_workspace: [] },
           { console_session_with_workspace: [] },
           { api_key: [] },
+          { client_session_with_customer: [] },
         ],
         summary: '/spaces/remove_devices',
         tags: [],
@@ -47888,6 +47953,7 @@ export default {
           { pat_with_workspace: [] },
           { console_session_with_workspace: [] },
           { api_key: [] },
+          { client_session_with_customer: [] },
         ],
         summary: '/spaces/remove_devices',
         tags: [],
@@ -47907,14 +47973,30 @@ export default {
             'application/json': {
               schema: {
                 properties: {
+                  acs_entrance_ids: {
+                    description:
+                      'IDs of the entrances that you want to set for the space. If specified, this will replace all existing entrances.',
+                    items: { format: 'uuid', type: 'string' },
+                    type: 'array',
+                  },
+                  device_ids: {
+                    description:
+                      'IDs of the devices that you want to set for the space. If specified, this will replace all existing devices.',
+                    items: { format: 'uuid', type: 'string' },
+                    type: 'array',
+                  },
                   name: { description: 'Name of the space.', type: 'string' },
                   space_id: {
                     description: 'ID of the space that you want to update.',
                     format: 'uuid',
                     type: 'string',
                   },
+                  space_key: {
+                    description:
+                      'Unique key of the space that you want to update.',
+                    type: 'string',
+                  },
                 },
-                required: ['space_id'],
                 type: 'object',
               },
             },
@@ -47943,6 +48025,7 @@ export default {
           { pat_with_workspace: [] },
           { console_session_with_workspace: [] },
           { api_key: [] },
+          { client_session_with_customer: [] },
         ],
         summary: '/spaces/update',
         tags: [],
@@ -47961,14 +48044,30 @@ export default {
             'application/json': {
               schema: {
                 properties: {
+                  acs_entrance_ids: {
+                    description:
+                      'IDs of the entrances that you want to set for the space. If specified, this will replace all existing entrances.',
+                    items: { format: 'uuid', type: 'string' },
+                    type: 'array',
+                  },
+                  device_ids: {
+                    description:
+                      'IDs of the devices that you want to set for the space. If specified, this will replace all existing devices.',
+                    items: { format: 'uuid', type: 'string' },
+                    type: 'array',
+                  },
                   name: { description: 'Name of the space.', type: 'string' },
                   space_id: {
                     description: 'ID of the space that you want to update.',
                     format: 'uuid',
                     type: 'string',
                   },
+                  space_key: {
+                    description:
+                      'Unique key of the space that you want to update.',
+                    type: 'string',
+                  },
                 },
-                required: ['space_id'],
                 type: 'object',
               },
             },
@@ -47997,6 +48096,7 @@ export default {
           { pat_with_workspace: [] },
           { console_session_with_workspace: [] },
           { api_key: [] },
+          { client_session_with_customer: [] },
         ],
         summary: '/spaces/update',
         tags: [],

package/src/lib/seam/connect/route-types.ts

@@ -9063,6 +9063,10 @@ export interface Routes {
       device_id: string
       /** Your user ID for the user by which to filter unmanaged access codes. */
       user_identifier_key?: string | undefined
+      /** Numerical limit on the number of unmanaged access codes to return. */
+      limit?: number
+      /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
+      page_cursor?: (string | undefined) | null
     }
     formData: {}
     jsonResponse: {
@@ -9608,6 +9612,15 @@ export interface Routes {
         /** Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational. */
         status: 'set'
       }>
+      /** Information about the current page of results. */
+      pagination: {
+        /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
+        next_page_cursor: string | null
+        /** Indicates whether there is another page of results after this one. */
+        has_next_page: boolean
+        /** URL to get the next page of results. */
+        next_page_url: string | null
+      }
     }
   }
   '/access_codes/unmanaged/update': {
@@ -11155,6 +11168,8 @@ export interface Routes {
           }
         }
     ) & {
+      /** Name for the access grant. */
+      name?: (string | undefined) | null
       /** Unique key for the access grant within the workspace. */
       access_grant_key?: string | undefined
       /**
@@ -11220,6 +11235,8 @@ export interface Routes {
         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.  */
@@ -11291,6 +11308,8 @@ export interface Routes {
         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.  */
@@ -11355,6 +11374,8 @@ export interface Routes {
         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.  */
@@ -11374,6 +11395,8 @@ export interface Routes {
     queryParams: {}
     jsonBody: {}
     commonParams: {
+      /** Display name for the access grant. */
+      name?: (string | null) | undefined
       /** ID of the Access Grant to update. */
       access_grant_id: string
       /** Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
@@ -56799,10 +56822,16 @@ export interface Routes {
     method: 'POST' | 'PATCH'
     queryParams: {}
     jsonBody: {
-      /** ID of the space that you want to update. */
-      space_id: string
       /** Name of the space. */
       name?: string | undefined
+      /** ID of the space that you want to update. */
+      space_id?: string | undefined
+      /** Unique key of the space that you want to update. */
+      space_key?: string | undefined
+      /** IDs of the devices that you want to set for the space. If specified, this will replace all existing devices. */
+      device_ids?: string[] | undefined
+      /** IDs of the entrances that you want to set for the space. If specified, this will replace all existing entrances. */
+      acs_entrance_ids?: string[] | undefined
     }
     commonParams: {}
     formData: {}
@@ -74879,6 +74908,8 @@ export interface Routes {
         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.  */
@@ -74945,6 +74976,8 @@ export interface Routes {
         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.  */
@@ -75007,6 +75040,8 @@ export interface Routes {
         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.  */