@seamapi/types 1.477.0 → 1.479.0

package/dist/connect.d.cts

@@ -23870,6 +23870,80 @@ declare const batch: z.ZodObject<{
         instant_key_url?: string | undefined;
         is_encoding_required?: boolean | undefined;
     }>, "many">>;
+    access_grants: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        workspace_id: z.ZodString;
+        access_grant_id: z.ZodString;
+        access_grant_key: z.ZodOptional<z.ZodString>;
+        user_identity_id: z.ZodString;
+        location_ids: z.ZodArray<z.ZodString, "many">;
+        space_ids: z.ZodArray<z.ZodString, "many">;
+        requested_access_methods: z.ZodArray<z.ZodObject<{
+            display_name: z.ZodString;
+            mode: z.ZodEnum<["code", "card", "mobile_key"]>;
+            created_at: z.ZodString;
+            created_access_method_ids: z.ZodArray<z.ZodString, "many">;
+        }, "strip", z.ZodTypeAny, {
+            display_name: string;
+            created_at: string;
+            mode: "code" | "card" | "mobile_key";
+            created_access_method_ids: string[];
+        }, {
+            display_name: string;
+            created_at: string;
+            mode: "code" | "card" | "mobile_key";
+            created_access_method_ids: string[];
+        }>, "many">;
+        access_method_ids: z.ZodArray<z.ZodString, "many">;
+        client_session_token: z.ZodOptional<z.ZodString>;
+        name: z.ZodNullable<z.ZodString>;
+        display_name: z.ZodString;
+        instant_key_url: z.ZodOptional<z.ZodString>;
+        created_at: z.ZodString;
+        starts_at: z.ZodString;
+        ends_at: z.ZodNullable<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        name: string | null;
+        display_name: string;
+        workspace_id: string;
+        created_at: string;
+        starts_at: string;
+        ends_at: string | null;
+        access_grant_id: string;
+        user_identity_id: string;
+        location_ids: string[];
+        space_ids: string[];
+        requested_access_methods: {
+            display_name: string;
+            created_at: string;
+            mode: "code" | "card" | "mobile_key";
+            created_access_method_ids: string[];
+        }[];
+        access_method_ids: string[];
+        access_grant_key?: string | undefined;
+        client_session_token?: string | undefined;
+        instant_key_url?: string | undefined;
+    }, {
+        name: string | null;
+        display_name: string;
+        workspace_id: string;
+        created_at: string;
+        starts_at: string;
+        ends_at: string | null;
+        access_grant_id: string;
+        user_identity_id: string;
+        location_ids: string[];
+        space_ids: string[];
+        requested_access_methods: {
+            display_name: string;
+            created_at: string;
+            mode: "code" | "card" | "mobile_key";
+            created_access_method_ids: string[];
+        }[];
+        access_method_ids: string[];
+        access_grant_key?: string | undefined;
+        client_session_token?: string | undefined;
+        instant_key_url?: string | undefined;
+    }>, "many">>;
 }, "strip", z.ZodTypeAny, {
     batch_type: "spaces" | "access_grants" | "access_methods" | "workspaces";
     spaces?: {
@@ -24664,6 +24738,28 @@ declare const batch: z.ZodObject<{
         system_type?: "assa_abloy_credential_service" | "assa_abloy_vostio" | "assa_abloy_vostio_credential_service" | "pti_site" | "alta_org" | "salto_ks_site" | "salto_space_system" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "latch_building" | "dormakaba_community_site" | "dormakaba_ambiance_site" | "legic_connect_credential_service" | undefined;
         system_type_display_name?: string | undefined;
     }[] | undefined;
+    access_grants?: {
+        name: string | null;
+        display_name: string;
+        workspace_id: string;
+        created_at: string;
+        starts_at: string;
+        ends_at: string | null;
+        access_grant_id: string;
+        user_identity_id: string;
+        location_ids: string[];
+        space_ids: string[];
+        requested_access_methods: {
+            display_name: string;
+            created_at: string;
+            mode: "code" | "card" | "mobile_key";
+            created_access_method_ids: string[];
+        }[];
+        access_method_ids: string[];
+        access_grant_key?: string | undefined;
+        client_session_token?: string | undefined;
+        instant_key_url?: string | undefined;
+    }[] | undefined;
     user_identities?: {
         display_name: string;
         workspace_id: string;
@@ -26796,6 +26892,28 @@ declare const batch: z.ZodObject<{
         system_type?: "assa_abloy_credential_service" | "assa_abloy_vostio" | "assa_abloy_vostio_credential_service" | "pti_site" | "alta_org" | "salto_ks_site" | "salto_space_system" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "latch_building" | "dormakaba_community_site" | "dormakaba_ambiance_site" | "legic_connect_credential_service" | undefined;
         system_type_display_name?: string | undefined;
     }[] | undefined;
+    access_grants?: {
+        name: string | null;
+        display_name: string;
+        workspace_id: string;
+        created_at: string;
+        starts_at: string;
+        ends_at: string | null;
+        access_grant_id: string;
+        user_identity_id: string;
+        location_ids: string[];
+        space_ids: string[];
+        requested_access_methods: {
+            display_name: string;
+            created_at: string;
+            mode: "code" | "card" | "mobile_key";
+            created_access_method_ids: string[];
+        }[];
+        access_method_ids: string[];
+        access_grant_key?: string | undefined;
+        client_session_token?: string | undefined;
+        instant_key_url?: string | undefined;
+    }[] | undefined;
     user_identities?: {
         display_name: string;
         workspace_id: string;
@@ -28980,13 +29098,15 @@ declare const custom_metadata: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString,
 type CustomMetadata = z.output<typeof custom_metadata>;
 
 declare const customization_profile: z.ZodObject<{
-    customization_profile_id: z.ZodString;
     workspace_id: z.ZodString;
+    name: z.ZodNullable<z.ZodString>;
+    customization_profile_id: z.ZodString;
     created_at: z.ZodString;
     logo_url: z.ZodOptional<z.ZodString>;
     primary_color: z.ZodOptional<z.ZodString>;
     secondary_color: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
+    name: string | null;
     workspace_id: string;
     created_at: string;
     customization_profile_id: string;
@@ -28994,6 +29114,7 @@ declare const customization_profile: z.ZodObject<{
     primary_color?: string | undefined;
     secondary_color?: string | undefined;
 }, {
+    name: string | null;
     workspace_id: string;
     created_at: string;
     customization_profile_id: string;
@@ -58729,6 +58850,12 @@ declare const _default: {
                                         batch: {
                                             description: string;
                                             properties: {
+                                                access_grants: {
+                                                    items: {
+                                                        $ref: string;
+                                                    };
+                                                    type: string;
+                                                };
                                                 access_methods: {
                                                     items: {
                                                         $ref: string;
@@ -58920,6 +59047,12 @@ declare const _default: {
                                         batch: {
                                             description: string;
                                             properties: {
+                                                access_grants: {
+                                                    items: {
+                                                        $ref: string;
+                                                    };
+                                                    type: string;
+                                                };
                                                 access_methods: {
                                                     items: {
                                                         $ref: string;
@@ -88335,6 +88468,11 @@ declare const _default: {
                         'application/json': {
                             schema: {
                                 properties: {
+                                    name: {
+                                        default: null;
+                                        nullable: boolean;
+                                        type: string;
+                                    };
                                     primary_color: {
                                         type: string;
                                     };
@@ -88369,6 +88507,10 @@ declare const _default: {
                                                     format: string;
                                                     type: string;
                                                 };
+                                                name: {
+                                                    nullable: boolean;
+                                                    type: string;
+                                                };
                                                 primary_color: {
                                                     type: string;
                                                 };
@@ -88451,6 +88593,10 @@ declare const _default: {
                                                     format: string;
                                                     type: string;
                                                 };
+                                                name: {
+                                                    nullable: boolean;
+                                                    type: string;
+                                                };
                                                 primary_color: {
                                                     type: string;
                                                 };
@@ -88538,6 +88684,10 @@ declare const _default: {
                                                     format: string;
                                                     type: string;
                                                 };
+                                                name: {
+                                                    nullable: boolean;
+                                                    type: string;
+                                                };
                                                 primary_color: {
                                                     type: string;
                                                 };
@@ -88612,6 +88762,10 @@ declare const _default: {
                                                         format: string;
                                                         type: string;
                                                     };
+                                                    name: {
+                                                        nullable: boolean;
+                                                        type: string;
+                                                    };
                                                     primary_color: {
                                                         type: string;
                                                     };
@@ -88686,6 +88840,10 @@ declare const _default: {
                                                         format: string;
                                                         type: string;
                                                     };
+                                                    name: {
+                                                        nullable: boolean;
+                                                        type: string;
+                                                    };
                                                     primary_color: {
                                                         type: string;
                                                     };
@@ -88749,6 +88907,10 @@ declare const _default: {
                                         format: string;
                                         type: string;
                                     };
+                                    name: {
+                                        nullable: boolean;
+                                        type: string;
+                                    };
                                     primary_color: {
                                         type: string;
                                     };
@@ -88809,6 +88971,10 @@ declare const _default: {
                                         format: string;
                                         type: string;
                                     };
+                                    name: {
+                                        nullable: boolean;
+                                        type: string;
+                                    };
                                     primary_color: {
                                         type: string;
                                     };
@@ -88920,6 +89086,12 @@ declare const _default: {
                                         batch: {
                                             description: string;
                                             properties: {
+                                                access_grants: {
+                                                    items: {
+                                                        $ref: string;
+                                                    };
+                                                    type: string;
+                                                };
                                                 access_methods: {
                                                     items: {
                                                         $ref: string;
@@ -89086,6 +89258,12 @@ declare const _default: {
                                         batch: {
                                             description: string;
                                             properties: {
+                                                access_grants: {
+                                                    items: {
+                                                        $ref: string;
+                                                    };
+                                                    type: string;
+                                                };
                                                 access_methods: {
                                                     items: {
                                                         $ref: string;
@@ -106681,6 +106859,48 @@ type Routes = {
                     /** The actual PIN code for code access methods. */
                     code?: string | undefined;
                 }[] | undefined;
+                access_grants?: {
+                    /** ID of the Seam workspace associated with the Access Grant. */
+                    workspace_id: string;
+                    /** ID of the Access Grant. */
+                    access_grant_id: string;
+                    /** Unique key for the access grant within the workspace. */
+                    access_grant_key?: string | undefined;
+                    /** ID of user identity to which the Access Grant gives access. */
+                    user_identity_id: string;
+                    /**
+                     * @deprecated Use `space_ids`.*/
+                    location_ids: string[];
+                    /** IDs of the spaces to which the Access Grant gives access. */
+                    space_ids: string[];
+                    /** Access methods that the user requested for the Access Grant. */
+                    requested_access_methods: {
+                        /** 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 requested access method was added to the Access Grant. */
+                        created_at: string;
+                        /** IDs of the access methods created for the requested access method. */
+                        created_access_method_ids: string[];
+                    }[];
+                    /** IDs of the access methods created for the Access Grant. */
+                    access_method_ids: string[];
+                    /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
+                    client_session_token?: string | undefined;
+                    /** Name of the Access Grant. If not provided, the display name will be computed. */
+                    name: string | null;
+                    /** Display name of the Access Grant. */
+                    display_name: string;
+                    /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method.  */
+                    instant_key_url?: string | undefined;
+                    /** Date and time at which the Access Grant was created. */
+                    created_at: string;
+                    /** Date and time at which the Access Grant starts. */
+                    starts_at: string;
+                    /** Date and time at which the Access Grant ends. */
+                    ends_at: string | null;
+                }[] | undefined;
             };
         };
     };
@@ -165488,6 +165708,7 @@ type Routes = {
         method: 'POST';
         queryParams: {};
         jsonBody: {
+            name?: string | null;
             primary_color: string;
             secondary_color: string;
         };
@@ -165496,8 +165717,9 @@ type Routes = {
         jsonResponse: {
             /** A customization profile. */
             customization_profile: {
-                customization_profile_id: string;
                 workspace_id: string;
+                name: string | null;
+                customization_profile_id: string;
                 created_at: string;
                 logo_url?: string | undefined;
                 primary_color?: string | undefined;
@@ -165517,8 +165739,9 @@ type Routes = {
         jsonResponse: {
             /** A customization profile. */
             customization_profile: {
-                customization_profile_id: string;
                 workspace_id: string;
+                name: string | null;
+                customization_profile_id: string;
                 created_at: string;
                 logo_url?: string | undefined;
                 primary_color?: string | undefined;
@@ -165535,8 +165758,9 @@ type Routes = {
         formData: {};
         jsonResponse: {
             customization_profiles: {
-                customization_profile_id: string;
                 workspace_id: string;
+                name: string | null;
+                customization_profile_id: string;
                 created_at: string;
                 logo_url?: string | undefined;
                 primary_color?: string | undefined;
@@ -165550,6 +165774,7 @@ type Routes = {
         queryParams: {};
         jsonBody: {
             customization_profile_id: string;
+            name?: (string | undefined) | null;
             primary_color?: string | undefined;
             secondary_color?: string | undefined;
         };
@@ -169329,6 +169554,48 @@ type Routes = {
                     /** The actual PIN code for code access methods. */
                     code?: string | undefined;
                 }[] | undefined;
+                access_grants?: {
+                    /** ID of the Seam workspace associated with the Access Grant. */
+                    workspace_id: string;
+                    /** ID of the Access Grant. */
+                    access_grant_id: string;
+                    /** Unique key for the access grant within the workspace. */
+                    access_grant_key?: string | undefined;
+                    /** ID of user identity to which the Access Grant gives access. */
+                    user_identity_id: string;
+                    /**
+                     * @deprecated Use `space_ids`.*/
+                    location_ids: string[];
+                    /** IDs of the spaces to which the Access Grant gives access. */
+                    space_ids: string[];
+                    /** Access methods that the user requested for the Access Grant. */
+                    requested_access_methods: {
+                        /** 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 requested access method was added to the Access Grant. */
+                        created_at: string;
+                        /** IDs of the access methods created for the requested access method. */
+                        created_access_method_ids: string[];
+                    }[];
+                    /** IDs of the access methods created for the Access Grant. */
+                    access_method_ids: string[];
+                    /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
+                    client_session_token?: string | undefined;
+                    /** Name of the Access Grant. If not provided, the display name will be computed. */
+                    name: string | null;
+                    /** Display name of the Access Grant. */
+                    display_name: string;
+                    /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method.  */
+                    instant_key_url?: string | undefined;
+                    /** Date and time at which the Access Grant was created. */
+                    created_at: string;
+                    /** Date and time at which the Access Grant starts. */
+                    starts_at: string;
+                    /** Date and time at which the Access Grant ends. */
+                    ends_at: string | null;
+                }[] | undefined;
             };
         };
     };