@seamapi/types 1.640.0 → 1.642.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.
Files changed (26) hide show
  1. package/dist/connect.cjs +81 -10
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +229 -19
  4. package/dist/index.cjs +81 -10
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/batch.d.ts +106 -26
  7. package/lib/seam/connect/models/customer/access-grant-resources.js +2 -0
  8. package/lib/seam/connect/models/customer/access-grant-resources.js.map +1 -1
  9. package/lib/seam/connect/models/customer/customer-portal.d.ts +14 -0
  10. package/lib/seam/connect/models/customer/customer-portal.js +5 -0
  11. package/lib/seam/connect/models/customer/customer-portal.js.map +1 -1
  12. package/lib/seam/connect/models/customization-profiles/customization-profile.d.ts +46 -2
  13. package/lib/seam/connect/models/customization-profiles/customization-profile.js +8 -0
  14. package/lib/seam/connect/models/customization-profiles/customization-profile.js.map +1 -1
  15. package/lib/seam/connect/models/instant-keys/instant-key.d.ts +4 -4
  16. package/lib/seam/connect/openapi.d.ts +97 -1
  17. package/lib/seam/connect/openapi.js +65 -1
  18. package/lib/seam/connect/openapi.js.map +1 -1
  19. package/lib/seam/connect/route-types.d.ts +48 -2
  20. package/package.json +1 -1
  21. package/src/lib/seam/connect/internal/schemas.ts +1 -0
  22. package/src/lib/seam/connect/models/customer/access-grant-resources.ts +2 -0
  23. package/src/lib/seam/connect/models/customer/customer-portal.ts +5 -0
  24. package/src/lib/seam/connect/models/customization-profiles/customization-profile.ts +10 -0
  25. package/src/lib/seam/connect/openapi.ts +68 -1
  26. package/src/lib/seam/connect/route-types.ts +65 -2
package/lib/seam/connect/route-types.d.ts CHANGED
@@ -20720,6 +20720,12 @@ export type Routes = {
20720
20720
  logo_url?: string | undefined;
20721
20721
  primary_color?: string | undefined;
20722
20722
  secondary_color?: string | undefined;
20723
+ customer_portal_theme?: {
20724
+ primary_color?: string | undefined;
20725
+ primary_foreground_color?: string | undefined;
20726
+ secondary_color?: string | undefined;
20727
+ secondary_foreground_color?: string | undefined;
20728
+ } | undefined;
20723
20729
  }[] | undefined;
20724
20730
  };
20725
20731
  };
@@ -31863,6 +31869,8 @@ export type Routes = {
31863
31869
  configure?: {
31864
31870
  /** Whether to exclude this feature from the portal. */
31865
31871
  exclude?: boolean;
31872
+ /** The ID of the customization profile to use for the portal. */
31873
+ customization_profile_id?: string | undefined;
31866
31874
  /** Indicates whether the customer can customize the access automation rules for their properties. */
31867
31875
  allow_access_automation_rule_customization?: boolean;
31868
31876
  /** Indicates whether the customer can customize the Instant Key profile for their properties. */
@@ -59560,6 +59568,8 @@ export type Routes = {
59560
59568
  configure?: {
59561
59569
  /** Whether to exclude this feature from the portal. */
59562
59570
  exclude?: boolean;
59571
+ /** The ID of the customization profile to use for the portal. */
59572
+ customization_profile_id?: string | undefined;
59563
59573
  /** Indicates whether the customer can customize the access automation rules for their properties. */
59564
59574
  allow_access_automation_rule_customization?: boolean;
59565
59575
  /** Indicates whether the customer can customize the Instant Key profile for their properties. */
@@ -81785,8 +81795,14 @@ export type Routes = {
81785
81795
  queryParams: {};
81786
81796
  jsonBody: {
81787
81797
  name?: string | null;
81788
- primary_color: string;
81789
- secondary_color: string;
81798
+ primary_color?: string | undefined;
81799
+ secondary_color?: string | undefined;
81800
+ customer_portal_theme?: {
81801
+ primary_color?: string | undefined;
81802
+ primary_foreground_color?: string | undefined;
81803
+ secondary_color?: string | undefined;
81804
+ secondary_foreground_color?: string | undefined;
81805
+ } | undefined;
81790
81806
  };
81791
81807
  commonParams: {};
81792
81808
  formData: {};
@@ -81800,6 +81816,12 @@ export type Routes = {
81800
81816
  logo_url?: string | undefined;
81801
81817
  primary_color?: string | undefined;
81802
81818
  secondary_color?: string | undefined;
81819
+ customer_portal_theme?: {
81820
+ primary_color?: string | undefined;
81821
+ primary_foreground_color?: string | undefined;
81822
+ secondary_color?: string | undefined;
81823
+ secondary_foreground_color?: string | undefined;
81824
+ } | undefined;
81803
81825
  };
81804
81826
  };
81805
81827
  };
@@ -81822,6 +81844,12 @@ export type Routes = {
81822
81844
  logo_url?: string | undefined;
81823
81845
  primary_color?: string | undefined;
81824
81846
  secondary_color?: string | undefined;
81847
+ customer_portal_theme?: {
81848
+ primary_color?: string | undefined;
81849
+ primary_foreground_color?: string | undefined;
81850
+ secondary_color?: string | undefined;
81851
+ secondary_foreground_color?: string | undefined;
81852
+ } | undefined;
81825
81853
  };
81826
81854
  };
81827
81855
  };
@@ -81844,6 +81872,12 @@ export type Routes = {
81844
81872
  logo_url?: string | undefined;
81845
81873
  primary_color?: string | undefined;
81846
81874
  secondary_color?: string | undefined;
81875
+ customer_portal_theme?: {
81876
+ primary_color?: string | undefined;
81877
+ primary_foreground_color?: string | undefined;
81878
+ secondary_color?: string | undefined;
81879
+ secondary_foreground_color?: string | undefined;
81880
+ } | undefined;
81847
81881
  }[];
81848
81882
  };
81849
81883
  };
@@ -81856,6 +81890,12 @@ export type Routes = {
81856
81890
  name?: (string | undefined) | null;
81857
81891
  primary_color?: string | undefined;
81858
81892
  secondary_color?: string | undefined;
81893
+ customer_portal_theme?: ({
81894
+ primary_color?: string | undefined;
81895
+ primary_foreground_color?: string | undefined;
81896
+ secondary_color?: string | undefined;
81897
+ secondary_foreground_color?: string | undefined;
81898
+ } | undefined) | null;
81859
81899
  };
81860
81900
  commonParams: {};
81861
81901
  formData: {};
@@ -89043,6 +89083,12 @@ export type Routes = {
89043
89083
  logo_url?: string | undefined;
89044
89084
  primary_color?: string | undefined;
89045
89085
  secondary_color?: string | undefined;
89086
+ customer_portal_theme?: {
89087
+ primary_color?: string | undefined;
89088
+ primary_foreground_color?: string | undefined;
89089
+ secondary_color?: string | undefined;
89090
+ secondary_foreground_color?: string | undefined;
89091
+ } | undefined;
89046
89092
  }[] | undefined;
89047
89093
  };
89048
89094
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.640.0",
3
+ "version": "1.642.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
package/src/lib/seam/connect/internal/schemas.ts CHANGED
@@ -39,6 +39,7 @@ export {
39
39
  connected_account,
40
40
  custom_metadata_input,
41
41
  customer_data,
42
+ customer_portal_theme,
42
43
  device_capability_flags,
43
44
  device_metadata,
44
45
  device_provider,
package/src/lib/seam/connect/models/customer/access-grant-resources.ts CHANGED
@@ -8,10 +8,12 @@ const base_access_grant_resource = z.object({
8
8
  .describe('Your name for this access grant resource.'),
9
9
  starts_at: z
10
10
  .string()
11
+ .datetime()
11
12
  .optional()
12
13
  .describe('Starting date and time for the access grant.'),
13
14
  ends_at: z
14
15
  .string()
16
+ .datetime()
15
17
  .optional()
16
18
  .describe('Ending date and time for the access grant.'),
17
19
  preferred_code: z
package/src/lib/seam/connect/models/customer/customer-portal.ts CHANGED
@@ -44,6 +44,11 @@ const base_manage_feature = base_feature.extend({
44
44
  const base_organize_feature = base_feature
45
45
 
46
46
  const base_configure_feature = base_feature.extend({
47
+ customization_profile_id: z
48
+ .string()
49
+ .uuid()
50
+ .optional()
51
+ .describe('The ID of the customization profile to use for the portal.'),
47
52
  allow_access_automation_rule_customization: z
48
53
  .boolean()
49
54
  .default(false)
package/src/lib/seam/connect/models/customization-profiles/customization-profile.ts CHANGED
@@ -1,5 +1,14 @@
1
1
  import { z } from 'zod'
2
2
 
3
+ import { hex_color_code } from '../colors.js'
4
+
5
+ export const customer_portal_theme = z.object({
6
+ primary_color: hex_color_code.optional(),
7
+ primary_foreground_color: hex_color_code.optional(),
8
+ secondary_color: hex_color_code.optional(),
9
+ secondary_foreground_color: hex_color_code.optional(),
10
+ })
11
+
3
12
  export const customization_profile = z.object({
4
13
  workspace_id: z.string().uuid(),
5
14
  name: z.string().nullable(),
@@ -8,6 +17,7 @@ export const customization_profile = z.object({
8
17
  logo_url: z.string().url().optional(),
9
18
  primary_color: z.string().optional(),
10
19
  secondary_color: z.string().optional(),
20
+ customer_portal_theme: customer_portal_theme.optional(),
11
21
  }).describe(`
12
22
  ---
13
23
  title: Customization Profile
package/src/lib/seam/connect/openapi.ts CHANGED
@@ -9408,6 +9408,15 @@ export default {
9408
9408
  description: 'A customization profile.',
9409
9409
  properties: {
9410
9410
  created_at: { format: 'date-time', type: 'string' },
9411
+ customer_portal_theme: {
9412
+ properties: {
9413
+ primary_color: { type: 'string' },
9414
+ primary_foreground_color: { type: 'string' },
9415
+ secondary_color: { type: 'string' },
9416
+ secondary_foreground_color: { type: 'string' },
9417
+ },
9418
+ type: 'object',
9419
+ },
9411
9420
  customization_profile_id: { format: 'uuid', type: 'string' },
9412
9421
  logo_url: { format: 'uri', type: 'string' },
9413
9422
  name: { nullable: true, type: 'string' },
@@ -41231,6 +41240,12 @@ export default {
41231
41240
  'Indicates whether the customer can customize the Instant Key profile for their properties.',
41232
41241
  type: 'boolean',
41233
41242
  },
41243
+ customization_profile_id: {
41244
+ description:
41245
+ 'The ID of the customization profile to use for the portal.',
41246
+ format: 'uuid',
41247
+ type: 'string',
41248
+ },
41234
41249
  exclude: {
41235
41250
  default: false,
41236
41251
  description:
@@ -41471,6 +41486,7 @@ export default {
41471
41486
  ends_at: {
41472
41487
  description:
41473
41488
  'Ending date and time for the access grant.',
41489
+ format: 'date-time',
41474
41490
  type: 'string',
41475
41491
  },
41476
41492
  facility_keys: {
@@ -41526,6 +41542,7 @@ export default {
41526
41542
  starts_at: {
41527
41543
  description:
41528
41544
  'Starting date and time for the access grant.',
41545
+ format: 'date-time',
41529
41546
  type: 'string',
41530
41547
  },
41531
41548
  tenant_key: {
@@ -41580,6 +41597,7 @@ export default {
41580
41597
  ends_at: {
41581
41598
  description:
41582
41599
  'Ending date and time for the access grant.',
41600
+ format: 'date-time',
41583
41601
  type: 'string',
41584
41602
  },
41585
41603
  facility_keys: {
@@ -41635,6 +41653,7 @@ export default {
41635
41653
  starts_at: {
41636
41654
  description:
41637
41655
  'Starting date and time for the access grant.',
41656
+ format: 'date-time',
41638
41657
  type: 'string',
41639
41658
  },
41640
41659
  tenant_key: {
@@ -41853,6 +41872,7 @@ export default {
41853
41872
  ends_at: {
41854
41873
  description:
41855
41874
  'Ending date and time for the access grant.',
41875
+ format: 'date-time',
41856
41876
  type: 'string',
41857
41877
  },
41858
41878
  facility_keys: {
@@ -41914,6 +41934,7 @@ export default {
41914
41934
  starts_at: {
41915
41935
  description:
41916
41936
  'Starting date and time for the access grant.',
41937
+ format: 'date-time',
41917
41938
  type: 'string',
41918
41939
  },
41919
41940
  tenant_key: {
@@ -42683,6 +42704,7 @@ export default {
42683
42704
  ends_at: {
42684
42705
  description:
42685
42706
  'Ending date and time for the access grant.',
42707
+ format: 'date-time',
42686
42708
  type: 'string',
42687
42709
  },
42688
42710
  facility_keys: {
@@ -42738,6 +42760,7 @@ export default {
42738
42760
  starts_at: {
42739
42761
  description:
42740
42762
  'Starting date and time for the access grant.',
42763
+ format: 'date-time',
42741
42764
  type: 'string',
42742
42765
  },
42743
42766
  tenant_key: {
@@ -42792,6 +42815,7 @@ export default {
42792
42815
  ends_at: {
42793
42816
  description:
42794
42817
  'Ending date and time for the access grant.',
42818
+ format: 'date-time',
42795
42819
  type: 'string',
42796
42820
  },
42797
42821
  facility_keys: {
@@ -42847,6 +42871,7 @@ export default {
42847
42871
  starts_at: {
42848
42872
  description:
42849
42873
  'Starting date and time for the access grant.',
42874
+ format: 'date-time',
42850
42875
  type: 'string',
42851
42876
  },
42852
42877
  tenant_key: {
@@ -43061,6 +43086,7 @@ export default {
43061
43086
  ends_at: {
43062
43087
  description:
43063
43088
  'Ending date and time for the access grant.',
43089
+ format: 'date-time',
43064
43090
  type: 'string',
43065
43091
  },
43066
43092
  facility_keys: {
@@ -43122,6 +43148,7 @@ export default {
43122
43148
  starts_at: {
43123
43149
  description:
43124
43150
  'Starting date and time for the access grant.',
43151
+ format: 'date-time',
43125
43152
  type: 'string',
43126
43153
  },
43127
43154
  tenant_key: {
@@ -53892,6 +53919,12 @@ export default {
53892
53919
  'Indicates whether the customer can customize the Instant Key profile for their properties.',
53893
53920
  type: 'boolean',
53894
53921
  },
53922
+ customization_profile_id: {
53923
+ description:
53924
+ 'The ID of the customization profile to use for the portal.',
53925
+ format: 'uuid',
53926
+ type: 'string',
53927
+ },
53895
53928
  exclude: {
53896
53929
  default: false,
53897
53930
  description:
@@ -54198,6 +54231,12 @@ export default {
54198
54231
  'Indicates whether the customer can customize the Instant Key profile for their properties.',
54199
54232
  type: 'boolean',
54200
54233
  },
54234
+ customization_profile_id: {
54235
+ description:
54236
+ 'The ID of the customization profile to use for the portal.',
54237
+ format: 'uuid',
54238
+ type: 'string',
54239
+ },
54201
54240
  exclude: {
54202
54241
  default: false,
54203
54242
  description:
@@ -65135,11 +65174,19 @@ export default {
65135
65174
  'application/json': {
65136
65175
  schema: {
65137
65176
  properties: {
65177
+ customer_portal_theme: {
65178
+ properties: {
65179
+ primary_color: { type: 'string' },
65180
+ primary_foreground_color: { type: 'string' },
65181
+ secondary_color: { type: 'string' },
65182
+ secondary_foreground_color: { type: 'string' },
65183
+ },
65184
+ type: 'object',
65185
+ },
65138
65186
  name: { default: null, nullable: true, type: 'string' },
65139
65187
  primary_color: { type: 'string' },
65140
65188
  secondary_color: { type: 'string' },
65141
65189
  },
65142
- required: ['primary_color', 'secondary_color'],
65143
65190
  type: 'object',
65144
65191
  },
65145
65192
  },
@@ -65405,6 +65452,16 @@ export default {
65405
65452
  'application/json': {
65406
65453
  schema: {
65407
65454
  properties: {
65455
+ customer_portal_theme: {
65456
+ nullable: true,
65457
+ properties: {
65458
+ primary_color: { type: 'string' },
65459
+ primary_foreground_color: { type: 'string' },
65460
+ secondary_color: { type: 'string' },
65461
+ secondary_foreground_color: { type: 'string' },
65462
+ },
65463
+ type: 'object',
65464
+ },
65408
65465
  customization_profile_id: { format: 'uuid', type: 'string' },
65409
65466
  name: { nullable: true, type: 'string' },
65410
65467
  primary_color: { type: 'string' },
@@ -65454,6 +65511,16 @@ export default {
65454
65511
  'application/json': {
65455
65512
  schema: {
65456
65513
  properties: {
65514
+ customer_portal_theme: {
65515
+ nullable: true,
65516
+ properties: {
65517
+ primary_color: { type: 'string' },
65518
+ primary_foreground_color: { type: 'string' },
65519
+ secondary_color: { type: 'string' },
65520
+ secondary_foreground_color: { type: 'string' },
65521
+ },
65522
+ type: 'object',
65523
+ },
65457
65524
  customization_profile_id: { format: 'uuid', type: 'string' },
65458
65525
  name: { nullable: true, type: 'string' },
65459
65526
  primary_color: { type: 'string' },
package/src/lib/seam/connect/route-types.ts CHANGED
@@ -24083,6 +24083,14 @@ export type Routes = {
24083
24083
  logo_url?: string | undefined
24084
24084
  primary_color?: string | undefined
24085
24085
  secondary_color?: string | undefined
24086
+ customer_portal_theme?:
24087
+ | {
24088
+ primary_color?: string | undefined
24089
+ primary_foreground_color?: string | undefined
24090
+ secondary_color?: string | undefined
24091
+ secondary_foreground_color?: string | undefined
24092
+ }
24093
+ | undefined
24086
24094
  }[]
24087
24095
  | undefined
24088
24096
  }
@@ -36997,6 +37005,8 @@ export type Routes = {
36997
37005
  configure?: {
36998
37006
  /** Whether to exclude this feature from the portal. */
36999
37007
  exclude?: boolean
37008
+ /** The ID of the customization profile to use for the portal. */
37009
+ customization_profile_id?: string | undefined
37000
37010
  /** Indicates whether the customer can customize the access automation rules for their properties. */
37001
37011
  allow_access_automation_rule_customization?: boolean
37002
37012
  /** Indicates whether the customer can customize the Instant Key profile for their properties. */
@@ -70913,6 +70923,8 @@ export type Routes = {
70913
70923
  configure?: {
70914
70924
  /** Whether to exclude this feature from the portal. */
70915
70925
  exclude?: boolean
70926
+ /** The ID of the customization profile to use for the portal. */
70927
+ customization_profile_id?: string | undefined
70916
70928
  /** Indicates whether the customer can customize the access automation rules for their properties. */
70917
70929
  allow_access_automation_rule_customization?: boolean
70918
70930
  /** Indicates whether the customer can customize the Instant Key profile for their properties. */
@@ -97215,8 +97227,16 @@ export type Routes = {
97215
97227
  queryParams: {}
97216
97228
  jsonBody: {
97217
97229
  name?: string | null
97218
- primary_color: string
97219
- secondary_color: string
97230
+ primary_color?: string | undefined
97231
+ secondary_color?: string | undefined
97232
+ customer_portal_theme?:
97233
+ | {
97234
+ primary_color?: string | undefined
97235
+ primary_foreground_color?: string | undefined
97236
+ secondary_color?: string | undefined
97237
+ secondary_foreground_color?: string | undefined
97238
+ }
97239
+ | undefined
97220
97240
  }
97221
97241
  commonParams: {}
97222
97242
  formData: {}
@@ -97230,6 +97250,14 @@ export type Routes = {
97230
97250
  logo_url?: string | undefined
97231
97251
  primary_color?: string | undefined
97232
97252
  secondary_color?: string | undefined
97253
+ customer_portal_theme?:
97254
+ | {
97255
+ primary_color?: string | undefined
97256
+ primary_foreground_color?: string | undefined
97257
+ secondary_color?: string | undefined
97258
+ secondary_foreground_color?: string | undefined
97259
+ }
97260
+ | undefined
97233
97261
  }
97234
97262
  }
97235
97263
  }
@@ -97252,6 +97280,14 @@ export type Routes = {
97252
97280
  logo_url?: string | undefined
97253
97281
  primary_color?: string | undefined
97254
97282
  secondary_color?: string | undefined
97283
+ customer_portal_theme?:
97284
+ | {
97285
+ primary_color?: string | undefined
97286
+ primary_foreground_color?: string | undefined
97287
+ secondary_color?: string | undefined
97288
+ secondary_foreground_color?: string | undefined
97289
+ }
97290
+ | undefined
97255
97291
  }
97256
97292
  }
97257
97293
  }
@@ -97274,6 +97310,14 @@ export type Routes = {
97274
97310
  logo_url?: string | undefined
97275
97311
  primary_color?: string | undefined
97276
97312
  secondary_color?: string | undefined
97313
+ customer_portal_theme?:
97314
+ | {
97315
+ primary_color?: string | undefined
97316
+ primary_foreground_color?: string | undefined
97317
+ secondary_color?: string | undefined
97318
+ secondary_foreground_color?: string | undefined
97319
+ }
97320
+ | undefined
97277
97321
  }[]
97278
97322
  }
97279
97323
  }
@@ -97286,6 +97330,17 @@ export type Routes = {
97286
97330
  name?: (string | undefined) | null
97287
97331
  primary_color?: string | undefined
97288
97332
  secondary_color?: string | undefined
97333
+ customer_portal_theme?:
97334
+ | (
97335
+ | {
97336
+ primary_color?: string | undefined
97337
+ primary_foreground_color?: string | undefined
97338
+ secondary_color?: string | undefined
97339
+ secondary_foreground_color?: string | undefined
97340
+ }
97341
+ | undefined
97342
+ )
97343
+ | null
97289
97344
  }
97290
97345
  commonParams: {}
97291
97346
  formData: {}
@@ -105874,6 +105929,14 @@ export type Routes = {
105874
105929
  logo_url?: string | undefined
105875
105930
  primary_color?: string | undefined
105876
105931
  secondary_color?: string | undefined
105932
+ customer_portal_theme?:
105933
+ | {
105934
+ primary_color?: string | undefined
105935
+ primary_foreground_color?: string | undefined
105936
+ secondary_color?: string | undefined
105937
+ secondary_foreground_color?: string | undefined
105938
+ }
105939
+ | undefined
105877
105940
  }[]
105878
105941
  | undefined
105879
105942
  }