@seamapi/types 1.473.0 → 1.474.0

package/dist/connect.d.cts

@@ -23833,6 +23833,43 @@ declare const batch: z.ZodObject<{
         selected_provider: string | null;
         customer_key?: string | undefined;
     }>, "many">>;
+    access_methods: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        workspace_id: z.ZodString;
+        access_method_id: z.ZodString;
+        display_name: z.ZodString;
+        mode: z.ZodEnum<["code", "card", "mobile_key"]>;
+        created_at: z.ZodString;
+        issued_at: z.ZodNullable<z.ZodString>;
+        is_issued: z.ZodBoolean;
+        instant_key_url: z.ZodOptional<z.ZodString>;
+        client_session_token: z.ZodOptional<z.ZodString>;
+        is_encoding_required: z.ZodOptional<z.ZodBoolean>;
+        code: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        display_name: string;
+        workspace_id: string;
+        created_at: string;
+        mode: "code" | "card" | "mobile_key";
+        access_method_id: string;
+        issued_at: string | null;
+        is_issued: boolean;
+        code?: string | undefined;
+        client_session_token?: string | undefined;
+        instant_key_url?: string | undefined;
+        is_encoding_required?: boolean | undefined;
+    }, {
+        display_name: string;
+        workspace_id: string;
+        created_at: string;
+        mode: "code" | "card" | "mobile_key";
+        access_method_id: string;
+        issued_at: string | null;
+        is_issued: boolean;
+        code?: string | undefined;
+        client_session_token?: string | undefined;
+        instant_key_url?: string | undefined;
+        is_encoding_required?: boolean | undefined;
+    }>, "many">>;
 }, "strip", z.ZodTypeAny, {
     batch_type: "spaces" | "access_grants" | "access_methods" | "workspaces";
     spaces?: {
@@ -24654,6 +24691,19 @@ declare const batch: z.ZodObject<{
         user_identity_key: string | null;
         acs_user_ids: string[];
     }[] | undefined;
+    access_methods?: {
+        display_name: string;
+        workspace_id: string;
+        created_at: string;
+        mode: "code" | "card" | "mobile_key";
+        access_method_id: string;
+        issued_at: string | null;
+        is_issued: boolean;
+        code?: string | undefined;
+        client_session_token?: string | undefined;
+        instant_key_url?: string | undefined;
+        is_encoding_required?: boolean | undefined;
+    }[] | undefined;
     workspaces?: {
         name: string;
         workspace_id: string;
@@ -26773,6 +26823,19 @@ declare const batch: z.ZodObject<{
         user_identity_key: string | null;
         acs_user_ids: string[];
     }[] | undefined;
+    access_methods?: {
+        display_name: string;
+        workspace_id: string;
+        created_at: string;
+        mode: "code" | "card" | "mobile_key";
+        access_method_id: string;
+        issued_at: string | null;
+        is_issued: boolean;
+        code?: string | undefined;
+        client_session_token?: string | undefined;
+        instant_key_url?: string | undefined;
+        is_encoding_required?: boolean | undefined;
+    }[] | undefined;
     workspaces?: {
         name: string;
         workspace_id: string;
@@ -58642,6 +58705,12 @@ declare const _default: {
                                         batch: {
                                             description: string;
                                             properties: {
+                                                access_methods: {
+                                                    items: {
+                                                        $ref: string;
+                                                    };
+                                                    type: string;
+                                                };
                                                 acs_access_groups: {
                                                     items: {
                                                         $ref: string;
@@ -58827,6 +58896,12 @@ declare const _default: {
                                         batch: {
                                             description: string;
                                             properties: {
+                                                access_methods: {
+                                                    items: {
+                                                        $ref: string;
+                                                    };
+                                                    type: string;
+                                                };
                                                 acs_access_groups: {
                                                     items: {
                                                         $ref: string;
@@ -88249,6 +88324,12 @@ declare const _default: {
                                         batch: {
                                             description: string;
                                             properties: {
+                                                access_methods: {
+                                                    items: {
+                                                        $ref: string;
+                                                    };
+                                                    type: string;
+                                                };
                                                 acs_access_groups: {
                                                     items: {
                                                         $ref: string;
@@ -88409,6 +88490,12 @@ declare const _default: {
                                         batch: {
                                             description: string;
                                             properties: {
+                                                access_methods: {
+                                                    items: {
+                                                        $ref: string;
+                                                    };
+                                                    type: string;
+                                                };
                                                 acs_access_groups: {
                                                     items: {
                                                         $ref: string;
@@ -105974,6 +106061,30 @@ type Routes = {
                     /** The customer key associated with this webview, if any. */
                     customer_key?: string | undefined;
                 }[] | 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 | undefined;
+                }[] | undefined;
             };
         };
     };
@@ -168515,6 +168626,30 @@ type Routes = {
                     /** The customer key associated with this webview, if any. */
                     customer_key?: string | undefined;
                 }[] | 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 | undefined;
+                }[] | undefined;
             };
         };
     };

package/dist/index.cjs

@@ -2265,6 +2265,29 @@ var unmanaged_access_code = access_code.pick({
     
     - [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks)
   `);
+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."),
+  display_name: zod.z.string().describe("Display name of the access method."),
+  mode: zod.z.enum(["code", "card", "mobile_key"]).describe(
+    "Access method mode. Supported values: `code`, `card`, `mobile_key`."
+  ),
+  created_at: zod.z.string().datetime().describe("Date and time at which the access method was created."),
+  issued_at: zod.z.string().datetime().nullable().describe("Date and time at which the access method was issued."),
+  is_issued: zod.z.boolean().describe("Indicates whether the access method has been issued."),
+  instant_key_url: zod.z.string().url().optional().describe("URL of the Instant Key for mobile key access methods."),
+  client_session_token: zod.z.string().optional().describe("Token of the client session associated with the access method."),
+  is_encoding_required: zod.z.boolean().optional().describe(
+    "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().optional().describe("The actual PIN code for code access methods.")
+}).describe(`
+  ---
+  draft: Early access.
+  route_path: /access_methods
+  ---
+  Represents an access method for an Access Grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key.
+  `);
 var acs_access_group_external_type = zod.z.enum([
   "pti_unit",
   "pti_access_level",
@@ -4134,7 +4157,8 @@ zod.z.object({
   unmanaged_acs_users: unmanaged_acs_user.array().optional(),
   unmanaged_acs_access_groups: unmanaged_acs_access_group.array().optional(),
   unmanaged_devices: unmanaged_device.array().optional(),
-  connect_webviews: connect_webview.array().optional()
+  connect_webviews: connect_webview.array().optional(),
+  access_methods: access_method.array().optional()
 }).describe("A batch of workspace resources.");
 var batch = zod.z.object({
   batch_type: zod.z.enum([
@@ -4157,7 +4181,8 @@ var batch = zod.z.object({
   unmanaged_acs_users: unmanaged_acs_user.array().optional(),
   unmanaged_acs_access_groups: unmanaged_acs_access_group.array().optional(),
   unmanaged_devices: unmanaged_device.array().optional(),
-  connect_webviews: connect_webview.array().optional()
+  connect_webviews: connect_webview.array().optional(),
+  access_methods: access_method.array().optional()
 }).describe("A batch of workspace resources.");
 var bridge = zod.z.object({
   bridge_id: zod.z.string().uuid().describe("ID of Seam Bridge."),
@@ -31685,6 +31710,10 @@ var openapi_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"
@@ -31842,6 +31871,10 @@ var openapi_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"
@@ -57216,6 +57249,10 @@ var openapi_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"
@@ -57350,6 +57387,10 @@ var openapi_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"