@seamapi/types 1.416.1 → 1.417.0

package/lib/seam/connect/models/workspaces/workspace.js

@@ -1,26 +1,48 @@
 import { z } from 'zod';
 import { hex_color_code } from '../colors.js';
 export const workspace = z.object({
-    workspace_id: z.string().uuid(),
-    name: z.string(),
-    company_name: z.string(),
-    is_sandbox: z.boolean(),
+    workspace_id: z
+        .string()
+        .uuid()
+        .describe('ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).'),
+    name: z
+        .string()
+        .describe('Name of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).'),
+    company_name: z
+        .string()
+        .describe('Company name associated with the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).'),
+    is_sandbox: z
+        .boolean()
+        .describe('Indicates whether the workspace is a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).'),
     connect_webview_customization: z.object({
-        primary_button_color: hex_color_code.optional(),
-        primary_button_text_color: hex_color_code.optional(),
-        success_message: z.string().optional(),
-        logo_shape: z.enum(['circle', 'square']).optional(),
-        inviter_logo_url: z.string().optional(),
+        primary_button_color: hex_color_code
+            .optional()
+            .describe('Primary button color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).'),
+        primary_button_text_color: hex_color_code
+            .optional()
+            .describe('Primary button text color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).'),
+        success_message: z
+            .string()
+            .optional()
+            .describe('Success message for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).'),
+        logo_shape: z
+            .enum(['circle', 'square'])
+            .optional()
+            .describe('Logo shape for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).'),
+        inviter_logo_url: z
+            .string()
+            .optional()
+            .describe('URL of the inviter logo for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).'),
     }),
     is_suspended: z
         .boolean()
-        .describe('True if a sandbox workspace has not been accessed in 14 days'),
+        .describe('Indicates whether the [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces) is suspended. Seam suspends sandbox workspaces that have not been accessed in 14 days.'),
     connect_partner_name: z
         .string()
         .nullable()
         .describe(`
     ---
-    deprecated: use company_name
+    deprecated: Use \`company_name\` instead.
     ---
   `)
         .nullable(),

package/lib/seam/connect/models/workspaces/workspace.js.map

@@ -1 +1 @@
-{"version":3,"file":"workspace.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/workspaces/workspace.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAE7C,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC;IAChC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;IAC/B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;IACxB,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE;IACvB,6BAA6B,EAAE,CAAC,CAAC,MAAM,CAAC;QACtC,oBAAoB,EAAE,cAAc,CAAC,QAAQ,EAAE;QAC/C,yBAAyB,EAAE,cAAc,CAAC,QAAQ,EAAE;QACpD,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QACtC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,QAAQ,EAAE;QACnD,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KACxC,CAAC;IACF,YAAY,EAAE,CAAC;SACZ,OAAO,EAAE;SACT,QAAQ,CAAC,8DAA8D,CAAC;IAC3E,oBAAoB,EAAE,CAAC;SACpB,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP;;;;GAIH,CACE;SACA,QAAQ,EAAE;CACd,CAAC,CAAC,QAAQ,CAAC;;;;;CAKX,CAAC,CAAA"}
+{"version":3,"file":"workspace.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/workspaces/workspace.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAE7C,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC;IAChC,YAAY,EAAE,CAAC;SACZ,MAAM,EAAE;SACR,IAAI,EAAE;SACN,QAAQ,CACP,8EAA8E,CAC/E;IACH,IAAI,EAAE,CAAC;SACJ,MAAM,EAAE;SACR,QAAQ,CACP,gFAAgF,CACjF;IACH,YAAY,EAAE,CAAC;SACZ,MAAM,EAAE;SACR,QAAQ,CACP,qGAAqG,CACtG;IACH,UAAU,EAAE,CAAC;SACV,OAAO,EAAE;SACT,QAAQ,CACP,oIAAoI,CACrI;IACH,6BAA6B,EAAE,CAAC,CAAC,MAAM,CAAC;QACtC,oBAAoB,EAAE,cAAc;aACjC,QAAQ,EAAE;aACV,QAAQ,CACP,0UAA0U,CAC3U;QACH,yBAAyB,EAAE,cAAc;aACtC,QAAQ,EAAE;aACV,QAAQ,CACP,+UAA+U,CAChV;QACH,eAAe,EAAE,CAAC;aACf,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CACP,qUAAqU,CACtU;QACH,UAAU,EAAE,CAAC;aACV,IAAI,CAAC,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;aAC1B,QAAQ,EAAE;aACV,QAAQ,CACP,gUAAgU,CACjU;QACH,gBAAgB,EAAE,CAAC;aAChB,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CACP,6UAA6U,CAC9U;KACJ,CAAC;IACF,YAAY,EAAE,CAAC;SACZ,OAAO,EAAE;SACT,QAAQ,CACP,2MAA2M,CAC5M;IACH,oBAAoB,EAAE,CAAC;SACpB,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP;;;;GAIH,CACE;SACA,QAAQ,EAAE;CACd,CAAC,CAAC,QAAQ,CAAC;;;;;CAKX,CAAC,CAAA"}