@seamapi/types 1.553.0 → 1.555.0

package/dist/connect.cjs

@@ -2310,6 +2310,24 @@ var requested_access_method = zod.z.object({
 });
 
 // src/lib/seam/connect/models/access-grants/access-grant.ts
+var common_access_grant_warning = zod.z.object({
+  created_at: zod.z.string().datetime().describe("Date and time at which Seam created the warning."),
+  message: zod.z.string().describe(
+    "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it."
+  )
+});
+var warning_code_description4 = "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.";
+var being_deleted = common_access_grant_warning.extend({
+  warning_code: zod.z.literal("being_deleted").describe(warning_code_description4)
+}).describe(
+  "Indicates that the [access grant](https://docs.seam.co/latest/capability-guides/access-grants) is being deleted."
+);
+var access_grant_warning = zod.z.discriminatedUnion("warning_code", [being_deleted]).describe(
+  "Warning associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants)."
+);
+zod.z.object({
+  being_deleted: being_deleted.optional().nullable()
+});
 var access_grant = zod.z.object({
   workspace_id: zod.z.string().uuid().describe("ID of the Seam workspace associated with the Access Grant."),
   access_grant_id: zod.z.string().uuid().describe("ID of the Access Grant."),
@@ -2336,6 +2354,9 @@ var access_grant = zod.z.object({
   created_at: zod.z.string().datetime().describe("Date and time at which the Access Grant was created."),
   starts_at: zod.z.string().datetime().describe("Date and time at which the Access Grant starts."),
   ends_at: zod.z.string().datetime().nullable().describe("Date and time at which the Access Grant ends."),
+  warnings: zod.z.array(access_grant_warning).describe(
+    "Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants)."
+  ),
   customization_profile_id: zod.z.string().uuid().optional().describe(
     "ID of the customization profile associated with the Access Grant."
   )
@@ -2346,6 +2367,24 @@ var access_grant = zod.z.object({
   ---
   Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant.
   `);
+var common_access_method_warning = zod.z.object({
+  created_at: zod.z.string().datetime().describe("Date and time at which Seam created the warning."),
+  message: zod.z.string().describe(
+    "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it."
+  )
+});
+var warning_code_description5 = "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.";
+var being_deleted2 = common_access_method_warning.extend({
+  warning_code: zod.z.literal("being_deleted").describe(warning_code_description5)
+}).describe(
+  "Indicates that the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods) is being deleted."
+);
+var access_method_warning = zod.z.discriminatedUnion("warning_code", [being_deleted2]).describe(
+  "Warning associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods)."
+);
+zod.z.object({
+  being_deleted: being_deleted2.optional().nullable()
+});
 var access_method = zod.z.object({
   workspace_id: zod.z.string().uuid().describe("ID of the Seam workspace associated with the access method."),
   access_method_id: zod.z.string().uuid().describe("ID of the access method."),
@@ -2362,6 +2401,9 @@ var access_method = zod.z.object({
     "Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method."
   ),
   code: zod.z.string().nullable().optional().describe("The actual PIN code for code access methods."),
+  warnings: zod.z.array(access_method_warning).describe(
+    "Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods)."
+  ),
   customization_profile_id: zod.z.string().uuid().optional().describe(
     "ID of the customization profile associated with the access method."
   )
@@ -2387,9 +2429,9 @@ var common_acs_access_group_warning = zod.z.object({
     "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it."
   )
 });
-var warning_code_description4 = "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.";
+var warning_code_description6 = "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.";
 var unknown_issue_with_acs_access_group = common_acs_access_group_warning.extend({
-  warning_code: zod.z.literal("unknown_issue_with_acs_access_group").describe(warning_code_description4)
+  warning_code: zod.z.literal("unknown_issue_with_acs_access_group").describe(warning_code_description6)
 }).describe(
   "An unknown issue occurred while syncing the state of this access group with the provider. This issue may affect the proper functioning of this access group."
 );
@@ -2562,34 +2604,34 @@ var common_acs_credential_warning = zod.z.object({
     "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it."
   )
 });
-var warning_code_description5 = "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.";
+var warning_code_description7 = "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.";
 var waiting_to_be_issued = common_acs_credential_warning.extend({
-  warning_code: zod.z.literal("waiting_to_be_issued").describe(warning_code_description5)
+  warning_code: zod.z.literal("waiting_to_be_issued").describe(warning_code_description7)
 }).describe(
   "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is waiting to be issued."
 );
 var schedule_externally_modified = common_acs_credential_warning.extend({
-  warning_code: zod.z.literal("schedule_externally_modified").describe(warning_code_description5)
+  warning_code: zod.z.literal("schedule_externally_modified").describe(warning_code_description7)
 }).describe(
   "Indicates that the schedule of one of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)'s children was modified externally."
 );
 var schedule_modified = common_acs_credential_warning.extend({
-  warning_code: zod.z.literal("schedule_modified").describe(warning_code_description5)
+  warning_code: zod.z.literal("schedule_modified").describe(warning_code_description7)
 }).describe(
   "Indicates that the schedule of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past."
 );
-var being_deleted = common_acs_credential_warning.extend({
-  warning_code: zod.z.literal("being_deleted").describe(warning_code_description5)
+var being_deleted3 = common_acs_credential_warning.extend({
+  warning_code: zod.z.literal("being_deleted").describe(warning_code_description7)
 }).describe(
   "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted."
 );
 var unknown_issue_with_acs_credential = common_acs_credential_warning.extend({
-  warning_code: zod.z.literal("unknown_issue_with_acs_credential").describe(warning_code_description5)
+  warning_code: zod.z.literal("unknown_issue_with_acs_credential").describe(warning_code_description7)
 }).describe(
   "An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential."
 );
 var needs_to_be_reissued = common_acs_credential_warning.extend({
-  warning_code: zod.z.literal("needs_to_be_reissued").describe(warning_code_description5)
+  warning_code: zod.z.literal("needs_to_be_reissued").describe(warning_code_description7)
 }).describe(
   "Access permissions for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential."
 );
@@ -2597,7 +2639,7 @@ var acs_credential_warning = zod.z.discriminatedUnion("warning_code", [
   waiting_to_be_issued,
   schedule_externally_modified,
   schedule_modified,
-  being_deleted,
+  being_deleted3,
   unknown_issue_with_acs_credential,
   needs_to_be_reissued
 ]).describe(
@@ -2607,7 +2649,7 @@ zod.z.object({
   waiting_to_be_issued: waiting_to_be_issued.optional().nullable(),
   schedule_externally_modified: schedule_externally_modified.optional().nullable(),
   schedule_modified: schedule_modified.optional().nullable(),
-  being_deleted: being_deleted.optional().nullable(),
+  being_deleted: being_deleted3.optional().nullable(),
   unknown_issue_with_acs_credential: unknown_issue_with_acs_credential.optional().nullable(),
   needs_to_be_reissued: needs_to_be_reissued.optional().nullable()
 });
@@ -2956,7 +2998,7 @@ var common_acs_system_error = zod.z.object({
   )
 });
 var error_code_description5 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
-var warning_code_description6 = "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.";
+var warning_code_description8 = "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.";
 var seam_bridge_disconnected = common_acs_system_error.extend({
   error_code: zod.z.literal("seam_bridge_disconnected").describe(error_code_description5)
 }).describe(`Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.
@@ -3019,12 +3061,12 @@ var common_acs_system_warning = zod.z.object({
   )
 });
 var salto_ks_subscription_limit_almost_reached3 = common_acs_system_warning.extend({
-  warning_code: zod.z.literal("salto_ks_subscription_limit_almost_reached").describe(warning_code_description6)
+  warning_code: zod.z.literal("salto_ks_subscription_limit_almost_reached").describe(warning_code_description8)
 }).describe(
   "Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site to rectify the issue."
 );
 var time_zone_does_not_match_location = common_acs_system_warning.extend({
-  warning_code: zod.z.literal("time_zone_does_not_match_location").describe(warning_code_description6),
+  warning_code: zod.z.literal("time_zone_does_not_match_location").describe(warning_code_description8),
   misconfigured_acs_entrance_ids: zod.z.array(zod.z.string().uuid()).optional().describe(
     `
     ---
@@ -4315,12 +4357,24 @@ var access_grant_access_to_door_lost_event = access_grant_event.extend(
     ---
     Access to a particular door that was requested as part of an Access Grant was lost.
   `);
+var access_grant_access_times_changed_event = access_grant_event.extend({
+  event_type: zod.z.literal("access_grant.access_times_changed"),
+  access_grant_key: zod.z.string().optional().describe("Key of the affected Access Grant (if present)."),
+  starts_at: zod.z.string().optional().describe("The new start time for the access grant."),
+  ends_at: zod.z.string().optional().describe("The new end time for the access grant.")
+}).describe(`
+    ---
+    route_path: /access_grants
+    ---
+    An Access Grant's start or end time was changed.
+  `);
 var access_grant_events = [
   access_grant_created_event,
   access_grant_deleted_event,
   access_grant_access_granted_to_all_doors_event,
   access_grant_access_granted_to_door_event,
-  access_grant_access_to_door_lost_event
+  access_grant_access_to_door_lost_event,
+  access_grant_access_times_changed_event
 ];
 var access_method_event = common_event.extend({
   access_method_id: zod.z.string().uuid().describe("ID of the affected access method."),
@@ -4381,12 +4435,24 @@ var access_method_reissued_event = access_method_event.extend({
     ---
     An access method was reissued due to an Access Grant update.
   `);
+var access_method_code_changed_event = access_method_event.extend({
+  event_type: zod.z.literal("access_method.code_changed"),
+  code: zod.z.string().describe(
+    "The new PIN code for code access methods (only present when mode is 'code')."
+  )
+}).describe(`
+    ---
+    route_path: /access_methods
+    ---
+    An access method's PIN code was changed.
+  `);
 var access_method_events = [
   access_method_issued_event,
   access_method_revoked_event,
   access_method_card_encoding_required_event,
   access_method_deleted_event,
-  access_method_reissued_event
+  access_method_reissued_event,
+  access_method_code_changed_event
 ];
 var common_acs_event = common_event.extend({
   connected_account_id: zod.z.string().uuid().optional().describe("ID of the connected account."),
@@ -7303,6 +7369,37 @@ var openapi_default = {
             format: "uuid",
             type: "string"
           },
+          warnings: {
+            description: "Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).",
+            items: {
+              description: "Warning associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).",
+              discriminator: { propertyName: "warning_code" },
+              oneOf: [
+                {
+                  description: "Indicates that the [access grant](https://docs.seam.co/latest/capability-guides/access-grants) is being deleted.",
+                  properties: {
+                    created_at: {
+                      description: "Date and time at which Seam created the warning.",
+                      format: "date-time",
+                      type: "string"
+                    },
+                    message: {
+                      description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
+                      type: "string"
+                    },
+                    warning_code: {
+                      description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
+                      enum: ["being_deleted"],
+                      type: "string"
+                    }
+                  },
+                  required: ["created_at", "message", "warning_code"],
+                  type: "object"
+                }
+              ]
+            },
+            type: "array"
+          },
           workspace_id: {
             description: "ID of the Seam workspace associated with the Access Grant.",
             format: "uuid",
@@ -7321,7 +7418,8 @@ var openapi_default = {
           "display_name",
           "created_at",
           "starts_at",
-          "ends_at"
+          "ends_at",
+          "warnings"
         ],
         type: "object",
         "x-draft": "Early access.",
@@ -7382,6 +7480,37 @@ var openapi_default = {
             enum: ["code", "card", "mobile_key"],
             type: "string"
           },
+          warnings: {
+            description: "Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods).",
+            items: {
+              description: "Warning associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods).",
+              discriminator: { propertyName: "warning_code" },
+              oneOf: [
+                {
+                  description: "Indicates that the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods) is being deleted.",
+                  properties: {
+                    created_at: {
+                      description: "Date and time at which Seam created the warning.",
+                      format: "date-time",
+                      type: "string"
+                    },
+                    message: {
+                      description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
+                      type: "string"
+                    },
+                    warning_code: {
+                      description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
+                      enum: ["being_deleted"],
+                      type: "string"
+                    }
+                  },
+                  required: ["created_at", "message", "warning_code"],
+                  type: "object"
+                }
+              ]
+            },
+            type: "array"
+          },
           workspace_id: {
             description: "ID of the Seam workspace associated with the access method.",
             format: "uuid",
@@ -7395,7 +7524,8 @@ var openapi_default = {
           "mode",
           "created_at",
           "issued_at",
-          "is_issued"
+          "is_issued",
+          "warnings"
         ],
         type: "object",
         "x-draft": "Early access.",
@@ -18738,6 +18868,62 @@ var openapi_default = {
             type: "object",
             "x-route-path": "/access_grants"
           },
+          {
+            description: "An Access Grant's start or end time was changed.",
+            properties: {
+              access_grant_id: {
+                description: "ID of the affected Access Grant.",
+                format: "uuid",
+                type: "string"
+              },
+              access_grant_key: {
+                description: "Key of the affected Access Grant (if present).",
+                type: "string"
+              },
+              created_at: {
+                description: "Date and time at which the event was created.",
+                format: "date-time",
+                type: "string"
+              },
+              ends_at: {
+                description: "The new end time for the access grant.",
+                type: "string"
+              },
+              event_id: {
+                description: "ID of the event.",
+                format: "uuid",
+                type: "string"
+              },
+              event_type: {
+                enum: ["access_grant.access_times_changed"],
+                type: "string"
+              },
+              occurred_at: {
+                description: "Date and time at which the event occurred.",
+                format: "date-time",
+                type: "string"
+              },
+              starts_at: {
+                description: "The new start time for the access grant.",
+                type: "string"
+              },
+              workspace_id: {
+                description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event.",
+                format: "uuid",
+                type: "string"
+              }
+            },
+            required: [
+              "event_id",
+              "workspace_id",
+              "created_at",
+              "occurred_at",
+              "access_grant_id",
+              "event_type"
+            ],
+            type: "object",
+            "x-route-path": "/access_grants"
+          },
           {
             description: "An access method was issued.",
             properties: {
@@ -19017,6 +19203,66 @@ var openapi_default = {
             type: "object",
             "x-route-path": "/access_methods"
           },
+          {
+            description: "An access method's PIN code was changed.",
+            properties: {
+              access_grant_ids: {
+                description: "IDs of the access grants associated with this access method.",
+                items: { format: "uuid", type: "string" },
+                type: "array"
+              },
+              access_grant_keys: {
+                description: "Keys of the access grants associated with this access method (if present).",
+                items: { type: "string" },
+                type: "array"
+              },
+              access_method_id: {
+                description: "ID of the affected access method.",
+                format: "uuid",
+                type: "string"
+              },
+              code: {
+                description: "The new PIN code for code access methods (only present when mode is 'code').",
+                type: "string"
+              },
+              created_at: {
+                description: "Date and time at which the event was created.",
+                format: "date-time",
+                type: "string"
+              },
+              event_id: {
+                description: "ID of the event.",
+                format: "uuid",
+                type: "string"
+              },
+              event_type: {
+                enum: ["access_method.code_changed"],
+                type: "string"
+              },
+              occurred_at: {
+                description: "Date and time at which the event occurred.",
+                format: "date-time",
+                type: "string"
+              },
+              workspace_id: {
+                description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event.",
+                format: "uuid",
+                type: "string"
+              }
+            },
+            required: [
+              "event_id",
+              "workspace_id",
+              "created_at",
+              "occurred_at",
+              "access_method_id",
+              "access_grant_ids",
+              "event_type",
+              "code"
+            ],
+            type: "object",
+            "x-route-path": "/access_methods"
+          },
           {
             description: "An [access system](https://docs.seam.co/latest/capability-guides/access-systems) was connected.",
             properties: {
@@ -45318,11 +45564,13 @@ var openapi_default = {
                 "access_grant.access_granted_to_all_doors",
                 "access_grant.access_granted_to_door",
                 "access_grant.access_to_door_lost",
+                "access_grant.access_times_changed",
                 "access_method.issued",
                 "access_method.revoked",
                 "access_method.card_encoding_required",
                 "access_method.deleted",
                 "access_method.reissued",
+                "access_method.code_changed",
                 "acs_system.connected",
                 "acs_system.added",
                 "acs_system.disconnected",
@@ -45419,11 +45667,13 @@ var openapi_default = {
                   "access_grant.access_granted_to_all_doors",
                   "access_grant.access_granted_to_door",
                   "access_grant.access_to_door_lost",
+                  "access_grant.access_times_changed",
                   "access_method.issued",
                   "access_method.revoked",
                   "access_method.card_encoding_required",
                   "access_method.deleted",
                   "access_method.reissued",
+                  "access_method.code_changed",
                   "acs_system.connected",
                   "acs_system.added",
                   "acs_system.disconnected",
@@ -45662,11 +45912,13 @@ var openapi_default = {
                       "access_grant.access_granted_to_all_doors",
                       "access_grant.access_granted_to_door",
                       "access_grant.access_to_door_lost",
+                      "access_grant.access_times_changed",
                       "access_method.issued",
                       "access_method.revoked",
                       "access_method.card_encoding_required",
                       "access_method.deleted",
                       "access_method.reissued",
+                      "access_method.code_changed",
                       "acs_system.connected",
                       "acs_system.added",
                       "acs_system.disconnected",
@@ -45759,11 +46011,13 @@ var openapi_default = {
                         "access_grant.access_granted_to_all_doors",
                         "access_grant.access_granted_to_door",
                         "access_grant.access_to_door_lost",
+                        "access_grant.access_times_changed",
                         "access_method.issued",
                         "access_method.revoked",
                         "access_method.card_encoding_required",
                         "access_method.deleted",
                         "access_method.reissued",
+                        "access_method.code_changed",
                         "acs_system.connected",
                         "acs_system.added",
                         "acs_system.disconnected",
@@ -50730,11 +50984,13 @@ var openapi_default = {
                 "access_grant.access_granted_to_all_doors",
                 "access_grant.access_granted_to_door",
                 "access_grant.access_to_door_lost",
+                "access_grant.access_times_changed",
                 "access_method.issued",
                 "access_method.revoked",
                 "access_method.card_encoding_required",
                 "access_method.deleted",
                 "access_method.reissued",
+                "access_method.code_changed",
                 "acs_system.connected",
                 "acs_system.added",
                 "acs_system.disconnected",
@@ -50832,11 +51088,13 @@ var openapi_default = {
                   "access_grant.access_granted_to_all_doors",
                   "access_grant.access_granted_to_door",
                   "access_grant.access_to_door_lost",
+                  "access_grant.access_times_changed",
                   "access_method.issued",
                   "access_method.revoked",
                   "access_method.card_encoding_required",
                   "access_method.deleted",
                   "access_method.reissued",
+                  "access_method.code_changed",
                   "acs_system.connected",
                   "acs_system.added",
                   "acs_system.disconnected",
@@ -50995,11 +51253,13 @@ var openapi_default = {
                       "access_grant.access_granted_to_all_doors",
                       "access_grant.access_granted_to_door",
                       "access_grant.access_to_door_lost",
+                      "access_grant.access_times_changed",
                       "access_method.issued",
                       "access_method.revoked",
                       "access_method.card_encoding_required",
                       "access_method.deleted",
                       "access_method.reissued",
+                      "access_method.code_changed",
                       "acs_system.connected",
                       "acs_system.added",
                       "acs_system.disconnected",
@@ -51092,11 +51352,13 @@ var openapi_default = {
                         "access_grant.access_granted_to_all_doors",
                         "access_grant.access_granted_to_door",
                         "access_grant.access_to_door_lost",
+                        "access_grant.access_times_changed",
                         "access_method.issued",
                         "access_method.revoked",
                         "access_method.card_encoding_required",
                         "access_method.deleted",
                         "access_method.reissued",
+                        "access_method.code_changed",
                         "acs_system.connected",
                         "acs_system.added",
                         "acs_system.disconnected",