@seamapi/types 1.1121.0 → 1.1123.0

package/lib/seam/connect/route-types.d.ts

@@ -88295,6 +88295,8 @@ export type Routes = {
                 /** Key of the customer that owns the profile, or `null` for a workspace-level profile. A customer can own a profile without using it; the profile a customer uses is `customization_profile_id` on the customer. */
                 customer_key: string | null;
                 created_at: string;
+                /** Whether this is the workspace's default profile, used for access grants and Instant Keys created without a customization profile. */
+                is_workspace_default: boolean;
                 logo_url?: string | undefined;
                 primary_color?: string | undefined;
                 secondary_color?: string | undefined;
@@ -148608,6 +148610,7 @@ export type Routes = {
         method: 'POST';
         queryParams: {};
         jsonBody: {
+            base_customization_profile_id?: string | undefined;
             name?: string | null;
             primary_color?: string | undefined;
             secondary_color?: string | undefined;
@@ -148758,6 +148761,8 @@ export type Routes = {
                 /** Key of the customer that owns the profile, or `null` for a workspace-level profile. A customer can own a profile without using it; the profile a customer uses is `customization_profile_id` on the customer. */
                 customer_key: string | null;
                 created_at: string;
+                /** Whether this is the workspace's default profile, used for access grants and Instant Keys created without a customization profile. */
+                is_workspace_default: boolean;
                 logo_url?: string | undefined;
                 primary_color?: string | undefined;
                 secondary_color?: string | undefined;
@@ -148919,6 +148924,8 @@ export type Routes = {
                 /** Key of the customer that owns the profile, or `null` for a workspace-level profile. A customer can own a profile without using it; the profile a customer uses is `customization_profile_id` on the customer. */
                 customer_key: string | null;
                 created_at: string;
+                /** Whether this is the workspace's default profile, used for access grants and Instant Keys created without a customization profile. */
+                is_workspace_default: boolean;
                 logo_url?: string | undefined;
                 primary_color?: string | undefined;
                 secondary_color?: string | undefined;
@@ -149080,6 +149087,8 @@ export type Routes = {
                 /** Key of the customer that owns the profile, or `null` for a workspace-level profile. A customer can own a profile without using it; the profile a customer uses is `customization_profile_id` on the customer. */
                 customer_key: string | null;
                 created_at: string;
+                /** Whether this is the workspace's default profile, used for access grants and Instant Keys created without a customization profile. */
+                is_workspace_default: boolean;
                 logo_url?: string | undefined;
                 primary_color?: string | undefined;
                 secondary_color?: string | undefined;
@@ -149367,6 +149376,7 @@ export type Routes = {
                     [x: string]: string;
                 };
             } | undefined) | null;
+            is_workspace_default?: boolean | undefined;
         };
         commonParams: {};
         formData: {};
@@ -160544,6 +160554,8 @@ export type Routes = {
                     /** Key of the customer that owns the profile, or `null` for a workspace-level profile. A customer can own a profile without using it; the profile a customer uses is `customization_profile_id` on the customer. */
                     customer_key: string | null;
                     created_at: string;
+                    /** Whether this is the workspace's default profile, used for access grants and Instant Keys created without a customization profile. */
+                    is_workspace_default: boolean;
                     logo_url?: string | undefined;
                     primary_color?: string | undefined;
                     secondary_color?: string | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.1121.0",
+  "version": "1.1123.0",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",

package/src/lib/seam/connect/models/customization-profiles/customization-profile.ts

@@ -120,6 +120,11 @@ export const customization_profile = z.object({
       'Key of the customer that owns the profile, or `null` for a workspace-level profile. A customer can own a profile without using it; the profile a customer uses is `customization_profile_id` on the customer.',
     ),
   created_at: datetime,
+  is_workspace_default: z
+    .boolean()
+    .describe(
+      "Whether this is the workspace's default profile, used for access grants and Instant Keys created without a customization profile.",
+    ),
   logo_url: z.string().url().optional(),
   primary_color: z.string().optional(),
   secondary_color: z.string().optional(),

package/src/lib/seam/connect/openapi.ts

@@ -14918,6 +14918,11 @@ const openapi: OpenAPISpec = {
             },
             type: 'object',
           },
+          is_workspace_default: {
+            description:
+              "Whether this is the workspace's default profile, used for access grants and Instant Keys created without a customization profile.",
+            type: 'boolean',
+          },
           logo_url: { format: 'uri', type: 'string' },
           message_overrides: {
             additionalProperties: {
@@ -14937,6 +14942,7 @@ const openapi: OpenAPISpec = {
           'customization_profile_id',
           'customer_key',
           'created_at',
+          'is_workspace_default',
         ],
         type: 'object',
         'x-route-path': '/workspaces/customization_profiles',
@@ -76372,13 +76378,17 @@ const openapi: OpenAPISpec = {
     '/workspaces/customization_profiles/create': {
       post: {
         description:
-          "Creates a customization profile. From a customer client session, the profile is owned by that customer, and it becomes the customer's `customization_profile_id` when the customer has none yet.",
+          "Creates a customization profile. With `base_customization_profile_id`, the new profile starts as a copy of that profile and the other fields replace its values.\n\nFrom a customer client session, the profile is owned by that customer, and it becomes the customer's `customization_profile_id` when the customer has none yet or when it's a copy of the customer's current profile. That's how a customer customizes the workspace-level profile it uses without changing it for other customers.\n\nA workspace's first workspace-level profile becomes its default (`is_workspace_default`).",
         operationId: 'workspacesCustomizationProfilesCreatePost',
         requestBody: {
           content: {
             'application/json': {
               schema: {
                 properties: {
+                  base_customization_profile_id: {
+                    format: 'uuid',
+                    type: 'string',
+                  },
                   customer_portal_theme: {
                     properties: {
                       font_family: { type: 'string' },
@@ -76864,7 +76874,8 @@ const openapi: OpenAPISpec = {
     },
     '/workspaces/customization_profiles/update': {
       patch: {
-        description: 'Updates the customization profile for the workspace.',
+        description:
+          "Updates the customization profile for the workspace.\n\n`is_workspace_default: true` makes a workspace-level profile the workspace's default, replacing the previous one: access grants and Instant Keys created without a customization profile use it. `false` removes it, so they use the Seam default again. A customer client session can't change the default.",
         operationId: 'workspacesCustomizationProfilesUpdatePatch',
         requestBody: {
           content: {
@@ -77196,6 +77207,7 @@ const openapi: OpenAPISpec = {
                     },
                     type: 'object',
                   },
+                  is_workspace_default: { type: 'boolean' },
                   message_overrides: {
                     additionalProperties: {
                       additionalProperties: { type: 'string' },

package/src/lib/seam/connect/route-types.ts

@@ -105620,6 +105620,8 @@ export type Routes = {
         /** Key of the customer that owns the profile, or `null` for a workspace-level profile. A customer can own a profile without using it; the profile a customer uses is `customization_profile_id` on the customer. */
         customer_key: string | null
         created_at: string
+        /** Whether this is the workspace's default profile, used for access grants and Instant Keys created without a customization profile. */
+        is_workspace_default: boolean
         logo_url?: string | undefined
         primary_color?: string | undefined
         secondary_color?: string | undefined
@@ -176519,6 +176521,7 @@ export type Routes = {
     method: 'POST'
     queryParams: {}
     jsonBody: {
+      base_customization_profile_id?: string | undefined
       name?: string | null
       primary_color?: string | undefined
       secondary_color?: string | undefined
@@ -176679,6 +176682,8 @@ export type Routes = {
         /** Key of the customer that owns the profile, or `null` for a workspace-level profile. A customer can own a profile without using it; the profile a customer uses is `customization_profile_id` on the customer. */
         customer_key: string | null
         created_at: string
+        /** Whether this is the workspace's default profile, used for access grants and Instant Keys created without a customization profile. */
+        is_workspace_default: boolean
         logo_url?: string | undefined
         primary_color?: string | undefined
         secondary_color?: string | undefined
@@ -176850,6 +176855,8 @@ export type Routes = {
         /** Key of the customer that owns the profile, or `null` for a workspace-level profile. A customer can own a profile without using it; the profile a customer uses is `customization_profile_id` on the customer. */
         customer_key: string | null
         created_at: string
+        /** Whether this is the workspace's default profile, used for access grants and Instant Keys created without a customization profile. */
+        is_workspace_default: boolean
         logo_url?: string | undefined
         primary_color?: string | undefined
         secondary_color?: string | undefined
@@ -177021,6 +177028,8 @@ export type Routes = {
         /** Key of the customer that owns the profile, or `null` for a workspace-level profile. A customer can own a profile without using it; the profile a customer uses is `customization_profile_id` on the customer. */
         customer_key: string | null
         created_at: string
+        /** Whether this is the workspace's default profile, used for access grants and Instant Keys created without a customization profile. */
+        is_workspace_default: boolean
         logo_url?: string | undefined
         primary_color?: string | undefined
         secondary_color?: string | undefined
@@ -177337,6 +177346,7 @@ export type Routes = {
             | undefined
           )
         | null
+      is_workspace_default?: boolean | undefined
     }
     commonParams: {}
     formData: {}
@@ -190481,6 +190491,8 @@ export type Routes = {
               /** Key of the customer that owns the profile, or `null` for a workspace-level profile. A customer can own a profile without using it; the profile a customer uses is `customization_profile_id` on the customer. */
               customer_key: string | null
               created_at: string
+              /** Whether this is the workspace's default profile, used for access grants and Instant Keys created without a customization profile. */
+              is_workspace_default: boolean
               logo_url?: string | undefined
               primary_color?: string | undefined
               secondary_color?: string | undefined