@seamapi/types 1.286.1 → 1.286.3

package/dist/connect.cjs

@@ -671,6 +671,9 @@ var device_metadata = zod.z.object({
      * Group ID to add users to for this device
      */
     _member_group_id: zod.z.string().optional()
+  }),
+  assa_abloy_vostio_metadata: zod.z.object({
+    encoder_id: zod.z.string()
   })
 }).partial();
 var LOCK_DEVICE_TYPE = {
@@ -731,7 +734,8 @@ var phone_device_type = zod.z.enum(
   Object.values(PHONE_DEVICE_TYPE_LIST)
 );
 var ENCODER_DEVICE_TYPE = {
-  VISIONLINE_ENCODER: "visionline_encoder"
+  VISIONLINE_ENCODER: "visionline_encoder",
+  ASSA_ABLOY_VOSTIO_ENCODER: "assa_abloy_vostio_encoder"
 };
 var ENCODER_DEVICE_TYPE_LIST = Object.values(ENCODER_DEVICE_TYPE);
 var encoder_device_type = zod.z.enum(
@@ -1794,7 +1798,7 @@ var deprecated_action_attempts = [
   ...delete_noise_threshold_action_attempt.options,
   ...update_noise_threshold_action_attempt.options
 ];
-var action_type2 = zod.z.literal("ENCODE_CARD");
+var action_type2 = zod.z.literal("ENCODE_CREDENTIAL");
 var no_card_on_encoder_error = zod.z.object({
   type: zod.z.literal("no_card_on_encoder"),
   message: zod.z.string()
@@ -1809,15 +1813,15 @@ var error3 = zod.z.union([
   incompatible_card_format_error
 ]);
 var result3 = acs_credential.or(unmanaged_acs_credential);
-var encode_card_action_attempt = zod.z.discriminatedUnion("status", [
+var encode_credential_action_attempt = zod.z.discriminatedUnion("status", [
   common_pending_action_attempt.extend({
     action_type: action_type2
-  }).describe("Encoding card data from physical encoder."),
+  }).describe("Encoding credential data from physical encoder."),
   common_succeeded_action_attempt.extend({
     action_type: action_type2,
     result: result3
-  }).describe("Encoding card data from physical encoder succeeded."),
-  common_failed_action_attempt.extend({ action_type: action_type2, error: error3 }).describe("Encoding card data from physical encoder failed.")
+  }).describe("Encoding credential data from physical encoder succeeded."),
+  common_failed_action_attempt.extend({ action_type: action_type2, error: error3 }).describe("Encoding credential data from physical encoder failed.")
 ]);
 var action_type3 = zod.z.literal("LOCK_DOOR");
 var error4 = zod.z.object({
@@ -1857,7 +1861,7 @@ var reset_sandbox_workspace_action_attempt = zod.z.discriminatedUnion(
     }).describe("Resetting sandbox workspace failed.")
   ]
 );
-var action_type5 = zod.z.literal("SCAN_CARD");
+var action_type5 = zod.z.literal("SCAN_CREDENTIAL");
 var no_card_on_encoder_error2 = zod.z.object({
   type: zod.z.literal("no_card_on_encoder"),
   message: zod.z.string()
@@ -1873,20 +1877,20 @@ var warning = zod.z.object({
 var acs_credential_on_seam = acs_credential.or(unmanaged_acs_credential);
 var result6 = zod.z.object({
   acs_credential_on_encoder: acs_credential_on_encoder.describe(
-    "Snapshot of the card data read from the physical encoder."
+    "Snapshot of credential data read from physical encoder."
   ),
   acs_credential_on_seam: acs_credential_on_seam.nullable().describe("Matching acs_credential currently encoded on this card."),
   warnings: zod.z.array(warning)
 });
-var scan_card_action_attempt = zod.z.discriminatedUnion("status", [
+var scan_credential_action_attempt = zod.z.discriminatedUnion("status", [
   common_pending_action_attempt.extend({
     action_type: action_type5
-  }).describe("Reading card data from physical encoder."),
+  }).describe("Reading credential data from physical encoder."),
   common_succeeded_action_attempt.extend({
     action_type: action_type5,
     result: result6
-  }).describe("Reading card data from physical encoder succeeded."),
-  common_failed_action_attempt.extend({ action_type: action_type5, error: error6 }).describe("Reading card data from physical encoder failed.")
+  }).describe("Reading credential data from physical encoder succeeded."),
+  common_failed_action_attempt.extend({ action_type: action_type5, error: error6 }).describe("Reading credential data from physical encoder failed.")
 ]);
 var action_type6 = zod.z.literal("SET_COOL");
 var error7 = zod.z.object({
@@ -1992,8 +1996,8 @@ var unlock_door_action_attempt = zod.z.discriminatedUnion("status", [
 var action_attempt = zod.z.union([
   ...lock_door_action_attempt.options,
   ...unlock_door_action_attempt.options,
-  ...scan_card_action_attempt.options,
-  ...encode_card_action_attempt.options,
+  ...scan_credential_action_attempt.options,
+  ...encode_credential_action_attempt.options,
   ...reset_sandbox_workspace_action_attempt.options,
   ...set_cool_action_attempt.options,
   ...set_heat_action_attempt.options,
@@ -2216,7 +2220,13 @@ var acs_credential_event = common_acs_event.extend({
 var acs_credential_deleted_event = acs_credential_event.extend({
   event_type: zod.z.literal("acs_credential.deleted")
 }).describe("An ACS credential was deleted.");
-var acs_credential_events = [acs_credential_deleted_event];
+var acs_credential_issued = acs_credential_event.extend({
+  event_type: zod.z.literal("acs_credential.issued")
+}).describe("An ACS credential was issued.");
+var acs_credential_events = [
+  acs_credential_deleted_event,
+  acs_credential_issued
+];
 var acs_system_event = common_acs_event.extend({});
 var acs_system_connected_event = acs_system_event.extend({
   event_type: zod.z.literal("acs_system.connected")
@@ -2242,6 +2252,44 @@ var acs_events = [
   ...acs_credential_events,
   ...acs_user_events
 ];
+var action_attempt_event = common_event.extend({
+  action_attempt_id: zod.z.string().uuid().describe(`
+    ---
+    title: Action Attempt ID
+    ---
+    The ID of the action attempt.
+  `),
+  action_type: zod.z.string().describe(`
+    ---
+    title: Action Type
+    ---
+    The type of action.
+  `),
+  status: zod.z.string().describe(`
+    ---
+    title: Status
+    ---
+    The status of the action.
+  `)
+});
+var action_attempt_lock_door_succeeded_event = action_attempt_event.extend({
+  event_type: zod.z.literal("action_attempt.lock_door.succeeded")
+}).describe("A lock door action attempt succeeded.");
+var action_attempt_lock_door_failed_event = action_attempt_event.extend({
+  event_type: zod.z.literal("action_attempt.lock_door.failed")
+}).describe("A lock door action attempt failed.");
+var action_attempt_unlock_door_succeeded_event = action_attempt_event.extend({
+  event_type: zod.z.literal("action_attempt.unlock_door.succeeded")
+}).describe("An unlock door action attempt succeeded.");
+var action_attempt_unlock_door_failed_event = action_attempt_event.extend({
+  event_type: zod.z.literal("action_attempt.unlock_door.failed")
+}).describe("An unlock door action attempt failed.");
+var action_attempt_events = [
+  action_attempt_lock_door_succeeded_event,
+  action_attempt_lock_door_failed_event,
+  action_attempt_unlock_door_succeeded_event,
+  action_attempt_unlock_door_failed_event
+];
 var client_session_event = common_event.extend({
   client_session_id: zod.z.string().uuid().describe(`
     ---
@@ -2622,6 +2670,7 @@ var seam_event = zod.z.discriminatedUnion("event_type", [
   ...acs_events,
   ...client_session_events,
   ...connected_account_events,
+  ...action_attempt_events,
   ...connect_webview_events,
   ...device_events,
   ...enrollment_automation_events,
@@ -3922,7 +3971,7 @@ var openapi_default = {
             type: "object"
           },
           {
-            description: "Reading card data from physical encoder.",
+            description: "Reading credential data from physical encoder.",
             properties: {
               action_attempt_id: {
                 description: "The ID of the action attempt.",
@@ -3930,7 +3979,7 @@ var openapi_default = {
                 type: "string",
                 "x-title": "Action Attempt ID"
               },
-              action_type: { enum: ["SCAN_CARD"], type: "string" },
+              action_type: { enum: ["SCAN_CREDENTIAL"], type: "string" },
               error: { nullable: true },
               result: { nullable: true },
               status: { enum: ["pending"], type: "string" }
@@ -3945,7 +3994,7 @@ var openapi_default = {
             type: "object"
           },
           {
-            description: "Reading card data from physical encoder succeeded.",
+            description: "Reading credential data from physical encoder succeeded.",
             properties: {
               action_attempt_id: {
                 description: "The ID of the action attempt.",
@@ -3953,12 +4002,12 @@ var openapi_default = {
                 type: "string",
                 "x-title": "Action Attempt ID"
               },
-              action_type: { enum: ["SCAN_CARD"], type: "string" },
+              action_type: { enum: ["SCAN_CREDENTIAL"], type: "string" },
               error: { nullable: true },
               result: {
                 properties: {
                   acs_credential_on_encoder: {
-                    description: "Snapshot of the card data read from the physical encoder.",
+                    description: "Snapshot of credential data read from physical encoder.",
                     properties: {
                       card_number: {
                         description: "A number or string that physically identifies this card.",
@@ -4392,7 +4441,7 @@ var openapi_default = {
             type: "object"
           },
           {
-            description: "Reading card data from physical encoder failed.",
+            description: "Reading credential data from physical encoder failed.",
             properties: {
               action_attempt_id: {
                 description: "The ID of the action attempt.",
@@ -4400,7 +4449,7 @@ var openapi_default = {
                 type: "string",
                 "x-title": "Action Attempt ID"
               },
-              action_type: { enum: ["SCAN_CARD"], type: "string" },
+              action_type: { enum: ["SCAN_CREDENTIAL"], type: "string" },
               error: {
                 oneOf: [
                   {
@@ -4445,7 +4494,7 @@ var openapi_default = {
             type: "object"
           },
           {
-            description: "Encoding card data from physical encoder.",
+            description: "Encoding credential data from physical encoder.",
             properties: {
               action_attempt_id: {
                 description: "The ID of the action attempt.",
@@ -4453,7 +4502,7 @@ var openapi_default = {
                 type: "string",
                 "x-title": "Action Attempt ID"
               },
-              action_type: { enum: ["ENCODE_CARD"], type: "string" },
+              action_type: { enum: ["ENCODE_CREDENTIAL"], type: "string" },
               error: { nullable: true },
               result: { nullable: true },
               status: { enum: ["pending"], type: "string" }
@@ -4468,7 +4517,7 @@ var openapi_default = {
             type: "object"
           },
           {
-            description: "Encoding card data from physical encoder succeeded.",
+            description: "Encoding credential data from physical encoder succeeded.",
             properties: {
               action_attempt_id: {
                 description: "The ID of the action attempt.",
@@ -4476,7 +4525,7 @@ var openapi_default = {
                 type: "string",
                 "x-title": "Action Attempt ID"
               },
-              action_type: { enum: ["ENCODE_CARD"], type: "string" },
+              action_type: { enum: ["ENCODE_CREDENTIAL"], type: "string" },
               error: { nullable: true },
               result: {
                 description: "Means by which a user gains access at an entrance.\n\n      The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.",
@@ -4813,7 +4862,7 @@ var openapi_default = {
             type: "object"
           },
           {
-            description: "Encoding card data from physical encoder failed.",
+            description: "Encoding credential data from physical encoder failed.",
             properties: {
               action_attempt_id: {
                 description: "The ID of the action attempt.",
@@ -4821,7 +4870,7 @@ var openapi_default = {
                 type: "string",
                 "x-title": "Action Attempt ID"
               },
-              action_type: { enum: ["ENCODE_CARD"], type: "string" },
+              action_type: { enum: ["ENCODE_CREDENTIAL"], type: "string" },
               error: {
                 oneOf: [
                   {
@@ -6204,7 +6253,10 @@ var openapi_default = {
                 type: "string"
               },
               { enum: ["ios_phone", "android_phone"], type: "string" },
-              { enum: ["visionline_encoder"], type: "string" }
+              {
+                enum: ["visionline_encoder", "assa_abloy_vostio_encoder"],
+                type: "string"
+              }
             ]
           },
           display_name: {
@@ -6471,6 +6523,11 @@ var openapi_default = {
                         required: ["gadget_name", "gadget_id"],
                         type: "object"
                       },
+                      assa_abloy_vostio_metadata: {
+                        properties: { encoder_id: { type: "string" } },
+                        required: ["encoder_id"],
+                        type: "object"
+                      },
                       august_metadata: {
                         properties: {
                           has_keypad: { type: "boolean" },
@@ -7944,7 +8001,10 @@ var openapi_default = {
                 type: "string"
               },
               { enum: ["ios_phone", "android_phone"], type: "string" },
-              { enum: ["visionline_encoder"], type: "string" }
+              {
+                enum: ["visionline_encoder", "assa_abloy_vostio_encoder"],
+                type: "string"
+              }
             ]
           },
           errors: {
@@ -9564,7 +9624,8 @@ var openapi_default = {
         tags: ["/acs"],
         "x-fern-sdk-group-name": ["acs", "access_groups"],
         "x-fern-sdk-method-name": "add_user",
-        "x-response-key": null
+        "x-response-key": null,
+        "x-title": "Add an ACS User to an Access Group"
       },
       put: {
         description: "Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
@@ -9615,7 +9676,8 @@ var openapi_default = {
         summary: "/acs/access_groups/add_user",
         tags: ["/acs"],
         "x-fern-ignore": true,
-        "x-response-key": null
+        "x-response-key": null,
+        "x-title": "Add an ACS User to an Access Group"
       }
     },
     "/acs/access_groups/get": {
@@ -9670,7 +9732,8 @@ var openapi_default = {
         "x-fern-sdk-group-name": ["acs", "access_groups"],
         "x-fern-sdk-method-name": "get",
         "x-fern-sdk-return-value": "acs_access_group",
-        "x-response-key": "acs_access_group"
+        "x-response-key": "acs_access_group",
+        "x-title": "Get an Access Group"
       }
     },
     "/acs/access_groups/list": {
@@ -9730,7 +9793,8 @@ var openapi_default = {
         "x-fern-sdk-group-name": ["acs", "access_groups"],
         "x-fern-sdk-method-name": "list",
         "x-fern-sdk-return-value": "acs_access_groups",
-        "x-response-key": "acs_access_groups"
+        "x-response-key": "acs_access_groups",
+        "x-title": "List Access Groups"
       }
     },
     "/acs/access_groups/list_accessible_entrances": {
@@ -9786,7 +9850,8 @@ var openapi_default = {
         "x-fern-sdk-group-name": ["acs", "access_groups"],
         "x-fern-sdk-method-name": "list_accessible_entrances",
         "x-fern-sdk-return-value": "acs_entrances",
-        "x-response-key": "acs_entrances"
+        "x-response-key": "acs_entrances",
+        "x-title": "List Entrances Accessible to an Access Group"
       }
     },
     "/acs/access_groups/list_users": {
@@ -9842,7 +9907,8 @@ var openapi_default = {
         "x-fern-sdk-group-name": ["acs", "access_groups"],
         "x-fern-sdk-method-name": "list_users",
         "x-fern-sdk-return-value": "acs_users",
-        "x-response-key": "acs_users"
+        "x-response-key": "acs_users",
+        "x-title": "List ACS Users in an Access Group"
       }
     },
     "/acs/access_groups/remove_user": {
@@ -9896,7 +9962,8 @@ var openapi_default = {
         tags: ["/acs"],
         "x-fern-sdk-group-name": ["acs", "access_groups"],
         "x-fern-sdk-method-name": "remove_user",
-        "x-response-key": null
+        "x-response-key": null,
+        "x-title": "Remove an ACS User from an Access Group"
       }
     },
     "/acs/access_groups/unmanaged/get": {
@@ -10451,6 +10518,7 @@ var openapi_default = {
                     description: "Visionline-specific metadata for the new credential.",
                     properties: {
                       assa_abloy_credential_service_mobile_endpoint_id: {
+                        description: "DEPRECATED: DO NOT USE",
                         format: "uuid",
                         type: "string"
                       },
@@ -11519,16 +11587,24 @@ var openapi_default = {
         "x-title": "Update a Credential"
       }
     },
-    "/acs/encoders/encode_card": {
+    "/acs/encoders/encode_credential": {
       post: {
-        operationId: "acsEncodersEncodeCardPost",
+        operationId: "acsEncodersEncodeCredentialPost",
         requestBody: {
           content: {
             "application/json": {
               schema: {
                 properties: {
-                  acs_credential_id: { format: "uuid", type: "string" },
-                  device_id: { format: "uuid", type: "string" }
+                  acs_credential_id: {
+                    description: "ID of the acs_credential to encode on a physical card.",
+                    format: "uuid",
+                    type: "string"
+                  },
+                  device_id: {
+                    description: "ID of the encoder to use for the encoding.",
+                    format: "uuid",
+                    type: "string"
+                  }
                 },
                 required: ["device_id", "acs_credential_id"],
                 type: "object"
@@ -11562,10 +11638,10 @@ var openapi_default = {
           { console_session: [] },
           { api_key: [] }
         ],
-        summary: "/acs/encoders/encode_card",
+        summary: "/acs/encoders/encode_credential",
         tags: ["/acs"],
         "x-fern-sdk-group-name": ["acs", "encoders"],
-        "x-fern-sdk-method-name": "encode_card",
+        "x-fern-sdk-method-name": "encode_credential",
         "x-fern-sdk-return-value": "action_attempt",
         "x-response-key": "action_attempt",
         "x-undocumented": "Encoding a card is currently unimplemented."
@@ -11657,16 +11733,24 @@ var openapi_default = {
         "x-undocumented": "Encoders are in alpha."
       }
     },
-    "/acs/encoders/scan_card": {
+    "/acs/encoders/scan_credential": {
       post: {
-        operationId: "acsEncodersScanCardPost",
+        operationId: "acsEncodersScanCredentialPost",
         requestBody: {
           content: {
             "application/json": {
               schema: {
                 properties: {
-                  acs_system_id: { format: "uuid", type: "string" },
-                  device_id: { format: "uuid", type: "string" }
+                  acs_system_id: {
+                    description: "ID of the acs_system the encoder belongs to.",
+                    format: "uuid",
+                    type: "string"
+                  },
+                  device_id: {
+                    description: "ID of the encoder to use for the scan.",
+                    format: "uuid",
+                    type: "string"
+                  }
                 },
                 required: ["acs_system_id", "device_id"],
                 type: "object"
@@ -11700,10 +11784,10 @@ var openapi_default = {
           { console_session: [] },
           { api_key: [] }
         ],
-        summary: "/acs/encoders/scan_card",
+        summary: "/acs/encoders/scan_credential",
         tags: ["/acs"],
         "x-fern-sdk-group-name": ["acs", "encoders"],
-        "x-fern-sdk-method-name": "scan_card",
+        "x-fern-sdk-method-name": "scan_credential",
         "x-fern-sdk-return-value": "action_attempt",
         "x-response-key": "action_attempt",
         "x-undocumented": "Reading a card is currently unimplemented."
@@ -11802,7 +11886,8 @@ var openapi_default = {
         tags: ["/acs"],
         "x-fern-sdk-group-name": ["acs", "entrances"],
         "x-fern-sdk-method-name": "grant_access",
-        "x-response-key": null
+        "x-response-key": null,
+        "x-title": "Grant an ACS User Access to an Entrance"
       }
     },
     "/acs/entrances/list": {
@@ -14903,7 +14988,13 @@ var openapi_default = {
                         type: "string"
                       },
                       { enum: ["ios_phone", "android_phone"], type: "string" },
-                      { enum: ["visionline_encoder"], type: "string" }
+                      {
+                        enum: [
+                          "visionline_encoder",
+                          "assa_abloy_vostio_encoder"
+                        ],
+                        type: "string"
+                      }
                     ]
                   },
                   device_types: {
@@ -14957,7 +15048,13 @@ var openapi_default = {
                           enum: ["ios_phone", "android_phone"],
                           type: "string"
                         },
-                        { enum: ["visionline_encoder"], type: "string" }
+                        {
+                          enum: [
+                            "visionline_encoder",
+                            "assa_abloy_vostio_encoder"
+                          ],
+                          type: "string"
+                        }
                       ]
                     },
                     type: "array"
@@ -15395,7 +15492,13 @@ var openapi_default = {
                         type: "string"
                       },
                       { enum: ["ios_phone", "android_phone"], type: "string" },
-                      { enum: ["visionline_encoder"], type: "string" }
+                      {
+                        enum: [
+                          "visionline_encoder",
+                          "assa_abloy_vostio_encoder"
+                        ],
+                        type: "string"
+                      }
                     ]
                   },
                   device_types: {
@@ -15449,7 +15552,13 @@ var openapi_default = {
                           enum: ["ios_phone", "android_phone"],
                           type: "string"
                         },
-                        { enum: ["visionline_encoder"], type: "string" }
+                        {
+                          enum: [
+                            "visionline_encoder",
+                            "assa_abloy_vostio_encoder"
+                          ],
+                          type: "string"
+                        }
                       ]
                     },
                     type: "array"
@@ -16187,7 +16296,13 @@ var openapi_default = {
                         type: "string"
                       },
                       { enum: ["ios_phone", "android_phone"], type: "string" },
-                      { enum: ["visionline_encoder"], type: "string" }
+                      {
+                        enum: [
+                          "visionline_encoder",
+                          "assa_abloy_vostio_encoder"
+                        ],
+                        type: "string"
+                      }
                     ]
                   },
                   device_types: {
@@ -16241,7 +16356,13 @@ var openapi_default = {
                           enum: ["ios_phone", "android_phone"],
                           type: "string"
                         },
-                        { enum: ["visionline_encoder"], type: "string" }
+                        {
+                          enum: [
+                            "visionline_encoder",
+                            "assa_abloy_vostio_encoder"
+                          ],
+                          type: "string"
+                        }
                       ]
                     },
                     type: "array"
@@ -16641,7 +16762,13 @@ var openapi_default = {
                         type: "string"
                       },
                       { enum: ["ios_phone", "android_phone"], type: "string" },
-                      { enum: ["visionline_encoder"], type: "string" }
+                      {
+                        enum: [
+                          "visionline_encoder",
+                          "assa_abloy_vostio_encoder"
+                        ],
+                        type: "string"
+                      }
                     ]
                   },
                   device_types: {
@@ -16695,7 +16822,13 @@ var openapi_default = {
                           enum: ["ios_phone", "android_phone"],
                           type: "string"
                         },
-                        { enum: ["visionline_encoder"], type: "string" }
+                        {
+                          enum: [
+                            "visionline_encoder",
+                            "assa_abloy_vostio_encoder"
+                          ],
+                          type: "string"
+                        }
                       ]
                     },
                     type: "array"
@@ -17907,7 +18040,13 @@ var openapi_default = {
                         type: "string"
                       },
                       { enum: ["ios_phone", "android_phone"], type: "string" },
-                      { enum: ["visionline_encoder"], type: "string" }
+                      {
+                        enum: [
+                          "visionline_encoder",
+                          "assa_abloy_vostio_encoder"
+                        ],
+                        type: "string"
+                      }
                     ]
                   },
                   device_types: {
@@ -17961,7 +18100,13 @@ var openapi_default = {
                           enum: ["ios_phone", "android_phone"],
                           type: "string"
                         },
-                        { enum: ["visionline_encoder"], type: "string" }
+                        {
+                          enum: [
+                            "visionline_encoder",
+                            "assa_abloy_vostio_encoder"
+                          ],
+                          type: "string"
+                        }
                       ]
                     },
                     type: "array"