@seamapi/types 1.602.0 → 1.604.0

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

@@ -9912,6 +9912,8 @@ export type Routes = {
             name?: (string | undefined) | null;
             /** Unique key for the access grant within the workspace. */
             access_grant_key?: string | undefined;
+            /** Reservation key for the access grant. */
+            reservation_key?: string | undefined;
             /**
              * @deprecated Use `space_ids`.*/
             location_ids?: string[] | undefined;
@@ -9957,6 +9959,8 @@ export type Routes = {
                 access_grant_id: string;
                 /** Unique key for the access grant within the workspace. */
                 access_grant_key?: string | undefined;
+                /** Reservation key for the access grant. */
+                reservation_key?: string | undefined;
                 /** ID of user identity to which the Access Grant gives access. */
                 user_identity_id: string;
                 /**
@@ -10041,6 +10045,8 @@ export type Routes = {
                 access_grant_id: string;
                 /** Unique key for the access grant within the workspace. */
                 access_grant_key?: string | undefined;
+                /** Reservation key for the access grant. */
+                reservation_key?: string | undefined;
                 /** ID of user identity to which the Access Grant gives access. */
                 user_identity_id: string;
                 /**
@@ -11820,6 +11826,8 @@ export type Routes = {
                 access_grant_id: string;
                 /** Unique key for the access grant within the workspace. */
                 access_grant_key?: string | undefined;
+                /** Reservation key for the access grant. */
+                reservation_key?: string | undefined;
                 /** ID of user identity to which the Access Grant gives access. */
                 user_identity_id: string;
                 /**
@@ -11896,6 +11904,8 @@ export type Routes = {
                 access_grant_id: string;
                 /** Unique key for the access grant within the workspace. */
                 access_grant_key?: string | undefined;
+                /** Reservation key for the access grant. */
+                reservation_key?: string | undefined;
                 /** ID of user identity to which the Access Grant gives access. */
                 user_identity_id: string;
                 /**
@@ -11963,6 +11973,8 @@ export type Routes = {
                 workspace_id: string;
                 /** ID of the Access Grant. */
                 access_grant_id: string;
+                /** Reservation key for the access grant. */
+                reservation_key?: string | undefined;
                 /** ID of user identity to which the Access Grant gives access. */
                 user_identity_id: string;
                 /**
@@ -12027,6 +12039,8 @@ export type Routes = {
                 workspace_id: string;
                 /** ID of the Access Grant. */
                 access_grant_id: string;
+                /** Reservation key for the access grant. */
+                reservation_key?: string | undefined;
                 /** ID of user identity to which the Access Grant gives access. */
                 user_identity_id: string;
                 /**
@@ -17522,6 +17536,8 @@ export type Routes = {
                     access_grant_id: string;
                     /** Unique key for the access grant within the workspace. */
                     access_grant_key?: string | undefined;
+                    /** Reservation key for the access grant. */
+                    reservation_key?: string | undefined;
                     /** ID of user identity to which the Access Grant gives access. */
                     user_identity_id: string;
                     /**
@@ -77692,6 +77708,12 @@ export type Routes = {
             search?: string | undefined;
             /** `acs_system_id` of the credential manager by which you want to filter the list of user identities. */
             credential_manager_acs_system_id?: string | undefined;
+            /** Maximum number of records to return per page. */
+            limit?: number;
+            /** Timestamp by which to limit returned user identities. Returns user identities created before this timestamp. */
+            created_before?: Date | undefined;
+            /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
+            page_cursor?: (string | undefined) | null;
         };
         formData: {};
         jsonResponse: {
@@ -77742,6 +77764,15 @@ export type Routes = {
                 /** Array of access system user IDs associated with the user identity. */
                 acs_user_ids: string[];
             }[];
+            /** 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;
+            };
         };
     };
     '/user_identities/list_accessible_devices': {
@@ -80632,6 +80663,12 @@ export type Routes = {
         commonParams: {
             /** String for which to search. Filters returned unmanaged user identities to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address` or `user_identity_id`. */
             search?: string | undefined;
+            /** Maximum number of records to return per page. */
+            limit?: number;
+            /** Timestamp by which to limit returned unmanaged user identities. Returns user identities created before this timestamp. */
+            created_before?: Date | undefined;
+            /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
+            page_cursor?: (string | undefined) | null;
         };
         formData: {};
         jsonResponse: {
@@ -80680,6 +80717,15 @@ export type Routes = {
                 /** Array of access system user IDs associated with the user identity. */
                 acs_user_ids: string[];
             }[];
+            /** 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;
+            };
         };
     };
     '/user_identities/unmanaged/update': {
@@ -85062,6 +85108,8 @@ export type Routes = {
                     access_grant_id: string;
                     /** Unique key for the access grant within the workspace. */
                     access_grant_key?: string | undefined;
+                    /** Reservation key for the access grant. */
+                    reservation_key?: string | undefined;
                     /** ID of user identity to which the Access Grant gives access. */
                     user_identity_id: string;
                     /**

package/package.json

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

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

@@ -47,6 +47,10 @@ export const access_grant = z.object({
     .string()
     .optional()
     .describe('Unique key for the access grant within the workspace.'),
+  reservation_key: z
+    .string()
+    .optional()
+    .describe('Reservation key for the access grant.'),
   user_identity_id: z
     .string()
     .uuid()

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

@@ -1896,6 +1896,10 @@ export default {
             },
             type: 'array',
           },
+          reservation_key: {
+            description: 'Reservation key for the access grant.',
+            type: 'string',
+          },
           space_ids: {
             description:
               'IDs of the spaces to which the Access Grant gives access.',
@@ -28450,6 +28454,10 @@ export default {
                         },
                         type: 'array',
                       },
+                      reservation_key: {
+                        description: 'Reservation key for the access grant.',
+                        type: 'string',
+                      },
                       space_ids: {
                         description:
                           'Set of IDs of existing spaces to which access is being granted.',
@@ -29369,6 +29377,10 @@ export default {
                           },
                           type: 'array',
                         },
+                        reservation_key: {
+                          description: 'Reservation key for the access grant.',
+                          type: 'string',
+                        },
                         space_ids: {
                           description:
                             'IDs of the spaces to which the Access Grant gives access.',
@@ -29599,6 +29611,10 @@ export default {
                           },
                           type: 'array',
                         },
+                        reservation_key: {
+                          description: 'Reservation key for the access grant.',
+                          type: 'string',
+                        },
                         space_ids: {
                           description:
                             'IDs of the spaces to which the Access Grant gives access.',
@@ -29846,6 +29862,11 @@ export default {
                             },
                             type: 'array',
                           },
+                          reservation_key: {
+                            description:
+                              'Reservation key for the access grant.',
+                            type: 'string',
+                          },
                           space_ids: {
                             description:
                               'IDs of the spaces to which the Access Grant gives access.',
@@ -30090,6 +30111,11 @@ export default {
                             },
                             type: 'array',
                           },
+                          reservation_key: {
+                            description:
+                              'Reservation key for the access grant.',
+                            type: 'string',
+                          },
                           space_ids: {
                             description:
                               'IDs of the spaces to which the Access Grant gives access.',
@@ -60442,6 +60468,37 @@ export default {
               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: 'created_before',
+            schema: {
+              description:
+                'Timestamp by which to limit returned user identities. Returns user identities created before this timestamp.',
+              format: 'date-time',
+              type: 'string',
+            },
+          },
+          {
+            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: {
@@ -60450,12 +60507,13 @@ export default {
                 schema: {
                   properties: {
                     ok: { type: 'boolean' },
+                    pagination: { $ref: '#/components/schemas/pagination' },
                     user_identities: {
                       items: { $ref: '#/components/schemas/user_identity' },
                       type: 'array',
                     },
                   },
-                  required: ['user_identities', 'ok'],
+                  required: ['user_identities', 'pagination', 'ok'],
                   type: 'object',
                 },
               },
@@ -60488,12 +60546,32 @@ export default {
             'application/json': {
               schema: {
                 properties: {
+                  created_before: {
+                    description:
+                      'Timestamp by which to limit returned user identities. Returns user identities created before this timestamp.',
+                    format: 'date-time',
+                    type: 'string',
+                  },
                   credential_manager_acs_system_id: {
                     description:
                       '`acs_system_id` of the credential manager by which you want to filter the list of user identities.',
                     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',
+                  },
                   search: {
                     description:
                       'String for which to search. Filters returned user identities to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address` or `user_identity_id`.',
@@ -60512,12 +60590,13 @@ export default {
                 schema: {
                   properties: {
                     ok: { type: 'boolean' },
+                    pagination: { $ref: '#/components/schemas/pagination' },
                     user_identities: {
                       items: { $ref: '#/components/schemas/user_identity' },
                       type: 'array',
                     },
                   },
-                  required: ['user_identities', 'ok'],
+                  required: ['user_identities', 'pagination', 'ok'],
                   type: 'object',
                 },
               },
@@ -61615,6 +61694,37 @@ export default {
               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: 'created_before',
+            schema: {
+              description:
+                'Timestamp by which to limit returned unmanaged user identities. Returns user identities created before this timestamp.',
+              format: 'date-time',
+              type: 'string',
+            },
+          },
+          {
+            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: {
@@ -61623,6 +61733,7 @@ export default {
                 schema: {
                   properties: {
                     ok: { type: 'boolean' },
+                    pagination: { $ref: '#/components/schemas/pagination' },
                     user_identities: {
                       items: {
                         description:
@@ -61817,7 +61928,7 @@ export default {
                       type: 'array',
                     },
                   },
-                  required: ['user_identities', 'ok'],
+                  required: ['user_identities', 'pagination', 'ok'],
                   type: 'object',
                 },
               },
@@ -61850,6 +61961,26 @@ export default {
             'application/json': {
               schema: {
                 properties: {
+                  created_before: {
+                    description:
+                      'Timestamp by which to limit returned unmanaged user identities. Returns user identities created before this timestamp.',
+                    format: 'date-time',
+                    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',
+                  },
                   search: {
                     description:
                       'String for which to search. Filters returned unmanaged user identities to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address` or `user_identity_id`.',
@@ -61868,6 +61999,7 @@ export default {
                 schema: {
                   properties: {
                     ok: { type: 'boolean' },
+                    pagination: { $ref: '#/components/schemas/pagination' },
                     user_identities: {
                       items: {
                         description:
@@ -62062,7 +62194,7 @@ export default {
                       type: 'array',
                     },
                   },
-                  required: ['user_identities', 'ok'],
+                  required: ['user_identities', 'pagination', 'ok'],
                   type: 'object',
                 },
               },

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

@@ -11165,6 +11165,8 @@ export type Routes = {
       name?: (string | undefined) | null
       /** Unique key for the access grant within the workspace. */
       access_grant_key?: string | undefined
+      /** Reservation key for the access grant. */
+      reservation_key?: string | undefined
       /**
        * @deprecated Use `space_ids`.*/
       location_ids?: string[] | undefined
@@ -11212,6 +11214,8 @@ export type Routes = {
         access_grant_id: string
         /** Unique key for the access grant within the workspace. */
         access_grant_key?: string | undefined
+        /** Reservation key for the access grant. */
+        reservation_key?: string | undefined
         /** ID of user identity to which the Access Grant gives access. */
         user_identity_id: string
         /**
@@ -11298,6 +11302,8 @@ export type Routes = {
         access_grant_id: string
         /** Unique key for the access grant within the workspace. */
         access_grant_key?: string | undefined
+        /** Reservation key for the access grant. */
+        reservation_key?: string | undefined
         /** ID of user identity to which the Access Grant gives access. */
         user_identity_id: string
         /**
@@ -13559,6 +13565,8 @@ export type Routes = {
         access_grant_id: string
         /** Unique key for the access grant within the workspace. */
         access_grant_key?: string | undefined
+        /** Reservation key for the access grant. */
+        reservation_key?: string | undefined
         /** ID of user identity to which the Access Grant gives access. */
         user_identity_id: string
         /**
@@ -13635,6 +13643,8 @@ export type Routes = {
         access_grant_id: string
         /** Unique key for the access grant within the workspace. */
         access_grant_key?: string | undefined
+        /** Reservation key for the access grant. */
+        reservation_key?: string | undefined
         /** ID of user identity to which the Access Grant gives access. */
         user_identity_id: string
         /**
@@ -13702,6 +13712,8 @@ export type Routes = {
         workspace_id: string
         /** ID of the Access Grant. */
         access_grant_id: string
+        /** Reservation key for the access grant. */
+        reservation_key?: string | undefined
         /** ID of user identity to which the Access Grant gives access. */
         user_identity_id: string
         /**
@@ -13766,6 +13778,8 @@ export type Routes = {
         workspace_id: string
         /** ID of the Access Grant. */
         access_grant_id: string
+        /** Reservation key for the access grant. */
+        reservation_key?: string | undefined
         /** ID of user identity to which the Access Grant gives access. */
         user_identity_id: string
         /**
@@ -20396,6 +20410,8 @@ export type Routes = {
               access_grant_id: string
               /** Unique key for the access grant within the workspace. */
               access_grant_key?: string | undefined
+              /** Reservation key for the access grant. */
+              reservation_key?: string | undefined
               /** ID of user identity to which the Access Grant gives access. */
               user_identity_id: string
               /**
@@ -92338,6 +92354,12 @@ export type Routes = {
       search?: string | undefined
       /** `acs_system_id` of the credential manager by which you want to filter the list of user identities. */
       credential_manager_acs_system_id?: string | undefined
+      /** Maximum number of records to return per page. */
+      limit?: number
+      /** Timestamp by which to limit returned user identities. Returns user identities created before this timestamp. */
+      created_before?: Date | undefined
+      /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
+      page_cursor?: (string | undefined) | null
     }
     formData: {}
     jsonResponse: {
@@ -92391,6 +92413,15 @@ export type Routes = {
         /** Array of access system user IDs associated with the user identity. */
         acs_user_ids: string[]
       }[]
+      /** 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
+      }
     }
   }
   '/user_identities/list_accessible_devices': {
@@ -95986,6 +96017,12 @@ export type Routes = {
     commonParams: {
       /** String for which to search. Filters returned unmanaged user identities to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address` or `user_identity_id`. */
       search?: string | undefined
+      /** Maximum number of records to return per page. */
+      limit?: number
+      /** Timestamp by which to limit returned unmanaged user identities. Returns user identities created before this timestamp. */
+      created_before?: Date | undefined
+      /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
+      page_cursor?: (string | undefined) | null
     }
     formData: {}
     jsonResponse: {
@@ -96037,6 +96074,15 @@ export type Routes = {
         /** Array of access system user IDs associated with the user identity. */
         acs_user_ids: string[]
       }[]
+      /** 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
+      }
     }
   }
   '/user_identities/unmanaged/update': {
@@ -101345,6 +101391,8 @@ export type Routes = {
               access_grant_id: string
               /** Unique key for the access grant within the workspace. */
               access_grant_key?: string | undefined
+              /** Reservation key for the access grant. */
+              reservation_key?: string | undefined
               /** ID of user identity to which the Access Grant gives access. */
               user_identity_id: string
               /**