@seamapi/types 1.565.0 → 1.567.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.
@@ -11369,6 +11369,8 @@ export type Routes = {
11369
11369
  acs_system_id: string;
11370
11370
  /** ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
11371
11371
  acs_entrance_id: string;
11372
+ /** IDs of the spaces that the entrance is in. */
11373
+ space_ids: string[];
11372
11374
  /** Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created. */
11373
11375
  created_at: string;
11374
11376
  /** Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
@@ -14548,6 +14550,8 @@ export type Routes = {
14548
14550
  acs_system_id: string;
14549
14551
  /** ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
14550
14552
  acs_entrance_id: string;
14553
+ /** IDs of the spaces that the entrance is in. */
14554
+ space_ids: string[];
14551
14555
  /** Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created. */
14552
14556
  created_at: string;
14553
14557
  /** Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
@@ -20517,6 +20521,8 @@ export type Routes = {
20517
20521
  acs_system_id: string;
20518
20522
  /** ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
20519
20523
  acs_entrance_id: string;
20524
+ /** IDs of the spaces that the entrance is in. */
20525
+ space_ids: string[];
20520
20526
  /** Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created. */
20521
20527
  created_at: string;
20522
20528
  /** Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
@@ -21883,6 +21889,8 @@ export type Routes = {
21883
21889
  acs_system_id: string;
21884
21890
  /** ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
21885
21891
  acs_entrance_id: string;
21892
+ /** IDs of the spaces that the entrance is in. */
21893
+ space_ids: string[];
21886
21894
  /** Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created. */
21887
21895
  created_at: string;
21888
21896
  /** Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
@@ -25329,6 +25337,8 @@ export type Routes = {
25329
25337
  acs_system_id: string;
25330
25338
  /** ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
25331
25339
  acs_entrance_id: string;
25340
+ /** IDs of the spaces that the entrance is in. */
25341
+ space_ids: string[];
25332
25342
  /** Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created. */
25333
25343
  created_at: string;
25334
25344
  /** Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
@@ -25496,6 +25506,8 @@ export type Routes = {
25496
25506
  acs_system_id: string;
25497
25507
  /** ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
25498
25508
  acs_entrance_id: string;
25509
+ /** IDs of the spaces that the entrance is in. */
25510
+ space_ids: string[];
25499
25511
  /** Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created. */
25500
25512
  created_at: string;
25501
25513
  /** Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
@@ -26937,6 +26949,8 @@ export type Routes = {
26937
26949
  acs_system_id: string;
26938
26950
  /** ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
26939
26951
  acs_entrance_id: string;
26952
+ /** IDs of the spaces that the entrance is in. */
26953
+ space_ids: string[];
26940
26954
  /** Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created. */
26941
26955
  created_at: string;
26942
26956
  /** Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
@@ -31200,6 +31214,8 @@ export type Routes = {
31200
31214
  connect?: {
31201
31215
  /** Whether to exclude this feature from the portal. */
31202
31216
  exclude?: boolean;
31217
+ /** List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account. */
31218
+ excluded_providers?: string[] | undefined;
31203
31219
  };
31204
31220
  /** Configuration for the manage devices feature. */
31205
31221
  manage_devices?: {
@@ -31225,7 +31241,7 @@ export type Routes = {
31225
31241
  is_embedded?: boolean;
31226
31242
  /** Configuration for the landing page when the portal loads. */
31227
31243
  landing_page?: {
31228
- manage?: ({
31244
+ manage?: (({
31229
31245
  space_key: string;
31230
31246
  } | {
31231
31247
  property_key: string;
@@ -31243,7 +31259,13 @@ export type Routes = {
31243
31259
  listing_key: string;
31244
31260
  } | {
31245
31261
  property_listing_key: string;
31246
- }) | undefined;
31262
+ }) | ({
31263
+ reservation_key: string;
31264
+ } | {
31265
+ booking_key: string;
31266
+ } | {
31267
+ access_grant_key: string;
31268
+ })) | undefined;
31247
31269
  } | undefined;
31248
31270
  } & {
31249
31271
  customer_data?: {
@@ -58168,6 +58190,7 @@ export type Routes = {
58168
58190
  features?: {
58169
58191
  connect?: {
58170
58192
  exclude?: boolean | undefined;
58193
+ excluded_providers?: string[] | undefined;
58171
58194
  } | undefined;
58172
58195
  manage_devices?: {
58173
58196
  exclude?: boolean | undefined;
@@ -58183,7 +58206,7 @@ export type Routes = {
58183
58206
  } | undefined;
58184
58207
  is_embedded?: boolean | undefined;
58185
58208
  landing_page?: {
58186
- manage?: ({
58209
+ manage?: (({
58187
58210
  space_key: string;
58188
58211
  } | {
58189
58212
  property_key: string;
@@ -58201,7 +58224,13 @@ export type Routes = {
58201
58224
  listing_key: string;
58202
58225
  } | {
58203
58226
  property_listing_key: string;
58204
- }) | undefined;
58227
+ }) | ({
58228
+ reservation_key: string;
58229
+ } | {
58230
+ booking_key: string;
58231
+ } | {
58232
+ access_grant_key: string;
58233
+ })) | undefined;
58205
58234
  } | undefined;
58206
58235
  /** Business vertical of the customer portal. */
58207
58236
  business_vertical?: ('short_term_rental' | 'hospitality' | 'multi_family' | 'gym_management' | 'property_tours') | undefined;
@@ -58727,6 +58756,8 @@ export type Routes = {
58727
58756
  acs_system_id: string;
58728
58757
  /** ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
58729
58758
  acs_entrance_id: string;
58759
+ /** IDs of the spaces that the entrance is in. */
58760
+ space_ids: string[];
58730
58761
  /** Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created. */
58731
58762
  created_at: string;
58732
58763
  /** Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
@@ -60278,6 +60309,8 @@ export type Routes = {
60278
60309
  acs_system_id: string;
60279
60310
  /** ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
60280
60311
  acs_entrance_id: string;
60312
+ /** IDs of the spaces that the entrance is in. */
60313
+ space_ids: string[];
60281
60314
  /** Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created. */
60282
60315
  created_at: string;
60283
60316
  /** Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
@@ -60391,7 +60424,6 @@ export type Routes = {
60391
60424
  can_unlock_with_card?: boolean | undefined;
60392
60425
  /** Indicates whether the ACS entrance can be unlocked with pin codes. */
60393
60426
  can_unlock_with_code?: boolean | undefined;
60394
- space_ids: string[];
60395
60427
  }[] | undefined;
60396
60428
  connected_accounts?: {
60397
60429
  /** ID of the connected account. */
@@ -81160,6 +81192,8 @@ export type Routes = {
81160
81192
  acs_system_id: string;
81161
81193
  /** ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
81162
81194
  acs_entrance_id: string;
81195
+ /** IDs of the spaces that the entrance is in. */
81196
+ space_ids: string[];
81163
81197
  /** Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created. */
81164
81198
  created_at: string;
81165
81199
  /** Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.565.0",
3
+ "version": "1.567.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -46,6 +46,9 @@ export const acs_entrance = z
46
46
  .describe(
47
47
  'ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
48
48
  ),
49
+ space_ids: z
50
+ .array(z.string().uuid())
51
+ .describe('IDs of the spaces that the entrance is in.'),
49
52
  created_at: z
50
53
  .string()
51
54
  .datetime()
@@ -42,12 +42,7 @@ export const spaces_batch = z
42
42
  })
43
43
  .array()
44
44
  .optional(),
45
- acs_entrances: acs_entrance
46
- .extend({
47
- space_ids: z.array(z.string().uuid()),
48
- })
49
- .array()
50
- .optional(),
45
+ acs_entrances: acs_entrance.array().optional(),
51
46
  connected_accounts: connected_account.array().optional(),
52
47
  acs_systems: acs_system.array().optional(),
53
48
  })
@@ -69,6 +64,10 @@ export const access_methods_batch = z.object({
69
64
  spaces: space.array().optional(),
70
65
  devices: device.array().optional(),
71
66
  acs_entrances: acs_entrance.array().optional(),
67
+ access_grants: access_grant.array().optional(),
68
+ access_methods: access_method.array().optional(),
69
+ instant_keys: instant_key.array().optional(),
70
+ client_sessions: client_session.array().optional(),
72
71
  })
73
72
 
74
73
  export const workspaces_batch = z
@@ -1,5 +1,6 @@
1
1
  import { z } from 'zod'
2
2
 
3
+ import { access_grant_key_aliases } from './access-grant-resources.js'
3
4
  import { location_key_aliases } from './location-resources.js'
4
5
 
5
6
  const base_feature = z.object({
@@ -9,7 +10,14 @@ const base_feature = z.object({
9
10
  .describe('Whether to exclude this feature from the portal.'),
10
11
  })
11
12
 
12
- const base_connect_feature = base_feature
13
+ const base_connect_feature = base_feature.extend({
14
+ excluded_providers: z
15
+ .array(z.string())
16
+ .optional()
17
+ .describe(
18
+ 'List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account.',
19
+ ),
20
+ })
13
21
  const base_manage_devices_feature = base_feature
14
22
  const base_organize_feature = base_feature
15
23
 
@@ -52,7 +60,9 @@ export const portal_configuration = z
52
60
  .describe('Whether the portal is embedded in another application.'),
53
61
  landing_page: z
54
62
  .object({
55
- manage: location_key_aliases.optional(),
63
+ manage: z
64
+ .union([location_key_aliases, access_grant_key_aliases])
65
+ .optional(),
56
66
  })
57
67
  .optional()
58
68
  .describe('Configuration for the landing page when the portal loads.'),