@seamapi/types 1.476.0 → 1.478.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,19 +29098,22 @@ 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<{
-    workspace_id: z.ZodString;
     customization_profile_id: z.ZodString;
+    workspace_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, {
     workspace_id: string;
+    created_at: string;
     customization_profile_id: string;
     logo_url?: string | undefined;
     primary_color?: string | undefined;
     secondary_color?: string | undefined;
 }, {
     workspace_id: string;
+    created_at: string;
     customization_profile_id: string;
     logo_url?: string | undefined;
     primary_color?: string | undefined;
@@ -58726,6 +58847,12 @@ declare const _default: {
                                         batch: {
                                             description: string;
                                             properties: {
+                                                access_grants: {
+                                                    items: {
+                                                        $ref: string;
+                                                    };
+                                                    type: string;
+                                                };
                                                 access_methods: {
                                                     items: {
                                                         $ref: string;
@@ -58917,6 +59044,12 @@ declare const _default: {
                                         batch: {
                                             description: string;
                                             properties: {
+                                                access_grants: {
+                                                    items: {
+                                                        $ref: string;
+                                                    };
+                                                    type: string;
+                                                };
                                                 access_methods: {
                                                     items: {
                                                         $ref: string;
@@ -88352,12 +88485,18 @@ declare const _default: {
                                 schema: {
                                     properties: {
                                         customization_profile: {
+                                            description: string;
                                             properties: {
+                                                created_at: {
+                                                    format: string;
+                                                    type: string;
+                                                };
                                                 customization_profile_id: {
                                                     format: string;
                                                     type: string;
                                                 };
                                                 logo_url: {
+                                                    format: string;
                                                     type: string;
                                                 };
                                                 primary_color: {
@@ -88373,6 +88512,9 @@ declare const _default: {
                                             };
                                             required: string[];
                                             type: string;
+                                            'x-route-path': string;
+                                            'x-title': string;
+                                            'x-undocumented': string;
                                         };
                                         ok: {
                                             type: string;
@@ -88402,6 +88544,7 @@ declare const _default: {
                 'x-fern-sdk-return-value': string;
                 'x-response-key': string;
                 'x-title': string;
+                'x-undocumented': string;
             };
         };
         '/workspaces/customization_profiles/get': {
@@ -88424,12 +88567,18 @@ declare const _default: {
                                 schema: {
                                     properties: {
                                         customization_profile: {
+                                            description: string;
                                             properties: {
+                                                created_at: {
+                                                    format: string;
+                                                    type: string;
+                                                };
                                                 customization_profile_id: {
                                                     format: string;
                                                     type: string;
                                                 };
                                                 logo_url: {
+                                                    format: string;
                                                     type: string;
                                                 };
                                                 primary_color: {
@@ -88445,6 +88594,9 @@ declare const _default: {
                                             };
                                             required: string[];
                                             type: string;
+                                            'x-route-path': string;
+                                            'x-title': string;
+                                            'x-undocumented': string;
                                         };
                                         ok: {
                                             type: string;
@@ -88474,6 +88626,7 @@ declare const _default: {
                 'x-fern-sdk-return-value': string;
                 'x-response-key': string;
                 'x-title': string;
+                'x-undocumented': string;
             };
             post: {
                 description: string;
@@ -88501,12 +88654,18 @@ declare const _default: {
                                 schema: {
                                     properties: {
                                         customization_profile: {
+                                            description: string;
                                             properties: {
+                                                created_at: {
+                                                    format: string;
+                                                    type: string;
+                                                };
                                                 customization_profile_id: {
                                                     format: string;
                                                     type: string;
                                                 };
                                                 logo_url: {
+                                                    format: string;
                                                     type: string;
                                                 };
                                                 primary_color: {
@@ -88522,6 +88681,9 @@ declare const _default: {
                                             };
                                             required: string[];
                                             type: string;
+                                            'x-route-path': string;
+                                            'x-title': string;
+                                            'x-undocumented': string;
                                         };
                                         ok: {
                                             type: string;
@@ -88551,6 +88713,7 @@ declare const _default: {
                 'x-fern-sdk-return-value': string;
                 'x-response-key': string;
                 'x-title': string;
+                'x-undocumented': string;
             };
         };
         '/workspaces/customization_profiles/list': {
@@ -88565,12 +88728,18 @@ declare const _default: {
                                     properties: {
                                         customization_profiles: {
                                             items: {
+                                                description: string;
                                                 properties: {
+                                                    created_at: {
+                                                        format: string;
+                                                        type: string;
+                                                    };
                                                     customization_profile_id: {
                                                         format: string;
                                                         type: string;
                                                     };
                                                     logo_url: {
+                                                        format: string;
                                                         type: string;
                                                     };
                                                     primary_color: {
@@ -88586,6 +88755,9 @@ declare const _default: {
                                                 };
                                                 required: string[];
                                                 type: string;
+                                                'x-route-path': string;
+                                                'x-title': string;
+                                                'x-undocumented': string;
                                             };
                                             type: string;
                                         };
@@ -88617,6 +88789,7 @@ declare const _default: {
                 'x-fern-sdk-return-value': string;
                 'x-response-key': string;
                 'x-title': string;
+                'x-undocumented': string;
             };
             post: {
                 description: string;
@@ -88629,12 +88802,18 @@ declare const _default: {
                                     properties: {
                                         customization_profiles: {
                                             items: {
+                                                description: string;
                                                 properties: {
+                                                    created_at: {
+                                                        format: string;
+                                                        type: string;
+                                                    };
                                                     customization_profile_id: {
                                                         format: string;
                                                         type: string;
                                                     };
                                                     logo_url: {
+                                                        format: string;
                                                         type: string;
                                                     };
                                                     primary_color: {
@@ -88650,6 +88829,9 @@ declare const _default: {
                                                 };
                                                 required: string[];
                                                 type: string;
+                                                'x-route-path': string;
+                                                'x-title': string;
+                                                'x-undocumented': string;
                                             };
                                             type: string;
                                         };
@@ -88681,6 +88863,7 @@ declare const _default: {
                 'x-fern-sdk-return-value': string;
                 'x-response-key': string;
                 'x-title': string;
+                'x-undocumented': string;
             };
         };
         '/workspaces/customization_profiles/update': {
@@ -88742,6 +88925,7 @@ declare const _default: {
                 'x-fern-sdk-method-name': string;
                 'x-response-key': null;
                 'x-title': string;
+                'x-undocumented': string;
             };
             post: {
                 description: string;
@@ -88801,6 +88985,7 @@ declare const _default: {
                 'x-fern-sdk-method-name': string;
                 'x-response-key': null;
                 'x-title': string;
+                'x-undocumented': string;
             };
         };
         '/workspaces/customization_profiles/upload_images': {
@@ -88865,6 +89050,12 @@ declare const _default: {
                                         batch: {
                                             description: string;
                                             properties: {
+                                                access_grants: {
+                                                    items: {
+                                                        $ref: string;
+                                                    };
+                                                    type: string;
+                                                };
                                                 access_methods: {
                                                     items: {
                                                         $ref: string;
@@ -89031,6 +89222,12 @@ declare const _default: {
                                         batch: {
                                             description: string;
                                             properties: {
+                                                access_grants: {
+                                                    items: {
+                                                        $ref: string;
+                                                    };
+                                                    type: string;
+                                                };
                                                 access_methods: {
                                                     items: {
                                                         $ref: string;
@@ -106626,6 +106823,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;
             };
         };
     };
@@ -165439,9 +165678,11 @@ type Routes = {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /** A customization profile. */
             customization_profile: {
-                workspace_id: string;
                 customization_profile_id: string;
+                workspace_id: string;
+                created_at: string;
                 logo_url?: string | undefined;
                 primary_color?: string | undefined;
                 secondary_color?: string | undefined;
@@ -165458,9 +165699,11 @@ type Routes = {
         };
         formData: {};
         jsonResponse: {
+            /** A customization profile. */
             customization_profile: {
-                workspace_id: string;
                 customization_profile_id: string;
+                workspace_id: string;
+                created_at: string;
                 logo_url?: string | undefined;
                 primary_color?: string | undefined;
                 secondary_color?: string | undefined;
@@ -165476,8 +165719,9 @@ type Routes = {
         formData: {};
         jsonResponse: {
             customization_profiles: {
-                workspace_id: string;
                 customization_profile_id: string;
+                workspace_id: string;
+                created_at: string;
                 logo_url?: string | undefined;
                 primary_color?: string | undefined;
                 secondary_color?: string | undefined;
@@ -169269,6 +169513,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;
             };
         };
     };