@seamapi/types 1.1094.0 → 1.1096.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -81035,6 +81035,8 @@ export type Routes = {
81035
81035
  workspace_id: string;
81036
81036
  name: string | null;
81037
81037
  customization_profile_id: string;
81038
+ /** 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. */
81039
+ customer_key: string | null;
81038
81040
  created_at: string;
81039
81041
  logo_url?: string | undefined;
81040
81042
  primary_color?: string | undefined;
@@ -84650,7 +84652,7 @@ export type Routes = {
84650
84652
  workspace_id: string;
84651
84653
  /** Date and time at which the customer was created. */
84652
84654
  created_at: string;
84653
- /** ID of the customization profile associated with the customer. Access grants that automations create for this customer use this profile. */
84655
+ /** ID of the customization profile the customer uses. Access grants that automations create for this customer use this profile. This can differ from the profiles the customer owns. */
84654
84656
  customization_profile_id: string | null;
84655
84657
  };
84656
84658
  };
@@ -84678,7 +84680,7 @@ export type Routes = {
84678
84680
  workspace_id: string;
84679
84681
  /** Date and time at which the customer was created. */
84680
84682
  created_at: string;
84681
- /** ID of the customization profile associated with the customer. Access grants that automations create for this customer use this profile. */
84683
+ /** ID of the customization profile the customer uses. Access grants that automations create for this customer use this profile. This can differ from the profiles the customer owns. */
84682
84684
  customization_profile_id: string | null;
84683
84685
  }[];
84684
84686
  /** Information about the current page of results. */
@@ -125207,6 +125209,8 @@ export type Routes = {
125207
125209
  workspace_id: string;
125208
125210
  name: string | null;
125209
125211
  customization_profile_id: string;
125212
+ /** 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. */
125213
+ customer_key: string | null;
125210
125214
  created_at: string;
125211
125215
  logo_url?: string | undefined;
125212
125216
  primary_color?: string | undefined;
@@ -125243,6 +125247,8 @@ export type Routes = {
125243
125247
  workspace_id: string;
125244
125248
  name: string | null;
125245
125249
  customization_profile_id: string;
125250
+ /** 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. */
125251
+ customer_key: string | null;
125246
125252
  created_at: string;
125247
125253
  logo_url?: string | undefined;
125248
125254
  primary_color?: string | undefined;
@@ -125270,7 +125276,7 @@ export type Routes = {
125270
125276
  queryParams: {};
125271
125277
  jsonBody: {};
125272
125278
  commonParams: {
125273
- /** Customer key for which you want to list customization profiles. */
125279
+ /** Key of the customer whose owned customization profiles you want to list. This filters by owner, not by the profile the customer uses. */
125274
125280
  customer_key?: string | undefined;
125275
125281
  };
125276
125282
  formData: {};
@@ -125279,6 +125285,8 @@ export type Routes = {
125279
125285
  workspace_id: string;
125280
125286
  name: string | null;
125281
125287
  customization_profile_id: string;
125288
+ /** 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. */
125289
+ customer_key: string | null;
125282
125290
  created_at: string;
125283
125291
  logo_url?: string | undefined;
125284
125292
  primary_color?: string | undefined;
@@ -136017,6 +136025,8 @@ export type Routes = {
136017
136025
  workspace_id: string;
136018
136026
  name: string | null;
136019
136027
  customization_profile_id: string;
136028
+ /** 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. */
136029
+ customer_key: string | null;
136020
136030
  created_at: string;
136021
136031
  logo_url?: string | undefined;
136022
136032
  primary_color?: string | undefined;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.1094.0",
3
+ "version": "1.1096.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -18,7 +18,7 @@ export const customer = z.object({
18
18
  .uuid()
19
19
  .nullable()
20
20
  .describe(
21
- 'ID of the customization profile associated with the customer. Access grants that automations create for this customer use this profile.',
21
+ 'ID of the customization profile the customer uses. Access grants that automations create for this customer use this profile. This can differ from the profiles the customer owns.',
22
22
  ),
23
23
  }).describe(`
24
24
  ---
@@ -21,6 +21,12 @@ export const customization_profile = z.object({
21
21
  workspace_id: z.string().uuid(),
22
22
  name: z.string().nullable(),
23
23
  customization_profile_id: z.string().uuid(),
24
+ customer_key: z
25
+ .string()
26
+ .nullable()
27
+ .describe(
28
+ '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.',
29
+ ),
24
30
  created_at: datetime,
25
31
  logo_url: z.string().url().optional(),
26
32
  primary_color: z.string().optional(),
@@ -13562,7 +13562,7 @@ const openapi: OpenAPISpec = {
13562
13562
  },
13563
13563
  customization_profile_id: {
13564
13564
  description:
13565
- 'ID of the customization profile associated with the customer. Access grants that automations create for this customer use this profile.',
13565
+ 'ID of the customization profile the customer uses. Access grants that automations create for this customer use this profile. This can differ from the profiles the customer owns.',
13566
13566
  format: 'uuid',
13567
13567
  nullable: true,
13568
13568
  type: 'string',
@@ -13629,6 +13629,12 @@ const openapi: OpenAPISpec = {
13629
13629
  description: 'A customization profile.',
13630
13630
  properties: {
13631
13631
  created_at: { format: 'date-time', type: 'string' },
13632
+ customer_key: {
13633
+ description:
13634
+ '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.',
13635
+ nullable: true,
13636
+ type: 'string',
13637
+ },
13632
13638
  customer_portal_theme: {
13633
13639
  properties: {
13634
13640
  font_family: { type: 'string' },
@@ -13658,6 +13664,7 @@ const openapi: OpenAPISpec = {
13658
13664
  'workspace_id',
13659
13665
  'name',
13660
13666
  'customization_profile_id',
13667
+ 'customer_key',
13661
13668
  'created_at',
13662
13669
  ],
13663
13670
  type: 'object',
@@ -72070,7 +72077,8 @@ const openapi: OpenAPISpec = {
72070
72077
  },
72071
72078
  '/workspaces/customization_profiles/list': {
72072
72079
  get: {
72073
- description: 'Retrieves the customization profile for the workspace.',
72080
+ description:
72081
+ 'Returns the customization profiles in the workspace. With `customer_key`, or from a customer client session, returns only the profiles that customer owns. A customer can own a profile without using it: the profile applied to the customer is `customization_profile_id` on `/seam/customer/v1/customers/get`.',
72074
72082
  operationId: 'workspacesCustomizationProfilesListGet',
72075
72083
  parameters: [
72076
72084
  {
@@ -72078,7 +72086,7 @@ const openapi: OpenAPISpec = {
72078
72086
  name: 'customer_key',
72079
72087
  schema: {
72080
72088
  description:
72081
- 'Customer key for which you want to list customization profiles.',
72089
+ 'Key of the customer whose owned customization profiles you want to list. This filters by owner, not by the profile the customer uses.',
72082
72090
  minLength: 1,
72083
72091
  type: 'string',
72084
72092
  },
@@ -72121,7 +72129,7 @@ const openapi: OpenAPISpec = {
72121
72129
  'x-fern-sdk-method-name': 'list',
72122
72130
  'x-fern-sdk-return-value': 'customization_profiles',
72123
72131
  'x-response-key': 'customization_profiles',
72124
- 'x-title': 'Get Customization Profile',
72132
+ 'x-title': 'List Customization Profiles',
72125
72133
  'x-undocumented': 'Unreleased.',
72126
72134
  },
72127
72135
  },
@@ -97483,6 +97483,8 @@ export type Routes = {
97483
97483
  workspace_id: string
97484
97484
  name: string | null
97485
97485
  customization_profile_id: string
97486
+ /** 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. */
97487
+ customer_key: string | null
97486
97488
  created_at: string
97487
97489
  logo_url?: string | undefined
97488
97490
  primary_color?: string | undefined
@@ -101645,7 +101647,7 @@ export type Routes = {
101645
101647
  workspace_id: string
101646
101648
  /** Date and time at which the customer was created. */
101647
101649
  created_at: string
101648
- /** ID of the customization profile associated with the customer. Access grants that automations create for this customer use this profile. */
101650
+ /** ID of the customization profile the customer uses. Access grants that automations create for this customer use this profile. This can differ from the profiles the customer owns. */
101649
101651
  customization_profile_id: string | null
101650
101652
  }
101651
101653
  }
@@ -101673,7 +101675,7 @@ export type Routes = {
101673
101675
  workspace_id: string
101674
101676
  /** Date and time at which the customer was created. */
101675
101677
  created_at: string
101676
- /** ID of the customization profile associated with the customer. Access grants that automations create for this customer use this profile. */
101678
+ /** ID of the customization profile the customer uses. Access grants that automations create for this customer use this profile. This can differ from the profiles the customer owns. */
101677
101679
  customization_profile_id: string | null
101678
101680
  }[]
101679
101681
  /** Information about the current page of results. */
@@ -149829,6 +149831,8 @@ export type Routes = {
149829
149831
  workspace_id: string
149830
149832
  name: string | null
149831
149833
  customization_profile_id: string
149834
+ /** 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. */
149835
+ customer_key: string | null
149832
149836
  created_at: string
149833
149837
  logo_url?: string | undefined
149834
149838
  primary_color?: string | undefined
@@ -149869,6 +149873,8 @@ export type Routes = {
149869
149873
  workspace_id: string
149870
149874
  name: string | null
149871
149875
  customization_profile_id: string
149876
+ /** 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. */
149877
+ customer_key: string | null
149872
149878
  created_at: string
149873
149879
  logo_url?: string | undefined
149874
149880
  primary_color?: string | undefined
@@ -149900,7 +149906,7 @@ export type Routes = {
149900
149906
  queryParams: {}
149901
149907
  jsonBody: {}
149902
149908
  commonParams: {
149903
- /** Customer key for which you want to list customization profiles. */
149909
+ /** Key of the customer whose owned customization profiles you want to list. This filters by owner, not by the profile the customer uses. */
149904
149910
  customer_key?: string | undefined
149905
149911
  }
149906
149912
  formData: {}
@@ -149909,6 +149915,8 @@ export type Routes = {
149909
149915
  workspace_id: string
149910
149916
  name: string | null
149911
149917
  customization_profile_id: string
149918
+ /** 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. */
149919
+ customer_key: string | null
149912
149920
  created_at: string
149913
149921
  logo_url?: string | undefined
149914
149922
  primary_color?: string | undefined
@@ -162570,6 +162578,8 @@ export type Routes = {
162570
162578
  workspace_id: string
162571
162579
  name: string | null
162572
162580
  customization_profile_id: string
162581
+ /** 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. */
162582
+ customer_key: string | null
162573
162583
  created_at: string
162574
162584
  logo_url?: string | undefined
162575
162585
  primary_color?: string | undefined