@seamapi/types 1.289.0 → 1.289.1

package/dist/connect.cjs

@@ -1804,7 +1804,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()
@@ -1819,15 +1819,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({
@@ -1867,7 +1867,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()
@@ -1883,20 +1883,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({
@@ -2002,8 +2002,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,
@@ -3982,7 +3982,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.",
@@ -3990,7 +3990,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" }
@@ -4005,7 +4005,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.",
@@ -4013,12 +4013,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.",
@@ -4452,7 +4452,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.",
@@ -4460,7 +4460,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: [
                   {
@@ -4505,7 +4505,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.",
@@ -4513,7 +4513,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" }
@@ -4528,7 +4528,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.",
@@ -4536,7 +4536,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.\nThe `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.",
@@ -4873,7 +4873,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.",
@@ -4881,7 +4881,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: [
                   {
@@ -11593,16 +11593,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"
@@ -11636,10 +11644,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."
@@ -11731,16 +11739,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"
@@ -11774,10 +11790,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."