@seamapi/types 1.375.2 → 1.376.0

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

@@ -7395,32 +7395,35 @@ export interface Routes {
                     error_code: 'failed_to_delete_on_acs_system';
                 }>;
                 /**  */
-                pending_modifications?: Array<{
+                pending_mutations?: Array<{
                     created_at: string;
-                    modification_code: 'create';
+                    mutation_code: 'creating';
                 } | {
                     created_at: string;
-                    modification_code: 'profile';
-                    modified_from: {
+                    mutation_code: 'deleting';
+                } | {
+                    created_at: string;
+                    mutation_code: 'updating_user_information';
+                    from: {
                         email_address?: (string | null) | undefined;
                         full_name?: (string | null) | undefined;
                         phone_number?: ((string | undefined) | null) | undefined;
                     };
-                    modified_to: {
+                    to: {
                         email_address?: (string | null) | undefined;
                         full_name?: (string | null) | undefined;
                         phone_number?: ((string | undefined) | null) | undefined;
                     };
                 } | {
                     created_at: string;
-                    modification_code: 'access_schedule';
-                    modified_from: {
+                    mutation_code: 'updating_access_schedule';
+                    from: {
                         /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
                         starts_at: string;
                         /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
                         ends_at: string | null;
                     };
-                    modified_to: {
+                    to: {
                         /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
                         starts_at: string;
                         /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
@@ -7428,20 +7431,20 @@ export interface Routes {
                     };
                 } | {
                     created_at: string;
-                    modification_code: 'suspension_state';
-                    modified_from: {
+                    mutation_code: 'updating_suspension_state';
+                    from: {
                         is_suspended: boolean;
                     };
-                    modified_to: {
+                    to: {
                         is_suspended: boolean;
                     };
                 } | {
                     created_at: string;
-                    modification_code: 'acs_access_group_membership';
-                    modified_from: {
+                    mutation_code: 'updating_group_membership';
+                    from: {
                         acs_access_group_id: string | null;
                     };
-                    modified_to: {
+                    to: {
                         acs_access_group_id: string | null;
                     };
                 }> | undefined;
@@ -11841,32 +11844,35 @@ export interface Routes {
                     error_code: 'failed_to_delete_on_acs_system';
                 }>;
                 /**  */
-                pending_modifications?: Array<{
+                pending_mutations?: Array<{
+                    created_at: string;
+                    mutation_code: 'creating';
+                } | {
                     created_at: string;
-                    modification_code: 'create';
+                    mutation_code: 'deleting';
                 } | {
                     created_at: string;
-                    modification_code: 'profile';
-                    modified_from: {
+                    mutation_code: 'updating_user_information';
+                    from: {
                         email_address?: (string | null) | undefined;
                         full_name?: (string | null) | undefined;
                         phone_number?: ((string | undefined) | null) | undefined;
                     };
-                    modified_to: {
+                    to: {
                         email_address?: (string | null) | undefined;
                         full_name?: (string | null) | undefined;
                         phone_number?: ((string | undefined) | null) | undefined;
                     };
                 } | {
                     created_at: string;
-                    modification_code: 'access_schedule';
-                    modified_from: {
+                    mutation_code: 'updating_access_schedule';
+                    from: {
                         /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
                         starts_at: string;
                         /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
                         ends_at: string | null;
                     };
-                    modified_to: {
+                    to: {
                         /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
                         starts_at: string;
                         /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
@@ -11874,20 +11880,20 @@ export interface Routes {
                     };
                 } | {
                     created_at: string;
-                    modification_code: 'suspension_state';
-                    modified_from: {
+                    mutation_code: 'updating_suspension_state';
+                    from: {
                         is_suspended: boolean;
                     };
-                    modified_to: {
+                    to: {
                         is_suspended: boolean;
                     };
                 } | {
                     created_at: string;
-                    modification_code: 'acs_access_group_membership';
-                    modified_from: {
+                    mutation_code: 'updating_group_membership';
+                    from: {
                         acs_access_group_id: string | null;
                     };
-                    modified_to: {
+                    to: {
                         acs_access_group_id: string | null;
                     };
                 }> | undefined;
@@ -12022,32 +12028,35 @@ export interface Routes {
                     error_code: 'failed_to_delete_on_acs_system';
                 }>;
                 /**  */
-                pending_modifications?: Array<{
+                pending_mutations?: Array<{
                     created_at: string;
-                    modification_code: 'create';
+                    mutation_code: 'creating';
                 } | {
                     created_at: string;
-                    modification_code: 'profile';
-                    modified_from: {
+                    mutation_code: 'deleting';
+                } | {
+                    created_at: string;
+                    mutation_code: 'updating_user_information';
+                    from: {
                         email_address?: (string | null) | undefined;
                         full_name?: (string | null) | undefined;
                         phone_number?: ((string | undefined) | null) | undefined;
                     };
-                    modified_to: {
+                    to: {
                         email_address?: (string | null) | undefined;
                         full_name?: (string | null) | undefined;
                         phone_number?: ((string | undefined) | null) | undefined;
                     };
                 } | {
                     created_at: string;
-                    modification_code: 'access_schedule';
-                    modified_from: {
+                    mutation_code: 'updating_access_schedule';
+                    from: {
                         /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
                         starts_at: string;
                         /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
                         ends_at: string | null;
                     };
-                    modified_to: {
+                    to: {
                         /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
                         starts_at: string;
                         /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
@@ -12055,20 +12064,20 @@ export interface Routes {
                     };
                 } | {
                     created_at: string;
-                    modification_code: 'suspension_state';
-                    modified_from: {
+                    mutation_code: 'updating_suspension_state';
+                    from: {
                         is_suspended: boolean;
                     };
-                    modified_to: {
+                    to: {
                         is_suspended: boolean;
                     };
                 } | {
                     created_at: string;
-                    modification_code: 'acs_access_group_membership';
-                    modified_from: {
+                    mutation_code: 'updating_group_membership';
+                    from: {
                         acs_access_group_id: string | null;
                     };
-                    modified_to: {
+                    to: {
                         acs_access_group_id: string | null;
                     };
                 }> | undefined;
@@ -12199,32 +12208,35 @@ export interface Routes {
                     error_code: 'failed_to_delete_on_acs_system';
                 }>;
                 /**  */
-                pending_modifications?: Array<{
+                pending_mutations?: Array<{
+                    created_at: string;
+                    mutation_code: 'creating';
+                } | {
                     created_at: string;
-                    modification_code: 'create';
+                    mutation_code: 'deleting';
                 } | {
                     created_at: string;
-                    modification_code: 'profile';
-                    modified_from: {
+                    mutation_code: 'updating_user_information';
+                    from: {
                         email_address?: (string | null) | undefined;
                         full_name?: (string | null) | undefined;
                         phone_number?: ((string | undefined) | null) | undefined;
                     };
-                    modified_to: {
+                    to: {
                         email_address?: (string | null) | undefined;
                         full_name?: (string | null) | undefined;
                         phone_number?: ((string | undefined) | null) | undefined;
                     };
                 } | {
                     created_at: string;
-                    modification_code: 'access_schedule';
-                    modified_from: {
+                    mutation_code: 'updating_access_schedule';
+                    from: {
                         /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
                         starts_at: string;
                         /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
                         ends_at: string | null;
                     };
-                    modified_to: {
+                    to: {
                         /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
                         starts_at: string;
                         /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
@@ -12232,20 +12244,20 @@ export interface Routes {
                     };
                 } | {
                     created_at: string;
-                    modification_code: 'suspension_state';
-                    modified_from: {
+                    mutation_code: 'updating_suspension_state';
+                    from: {
                         is_suspended: boolean;
                     };
-                    modified_to: {
+                    to: {
                         is_suspended: boolean;
                     };
                 } | {
                     created_at: string;
-                    modification_code: 'acs_access_group_membership';
-                    modified_from: {
+                    mutation_code: 'updating_group_membership';
+                    from: {
                         acs_access_group_id: string | null;
                     };
-                    modified_to: {
+                    to: {
                         acs_access_group_id: string | null;
                     };
                 }> | undefined;
@@ -12485,32 +12497,35 @@ export interface Routes {
                     error_code: 'failed_to_delete_on_acs_system';
                 }>;
                 /**  */
-                pending_modifications?: Array<{
+                pending_mutations?: Array<{
+                    created_at: string;
+                    mutation_code: 'creating';
+                } | {
                     created_at: string;
-                    modification_code: 'create';
+                    mutation_code: 'deleting';
                 } | {
                     created_at: string;
-                    modification_code: 'profile';
-                    modified_from: {
+                    mutation_code: 'updating_user_information';
+                    from: {
                         email_address?: (string | null) | undefined;
                         full_name?: (string | null) | undefined;
                         phone_number?: ((string | undefined) | null) | undefined;
                     };
-                    modified_to: {
+                    to: {
                         email_address?: (string | null) | undefined;
                         full_name?: (string | null) | undefined;
                         phone_number?: ((string | undefined) | null) | undefined;
                     };
                 } | {
                     created_at: string;
-                    modification_code: 'access_schedule';
-                    modified_from: {
+                    mutation_code: 'updating_access_schedule';
+                    from: {
                         /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
                         starts_at: string;
                         /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
                         ends_at: string | null;
                     };
-                    modified_to: {
+                    to: {
                         /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
                         starts_at: string;
                         /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
@@ -12518,20 +12533,20 @@ export interface Routes {
                     };
                 } | {
                     created_at: string;
-                    modification_code: 'suspension_state';
-                    modified_from: {
+                    mutation_code: 'updating_suspension_state';
+                    from: {
                         is_suspended: boolean;
                     };
-                    modified_to: {
+                    to: {
                         is_suspended: boolean;
                     };
                 } | {
                     created_at: string;
-                    modification_code: 'acs_access_group_membership';
-                    modified_from: {
+                    mutation_code: 'updating_group_membership';
+                    from: {
                         acs_access_group_id: string | null;
                     };
-                    modified_to: {
+                    to: {
                         acs_access_group_id: string | null;
                     };
                 }> | undefined;
@@ -12652,32 +12667,35 @@ export interface Routes {
                     error_code: 'failed_to_delete_on_acs_system';
                 }>;
                 /**  */
-                pending_modifications?: Array<{
+                pending_mutations?: Array<{
                     created_at: string;
-                    modification_code: 'create';
+                    mutation_code: 'creating';
                 } | {
                     created_at: string;
-                    modification_code: 'profile';
-                    modified_from: {
+                    mutation_code: 'deleting';
+                } | {
+                    created_at: string;
+                    mutation_code: 'updating_user_information';
+                    from: {
                         email_address?: (string | null) | undefined;
                         full_name?: (string | null) | undefined;
                         phone_number?: ((string | undefined) | null) | undefined;
                     };
-                    modified_to: {
+                    to: {
                         email_address?: (string | null) | undefined;
                         full_name?: (string | null) | undefined;
                         phone_number?: ((string | undefined) | null) | undefined;
                     };
                 } | {
                     created_at: string;
-                    modification_code: 'access_schedule';
-                    modified_from: {
+                    mutation_code: 'updating_access_schedule';
+                    from: {
                         /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
                         starts_at: string;
                         /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
                         ends_at: string | null;
                     };
-                    modified_to: {
+                    to: {
                         /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
                         starts_at: string;
                         /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
@@ -12685,20 +12703,20 @@ export interface Routes {
                     };
                 } | {
                     created_at: string;
-                    modification_code: 'suspension_state';
-                    modified_from: {
+                    mutation_code: 'updating_suspension_state';
+                    from: {
                         is_suspended: boolean;
                     };
-                    modified_to: {
+                    to: {
                         is_suspended: boolean;
                     };
                 } | {
                     created_at: string;
-                    modification_code: 'acs_access_group_membership';
-                    modified_from: {
+                    mutation_code: 'updating_group_membership';
+                    from: {
                         acs_access_group_id: string | null;
                     };
-                    modified_to: {
+                    to: {
                         acs_access_group_id: string | null;
                     };
                 }> | undefined;
@@ -41074,32 +41092,35 @@ export interface Routes {
                     error_code: 'failed_to_delete_on_acs_system';
                 }>;
                 /**  */
-                pending_modifications?: Array<{
+                pending_mutations?: Array<{
+                    created_at: string;
+                    mutation_code: 'creating';
+                } | {
                     created_at: string;
-                    modification_code: 'create';
+                    mutation_code: 'deleting';
                 } | {
                     created_at: string;
-                    modification_code: 'profile';
-                    modified_from: {
+                    mutation_code: 'updating_user_information';
+                    from: {
                         email_address?: (string | null) | undefined;
                         full_name?: (string | null) | undefined;
                         phone_number?: ((string | undefined) | null) | undefined;
                     };
-                    modified_to: {
+                    to: {
                         email_address?: (string | null) | undefined;
                         full_name?: (string | null) | undefined;
                         phone_number?: ((string | undefined) | null) | undefined;
                     };
                 } | {
                     created_at: string;
-                    modification_code: 'access_schedule';
-                    modified_from: {
+                    mutation_code: 'updating_access_schedule';
+                    from: {
                         /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
                         starts_at: string;
                         /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
                         ends_at: string | null;
                     };
-                    modified_to: {
+                    to: {
                         /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
                         starts_at: string;
                         /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
@@ -41107,20 +41128,20 @@ export interface Routes {
                     };
                 } | {
                     created_at: string;
-                    modification_code: 'suspension_state';
-                    modified_from: {
+                    mutation_code: 'updating_suspension_state';
+                    from: {
                         is_suspended: boolean;
                     };
-                    modified_to: {
+                    to: {
                         is_suspended: boolean;
                     };
                 } | {
                     created_at: string;
-                    modification_code: 'acs_access_group_membership';
-                    modified_from: {
+                    mutation_code: 'updating_group_membership';
+                    from: {
                         acs_access_group_id: string | null;
                     };
-                    modified_to: {
+                    to: {
                         acs_access_group_id: string | null;
                     };
                 }> | undefined;

package/package.json

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

package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts

@@ -2,7 +2,7 @@ import { z } from 'zod'
 
 import { phone_number } from '../../phone-number.js'
 import { schedule } from '../../schedule.js'
-import { acs_user_pending_modification } from './pending-modifications.js'
+import { acs_user_pending_mutations } from './pending-mutations.js'
 
 export const acs_user_external_type = z.enum([
   'pti_user',
@@ -326,8 +326,7 @@ const common_acs_user = z
       .describe(
         'Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
       ),
-    pending_modifications: z.array(acs_user_pending_modification).optional()
-      .describe(`
+    pending_mutations: z.array(acs_user_pending_mutations).optional().describe(`
       ---
       undocumented: Experimental.
       ---

package/src/lib/seam/connect/models/acs/acs-users/index.ts

@@ -1,2 +1,2 @@
 export * from './acs-user.js'
-export * from './pending-modifications.js'
+export * from './pending-mutations.js'

package/src/lib/seam/connect/models/acs/acs-users/pending-mutations.ts

@@ -0,0 +1,110 @@
+import { z } from 'zod'
+
+import { phone_number } from '../../phone-number.js'
+import { schedule } from '../../schedule.js'
+
+const common_pending_mutation = z.object({
+  created_at: z.string().datetime(),
+})
+
+const creating = common_pending_mutation.extend({
+  mutation_code: z.literal('creating'),
+})
+
+const deleting = common_pending_mutation.extend({
+  mutation_code: z.literal('deleting'),
+})
+
+const acs_user_info = z.object({
+  email_address: z.string().email().nullable(),
+  full_name: z.string().nullable(),
+  phone_number: phone_number.optional().nullable(),
+})
+
+export const updating_user_information_mutation =
+  common_pending_mutation.extend({
+    mutation_code: z.literal('updating_user_information'),
+    from: acs_user_info.partial(),
+    to: acs_user_info.partial(),
+  })
+
+const updating_access_schedule_mutation = common_pending_mutation.extend({
+  mutation_code: z.literal('updating_access_schedule'),
+  from: schedule,
+  to: schedule,
+})
+
+const updating_suspension_state_mutation = common_pending_mutation.extend({
+  mutation_code: z.literal('updating_suspension_state'),
+  from: z.object({ is_suspended: z.boolean() }),
+  to: z.object({ is_suspended: z.boolean() }),
+})
+
+const updating_group_membership_mutation = common_pending_mutation.extend({
+  mutation_code: z.literal('updating_group_membership'),
+  from: z.object({
+    acs_access_group_id: z.string().uuid().nullable(),
+  }),
+  to: z.object({
+    acs_access_group_id: z.string().uuid().nullable(),
+  }),
+})
+
+export const acs_user_pending_mutations = z.discriminatedUnion(
+  'mutation_code',
+  [
+    creating,
+    deleting,
+    updating_user_information_mutation,
+    updating_access_schedule_mutation,
+    updating_suspension_state_mutation,
+    updating_group_membership_mutation,
+  ],
+)
+
+export type AcsUserPendingMutation = z.infer<typeof acs_user_pending_mutations>
+
+export const acs_user_pending_mutations_map = z.object({
+  creating: creating.optional().nullable(),
+  deleting: deleting.optional().nullable(),
+  'updating_user_information.full_name': common_pending_mutation
+    .extend({
+      mutation_code: z.literal('updating_user_information'),
+      from: z.object({
+        full_name: z.string().nullable(),
+      }),
+      to: z.object({
+        full_name: z.string().nullable(),
+      }),
+    })
+    .optional()
+    .nullable(),
+  'updating_user_information.email_address': common_pending_mutation
+    .extend({
+      mutation_code: z.literal('updating_user_information'),
+      from: z.object({
+        email_address: z.string().email().nullable(),
+      }),
+      to: z.object({
+        email_address: z.string().email().nullable(),
+      }),
+    })
+    .optional()
+    .nullable(),
+  'updating_user_information.phone_number': common_pending_mutation
+    .extend({
+      mutation_code: z.literal('updating_user_information'),
+      from: z.object({
+        phone_number: phone_number.nullable(),
+      }),
+      to: z.object({
+        phone_number: phone_number.nullable(),
+      }),
+    })
+    .optional()
+    .nullable(),
+})
+
+export type AcsUserPendingMutationsMap = z.infer<
+  typeof acs_user_pending_mutations_map
+>