@seamapi/types 1.956.0 → 1.958.0

package/dist/connect.d.cts

@@ -35187,14 +35187,16 @@ type Routes = {
         commonParams: {
             /** Customer key for which you want to list access codes. */
             customer_key?: string | undefined;
-            /** ID of the device for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, or `access_grant_id`. */
+            /** ID of the device for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`. */
             device_id?: string | undefined;
-            /** IDs of the access codes that you want to retrieve. Specify `device_id`, `access_code_ids`, `access_method_id`, or `access_grant_id`. */
+            /** IDs of the access codes that you want to retrieve. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`. */
             access_code_ids?: string[] | undefined;
-            /** ID of the access method for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, or `access_grant_id`. */
+            /** ID of the access method for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`. */
             access_method_id?: string | undefined;
-            /** ID of the access grant for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, or `access_grant_id`. */
+            /** ID of the access grant for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`. */
             access_grant_id?: string | undefined;
+            /** Key of the access grant for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`. */
+            access_grant_key?: string | undefined;
             /** Your user ID for the user by which to filter access codes. */
             user_identifier_key?: string | undefined;
             /** Numerical limit on the number of access codes to return. */
@@ -105462,6 +105464,479 @@ type Routes = {
         };
         maxDuration: undefined;
     };
+    '/seam/console/v1/organizations/create': {
+        route: '/seam/console/v1/organizations/create';
+        method: 'POST';
+        queryParams: {};
+        jsonBody: {
+            name: string;
+            logo_image_base64?: string | undefined;
+        };
+        commonParams: {};
+        formData: {};
+        jsonResponse: {
+            organization: {
+                organization_id: string;
+                name: string;
+                logo_url: string | null;
+                connect_webview_customization: {
+                    primary_button_color: string | null;
+                    primary_button_text_color: string | null;
+                    logo_shape: ('circle' | 'square') | null;
+                };
+                created_at: string;
+                updated_at: string;
+            };
+        };
+        maxDuration: undefined;
+    };
+    '/seam/console/v1/organizations/customization_profiles/copy': {
+        route: '/seam/console/v1/organizations/customization_profiles/copy';
+        method: 'POST';
+        queryParams: {};
+        jsonBody: {
+            source_workspace_id: string;
+            source_customization_profile_id: string;
+            destination_workspace_id: string;
+            destination_customization_profile_id?: string | undefined;
+        };
+        commonParams: {};
+        formData: {};
+        jsonResponse: {
+            /** A customization profile. */
+            customization_profile: {
+                workspace_id: string;
+                name: string | null;
+                customization_profile_id: string;
+                created_at: string;
+                logo_url?: string | undefined;
+                primary_color?: string | undefined;
+                secondary_color?: string | undefined;
+                customer_portal_theme?: {
+                    primary_color?: string | undefined;
+                    primary_foreground_color?: string | undefined;
+                    secondary_color?: string | undefined;
+                    secondary_foreground_color?: string | undefined;
+                    font_family?: string | undefined;
+                    mono_font_family?: string | undefined;
+                } | undefined;
+                message_overrides?: {
+                    [x: string]: {
+                        [x: string]: string;
+                    };
+                } | undefined;
+            };
+        };
+        maxDuration: undefined;
+    };
+    '/seam/console/v1/organizations/delete': {
+        route: '/seam/console/v1/organizations/delete';
+        method: 'POST';
+        queryParams: {};
+        jsonBody: {
+            organization_id: string;
+        };
+        commonParams: {};
+        formData: {};
+        jsonResponse: {
+            organization: {
+                organization_id: string;
+                name: string;
+                logo_url: string | null;
+                connect_webview_customization: {
+                    primary_button_color: string | null;
+                    primary_button_text_color: string | null;
+                    logo_shape: ('circle' | 'square') | null;
+                };
+                created_at: string;
+                updated_at: string;
+            };
+        };
+        maxDuration: undefined;
+    };
+    '/seam/console/v1/organizations/get': {
+        route: '/seam/console/v1/organizations/get';
+        method: 'GET' | 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            organization_id: string;
+        };
+        formData: {};
+        jsonResponse: {
+            organization: {
+                organization_id: string;
+                name: string;
+                logo_url: string | null;
+                connect_webview_customization: {
+                    primary_button_color: string | null;
+                    primary_button_text_color: string | null;
+                    logo_shape: ('circle' | 'square') | null;
+                };
+                created_at: string;
+                updated_at: string;
+            };
+            members: {
+                organization_member_id: string;
+                organization_id: string;
+                user_id: string;
+                email: string | null;
+                first_name: string | null;
+                last_name: string | null;
+                role: 'admin' | 'member';
+                created_at: string;
+            }[];
+            pending_invitations: {
+                organization_invitation_id: string;
+                organization_id: string;
+                email: string;
+                role: 'admin' | 'member';
+                status: 'pending' | 'accepted' | 'revoked';
+                invited_at: string;
+                expires_at: string;
+            }[];
+            workspaces: {
+                workspace_id: string;
+                name: string;
+                is_sandbox: boolean;
+            }[];
+        };
+        maxDuration: undefined;
+    };
+    '/seam/console/v1/organizations/invitations/revoke': {
+        route: '/seam/console/v1/organizations/invitations/revoke';
+        method: 'POST';
+        queryParams: {};
+        jsonBody: {
+            organization_invitation_id: string;
+        };
+        commonParams: {};
+        formData: {};
+        jsonResponse: {
+            organization_invitation: {
+                organization_invitation_id: string;
+                organization_id: string;
+                email: string;
+                role: 'admin' | 'member';
+                status: 'pending' | 'accepted' | 'revoked';
+                invited_at: string;
+                expires_at: string;
+            };
+        };
+        maxDuration: undefined;
+    };
+    '/seam/console/v1/organizations/list': {
+        route: '/seam/console/v1/organizations/list';
+        method: 'GET' | 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {};
+        formData: {};
+        jsonResponse: {
+            organizations: {
+                organization_id: string;
+                name: string;
+                logo_url: string | null;
+                connect_webview_customization: {
+                    primary_button_color: string | null;
+                    primary_button_text_color: string | null;
+                    logo_shape: ('circle' | 'square') | null;
+                };
+                created_at: string;
+                updated_at: string;
+                workspace_count: number;
+                member_count: number;
+            }[];
+        };
+        maxDuration: undefined;
+    };
+    '/seam/console/v1/organizations/members/add': {
+        route: '/seam/console/v1/organizations/members/add';
+        method: 'POST';
+        queryParams: {};
+        jsonBody: {
+            organization_id: string;
+            email: string;
+            role?: 'admin' | 'member';
+        };
+        commonParams: {};
+        formData: {};
+        jsonResponse: {
+            organization_member?: {
+                organization_member_id: string;
+                organization_id: string;
+                user_id: string;
+                email: string | null;
+                first_name: string | null;
+                last_name: string | null;
+                role: 'admin' | 'member';
+                created_at: string;
+            } | undefined;
+            organization_invitation?: {
+                organization_invitation_id: string;
+                organization_id: string;
+                email: string;
+                role: 'admin' | 'member';
+                status: 'pending' | 'accepted' | 'revoked';
+                invited_at: string;
+                expires_at: string;
+            } | undefined;
+        };
+        maxDuration: undefined;
+    };
+    '/seam/console/v1/organizations/members/remove': {
+        route: '/seam/console/v1/organizations/members/remove';
+        method: 'POST';
+        queryParams: {};
+        jsonBody: {
+            organization_id: string;
+            user_id: string;
+        };
+        commonParams: {};
+        formData: {};
+        jsonResponse: {};
+        maxDuration: undefined;
+    };
+    '/seam/console/v1/organizations/members/update': {
+        route: '/seam/console/v1/organizations/members/update';
+        method: 'POST';
+        queryParams: {};
+        jsonBody: {
+            organization_id: string;
+            user_id: string;
+            role: 'admin' | 'member';
+        };
+        commonParams: {};
+        formData: {};
+        jsonResponse: {
+            organization_member: {
+                organization_member_id: string;
+                organization_id: string;
+                user_id: string;
+                email: string | null;
+                first_name: string | null;
+                last_name: string | null;
+                role: 'admin' | 'member';
+                created_at: string;
+            };
+        };
+        maxDuration: undefined;
+    };
+    '/seam/console/v1/organizations/members/workspaces/grant': {
+        route: '/seam/console/v1/organizations/members/workspaces/grant';
+        method: 'POST';
+        queryParams: {};
+        jsonBody: {
+            organization_id: string;
+            user_id: string;
+            workspace_id: string;
+        };
+        commonParams: {};
+        formData: {};
+        jsonResponse: {};
+        maxDuration: undefined;
+    };
+    '/seam/console/v1/organizations/members/workspaces/list': {
+        route: '/seam/console/v1/organizations/members/workspaces/list';
+        method: 'GET' | 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            organization_id: string;
+            user_id: string;
+        };
+        formData: {};
+        jsonResponse: {
+            workspaces: {
+                workspace_id: string;
+                name: string;
+                is_sandbox: boolean;
+                is_owner: boolean;
+                created_at: string;
+            }[];
+        };
+        maxDuration: undefined;
+    };
+    '/seam/console/v1/organizations/members/workspaces/revoke': {
+        route: '/seam/console/v1/organizations/members/workspaces/revoke';
+        method: 'POST';
+        queryParams: {};
+        jsonBody: {
+            organization_id: string;
+            user_id: string;
+            workspace_id: string;
+        };
+        commonParams: {};
+        formData: {};
+        jsonResponse: {};
+        maxDuration: undefined;
+    };
+    '/seam/console/v1/organizations/update': {
+        route: '/seam/console/v1/organizations/update';
+        method: 'PATCH' | 'POST';
+        queryParams: {};
+        jsonBody: {
+            organization_id: string;
+            name?: string | undefined;
+            logo_image_base64?: (string | null) | undefined;
+            connect_webview_customization?: {
+                primary_button_color?: (string | null) | undefined;
+                primary_button_text_color?: (string | null) | undefined;
+                logo_shape?: (('circle' | 'square') | null) | undefined;
+            } | undefined;
+        };
+        commonParams: {};
+        formData: {};
+        jsonResponse: {
+            organization: {
+                organization_id: string;
+                name: string;
+                logo_url: string | null;
+                connect_webview_customization: {
+                    primary_button_color: string | null;
+                    primary_button_text_color: string | null;
+                    logo_shape: ('circle' | 'square') | null;
+                };
+                created_at: string;
+                updated_at: string;
+            };
+        };
+        maxDuration: undefined;
+    };
+    '/seam/console/v1/organizations/upload_logo': {
+        route: '/seam/console/v1/organizations/upload_logo';
+        method: 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {};
+        formData: {};
+        jsonResponse: {
+            organization: {
+                organization_id: string;
+                name: string;
+                logo_url: string | null;
+                connect_webview_customization: {
+                    primary_button_color: string | null;
+                    primary_button_text_color: string | null;
+                    logo_shape: ('circle' | 'square') | null;
+                };
+                created_at: string;
+                updated_at: string;
+            };
+        };
+        maxDuration: undefined;
+    };
+    '/seam/console/v1/organizations/workspaces/create': {
+        route: '/seam/console/v1/organizations/workspaces/create';
+        method: 'POST';
+        queryParams: {};
+        jsonBody: {
+            organization_id: string;
+            name: string;
+            is_sandbox?: boolean;
+        };
+        commonParams: {};
+        formData: {};
+        jsonResponse: {
+            /** Represents a Seam [workspace](https://docs.seam.co/core-concepts/workspaces). A workspace is a top-level entity that encompasses all other resources below it, such as devices, connected accounts, and Connect Webviews. Seam provides two types of workspaces. A [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces) is a special type of workspace designed for testing code. Sandbox workspaces offer test device accounts and virtual devices that you can connect and control. This ability to work with virtual devices is quite handy because it removes the need to own physical devices from multiple brands. To connect real devices and systems to Seam, use a [production workspace](https://docs.seam.co/core-concepts/workspaces#production-workspaces). */
+            workspace: {
+                /** ID of the workspace. */
+                workspace_id: string;
+                /** Name of the [workspace](https://docs.seam.co/core-concepts/workspaces). */
+                name: string;
+                /** Company name associated with the [workspace](https://docs.seam.co/core-concepts/workspaces). */
+                company_name: string;
+                /** Indicates whether the workspace is a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). */
+                is_sandbox: boolean;
+                connect_webview_customization: {
+                    /** Primary button color for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
+                    primary_button_color?: string | undefined;
+                    /** Primary button text color for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
+                    primary_button_text_color?: string | undefined;
+                    /** Success message for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
+                    success_message?: string | undefined;
+                    /** Logo shape for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
+                    logo_shape?: ('circle' | 'square') | undefined;
+                    /** URL of the inviter logo for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
+                    inviter_logo_url?: string | undefined;
+                };
+                /** Indicates whether the [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces) is suspended. Seam suspends sandbox workspaces that have not been accessed in 14 days. */
+                is_suspended: boolean;
+                /**
+                 * @deprecated Use `company_name` instead.*/
+                connect_partner_name: (string | null) | null;
+                /** Publishable key for the [workspace](https://docs.seam.co/core-concepts/workspaces). This key is used to identify the workspace in client-side applications. */
+                publishable_key?: string | undefined;
+                /** Indicates whether publishable key authentication is enabled for this workspace. */
+                is_publishable_key_auth_enabled: boolean;
+                /** ID of the organization to which the workspace belongs, or `null` if the workspace is not assigned to an organization. */
+                organization_id: string | null;
+            };
+        };
+        maxDuration: undefined;
+    };
+    '/seam/console/v1/organizations/workspaces/remove': {
+        route: '/seam/console/v1/organizations/workspaces/remove';
+        method: 'POST';
+        queryParams: {};
+        jsonBody: {
+            workspace_id: string;
+        };
+        commonParams: {};
+        formData: {};
+        jsonResponse: {
+            ok: boolean;
+        };
+        maxDuration: undefined;
+    };
+    '/seam/console/v1/organizations/workspaces/update': {
+        route: '/seam/console/v1/organizations/workspaces/update';
+        method: 'POST';
+        queryParams: {};
+        jsonBody: {
+            workspace_id: string;
+            name: string;
+        };
+        commonParams: {};
+        formData: {};
+        jsonResponse: {
+            /** Represents a Seam [workspace](https://docs.seam.co/core-concepts/workspaces). A workspace is a top-level entity that encompasses all other resources below it, such as devices, connected accounts, and Connect Webviews. Seam provides two types of workspaces. A [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces) is a special type of workspace designed for testing code. Sandbox workspaces offer test device accounts and virtual devices that you can connect and control. This ability to work with virtual devices is quite handy because it removes the need to own physical devices from multiple brands. To connect real devices and systems to Seam, use a [production workspace](https://docs.seam.co/core-concepts/workspaces#production-workspaces). */
+            workspace: {
+                /** ID of the workspace. */
+                workspace_id: string;
+                /** Name of the [workspace](https://docs.seam.co/core-concepts/workspaces). */
+                name: string;
+                /** Company name associated with the [workspace](https://docs.seam.co/core-concepts/workspaces). */
+                company_name: string;
+                /** Indicates whether the workspace is a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). */
+                is_sandbox: boolean;
+                connect_webview_customization: {
+                    /** Primary button color for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
+                    primary_button_color?: string | undefined;
+                    /** Primary button text color for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
+                    primary_button_text_color?: string | undefined;
+                    /** Success message for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
+                    success_message?: string | undefined;
+                    /** Logo shape for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
+                    logo_shape?: ('circle' | 'square') | undefined;
+                    /** URL of the inviter logo for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
+                    inviter_logo_url?: string | undefined;
+                };
+                /** Indicates whether the [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces) is suspended. Seam suspends sandbox workspaces that have not been accessed in 14 days. */
+                is_suspended: boolean;
+                /**
+                 * @deprecated Use `company_name` instead.*/
+                connect_partner_name: (string | null) | null;
+                /** Publishable key for the [workspace](https://docs.seam.co/core-concepts/workspaces). This key is used to identify the workspace in client-side applications. */
+                publishable_key?: string | undefined;
+                /** Indicates whether publishable key authentication is enabled for this workspace. */
+                is_publishable_key_auth_enabled: boolean;
+                /** ID of the organization to which the workspace belongs, or `null` if the workspace is not assigned to an organization. */
+                organization_id: string | null;
+            };
+        };
+        maxDuration: undefined;
+    };
     '/seam/console/v1/sites/create': {
         route: '/seam/console/v1/sites/create';
         method: 'POST';