@seamapi/types 1.476.0 → 1.477.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.
@@ -75716,9 +75716,11 @@ export type Routes = {
75716
75716
  commonParams: {};
75717
75717
  formData: {};
75718
75718
  jsonResponse: {
75719
+ /** A customization profile. */
75719
75720
  customization_profile: {
75720
- workspace_id: string;
75721
75721
  customization_profile_id: string;
75722
+ workspace_id: string;
75723
+ created_at: string;
75722
75724
  logo_url?: string | undefined;
75723
75725
  primary_color?: string | undefined;
75724
75726
  secondary_color?: string | undefined;
@@ -75735,9 +75737,11 @@ export type Routes = {
75735
75737
  };
75736
75738
  formData: {};
75737
75739
  jsonResponse: {
75740
+ /** A customization profile. */
75738
75741
  customization_profile: {
75739
- workspace_id: string;
75740
75742
  customization_profile_id: string;
75743
+ workspace_id: string;
75744
+ created_at: string;
75741
75745
  logo_url?: string | undefined;
75742
75746
  primary_color?: string | undefined;
75743
75747
  secondary_color?: string | undefined;
@@ -75753,8 +75757,9 @@ export type Routes = {
75753
75757
  formData: {};
75754
75758
  jsonResponse: {
75755
75759
  customization_profiles: {
75756
- workspace_id: string;
75757
75760
  customization_profile_id: string;
75761
+ workspace_id: string;
75762
+ created_at: string;
75758
75763
  logo_url?: string | undefined;
75759
75764
  primary_color?: string | undefined;
75760
75765
  secondary_color?: string | undefined;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.476.0",
3
+ "version": "1.477.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -1,11 +1,19 @@
1
1
  import { z } from 'zod'
2
2
 
3
3
  export const customization_profile = z.object({
4
- workspace_id: z.string().uuid(),
5
4
  customization_profile_id: z.string().uuid(),
6
- logo_url: z.string().optional(),
5
+ workspace_id: z.string().uuid(),
6
+ created_at: z.string().datetime(),
7
+ logo_url: z.string().url().optional(),
7
8
  primary_color: z.string().optional(),
8
9
  secondary_color: z.string().optional(),
9
- })
10
+ }).describe(`
11
+ ---
12
+ title: Customization Profile
13
+ undocumented: Unreleased.
14
+ route_path: /workspaces/customization_profiles
15
+ ---
16
+ A customization profile.
17
+ `)
10
18
 
11
19
  export type CustomizationProfile = z.infer<typeof customization_profile>
@@ -56082,18 +56082,27 @@ export default {
56082
56082
  schema: {
56083
56083
  properties: {
56084
56084
  customization_profile: {
56085
+ description: 'A customization profile.',
56085
56086
  properties: {
56087
+ created_at: { format: 'date-time', type: 'string' },
56086
56088
  customization_profile_id: {
56087
56089
  format: 'uuid',
56088
56090
  type: 'string',
56089
56091
  },
56090
- logo_url: { type: 'string' },
56092
+ logo_url: { format: 'uri', type: 'string' },
56091
56093
  primary_color: { type: 'string' },
56092
56094
  secondary_color: { type: 'string' },
56093
56095
  workspace_id: { format: 'uuid', type: 'string' },
56094
56096
  },
56095
- required: ['workspace_id', 'customization_profile_id'],
56097
+ required: [
56098
+ 'customization_profile_id',
56099
+ 'workspace_id',
56100
+ 'created_at',
56101
+ ],
56096
56102
  type: 'object',
56103
+ 'x-route-path': '/workspaces/customization_profiles',
56104
+ 'x-title': 'Customization Profile',
56105
+ 'x-undocumented': 'Unreleased.',
56097
56106
  },
56098
56107
  ok: { type: 'boolean' },
56099
56108
  },
@@ -56115,6 +56124,7 @@ export default {
56115
56124
  'x-fern-sdk-return-value': 'customization_profile',
56116
56125
  'x-response-key': 'customization_profile',
56117
56126
  'x-title': 'Update Customization Profile',
56127
+ 'x-undocumented': 'Unreleased.',
56118
56128
  },
56119
56129
  },
56120
56130
  '/workspaces/customization_profiles/get': {
@@ -56136,18 +56146,27 @@ export default {
56136
56146
  schema: {
56137
56147
  properties: {
56138
56148
  customization_profile: {
56149
+ description: 'A customization profile.',
56139
56150
  properties: {
56151
+ created_at: { format: 'date-time', type: 'string' },
56140
56152
  customization_profile_id: {
56141
56153
  format: 'uuid',
56142
56154
  type: 'string',
56143
56155
  },
56144
- logo_url: { type: 'string' },
56156
+ logo_url: { format: 'uri', type: 'string' },
56145
56157
  primary_color: { type: 'string' },
56146
56158
  secondary_color: { type: 'string' },
56147
56159
  workspace_id: { format: 'uuid', type: 'string' },
56148
56160
  },
56149
- required: ['workspace_id', 'customization_profile_id'],
56161
+ required: [
56162
+ 'customization_profile_id',
56163
+ 'workspace_id',
56164
+ 'created_at',
56165
+ ],
56150
56166
  type: 'object',
56167
+ 'x-route-path': '/workspaces/customization_profiles',
56168
+ 'x-title': 'Customization Profile',
56169
+ 'x-undocumented': 'Unreleased.',
56151
56170
  },
56152
56171
  ok: { type: 'boolean' },
56153
56172
  },
@@ -56169,6 +56188,7 @@ export default {
56169
56188
  'x-fern-sdk-return-value': 'customization_profile',
56170
56189
  'x-response-key': 'customization_profile',
56171
56190
  'x-title': 'Get Customization Profile',
56191
+ 'x-undocumented': 'Unreleased.',
56172
56192
  },
56173
56193
  post: {
56174
56194
  description: 'Retrieves the customization profile for the workspace.',
@@ -56193,18 +56213,27 @@ export default {
56193
56213
  schema: {
56194
56214
  properties: {
56195
56215
  customization_profile: {
56216
+ description: 'A customization profile.',
56196
56217
  properties: {
56218
+ created_at: { format: 'date-time', type: 'string' },
56197
56219
  customization_profile_id: {
56198
56220
  format: 'uuid',
56199
56221
  type: 'string',
56200
56222
  },
56201
- logo_url: { type: 'string' },
56223
+ logo_url: { format: 'uri', type: 'string' },
56202
56224
  primary_color: { type: 'string' },
56203
56225
  secondary_color: { type: 'string' },
56204
56226
  workspace_id: { format: 'uuid', type: 'string' },
56205
56227
  },
56206
- required: ['workspace_id', 'customization_profile_id'],
56228
+ required: [
56229
+ 'customization_profile_id',
56230
+ 'workspace_id',
56231
+ 'created_at',
56232
+ ],
56207
56233
  type: 'object',
56234
+ 'x-route-path': '/workspaces/customization_profiles',
56235
+ 'x-title': 'Customization Profile',
56236
+ 'x-undocumented': 'Unreleased.',
56208
56237
  },
56209
56238
  ok: { type: 'boolean' },
56210
56239
  },
@@ -56226,6 +56255,7 @@ export default {
56226
56255
  'x-fern-sdk-return-value': 'customization_profile',
56227
56256
  'x-response-key': 'customization_profile',
56228
56257
  'x-title': 'Get Customization Profile',
56258
+ 'x-undocumented': 'Unreleased.',
56229
56259
  },
56230
56260
  },
56231
56261
  '/workspaces/customization_profiles/list': {
@@ -56240,18 +56270,27 @@ export default {
56240
56270
  properties: {
56241
56271
  customization_profiles: {
56242
56272
  items: {
56273
+ description: 'A customization profile.',
56243
56274
  properties: {
56275
+ created_at: { format: 'date-time', type: 'string' },
56244
56276
  customization_profile_id: {
56245
56277
  format: 'uuid',
56246
56278
  type: 'string',
56247
56279
  },
56248
- logo_url: { type: 'string' },
56280
+ logo_url: { format: 'uri', type: 'string' },
56249
56281
  primary_color: { type: 'string' },
56250
56282
  secondary_color: { type: 'string' },
56251
56283
  workspace_id: { format: 'uuid', type: 'string' },
56252
56284
  },
56253
- required: ['workspace_id', 'customization_profile_id'],
56285
+ required: [
56286
+ 'customization_profile_id',
56287
+ 'workspace_id',
56288
+ 'created_at',
56289
+ ],
56254
56290
  type: 'object',
56291
+ 'x-route-path': '/workspaces/customization_profiles',
56292
+ 'x-title': 'Customization Profile',
56293
+ 'x-undocumented': 'Unreleased.',
56255
56294
  },
56256
56295
  type: 'array',
56257
56296
  },
@@ -56275,6 +56314,7 @@ export default {
56275
56314
  'x-fern-sdk-return-value': 'customization_profiles',
56276
56315
  'x-response-key': 'customization_profiles',
56277
56316
  'x-title': 'Get Customization Profile',
56317
+ 'x-undocumented': 'Unreleased.',
56278
56318
  },
56279
56319
  post: {
56280
56320
  description: 'Retrieves the customization profile for the workspace.',
@@ -56287,18 +56327,27 @@ export default {
56287
56327
  properties: {
56288
56328
  customization_profiles: {
56289
56329
  items: {
56330
+ description: 'A customization profile.',
56290
56331
  properties: {
56332
+ created_at: { format: 'date-time', type: 'string' },
56291
56333
  customization_profile_id: {
56292
56334
  format: 'uuid',
56293
56335
  type: 'string',
56294
56336
  },
56295
- logo_url: { type: 'string' },
56337
+ logo_url: { format: 'uri', type: 'string' },
56296
56338
  primary_color: { type: 'string' },
56297
56339
  secondary_color: { type: 'string' },
56298
56340
  workspace_id: { format: 'uuid', type: 'string' },
56299
56341
  },
56300
- required: ['workspace_id', 'customization_profile_id'],
56342
+ required: [
56343
+ 'customization_profile_id',
56344
+ 'workspace_id',
56345
+ 'created_at',
56346
+ ],
56301
56347
  type: 'object',
56348
+ 'x-route-path': '/workspaces/customization_profiles',
56349
+ 'x-title': 'Customization Profile',
56350
+ 'x-undocumented': 'Unreleased.',
56302
56351
  },
56303
56352
  type: 'array',
56304
56353
  },
@@ -56322,6 +56371,7 @@ export default {
56322
56371
  'x-fern-sdk-return-value': 'customization_profiles',
56323
56372
  'x-response-key': 'customization_profiles',
56324
56373
  'x-title': 'Get Customization Profile',
56374
+ 'x-undocumented': 'Unreleased.',
56325
56375
  },
56326
56376
  },
56327
56377
  '/workspaces/customization_profiles/update': {
@@ -56366,6 +56416,7 @@ export default {
56366
56416
  'x-fern-sdk-method-name': 'update',
56367
56417
  'x-response-key': null,
56368
56418
  'x-title': 'Update Customization Profile',
56419
+ 'x-undocumented': 'Unreleased.',
56369
56420
  },
56370
56421
  post: {
56371
56422
  description: 'Updates the customization profile for the workspace.',
@@ -56408,6 +56459,7 @@ export default {
56408
56459
  'x-fern-sdk-method-name': 'update',
56409
56460
  'x-response-key': null,
56410
56461
  'x-title': 'Update Customization Profile',
56462
+ 'x-undocumented': 'Unreleased.',
56411
56463
  },
56412
56464
  },
56413
56465
  '/workspaces/customization_profiles/upload_images': {
@@ -56437,7 +56489,8 @@ export default {
56437
56489
  'x-fern-sdk-method-name': 'upload_images',
56438
56490
  'x-response-key': null,
56439
56491
  'x-title': 'Upload Customization Profile Logo',
56440
- 'x-undocumented': 'Internal endpoint for customer portals.',
56492
+ 'x-undocumented':
56493
+ 'Internal form-data endpoint for Console and Customer Portal.',
56441
56494
  },
56442
56495
  },
56443
56496
  '/workspaces/find_resources': {
@@ -89861,9 +89861,11 @@ export type Routes = {
89861
89861
  commonParams: {}
89862
89862
  formData: {}
89863
89863
  jsonResponse: {
89864
+ /** A customization profile. */
89864
89865
  customization_profile: {
89865
- workspace_id: string
89866
89866
  customization_profile_id: string
89867
+ workspace_id: string
89868
+ created_at: string
89867
89869
  logo_url?: string | undefined
89868
89870
  primary_color?: string | undefined
89869
89871
  secondary_color?: string | undefined
@@ -89880,9 +89882,11 @@ export type Routes = {
89880
89882
  }
89881
89883
  formData: {}
89882
89884
  jsonResponse: {
89885
+ /** A customization profile. */
89883
89886
  customization_profile: {
89884
- workspace_id: string
89885
89887
  customization_profile_id: string
89888
+ workspace_id: string
89889
+ created_at: string
89886
89890
  logo_url?: string | undefined
89887
89891
  primary_color?: string | undefined
89888
89892
  secondary_color?: string | undefined
@@ -89898,8 +89902,9 @@ export type Routes = {
89898
89902
  formData: {}
89899
89903
  jsonResponse: {
89900
89904
  customization_profiles: {
89901
- workspace_id: string
89902
89905
  customization_profile_id: string
89906
+ workspace_id: string
89907
+ created_at: string
89903
89908
  logo_url?: string | undefined
89904
89909
  primary_color?: string | undefined
89905
89910
  secondary_color?: string | undefined