@seamapi/types 1.726.0 → 1.728.0

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

@@ -10456,8 +10456,8 @@ export type Routes = {
             access_grant_ids?: string[] | undefined;
             /** Keys of the access grants that you want to get along with their related resources. */
             access_grant_keys?: string[] | undefined;
-            include?: ('spaces' | 'devices' | 'acs_entrances' | 'connected_accounts' | 'acs_systems' | 'user_identities' | 'acs_access_groups')[] | undefined;
-            exclude?: ('spaces' | 'devices' | 'acs_entrances' | 'connected_accounts' | 'acs_systems' | 'user_identities' | 'acs_access_groups')[] | undefined;
+            include?: ('spaces' | 'devices' | 'acs_entrances' | 'connected_accounts' | 'acs_systems' | 'user_identities' | 'acs_access_groups' | 'access_methods')[] | undefined;
+            exclude?: ('spaces' | 'devices' | 'acs_entrances' | 'connected_accounts' | 'acs_systems' | 'user_identities' | 'acs_access_groups' | 'access_methods')[] | undefined;
         };
         formData: {};
         jsonResponse: {
@@ -12246,8 +12246,114 @@ export type Routes = {
                         /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                         warning_code: 'being_deleted';
                     })[];
+                    /** `starts_at` and `ends_at` timestamps for the access group's access. */
+                    access_schedule?: {
+                        /** 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;
+                    } | undefined;
                     is_managed: true;
                 }[] | undefined;
+                access_methods?: {
+                    /** ID of the Seam workspace associated with the access method. */
+                    workspace_id: string;
+                    /** ID of the access method. */
+                    access_method_id: string;
+                    /** Display name of the access method. */
+                    display_name: string;
+                    /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
+                    mode: 'code' | 'card' | 'mobile_key';
+                    /** Date and time at which the access method was created. */
+                    created_at: string;
+                    /** Date and time at which the access method was issued. */
+                    issued_at: string | null;
+                    /** Indicates whether the access method has been issued. */
+                    is_issued: boolean;
+                    /** URL of the Instant Key for mobile key access methods. */
+                    instant_key_url?: string | undefined;
+                    /** Token of the client session associated with the access method. */
+                    client_session_token?: string | undefined;
+                    /** Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method. */
+                    is_encoding_required?: boolean | undefined;
+                    /** The actual PIN code for code access methods. */
+                    code?: (string | null) | undefined;
+                    /** Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). */
+                    warnings: ({
+                        /** Date and time at which Seam created the warning. */
+                        created_at: string;
+                        /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                        message: string;
+                        /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                        warning_code: 'being_deleted';
+                    } | {
+                        /** Date and time at which Seam created the warning. */
+                        created_at: string;
+                        /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                        message: string;
+                        /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                        warning_code: 'updating_access_times';
+                    })[];
+                    /** Pending mutations for the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). Indicates operations that are in progress. */
+                    pending_mutations: ({
+                        /** Date and time at which the mutation was created. */
+                        created_at: string;
+                        /** Detailed description of the mutation. */
+                        message: string;
+                        /** Mutation code to indicate that Seam is in the process of provisioning access for this access method on new devices. */
+                        mutation_code: 'provisioning_access';
+                        /** Previous device configuration. */
+                        from: {
+                            /** Previous device IDs where access was provisioned. */
+                            device_ids: string[];
+                        };
+                        /** New device configuration. */
+                        to: {
+                            /** New device IDs where access is being provisioned. */
+                            device_ids: string[];
+                        };
+                    } | {
+                        /** Date and time at which the mutation was created. */
+                        created_at: string;
+                        /** Detailed description of the mutation. */
+                        message: string;
+                        /** Mutation code to indicate that Seam is in the process of revoking access for this access method from devices. */
+                        mutation_code: 'revoking_access';
+                        /** Previous device configuration. */
+                        from: {
+                            /** Previous device IDs where access existed. */
+                            device_ids: string[];
+                        };
+                        /** New device configuration. */
+                        to: {
+                            /** New device IDs where access should remain. */
+                            device_ids: string[];
+                        };
+                    } | {
+                        /** Date and time at which the mutation was created. */
+                        created_at: string;
+                        /** Detailed description of the mutation. */
+                        message: string;
+                        /** Mutation code to indicate that Seam is in the process of updating the access times for this access method. */
+                        mutation_code: 'updating_access_times';
+                        /** Previous access time configuration. */
+                        from: {
+                            /** Previous start time for access. */
+                            starts_at: string | null;
+                            /** Previous end time for access. */
+                            ends_at: string | null;
+                        };
+                        /** New access time configuration. */
+                        to: {
+                            /** New start time for access. */
+                            starts_at: string | null;
+                            /** New end time for access. */
+                            ends_at: string | null;
+                        };
+                    })[];
+                    /** ID of the customization profile associated with the access method. */
+                    customization_profile_id?: string | undefined;
+                }[] | undefined;
             };
         };
         maxDuration: undefined;
@@ -16733,6 +16839,13 @@ export type Routes = {
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'being_deleted';
                 })[];
+                /** `starts_at` and `ends_at` timestamps for the access group's access. */
+                access_schedule?: {
+                    /** 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;
+                } | undefined;
                 is_managed: true;
             };
         };
@@ -16795,6 +16908,13 @@ export type Routes = {
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'being_deleted';
                 })[];
+                /** `starts_at` and `ends_at` timestamps for the access group's access. */
+                access_schedule?: {
+                    /** 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;
+                } | undefined;
                 is_managed: true;
             }[];
         };
@@ -17241,6 +17361,13 @@ export type Routes = {
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'being_deleted';
                 })[];
+                /** `starts_at` and `ends_at` timestamps for the access group's access. */
+                access_schedule?: {
+                    /** 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;
+                } | undefined;
                 is_managed: false;
             };
         };
@@ -17301,6 +17428,13 @@ export type Routes = {
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'being_deleted';
                 })[];
+                /** `starts_at` and `ends_at` timestamps for the access group's access. */
+                access_schedule?: {
+                    /** 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;
+                } | undefined;
                 is_managed: false;
             }[];
         };
@@ -85782,6 +85916,13 @@ export type Routes = {
                         /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                         warning_code: 'being_deleted';
                     })[];
+                    /** `starts_at` and `ends_at` timestamps for the access group's access. */
+                    access_schedule?: {
+                        /** 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;
+                    } | undefined;
                     is_managed: true;
                 }[] | undefined;
                 acs_encoders?: {
@@ -87354,6 +87495,13 @@ export type Routes = {
                         /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                         warning_code: 'being_deleted';
                     })[];
+                    /** `starts_at` and `ends_at` timestamps for the access group's access. */
+                    access_schedule?: {
+                        /** 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;
+                    } | undefined;
                     is_managed: false;
                 }[] | undefined;
                 unmanaged_devices?: {

package/package.json

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

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

@@ -1,5 +1,7 @@
 import { z } from 'zod'
 
+import { schedule } from '../schedule.js'
+
 // If changed, update seam.acs_access_group.external_type generated column
 export const acs_access_group_external_type = z.enum([
   'pti_unit',
@@ -111,6 +113,11 @@ const common_acs_access_group = z.object({
   warnings: z
     .array(acs_access_group_warning)
     .describe('Warnings associated with the `acs_access_group`.'),
+  access_schedule: schedule
+    .optional()
+    .describe(
+      "`starts_at` and `ends_at` timestamps for the access group's access.",
+    ),
 })
 
 export const acs_access_group = common_acs_access_group.extend({

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

@@ -2703,6 +2703,27 @@ export default {
             type: 'string',
             'x-deprecated': 'Use `external_type_display_name`.',
           },
+          access_schedule: {
+            description:
+              "`starts_at` and `ends_at` timestamps for the access group's access.",
+            properties: {
+              ends_at: {
+                description:
+                  "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.",
+                format: 'date-time',
+                nullable: true,
+                type: 'string',
+              },
+              starts_at: {
+                description:
+                  "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.",
+                format: 'date-time',
+                type: 'string',
+              },
+            },
+            required: ['starts_at', 'ends_at'],
+            type: 'object',
+          },
           acs_access_group_id: {
             description: 'ID of the access group.',
             format: 'uuid',
@@ -26403,6 +26424,27 @@ export default {
             type: 'string',
             'x-deprecated': 'Use `external_type_display_name`.',
           },
+          access_schedule: {
+            description:
+              "`starts_at` and `ends_at` timestamps for the access group's access.",
+            properties: {
+              ends_at: {
+                description:
+                  "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.",
+                format: 'date-time',
+                nullable: true,
+                type: 'string',
+              },
+              starts_at: {
+                description:
+                  "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.",
+                format: 'date-time',
+                type: 'string',
+              },
+            },
+            required: ['starts_at', 'ends_at'],
+            type: 'object',
+          },
           acs_access_group_id: {
             description: 'ID of the access group.',
             format: 'uuid',
@@ -33038,6 +33080,7 @@ export default {
                   'acs_systems',
                   'user_identities',
                   'acs_access_groups',
+                  'access_methods',
                 ],
                 type: 'string',
               },
@@ -33057,6 +33100,7 @@ export default {
                   'acs_systems',
                   'user_identities',
                   'acs_access_groups',
+                  'access_methods',
                 ],
                 type: 'string',
               },
@@ -33073,6 +33117,10 @@ export default {
                     batch: {
                       description: 'A batch of workspace resources.',
                       properties: {
+                        access_methods: {
+                          items: { $ref: '#/components/schemas/access_method' },
+                          type: 'array',
+                        },
                         acs_access_groups: {
                           items: {
                             $ref: '#/components/schemas/acs_access_group',
@@ -33136,6 +33184,7 @@ export default {
           'acs_systems',
           'user_identities',
           'acs_access_groups',
+          'access_methods',
         ],
         'x-draft': 'Early access.',
         'x-fern-sdk-group-name': ['access_grants'],
@@ -33175,6 +33224,7 @@ export default {
                         'acs_systems',
                         'user_identities',
                         'acs_access_groups',
+                        'access_methods',
                       ],
                       type: 'string',
                     },
@@ -33190,6 +33240,7 @@ export default {
                         'acs_systems',
                         'user_identities',
                         'acs_access_groups',
+                        'access_methods',
                       ],
                       type: 'string',
                     },
@@ -33210,6 +33261,10 @@ export default {
                     batch: {
                       description: 'A batch of workspace resources.',
                       properties: {
+                        access_methods: {
+                          items: { $ref: '#/components/schemas/access_method' },
+                          type: 'array',
+                        },
                         acs_access_groups: {
                           items: {
                             $ref: '#/components/schemas/acs_access_group',
@@ -33273,6 +33328,7 @@ export default {
           'acs_systems',
           'user_identities',
           'acs_access_groups',
+          'access_methods',
         ],
         'x-draft': 'Early access.',
         'x-fern-sdk-group-name': ['access_grants'],

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

@@ -11786,6 +11786,7 @@ export type Routes = {
             | 'acs_systems'
             | 'user_identities'
             | 'acs_access_groups'
+            | 'access_methods'
           )[]
         | undefined
       exclude?:
@@ -11797,6 +11798,7 @@ export type Routes = {
             | 'acs_systems'
             | 'user_identities'
             | 'acs_access_groups'
+            | 'access_methods'
           )[]
         | undefined
     }
@@ -14061,9 +14063,126 @@ export type Routes = {
                     warning_code: 'being_deleted'
                   }
               )[]
+              /** `starts_at` and `ends_at` timestamps for the access group's access. */
+              access_schedule?:
+                | {
+                    /** 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
+                  }
+                | undefined
               is_managed: true
             }[]
           | undefined
+        access_methods?:
+          | {
+              /** ID of the Seam workspace associated with the access method. */
+              workspace_id: string
+              /** ID of the access method. */
+              access_method_id: string
+              /** Display name of the access method. */
+              display_name: string
+              /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
+              mode: 'code' | 'card' | 'mobile_key'
+              /** Date and time at which the access method was created. */
+              created_at: string
+              /** Date and time at which the access method was issued. */
+              issued_at: string | null
+              /** Indicates whether the access method has been issued. */
+              is_issued: boolean
+              /** URL of the Instant Key for mobile key access methods. */
+              instant_key_url?: string | undefined
+              /** Token of the client session associated with the access method. */
+              client_session_token?: string | undefined
+              /** Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method. */
+              is_encoding_required?: boolean | undefined
+              /** The actual PIN code for code access methods. */
+              code?: (string | null) | undefined
+              /** Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). */
+              warnings: (
+                | {
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'being_deleted'
+                  }
+                | {
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'updating_access_times'
+                  }
+              )[]
+              /** Pending mutations for the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). Indicates operations that are in progress. */
+              pending_mutations: (
+                | {
+                    /** Date and time at which the mutation was created. */
+                    created_at: string
+                    /** Detailed description of the mutation. */
+                    message: string
+                    /** Mutation code to indicate that Seam is in the process of provisioning access for this access method on new devices. */
+                    mutation_code: 'provisioning_access'
+                    /** Previous device configuration. */
+                    from: {
+                      /** Previous device IDs where access was provisioned. */
+                      device_ids: string[]
+                    }
+                    /** New device configuration. */
+                    to: {
+                      /** New device IDs where access is being provisioned. */
+                      device_ids: string[]
+                    }
+                  }
+                | {
+                    /** Date and time at which the mutation was created. */
+                    created_at: string
+                    /** Detailed description of the mutation. */
+                    message: string
+                    /** Mutation code to indicate that Seam is in the process of revoking access for this access method from devices. */
+                    mutation_code: 'revoking_access'
+                    /** Previous device configuration. */
+                    from: {
+                      /** Previous device IDs where access existed. */
+                      device_ids: string[]
+                    }
+                    /** New device configuration. */
+                    to: {
+                      /** New device IDs where access should remain. */
+                      device_ids: string[]
+                    }
+                  }
+                | {
+                    /** Date and time at which the mutation was created. */
+                    created_at: string
+                    /** Detailed description of the mutation. */
+                    message: string
+                    /** Mutation code to indicate that Seam is in the process of updating the access times for this access method. */
+                    mutation_code: 'updating_access_times'
+                    /** Previous access time configuration. */
+                    from: {
+                      /** Previous start time for access. */
+                      starts_at: string | null
+                      /** Previous end time for access. */
+                      ends_at: string | null
+                    }
+                    /** New access time configuration. */
+                    to: {
+                      /** New start time for access. */
+                      starts_at: string | null
+                      /** New end time for access. */
+                      ends_at: string | null
+                    }
+                  }
+              )[]
+              /** ID of the customization profile associated with the access method. */
+              customization_profile_id?: string | undefined
+            }[]
+          | undefined
       }
     }
     maxDuration: undefined
@@ -19283,6 +19402,15 @@ export type Routes = {
               warning_code: 'being_deleted'
             }
         )[]
+        /** `starts_at` and `ends_at` timestamps for the access group's access. */
+        access_schedule?:
+          | {
+              /** 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
+            }
+          | undefined
         is_managed: true
       }
     }
@@ -19362,6 +19490,15 @@ export type Routes = {
               warning_code: 'being_deleted'
             }
         )[]
+        /** `starts_at` and `ends_at` timestamps for the access group's access. */
+        access_schedule?:
+          | {
+              /** 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
+            }
+          | undefined
         is_managed: true
       }[]
     }
@@ -19888,6 +20025,15 @@ export type Routes = {
               warning_code: 'being_deleted'
             }
         )[]
+        /** `starts_at` and `ends_at` timestamps for the access group's access. */
+        access_schedule?:
+          | {
+              /** 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
+            }
+          | undefined
         is_managed: false
       }
     }
@@ -19965,6 +20111,15 @@ export type Routes = {
               warning_code: 'being_deleted'
             }
         )[]
+        /** `starts_at` and `ends_at` timestamps for the access group's access. */
+        access_schedule?:
+          | {
+              /** 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
+            }
+          | undefined
         is_managed: false
       }[]
     }
@@ -101799,6 +101954,15 @@ export type Routes = {
                     warning_code: 'being_deleted'
                   }
               )[]
+              /** `starts_at` and `ends_at` timestamps for the access group's access. */
+              access_schedule?:
+                | {
+                    /** 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
+                  }
+                | undefined
               is_managed: true
             }[]
           | undefined
@@ -103650,6 +103814,15 @@ export type Routes = {
                     warning_code: 'being_deleted'
                   }
               )[]
+              /** `starts_at` and `ends_at` timestamps for the access group's access. */
+              access_schedule?:
+                | {
+                    /** 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
+                  }
+                | undefined
               is_managed: false
             }[]
           | undefined