@seamapi/types 1.981.0 → 1.982.0

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

@@ -20569,14 +20569,18 @@ export type Routes = {
             access_grant_id?: string | undefined;
             /** Key of Access Grant to list access methods for. */
             access_grant_key?: string | undefined;
-            /** ID of the device for which you want to retrieve all access methods. */
+            /** ID of the device by which to filter the returned access methods. Must be combined with `access_grant_id`, `access_grant_key`, or `acs_entrance_id`. */
             device_id?: string | undefined;
-            /** ID of the entrance for which you want to retrieve all access methods. */
+            /** ID of the entrance for which you want to retrieve all access methods that grant access to it. */
             acs_entrance_id?: string | undefined;
-            /** ID of the space for which you want to retrieve all access methods. */
+            /** ID of the space by which to filter the returned access methods. Must be combined with `access_grant_id`, `access_grant_key`, or `acs_entrance_id`. */
             space_id?: string | undefined;
-            /** ID of the access code for which you want to retrieve all access methods. */
+            /** ID of the access code by which to filter the returned access methods. Must be combined with `access_grant_id`, `access_grant_key`, or `acs_entrance_id`. */
             access_code_id?: string | undefined;
+            /** Maximum number of records to return per page. */
+            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: {
@@ -20710,6 +20714,15 @@ export type Routes = {
                 /** ID of the customization profile associated with the access method. */
                 customization_profile_id?: string | undefined;
             }[];
+            /** 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;
+            };
         };
         maxDuration: undefined;
     };

package/package.json

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

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

@@ -42928,7 +42928,7 @@ const openapi: OpenAPISpec = {
             name: 'device_id',
             schema: {
               description:
-                'ID of the device for which you want to retrieve all access methods.',
+                'ID of the device by which to filter the returned access methods. Must be combined with `access_grant_id`, `access_grant_key`, or `acs_entrance_id`.',
               format: 'uuid',
               type: 'string',
             },
@@ -42938,7 +42938,7 @@ const openapi: OpenAPISpec = {
             name: 'acs_entrance_id',
             schema: {
               description:
-                'ID of the entrance for which you want to retrieve all access methods.',
+                'ID of the entrance for which you want to retrieve all access methods that grant access to it.',
               format: 'uuid',
               type: 'string',
             },
@@ -42948,7 +42948,7 @@ const openapi: OpenAPISpec = {
             name: 'space_id',
             schema: {
               description:
-                'ID of the space for which you want to retrieve all access methods.',
+                'ID of the space by which to filter the returned access methods. Must be combined with `access_grant_id`, `access_grant_key`, or `acs_entrance_id`.',
               format: 'uuid',
               type: 'string',
             },
@@ -42958,11 +42958,32 @@ const openapi: OpenAPISpec = {
             name: 'access_code_id',
             schema: {
               description:
-                'ID of the access code for which you want to retrieve all access methods.',
+                'ID of the access code by which to filter the returned access methods. Must be combined with `access_grant_id`, `access_grant_key`, or `acs_entrance_id`.',
               format: 'uuid',
               type: 'string',
             },
           },
+          {
+            in: 'query',
+            name: 'limit',
+            schema: {
+              default: 500,
+              description: 'Maximum number of records to return per page.',
+              exclusiveMinimum: true,
+              minimum: 0,
+              type: 'integer',
+            },
+          },
+          {
+            in: 'query',
+            name: 'page_cursor',
+            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: {
@@ -42975,8 +42996,9 @@ const openapi: OpenAPISpec = {
                       type: 'array',
                     },
                     ok: { type: 'boolean' },
+                    pagination: { $ref: '#/components/schemas/pagination' },
                   },
-                  required: ['access_methods', 'ok'],
+                  required: ['access_methods', 'pagination', 'ok'],
                   type: 'object',
                 },
               },
@@ -43013,7 +43035,7 @@ const openapi: OpenAPISpec = {
                 properties: {
                   access_code_id: {
                     description:
-                      'ID of the access code for which you want to retrieve all access methods.',
+                      'ID of the access code by which to filter the returned access methods. Must be combined with `access_grant_id`, `access_grant_key`, or `acs_entrance_id`.',
                     format: 'uuid',
                     type: 'string',
                   },
@@ -43031,19 +43053,33 @@ const openapi: OpenAPISpec = {
                   },
                   acs_entrance_id: {
                     description:
-                      'ID of the entrance for which you want to retrieve all access methods.',
+                      'ID of the entrance for which you want to retrieve all access methods that grant access to it.',
                     format: 'uuid',
                     type: 'string',
                   },
                   device_id: {
                     description:
-                      'ID of the device for which you want to retrieve all access methods.',
+                      'ID of the device by which to filter the returned access methods. Must be combined with `access_grant_id`, `access_grant_key`, or `acs_entrance_id`.',
                     format: 'uuid',
                     type: 'string',
                   },
+                  limit: {
+                    default: 500,
+                    description:
+                      'Maximum number of records to return per page.',
+                    exclusiveMinimum: true,
+                    minimum: 0,
+                    type: 'integer',
+                  },
+                  page_cursor: {
+                    description:
+                      "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
+                    nullable: true,
+                    type: 'string',
+                  },
                   space_id: {
                     description:
-                      'ID of the space for which you want to retrieve all access methods.',
+                      'ID of the space by which to filter the returned access methods. Must be combined with `access_grant_id`, `access_grant_key`, or `acs_entrance_id`.',
                     format: 'uuid',
                     type: 'string',
                   },
@@ -43064,8 +43100,9 @@ const openapi: OpenAPISpec = {
                       type: 'array',
                     },
                     ok: { type: 'boolean' },
+                    pagination: { $ref: '#/components/schemas/pagination' },
                   },
-                  required: ['access_methods', 'ok'],
+                  required: ['access_methods', 'pagination', 'ok'],
                   type: 'object',
                 },
               },

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

@@ -24482,14 +24482,18 @@ export type Routes = {
       access_grant_id?: string | undefined
       /** Key of Access Grant to list access methods for. */
       access_grant_key?: string | undefined
-      /** ID of the device for which you want to retrieve all access methods. */
+      /** ID of the device by which to filter the returned access methods. Must be combined with `access_grant_id`, `access_grant_key`, or `acs_entrance_id`. */
       device_id?: string | undefined
-      /** ID of the entrance for which you want to retrieve all access methods. */
+      /** ID of the entrance for which you want to retrieve all access methods that grant access to it. */
       acs_entrance_id?: string | undefined
-      /** ID of the space for which you want to retrieve all access methods. */
+      /** ID of the space by which to filter the returned access methods. Must be combined with `access_grant_id`, `access_grant_key`, or `acs_entrance_id`. */
       space_id?: string | undefined
-      /** ID of the access code for which you want to retrieve all access methods. */
+      /** ID of the access code by which to filter the returned access methods. Must be combined with `access_grant_id`, `access_grant_key`, or `acs_entrance_id`. */
       access_code_id?: string | undefined
+      /** Maximum number of records to return per page. */
+      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: {
@@ -24632,6 +24636,15 @@ export type Routes = {
         /** ID of the customization profile associated with the access method. */
         customization_profile_id?: string | undefined
       }[]
+      /** 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
+      }
     }
     maxDuration: undefined
   }