@seamapi/types 1.263.1 → 1.264.0

package/dist/connect.cjs

@@ -1214,6 +1214,29 @@ var unmanaged_acs_credential = common_acs_credential.merge(
     is_managed: zod.z.literal(false)
   })
 );
+var acs_credential_on_encoder = zod.z.object({
+  created_at: zod.z.string().datetime().describe("Date and time the credential was created."),
+  is_issued: zod.z.boolean().nullable(),
+  starts_at: zod.z.string().datetime().nullable().describe("Date and time the credential will become useable."),
+  ends_at: zod.z.string().datetime().nullable().describe("Date and time the credential will stop being useable."),
+  card_number: zod.z.string().nullable().describe("A number or string that physically identifies this card."),
+  visionline_metadata: zod.z.object({
+    card_id: zod.z.string(),
+    card_function_type: zod.z.enum(["guest", "staff"]),
+    // computed, looks at door ops, and checks is guest op is present.
+    cancelled: zod.z.boolean(),
+    discarded: zod.z.boolean(),
+    expired: zod.z.boolean(),
+    overwritten: zod.z.boolean(),
+    overridden: zod.z.boolean().optional(),
+    pending_auto_update: zod.z.boolean(),
+    card_format: zod.z.enum(["TLCode", "rfid48"]),
+    card_holder: zod.z.string().optional(),
+    number_of_issued_cards: zod.z.number()
+    // guest_acs_entrance_ids: z.array(z.string().uuid()).optional(), // computed
+    // common_acs_entrance_ids: z.array(z.string().uuid()).optional(), // computed
+  }).optional()
+});
 var acs_entrance = zod.z.object({
   acs_system_id: zod.z.string().uuid().describe("ID of the access control system that contains the entrance."),
   acs_entrance_id: zod.z.string().uuid().describe("ID of the entrance."),
@@ -1698,52 +1721,50 @@ var lock_door_action_attempt = zod.z.discriminatedUnion("status", [
   }).describe("Locking door succeeded."),
   common_failed_action_attempt.extend({ action_type: action_type3, error: error4 }).describe("Locking door failed.")
 ]);
-var action_type4 = zod.z.literal("READ_CARD");
+var action_type4 = zod.z.literal("RESET_SANDBOX_WORKSPACE");
 var error5 = zod.z.object({
-  type: zod.z.literal("no_card_on_encoder"),
-  message: zod.z.string()
-});
-var result5 = zod.z.object({
-  // TODO acs_credential_id: z
-  //   .string()
-  //   .uuid()
-  //   .nullable()
-  //   .describe("Matching acs_credential currently encoded on this card."),
-  card_number: zod.z.string().nullable().describe("A number or string that physically identifies this card.")
-  // TODO visionline_metadata: visionline_credential_metadata,
-});
-var read_card_action_attempt = zod.z.discriminatedUnion("status", [
-  common_pending_action_attempt.extend({
-    action_type: action_type4
-  }).describe("Reading card data from physical encoder."),
-  common_succeeded_action_attempt.extend({
-    action_type: action_type4,
-    result: result5
-  }).describe("Reading card data from physical encoder succeeded."),
-  common_failed_action_attempt.extend({ action_type: action_type4, error: error5 }).describe("Reading card data from physical encoder failed.")
-]);
-var action_type5 = zod.z.literal("RESET_SANDBOX_WORKSPACE");
-var error6 = zod.z.object({
   type: zod.z.string(),
   message: zod.z.string()
 });
-var result6 = zod.z.object({});
+var result5 = zod.z.object({});
 var reset_sandbox_workspace_action_attempt = zod.z.discriminatedUnion(
   "status",
   [
     common_pending_action_attempt.extend({
-      action_type: action_type5
+      action_type: action_type4
     }).describe("Resetting sandbox workspace."),
     common_succeeded_action_attempt.extend({
-      action_type: action_type5,
-      result: result6
+      action_type: action_type4,
+      result: result5
     }).describe("Resetting sandbox workspace succeeded."),
     common_failed_action_attempt.extend({
-      action_type: action_type5,
-      error: error6
+      action_type: action_type4,
+      error: error5
     }).describe("Resetting sandbox workspace failed.")
   ]
 );
+var action_type5 = zod.z.literal("SCAN_CARD");
+var error6 = zod.z.object({
+  type: zod.z.literal("no_card_on_encoder"),
+  message: zod.z.string()
+});
+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."
+  ),
+  acs_credential_on_seam: acs_credential_on_seam.nullable().describe("Matching acs_credential currently encoded on this card.")
+});
+var scan_card_action_attempt = zod.z.discriminatedUnion("status", [
+  common_pending_action_attempt.extend({
+    action_type: action_type5
+  }).describe("Reading card 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.")
+]);
 var action_type6 = zod.z.literal("SET_COOL");
 var error7 = zod.z.object({
   type: zod.z.string(),
@@ -1848,7 +1869,7 @@ 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,
-  ...read_card_action_attempt.options,
+  ...scan_card_action_attempt.options,
   ...encode_card_action_attempt.options,
   ...reset_sandbox_workspace_action_attempt.options,
   ...set_cool_action_attempt.options,
@@ -3643,7 +3664,7 @@ var openapi_default = {
                 type: "string",
                 "x-title": "Action Attempt ID"
               },
-              action_type: { enum: ["READ_CARD"], type: "string" },
+              action_type: { enum: ["SCAN_CARD"], type: "string" },
               error: { nullable: true },
               result: { nullable: true },
               status: { enum: ["pending"], type: "string" }
@@ -3666,17 +3687,317 @@ var openapi_default = {
                 type: "string",
                 "x-title": "Action Attempt ID"
               },
-              action_type: { enum: ["READ_CARD"], type: "string" },
+              action_type: { enum: ["SCAN_CARD"], type: "string" },
               error: { nullable: true },
               result: {
                 properties: {
-                  card_number: {
-                    description: "A number or string that physically identifies this card.",
+                  acs_credential_on_encoder: {
+                    description: "Snapshot of the card data read from the physical encoder.",
+                    properties: {
+                      card_number: {
+                        description: "A number or string that physically identifies this card.",
+                        nullable: true,
+                        type: "string"
+                      },
+                      created_at: {
+                        description: "Date and time the credential was created.",
+                        format: "date-time",
+                        type: "string"
+                      },
+                      ends_at: {
+                        description: "Date and time the credential will stop being useable.",
+                        format: "date-time",
+                        nullable: true,
+                        type: "string"
+                      },
+                      is_issued: { nullable: true, type: "boolean" },
+                      starts_at: {
+                        description: "Date and time the credential will become useable.",
+                        format: "date-time",
+                        nullable: true,
+                        type: "string"
+                      },
+                      visionline_metadata: {
+                        properties: {
+                          cancelled: { type: "boolean" },
+                          card_format: {
+                            enum: ["TLCode", "rfid48"],
+                            type: "string"
+                          },
+                          card_function_type: {
+                            enum: ["guest", "staff"],
+                            type: "string"
+                          },
+                          card_holder: { type: "string" },
+                          card_id: { type: "string" },
+                          discarded: { type: "boolean" },
+                          expired: { type: "boolean" },
+                          number_of_issued_cards: {
+                            format: "float",
+                            type: "number"
+                          },
+                          overridden: { type: "boolean" },
+                          overwritten: { type: "boolean" },
+                          pending_auto_update: { type: "boolean" }
+                        },
+                        required: [
+                          "card_id",
+                          "card_function_type",
+                          "cancelled",
+                          "discarded",
+                          "expired",
+                          "overwritten",
+                          "pending_auto_update",
+                          "card_format",
+                          "number_of_issued_cards"
+                        ],
+                        type: "object"
+                      }
+                    },
+                    required: [
+                      "created_at",
+                      "is_issued",
+                      "starts_at",
+                      "ends_at",
+                      "card_number"
+                    ],
+                    type: "object"
+                  },
+                  acs_credential_on_seam: {
+                    description: "Matching acs_credential currently encoded on this card.",
                     nullable: true,
-                    type: "string"
+                    oneOf: [
+                      {
+                        properties: {
+                          access_method: {
+                            enum: ["code", "card", "mobile_key"],
+                            type: "string"
+                          },
+                          acs_credential_id: { format: "uuid", type: "string" },
+                          acs_credential_pool_id: {
+                            format: "uuid",
+                            type: "string"
+                          },
+                          acs_system_id: { format: "uuid", type: "string" },
+                          acs_user_id: { format: "uuid", type: "string" },
+                          card_number: { nullable: true, type: "string" },
+                          code: { nullable: true, type: "string" },
+                          created_at: { format: "date-time", type: "string" },
+                          display_name: { minLength: 1, type: "string" },
+                          ends_at: { type: "string" },
+                          errors: {
+                            items: {
+                              properties: {
+                                error_code: { type: "string" },
+                                message: { type: "string" }
+                              },
+                              required: ["error_code", "message"],
+                              type: "object"
+                            },
+                            type: "array"
+                          },
+                          external_type: {
+                            enum: [
+                              "pti_card",
+                              "brivo_credential",
+                              "hid_credential",
+                              "visionline_card",
+                              "salto_ks_credential"
+                            ],
+                            type: "string"
+                          },
+                          external_type_display_name: { type: "string" },
+                          is_issued: { type: "boolean" },
+                          is_latest_desired_state_synced_with_provider: {
+                            type: "boolean"
+                          },
+                          is_managed: { enum: [true], type: "boolean" },
+                          is_multi_phone_sync_credential: { type: "boolean" },
+                          issued_at: {
+                            format: "date-time",
+                            nullable: true,
+                            type: "string"
+                          },
+                          latest_desired_state_synced_with_provider_at: {
+                            format: "date-time",
+                            type: "string"
+                          },
+                          parent_acs_credential_id: {
+                            format: "uuid",
+                            type: "string"
+                          },
+                          starts_at: { type: "string" },
+                          visionline_metadata: {
+                            properties: {
+                              auto_join: { type: "boolean" },
+                              card_function_type: {
+                                enum: ["guest", "staff"],
+                                type: "string"
+                              },
+                              card_id: { type: "string" },
+                              common_acs_entrance_ids: {
+                                items: { format: "uuid", type: "string" },
+                                type: "array"
+                              },
+                              credential_id: { type: "string" },
+                              guest_acs_entrance_ids: {
+                                items: { format: "uuid", type: "string" },
+                                type: "array"
+                              },
+                              is_valid: { type: "boolean" },
+                              joiner_acs_credential_ids: {
+                                items: { format: "uuid", type: "string" },
+                                type: "array"
+                              }
+                            },
+                            required: ["card_function_type"],
+                            type: "object"
+                          },
+                          warnings: {
+                            items: {
+                              properties: {
+                                message: { type: "string" },
+                                warning_code: { type: "string" }
+                              },
+                              required: ["warning_code", "message"],
+                              type: "object"
+                            },
+                            type: "array"
+                          },
+                          workspace_id: { format: "uuid", type: "string" }
+                        },
+                        required: [
+                          "acs_credential_id",
+                          "acs_system_id",
+                          "display_name",
+                          "access_method",
+                          "created_at",
+                          "workspace_id",
+                          "errors",
+                          "warnings",
+                          "is_managed"
+                        ],
+                        type: "object"
+                      },
+                      {
+                        properties: {
+                          access_method: {
+                            enum: ["code", "card", "mobile_key"],
+                            type: "string"
+                          },
+                          acs_credential_id: { format: "uuid", type: "string" },
+                          acs_credential_pool_id: {
+                            format: "uuid",
+                            type: "string"
+                          },
+                          acs_system_id: { format: "uuid", type: "string" },
+                          acs_user_id: { format: "uuid", type: "string" },
+                          card_number: { nullable: true, type: "string" },
+                          code: { nullable: true, type: "string" },
+                          created_at: { format: "date-time", type: "string" },
+                          display_name: { minLength: 1, type: "string" },
+                          ends_at: { type: "string" },
+                          errors: {
+                            items: {
+                              properties: {
+                                error_code: { type: "string" },
+                                message: { type: "string" }
+                              },
+                              required: ["error_code", "message"],
+                              type: "object"
+                            },
+                            type: "array"
+                          },
+                          external_type: {
+                            enum: [
+                              "pti_card",
+                              "brivo_credential",
+                              "hid_credential",
+                              "visionline_card",
+                              "salto_ks_credential"
+                            ],
+                            type: "string"
+                          },
+                          external_type_display_name: { type: "string" },
+                          is_issued: { type: "boolean" },
+                          is_latest_desired_state_synced_with_provider: {
+                            type: "boolean"
+                          },
+                          is_managed: { enum: [false], type: "boolean" },
+                          is_multi_phone_sync_credential: { type: "boolean" },
+                          issued_at: {
+                            format: "date-time",
+                            nullable: true,
+                            type: "string"
+                          },
+                          latest_desired_state_synced_with_provider_at: {
+                            format: "date-time",
+                            type: "string"
+                          },
+                          parent_acs_credential_id: {
+                            format: "uuid",
+                            type: "string"
+                          },
+                          starts_at: { type: "string" },
+                          visionline_metadata: {
+                            properties: {
+                              auto_join: { type: "boolean" },
+                              card_function_type: {
+                                enum: ["guest", "staff"],
+                                type: "string"
+                              },
+                              card_id: { type: "string" },
+                              common_acs_entrance_ids: {
+                                items: { format: "uuid", type: "string" },
+                                type: "array"
+                              },
+                              credential_id: { type: "string" },
+                              guest_acs_entrance_ids: {
+                                items: { format: "uuid", type: "string" },
+                                type: "array"
+                              },
+                              is_valid: { type: "boolean" },
+                              joiner_acs_credential_ids: {
+                                items: { format: "uuid", type: "string" },
+                                type: "array"
+                              }
+                            },
+                            required: ["card_function_type"],
+                            type: "object"
+                          },
+                          warnings: {
+                            items: {
+                              properties: {
+                                message: { type: "string" },
+                                warning_code: { type: "string" }
+                              },
+                              required: ["warning_code", "message"],
+                              type: "object"
+                            },
+                            type: "array"
+                          },
+                          workspace_id: { format: "uuid", type: "string" }
+                        },
+                        required: [
+                          "acs_credential_id",
+                          "acs_system_id",
+                          "display_name",
+                          "access_method",
+                          "created_at",
+                          "workspace_id",
+                          "errors",
+                          "warnings",
+                          "is_managed"
+                        ],
+                        type: "object"
+                      }
+                    ]
                   }
                 },
-                required: ["card_number"],
+                required: [
+                  "acs_credential_on_encoder",
+                  "acs_credential_on_seam"
+                ],
                 type: "object"
               },
               status: { enum: ["success"], type: "string" }
@@ -3699,7 +4020,7 @@ var openapi_default = {
                 type: "string",
                 "x-title": "Action Attempt ID"
               },
-              action_type: { enum: ["READ_CARD"], type: "string" },
+              action_type: { enum: ["SCAN_CARD"], type: "string" },
               error: {
                 properties: {
                   message: { type: "string" },
@@ -10126,9 +10447,9 @@ var openapi_default = {
         "x-undocumented": "Encoders are in alpha."
       }
     },
-    "/acs/encoders/read_card": {
+    "/acs/encoders/scan_card": {
       post: {
-        operationId: "acsEncodersReadCardPost",
+        operationId: "acsEncodersScanCardPost",
         requestBody: {
           content: {
             "application/json": {
@@ -10181,10 +10502,10 @@ var openapi_default = {
           { console_session: [] },
           { api_key: [] }
         ],
-        summary: "/acs/encoders/read_card",
+        summary: "/acs/encoders/scan_card",
         tags: ["/acs"],
         "x-fern-sdk-group-name": ["acs", "encoders"],
-        "x-fern-sdk-method-name": "read_card",
+        "x-fern-sdk-method-name": "scan_card",
         "x-fern-sdk-return-value": "action_attempt",
         "x-response-key": "action_attempt",
         "x-undocumented": "Reading a card is currently unimplemented."