@seamapi/types 1.43.0 → 1.44.0

package/dist/connect.d.cts

@@ -13,39 +13,65 @@ declare const connect_webview: z.ZodObject<{
     created_at: z.ZodString;
     login_successful: z.ZodBoolean;
     status: z.ZodEnum<["pending", "failed", "authorized"]>;
+    custom_redirect_url: z.ZodNullable<z.ZodString>;
+    custom_redirect_failure_url: z.ZodNullable<z.ZodString>;
+    custom_metadata: z.ZodEffects<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodNull, z.ZodBoolean]>>, Record<string, string | number | boolean | null>, Record<string, string | number | boolean | null>>;
+    automatically_manage_new_devices: z.ZodBoolean;
+    wait_for_device_creation: z.ZodBoolean;
+    authorized_at: z.ZodNullable<z.ZodString>;
+    selected_provider: z.ZodNullable<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
+    status: "pending" | "failed" | "authorized";
     connect_webview_id: string;
     url: string;
     workspace_id: string;
     device_selection_mode: "none" | "single" | "multiple";
-    status: "pending" | "failed" | "authorized";
     accepted_providers: string[];
     accepted_devices: string[];
     any_provider_allowed: boolean;
     any_device_allowed: boolean;
     created_at: string;
     login_successful: boolean;
+    custom_redirect_url: string | null;
+    custom_redirect_failure_url: string | null;
+    custom_metadata: Record<string, string | number | boolean | null>;
+    automatically_manage_new_devices: boolean;
+    wait_for_device_creation: boolean;
+    authorized_at: string | null;
+    selected_provider: string | null;
     connected_account_id?: string | undefined;
 }, {
+    status: "pending" | "failed" | "authorized";
     connect_webview_id: string;
     url: string;
     workspace_id: string;
     device_selection_mode: "none" | "single" | "multiple";
-    status: "pending" | "failed" | "authorized";
     accepted_providers: string[];
     accepted_devices: string[];
     any_provider_allowed: boolean;
     any_device_allowed: boolean;
     created_at: string;
     login_successful: boolean;
+    custom_redirect_url: string | null;
+    custom_redirect_failure_url: string | null;
+    custom_metadata: Record<string, string | number | boolean | null>;
+    automatically_manage_new_devices: boolean;
+    wait_for_device_creation: boolean;
+    authorized_at: string | null;
+    selected_provider: string | null;
     connected_account_id?: string | undefined;
 }>;
 type ConnectWebview = z.infer<typeof connect_webview>;
 
+declare const custom_metadata: z.ZodEffects<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodNull, z.ZodBoolean]>>, Record<string, string | number | boolean | null>, Record<string, string | number | boolean | null>>;
+type CustomMetadata = z.infer<typeof custom_metadata>;
+
 declare const schemas_connect_webview: typeof connect_webview;
+declare const schemas_custom_metadata: typeof custom_metadata;
 declare namespace schemas {
   export {
     schemas_connect_webview as connect_webview,
+    schemas_custom_metadata as custom_metadata,
   };
 }
 
@@ -488,6 +514,14 @@ declare const _default: {
                     any_provider_allowed: {
                         type: string;
                     };
+                    authorized_at: {
+                        format: string;
+                        nullable: boolean;
+                        type: string;
+                    };
+                    automatically_manage_new_devices: {
+                        type: string;
+                    };
                     connect_webview_id: {
                         format: string;
                         type: string;
@@ -500,6 +534,38 @@ declare const _default: {
                         format: string;
                         type: string;
                     };
+                    custom_metadata: {
+                        additionalProperties: {
+                            nullable: boolean;
+                            oneOf: ({
+                                maxLength: number;
+                                type: string;
+                                format?: never;
+                                nullable?: never;
+                            } | {
+                                type: string;
+                                maxLength?: never;
+                                format?: never;
+                                nullable?: never;
+                            } | {
+                                format: string;
+                                nullable: boolean;
+                                type: string;
+                                maxLength?: never;
+                            })[];
+                        };
+                        type: string;
+                    };
+                    custom_redirect_failure_url: {
+                        format: string;
+                        nullable: boolean;
+                        type: string;
+                    };
+                    custom_redirect_url: {
+                        format: string;
+                        nullable: boolean;
+                        type: string;
+                    };
                     device_selection_mode: {
                         enum: string[];
                         type: string;
@@ -507,6 +573,10 @@ declare const _default: {
                     login_successful: {
                         type: string;
                     };
+                    selected_provider: {
+                        nullable: boolean;
+                        type: string;
+                    };
                     status: {
                         enum: string[];
                         type: string;
@@ -515,6 +585,9 @@ declare const _default: {
                         format: string;
                         type: string;
                     };
+                    wait_for_device_creation: {
+                        type: string;
+                    };
                     workspace_id: {
                         format: string;
                         type: string;
@@ -4628,6 +4701,141 @@ declare const _default: {
                 'x-fern-sdk-method-name': string;
             };
         };
+        '/acs/credentials/assign': {
+            patch: {
+                operationId: string;
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                properties: {
+                                    acs_credential_id: {
+                                        format: string;
+                                        type: string;
+                                    };
+                                    acs_user_id: {
+                                        format: string;
+                                        type: string;
+                                    };
+                                };
+                                required: string[];
+                                type: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        ok: {
+                                            type: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: ({
+                    access_token: never[];
+                    seam_workspace: never[];
+                    seam_client_session_token?: never;
+                    client_session_token?: never;
+                } | {
+                    seam_client_session_token: never[];
+                    access_token?: never;
+                    seam_workspace?: never;
+                    client_session_token?: never;
+                } | {
+                    client_session_token: never[];
+                    access_token?: never;
+                    seam_workspace?: never;
+                    seam_client_session_token?: never;
+                })[];
+                summary: string;
+                tags: never[];
+                'x-fern-ignore': boolean;
+            };
+            post: {
+                operationId: string;
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                properties: {
+                                    acs_credential_id: {
+                                        format: string;
+                                        type: string;
+                                    };
+                                    acs_user_id: {
+                                        format: string;
+                                        type: string;
+                                    };
+                                };
+                                required: string[];
+                                type: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        ok: {
+                                            type: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: ({
+                    access_token: never[];
+                    seam_workspace: never[];
+                    seam_client_session_token?: never;
+                    client_session_token?: never;
+                } | {
+                    seam_client_session_token: never[];
+                    access_token?: never;
+                    seam_workspace?: never;
+                    client_session_token?: never;
+                } | {
+                    client_session_token: never[];
+                    access_token?: never;
+                    seam_workspace?: never;
+                    seam_client_session_token?: never;
+                })[];
+                summary: string;
+                tags: never[];
+                'x-fern-sdk-group-name': string[];
+                'x-fern-sdk-method-name': string;
+            };
+        };
         '/acs/credentials/create': {
             post: {
                 operationId: string;
@@ -5032,6 +5240,141 @@ declare const _default: {
                 'x-fern-sdk-method-name': string;
             };
         };
+        '/acs/credentials/unassign': {
+            patch: {
+                operationId: string;
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                properties: {
+                                    acs_credential_id: {
+                                        format: string;
+                                        type: string;
+                                    };
+                                    acs_user_id: {
+                                        format: string;
+                                        type: string;
+                                    };
+                                };
+                                required: string[];
+                                type: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        ok: {
+                                            type: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: ({
+                    access_token: never[];
+                    seam_workspace: never[];
+                    seam_client_session_token?: never;
+                    client_session_token?: never;
+                } | {
+                    seam_client_session_token: never[];
+                    access_token?: never;
+                    seam_workspace?: never;
+                    client_session_token?: never;
+                } | {
+                    client_session_token: never[];
+                    access_token?: never;
+                    seam_workspace?: never;
+                    seam_client_session_token?: never;
+                })[];
+                summary: string;
+                tags: never[];
+                'x-fern-ignore': boolean;
+            };
+            post: {
+                operationId: string;
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                properties: {
+                                    acs_credential_id: {
+                                        format: string;
+                                        type: string;
+                                    };
+                                    acs_user_id: {
+                                        format: string;
+                                        type: string;
+                                    };
+                                };
+                                required: string[];
+                                type: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        ok: {
+                                            type: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: ({
+                    access_token: never[];
+                    seam_workspace: never[];
+                    seam_client_session_token?: never;
+                    client_session_token?: never;
+                } | {
+                    seam_client_session_token: never[];
+                    access_token?: never;
+                    seam_workspace?: never;
+                    client_session_token?: never;
+                } | {
+                    client_session_token: never[];
+                    access_token?: never;
+                    seam_workspace?: never;
+                    seam_client_session_token?: never;
+                })[];
+                summary: string;
+                tags: never[];
+                'x-fern-sdk-group-name': string[];
+                'x-fern-sdk-method-name': string;
+            };
+        };
         '/acs/systems/get': {
             post: {
                 operationId: string;
@@ -5304,6 +5647,10 @@ declare const _default: {
                                         format: string;
                                         type: string;
                                     };
+                                    email_address: {
+                                        format: string;
+                                        type: string;
+                                    };
                                     full_name: {
                                         type: string;
                                     };
@@ -5774,6 +6121,10 @@ declare const _default: {
                                         format: string;
                                         type: string;
                                     };
+                                    email_address: {
+                                        format: string;
+                                        type: string;
+                                    };
                                     full_name: {
                                         type: string;
                                     };
@@ -5848,6 +6199,10 @@ declare const _default: {
                                         format: string;
                                         type: string;
                                     };
+                                    email_address: {
+                                        format: string;
+                                        type: string;
+                                    };
                                     full_name: {
                                         type: string;
                                     };
@@ -13031,7 +13386,7 @@ interface Routes {
                 workspace_id: string;
                 created_at: string;
                 display_name: string;
-                external_type: 'pti_user';
+                external_type: 'pti_user' | 'brivo_user';
                 external_type_display_name: string;
                 is_suspended: boolean;
                 full_name?: string | undefined;
@@ -13066,6 +13421,18 @@ interface Routes {
         formData: {};
         jsonResponse: {};
     };
+    '/acs/credentials/assign': {
+        route: '/acs/credentials/assign';
+        method: 'PATCH' | 'POST';
+        queryParams: {};
+        jsonBody: {
+            acs_user_id: string;
+            acs_credential_id: string;
+        };
+        commonParams: {};
+        formData: {};
+        jsonResponse: {};
+    };
     '/acs/credentials/create': {
         route: '/acs/credentials/create';
         method: 'POST';
@@ -13079,10 +13446,10 @@ interface Routes {
         jsonResponse: {
             acs_credential: {
                 acs_credential_id: string;
-                acs_user_id: string;
+                acs_user_id?: string | undefined;
                 acs_system_id: string;
                 code: string | null;
-                external_type: 'pti_card';
+                external_type: 'pti_card' | 'brivo_credential';
                 external_type_display_name: string;
                 created_at: string;
                 workspace_id: string;
@@ -13112,10 +13479,10 @@ interface Routes {
         jsonResponse: {
             acs_credential: {
                 acs_credential_id: string;
-                acs_user_id: string;
+                acs_user_id?: string | undefined;
                 acs_system_id: string;
                 code: string | null;
-                external_type: 'pti_card';
+                external_type: 'pti_card' | 'brivo_credential';
                 external_type_display_name: string;
                 created_at: string;
                 workspace_id: string;
@@ -13139,16 +13506,28 @@ interface Routes {
         jsonResponse: {
             acs_credentials: Array<{
                 acs_credential_id: string;
-                acs_user_id: string;
+                acs_user_id?: string | undefined;
                 acs_system_id: string;
                 code: string | null;
-                external_type: 'pti_card';
+                external_type: 'pti_card' | 'brivo_credential';
                 external_type_display_name: string;
                 created_at: string;
                 workspace_id: string;
             }>;
         };
     };
+    '/acs/credentials/unassign': {
+        route: '/acs/credentials/unassign';
+        method: 'PATCH' | 'POST';
+        queryParams: {};
+        jsonBody: {
+            acs_user_id: string;
+            acs_credential_id: string;
+        };
+        commonParams: {};
+        formData: {};
+        jsonResponse: {};
+    };
     '/acs/systems/get': {
         route: '/acs/systems/get';
         method: 'GET' | 'POST';
@@ -13213,15 +13592,16 @@ interface Routes {
         route: '/acs/users/create';
         method: 'POST';
         queryParams: {};
-        jsonBody: {};
-        commonParams: {
+        jsonBody: {
             acs_system_id: string;
             acs_access_group_ids?: string[];
             full_name?: string | undefined;
             /** Deprecated: use email_address. */
             email?: string | undefined;
             phone_number?: string | undefined;
+            email_address?: string | undefined;
         };
+        commonParams: {};
         formData: {};
         jsonResponse: {
             acs_user: {
@@ -13230,7 +13610,7 @@ interface Routes {
                 workspace_id: string;
                 created_at: string;
                 display_name: string;
-                external_type: 'pti_user';
+                external_type: 'pti_user' | 'brivo_user';
                 external_type_display_name: string;
                 is_suspended: boolean;
                 full_name?: string | undefined;
@@ -13268,7 +13648,7 @@ interface Routes {
                 workspace_id: string;
                 created_at: string;
                 display_name: string;
-                external_type: 'pti_user';
+                external_type: 'pti_user' | 'brivo_user';
                 external_type_display_name: string;
                 is_suspended: boolean;
                 full_name?: string | undefined;
@@ -13295,7 +13675,7 @@ interface Routes {
                 workspace_id: string;
                 created_at: string;
                 display_name: string;
-                external_type: 'pti_user';
+                external_type: 'pti_user' | 'brivo_user';
                 external_type_display_name: string;
                 is_suspended: boolean;
                 full_name?: string | undefined;
@@ -13344,14 +13724,15 @@ interface Routes {
         route: '/acs/users/update';
         method: 'PATCH' | 'POST';
         queryParams: {};
-        jsonBody: {};
-        commonParams: {
+        jsonBody: {
             acs_user_id: string;
             full_name?: string | undefined;
             /** Deprecated: use email_address. */
             email?: string | undefined;
             phone_number?: string | undefined;
+            email_address?: string | undefined;
         };
+        commonParams: {};
         formData: {};
         jsonResponse: {};
     };
@@ -13597,6 +13978,13 @@ interface Routes {
                 created_at: string;
                 login_successful: boolean;
                 status: 'pending' | 'failed' | 'authorized';
+                custom_redirect_url: string | null;
+                custom_redirect_failure_url: string | null;
+                custom_metadata: Record<string, string | number | null | boolean>;
+                automatically_manage_new_devices: boolean;
+                wait_for_device_creation: boolean;
+                authorized_at: string | null;
+                selected_provider: string | null;
             };
         };
     };
@@ -13634,6 +14022,13 @@ interface Routes {
                 created_at: string;
                 login_successful: boolean;
                 status: 'pending' | 'failed' | 'authorized';
+                custom_redirect_url: string | null;
+                custom_redirect_failure_url: string | null;
+                custom_metadata: Record<string, string | number | null | boolean>;
+                automatically_manage_new_devices: boolean;
+                wait_for_device_creation: boolean;
+                authorized_at: string | null;
+                selected_provider: string | null;
             };
         };
     };
@@ -13660,6 +14055,13 @@ interface Routes {
                 created_at: string;
                 login_successful: boolean;
                 status: 'pending' | 'failed' | 'authorized';
+                custom_redirect_url: string | null;
+                custom_redirect_failure_url: string | null;
+                custom_metadata: Record<string, string | number | null | boolean>;
+                automatically_manage_new_devices: boolean;
+                wait_for_device_creation: boolean;
+                authorized_at: string | null;
+                selected_provider: string | null;
             }>;
         };
     };
@@ -14868,6 +15270,9 @@ interface Routes {
                     model: {
                         display_name: string;
                         manufacturer_display_name: string;
+                        offline_access_codes_supported?: boolean | undefined;
+                        access_codes_supported?: boolean | undefined;
+                        accessory_keypad_supported?: boolean | undefined;
                     };
                     has_direct_power?: boolean | undefined;
                     battery_level?: number | undefined;
@@ -14879,7 +15284,13 @@ interface Routes {
                     image_url?: string | undefined;
                     image_alt_text?: string | undefined;
                     serial_number?: string | undefined;
+                    /** Currently possible to use online access codes */
+                    online_access_codes_enabled?: boolean | undefined;
+                    /** Currently possible to use offline access codes */
+                    offline_access_codes_enabled?: boolean | undefined;
+                    /** Deprecated: use model.offline_access_codes_enabled. */
                     supports_accessory_keypad?: boolean | undefined;
+                    /** Deprecated: use model.accessory_keypad_supported. */
                     supports_offline_access_codes?: boolean | undefined;
                 } & {
                     august_metadata?: {
@@ -15256,6 +15667,9 @@ interface Routes {
                     model: {
                         display_name: string;
                         manufacturer_display_name: string;
+                        offline_access_codes_supported?: boolean | undefined;
+                        access_codes_supported?: boolean | undefined;
+                        accessory_keypad_supported?: boolean | undefined;
                     };
                     has_direct_power?: boolean | undefined;
                     battery_level?: number | undefined;
@@ -15267,7 +15681,13 @@ interface Routes {
                     image_url?: string | undefined;
                     image_alt_text?: string | undefined;
                     serial_number?: string | undefined;
+                    /** Currently possible to use online access codes */
+                    online_access_codes_enabled?: boolean | undefined;
+                    /** Currently possible to use offline access codes */
+                    offline_access_codes_enabled?: boolean | undefined;
+                    /** Deprecated: use model.offline_access_codes_enabled. */
                     supports_accessory_keypad?: boolean | undefined;
+                    /** Deprecated: use model.accessory_keypad_supported. */
                     supports_offline_access_codes?: boolean | undefined;
                 } & {
                     august_metadata?: {
@@ -15666,6 +16086,9 @@ interface Routes {
                     model: {
                         display_name: string;
                         manufacturer_display_name: string;
+                        offline_access_codes_supported?: boolean | undefined;
+                        access_codes_supported?: boolean | undefined;
+                        accessory_keypad_supported?: boolean | undefined;
                     };
                     has_direct_power?: boolean | undefined;
                     battery_level?: number | undefined;
@@ -15677,7 +16100,13 @@ interface Routes {
                     image_url?: string | undefined;
                     image_alt_text?: string | undefined;
                     serial_number?: string | undefined;
+                    /** Currently possible to use online access codes */
+                    online_access_codes_enabled?: boolean | undefined;
+                    /** Currently possible to use offline access codes */
+                    offline_access_codes_enabled?: boolean | undefined;
+                    /** Deprecated: use model.offline_access_codes_enabled. */
                     supports_accessory_keypad?: boolean | undefined;
+                    /** Deprecated: use model.accessory_keypad_supported. */
                     supports_offline_access_codes?: boolean | undefined;
                 } & {
                     august_metadata?: {
@@ -16054,6 +16483,9 @@ interface Routes {
                     model: {
                         display_name: string;
                         manufacturer_display_name: string;
+                        offline_access_codes_supported?: boolean | undefined;
+                        access_codes_supported?: boolean | undefined;
+                        accessory_keypad_supported?: boolean | undefined;
                     };
                     has_direct_power?: boolean | undefined;
                     battery_level?: number | undefined;
@@ -16065,7 +16497,13 @@ interface Routes {
                     image_url?: string | undefined;
                     image_alt_text?: string | undefined;
                     serial_number?: string | undefined;
+                    /** Currently possible to use online access codes */
+                    online_access_codes_enabled?: boolean | undefined;
+                    /** Currently possible to use offline access codes */
+                    offline_access_codes_enabled?: boolean | undefined;
+                    /** Deprecated: use model.offline_access_codes_enabled. */
                     supports_accessory_keypad?: boolean | undefined;
+                    /** Deprecated: use model.accessory_keypad_supported. */
                     supports_offline_access_codes?: boolean | undefined;
                 } & {
                     august_metadata?: {
@@ -18237,7 +18675,7 @@ interface Routes {
                 workspace_id: string;
                 created_at: string;
                 display_name: string;
-                external_type: 'pti_user';
+                external_type: 'pti_user' | 'brivo_user';
                 external_type_display_name: string;
                 is_suspended: boolean;
                 full_name?: string | undefined;
@@ -18386,4 +18824,4 @@ type RouteRequestParams<Path extends keyof Routes> = Routes[Path]['queryParams']
 
 declare const routes: {};
 
-export { ConnectWebview, RouteRequestBody, RouteRequestParams, RouteResponse, Routes, _default as openapi, routes, schemas };
+export { ConnectWebview, CustomMetadata, RouteRequestBody, RouteRequestParams, RouteResponse, Routes, _default as openapi, routes, schemas };