@seamapi/types 1.780.0 → 1.782.0

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

@@ -12570,6 +12570,15 @@ export type Routes = {
                     external_type_display_name: string;
                     /** Date and time at which the access group was created. */
                     created_at: string;
+                    /** Errors associated with the `acs_access_group`. */
+                    errors: {
+                        /** Date and time at which Seam created the error. */
+                        created_at: string;
+                        /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                        message: string;
+                        /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                        error_code: 'failed_to_create_on_acs_system';
+                    }[];
                     /** Warnings associated with the `acs_access_group`. */
                     warnings: ({
                         /** Date and time at which Seam created the warning. */
@@ -17451,6 +17460,15 @@ export type Routes = {
                 external_type_display_name: string;
                 /** Date and time at which the access group was created. */
                 created_at: string;
+                /** Errors associated with the `acs_access_group`. */
+                errors: {
+                    /** Date and time at which Seam created the error. */
+                    created_at: string;
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'failed_to_create_on_acs_system';
+                }[];
                 /** Warnings associated with the `acs_access_group`. */
                 warnings: ({
                     /** Date and time at which Seam created the warning. */
@@ -17626,6 +17644,15 @@ export type Routes = {
                 external_type_display_name: string;
                 /** Date and time at which the access group was created. */
                 created_at: string;
+                /** Errors associated with the `acs_access_group`. */
+                errors: {
+                    /** Date and time at which Seam created the error. */
+                    created_at: string;
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'failed_to_create_on_acs_system';
+                }[];
                 /** Warnings associated with the `acs_access_group`. */
                 warnings: ({
                     /** Date and time at which Seam created the warning. */
@@ -18207,6 +18234,15 @@ export type Routes = {
                 external_type_display_name: string;
                 /** Date and time at which the access group was created. */
                 created_at: string;
+                /** Errors associated with the `acs_access_group`. */
+                errors: {
+                    /** Date and time at which Seam created the error. */
+                    created_at: string;
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'failed_to_create_on_acs_system';
+                }[];
                 /** Warnings associated with the `acs_access_group`. */
                 warnings: ({
                     /** Date and time at which Seam created the warning. */
@@ -18380,6 +18416,15 @@ export type Routes = {
                 external_type_display_name: string;
                 /** Date and time at which the access group was created. */
                 created_at: string;
+                /** Errors associated with the `acs_access_group`. */
+                errors: {
+                    /** Date and time at which Seam created the error. */
+                    created_at: string;
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'failed_to_create_on_acs_system';
+                }[];
                 /** Warnings associated with the `acs_access_group`. */
                 warnings: ({
                     /** Date and time at which Seam created the warning. */
@@ -69683,6 +69728,10 @@ export type Routes = {
             connected_account_id?: string | undefined;
             /** Filter spaces by space_key. */
             space_key?: 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: {
@@ -69708,6 +69757,15 @@ export type Routes = {
                 /**  */
                 parent_space_key?: 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;
     };
@@ -92536,6 +92594,15 @@ export type Routes = {
                     external_type_display_name: string;
                     /** Date and time at which the access group was created. */
                     created_at: string;
+                    /** Errors associated with the `acs_access_group`. */
+                    errors: {
+                        /** Date and time at which Seam created the error. */
+                        created_at: string;
+                        /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                        message: string;
+                        /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                        error_code: 'failed_to_create_on_acs_system';
+                    }[];
                     /** Warnings associated with the `acs_access_group`. */
                     warnings: ({
                         /** Date and time at which Seam created the warning. */
@@ -94292,6 +94359,15 @@ export type Routes = {
                     external_type_display_name: string;
                     /** Date and time at which the access group was created. */
                     created_at: string;
+                    /** Errors associated with the `acs_access_group`. */
+                    errors: {
+                        /** Date and time at which Seam created the error. */
+                        created_at: string;
+                        /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                        message: string;
+                        /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                        error_code: 'failed_to_create_on_acs_system';
+                    }[];
                     /** Warnings associated with the `acs_access_group`. */
                     warnings: ({
                         /** Date and time at which Seam created the warning. */

package/package.json

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

package/src/lib/seam/connect/models/acs/acs-access-group.ts

@@ -18,6 +18,45 @@ export type AcsAccessGroupExternalType = z.infer<
   typeof acs_access_group_external_type
 >
 
+const common_acs_access_group_error = z.object({
+  created_at: z
+    .string()
+    .datetime()
+    .describe('Date and time at which Seam created the error.'),
+  message: z
+    .string()
+    .describe(
+      'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+    ),
+})
+
+const error_code_description =
+  'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.'
+
+const acs_access_groups_failed_to_create_on_acs_system =
+  common_acs_access_group_error
+    .extend({
+      error_code: z
+        .literal('failed_to_create_on_acs_system')
+        .describe(error_code_description),
+    })
+    .describe(
+      `Indicates that the [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).`,
+    )
+
+const acs_access_group_errors = z
+  .discriminatedUnion('error_code', [
+    acs_access_groups_failed_to_create_on_acs_system,
+  ])
+  .describe('Error associated with the `acs_access_group`.')
+
+const _acs_access_group_error_map = z.object({
+  failed_to_create_on_acs_system:
+    acs_access_groups_failed_to_create_on_acs_system.optional().nullable(),
+})
+
+export type AcsAccessGroupErrorMap = z.infer<typeof _acs_access_group_error_map>
+
 const common_acs_access_group_warning = z.object({
   created_at: z
     .string()
@@ -111,6 +150,9 @@ const common_acs_access_group = z.object({
     .string()
     .datetime()
     .describe('Date and time at which the access group was created.'),
+  errors: z
+    .array(acs_access_group_errors)
+    .describe('Errors associated with the `acs_access_group`.'),
   warnings: z
     .array(acs_access_group_warning)
     .describe('Warnings associated with the `acs_access_group`.'),

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

@@ -2808,6 +2808,41 @@ export default {
             type: 'string',
           },
           display_name: { type: 'string' },
+          errors: {
+            description: 'Errors associated with the `acs_access_group`.',
+            items: {
+              description: 'Error associated with the `acs_access_group`.',
+              discriminator: { propertyName: 'error_code' },
+              oneOf: [
+                {
+                  description:
+                    'Indicates that the [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).',
+                  properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the error.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
+                    error_code: {
+                      description:
+                        'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
+                      enum: ['failed_to_create_on_acs_system'],
+                      type: 'string',
+                    },
+                    message: {
+                      description:
+                        'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+                      type: 'string',
+                    },
+                  },
+                  required: ['created_at', 'message', 'error_code'],
+                  type: 'object',
+                },
+              ],
+            },
+            type: 'array',
+          },
           external_type: {
             description:
               'Brand-specific terminology for the access group type.',
@@ -3263,6 +3298,7 @@ export default {
           'external_type',
           'external_type_display_name',
           'created_at',
+          'errors',
           'warnings',
           'pending_mutations',
           'is_managed',
@@ -27490,6 +27526,41 @@ export default {
             type: 'string',
           },
           display_name: { type: 'string' },
+          errors: {
+            description: 'Errors associated with the `acs_access_group`.',
+            items: {
+              description: 'Error associated with the `acs_access_group`.',
+              discriminator: { propertyName: 'error_code' },
+              oneOf: [
+                {
+                  description:
+                    'Indicates that the [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).',
+                  properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the error.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
+                    error_code: {
+                      description:
+                        'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
+                      enum: ['failed_to_create_on_acs_system'],
+                      type: 'string',
+                    },
+                    message: {
+                      description:
+                        'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+                      type: 'string',
+                    },
+                  },
+                  required: ['created_at', 'message', 'error_code'],
+                  type: 'object',
+                },
+              ],
+            },
+            type: 'array',
+          },
           external_type: {
             description:
               'Brand-specific terminology for the access group type.',
@@ -27945,6 +28016,7 @@ export default {
           'external_type',
           'external_type_display_name',
           'created_at',
+          'errors',
           'warnings',
           'pending_mutations',
           'is_managed',
@@ -72889,6 +72961,26 @@ export default {
               type: 'string',
             },
           },
+          {
+            in: 'query',
+            name: 'limit',
+            schema: {
+              default: 500,
+              description: 'Maximum number of records to return per page.',
+              format: 'float',
+              type: 'number',
+            },
+          },
+          {
+            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: {
@@ -72897,12 +72989,13 @@ export default {
                 schema: {
                   properties: {
                     ok: { type: 'boolean' },
+                    pagination: { $ref: '#/components/schemas/pagination' },
                     spaces: {
                       items: { $ref: '#/components/schemas/space' },
                       type: 'array',
                     },
                   },
-                  required: ['spaces', 'ok'],
+                  required: ['spaces', 'pagination', 'ok'],
                   type: 'object',
                 },
               },
@@ -72948,6 +73041,19 @@ export default {
                       'Customer key for which you want to list spaces.',
                     type: 'string',
                   },
+                  limit: {
+                    default: 500,
+                    description:
+                      'Maximum number of records to return per page.',
+                    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',
+                  },
                   search: {
                     description:
                       'String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`.',
@@ -72971,12 +73077,13 @@ export default {
                 schema: {
                   properties: {
                     ok: { type: 'boolean' },
+                    pagination: { $ref: '#/components/schemas/pagination' },
                     spaces: {
                       items: { $ref: '#/components/schemas/space' },
                       type: 'array',
                     },
                   },
-                  required: ['spaces', 'ok'],
+                  required: ['spaces', 'pagination', 'ok'],
                   type: 'object',
                 },
               },

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

@@ -14488,6 +14488,15 @@ export type Routes = {
               external_type_display_name: string
               /** Date and time at which the access group was created. */
               created_at: string
+              /** Errors associated with the `acs_access_group`. */
+              errors: {
+                /** Date and time at which Seam created the error. */
+                created_at: string
+                /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                message: string
+                /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                error_code: 'failed_to_create_on_acs_system'
+              }[]
               /** Warnings associated with the `acs_access_group`. */
               warnings: (
                 | {
@@ -20162,6 +20171,15 @@ export type Routes = {
         external_type_display_name: string
         /** Date and time at which the access group was created. */
         created_at: string
+        /** Errors associated with the `acs_access_group`. */
+        errors: {
+          /** Date and time at which Seam created the error. */
+          created_at: string
+          /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+          message: string
+          /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+          error_code: 'failed_to_create_on_acs_system'
+        }[]
         /** Warnings associated with the `acs_access_group`. */
         warnings: (
           | {
@@ -20365,6 +20383,15 @@ export type Routes = {
         external_type_display_name: string
         /** Date and time at which the access group was created. */
         created_at: string
+        /** Errors associated with the `acs_access_group`. */
+        errors: {
+          /** Date and time at which Seam created the error. */
+          created_at: string
+          /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+          message: string
+          /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+          error_code: 'failed_to_create_on_acs_system'
+        }[]
         /** Warnings associated with the `acs_access_group`. */
         warnings: (
           | {
@@ -21040,6 +21067,15 @@ export type Routes = {
         external_type_display_name: string
         /** Date and time at which the access group was created. */
         created_at: string
+        /** Errors associated with the `acs_access_group`. */
+        errors: {
+          /** Date and time at which Seam created the error. */
+          created_at: string
+          /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+          message: string
+          /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+          error_code: 'failed_to_create_on_acs_system'
+        }[]
         /** Warnings associated with the `acs_access_group`. */
         warnings: (
           | {
@@ -21241,6 +21277,15 @@ export type Routes = {
         external_type_display_name: string
         /** Date and time at which the access group was created. */
         created_at: string
+        /** Errors associated with the `acs_access_group`. */
+        errors: {
+          /** Date and time at which Seam created the error. */
+          created_at: string
+          /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+          message: string
+          /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+          error_code: 'failed_to_create_on_acs_system'
+        }[]
         /** Warnings associated with the `acs_access_group`. */
         warnings: (
           | {
@@ -82869,6 +82914,10 @@ export type Routes = {
       connected_account_id?: string | undefined
       /** Filter spaces by space_key. */
       space_key?: 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: {
@@ -82894,6 +82943,15 @@ export type Routes = {
         /**  */
         parent_space_key?: 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
   }
@@ -110002,6 +110060,15 @@ export type Routes = {
               external_type_display_name: string
               /** Date and time at which the access group was created. */
               created_at: string
+              /** Errors associated with the `acs_access_group`. */
+              errors: {
+                /** Date and time at which Seam created the error. */
+                created_at: string
+                /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                message: string
+                /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                error_code: 'failed_to_create_on_acs_system'
+              }[]
               /** Warnings associated with the `acs_access_group`. */
               warnings: (
                 | {
@@ -112077,6 +112144,15 @@ export type Routes = {
               external_type_display_name: string
               /** Date and time at which the access group was created. */
               created_at: string
+              /** Errors associated with the `acs_access_group`. */
+              errors: {
+                /** Date and time at which Seam created the error. */
+                created_at: string
+                /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                message: string
+                /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                error_code: 'failed_to_create_on_acs_system'
+              }[]
               /** Warnings associated with the `acs_access_group`. */
               warnings: (
                 | {