@seamapi/types 1.596.0 → 1.598.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.
@@ -30539,7 +30539,7 @@ export type Routes = {
30539
30539
  user_identity_ids?: string[] | undefined;
30540
30540
  /** ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session (or that are already associated with the existing client session). */
30541
30541
  user_identity_id?: string | undefined;
30542
- /** Date and time at which the client session should expire (or at which the existing client session expires), in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
30542
+ /** Date and time at which the client session should expire in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. If the client session already exists, this will update the expiration before returning it. */
30543
30543
  expires_at?: Date | undefined;
30544
30544
  };
30545
30545
  commonParams: {};
@@ -31453,10 +31453,24 @@ export type Routes = {
31453
31453
  /** List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account. */
31454
31454
  excluded_providers?: string[] | undefined;
31455
31455
  };
31456
+ /** Configuration for the manage reservations feature. */
31457
+ manage_reservations?: {
31458
+ /** Whether to exclude this feature from the portal. */
31459
+ exclude?: boolean;
31460
+ /** Configuration for the reservations feature. */
31461
+ reservations?: {
31462
+ /** Indicates whether the customer can view reservations for their properties. */
31463
+ exclude?: boolean;
31464
+ };
31465
+ };
31456
31466
  /** Configuration for the manage devices feature. */
31457
31467
  manage_devices?: {
31458
31468
  /** Whether to exclude this feature from the portal. */
31459
31469
  exclude?: boolean;
31470
+ /** List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account. */
31471
+ accepted_providers?: string[] | undefined;
31472
+ /** List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account. */
31473
+ excluded_providers?: string[] | undefined;
31460
31474
  };
31461
31475
  /** Configuration for the organize feature. */
31462
31476
  organize?: {
@@ -58582,23 +58596,52 @@ export type Routes = {
58582
58596
  jsonResponse: {
58583
58597
  customer_portal: {
58584
58598
  features?: {
58599
+ /** Configuration for the connect accounts feature. */
58585
58600
  connect?: {
58586
- exclude?: boolean | undefined;
58601
+ /** Whether to exclude this feature from the portal. */
58602
+ exclude?: boolean;
58603
+ /** List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account. */
58604
+ accepted_providers?: string[] | undefined;
58605
+ /** List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account. */
58587
58606
  excluded_providers?: string[] | undefined;
58588
- } | undefined;
58607
+ };
58608
+ /** Configuration for the manage reservations feature. */
58609
+ manage_reservations?: {
58610
+ /** Whether to exclude this feature from the portal. */
58611
+ exclude?: boolean;
58612
+ /** Configuration for the reservations feature. */
58613
+ reservations?: {
58614
+ /** Indicates whether the customer can view reservations for their properties. */
58615
+ exclude?: boolean;
58616
+ };
58617
+ };
58618
+ /** Configuration for the manage devices feature. */
58589
58619
  manage_devices?: {
58590
- exclude?: boolean | undefined;
58591
- } | undefined;
58620
+ /** Whether to exclude this feature from the portal. */
58621
+ exclude?: boolean;
58622
+ /** List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account. */
58623
+ accepted_providers?: string[] | undefined;
58624
+ /** List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account. */
58625
+ excluded_providers?: string[] | undefined;
58626
+ };
58627
+ /** Configuration for the organize feature. */
58592
58628
  organize?: {
58593
- exclude?: boolean | undefined;
58594
- } | undefined;
58629
+ /** Whether to exclude this feature from the portal. */
58630
+ exclude?: boolean;
58631
+ };
58632
+ /** Configuration for the configure feature. */
58595
58633
  configure?: {
58596
- exclude?: boolean | undefined;
58597
- allow_access_automation_rule_customization?: boolean | undefined;
58598
- allow_instant_key_customization?: boolean | undefined;
58599
- } | undefined;
58600
- } | undefined;
58601
- is_embedded?: boolean | undefined;
58634
+ /** Whether to exclude this feature from the portal. */
58635
+ exclude?: boolean;
58636
+ /** Indicates whether the customer can customize the access automation rules for their properties. */
58637
+ allow_access_automation_rule_customization?: boolean;
58638
+ /** Indicates whether the customer can customize the Instant Key profile for their properties. */
58639
+ allow_instant_key_customization?: boolean;
58640
+ };
58641
+ };
58642
+ /** Whether the portal is embedded in another application. */
58643
+ is_embedded?: boolean;
58644
+ /** Configuration for the landing page when the portal loads. */
58602
58645
  landing_page?: {
58603
58646
  manage?: (({
58604
58647
  space_key: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.596.0",
3
+ "version": "1.598.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -24,7 +24,19 @@ const base_connect_feature = base_feature.extend({
24
24
  'List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account.',
25
25
  ),
26
26
  })
27
- const base_manage_devices_feature = base_feature
27
+ const base_manage_devices_feature = base_feature.extend({
28
+ reservations: z
29
+ .object({
30
+ exclude: z
31
+ .boolean()
32
+ .default(false)
33
+ .describe(
34
+ 'Indicates whether the customer can view reservations for their properties.',
35
+ ),
36
+ })
37
+ .default({ exclude: false })
38
+ .describe('Configuration for the reservations feature.'),
39
+ })
28
40
  const base_organize_feature = base_feature
29
41
 
30
42
  const base_configure_feature = base_feature.extend({
@@ -46,7 +58,10 @@ const base_features = z.object({
46
58
  connect: base_connect_feature
47
59
  .default({})
48
60
  .describe('Configuration for the connect accounts feature.'),
49
- manage_devices: base_manage_devices_feature
61
+ manage_reservations: base_manage_devices_feature
62
+ .default({})
63
+ .describe('Configuration for the manage reservations feature.'),
64
+ manage_devices: base_connect_feature
50
65
  .default({})
51
66
  .describe('Configuration for the manage devices feature.'),
52
67
  organize: base_organize_feature
@@ -57,27 +72,31 @@ const base_features = z.object({
57
72
  .describe('Configuration for the configure feature.'),
58
73
  })
59
74
 
60
- export const portal_configuration = z
61
- .object({
62
- features: base_features.default({}),
63
- is_embedded: z
64
- .boolean()
65
- .default(false)
66
- .describe('Whether the portal is embedded in another application.'),
67
- landing_page: z
68
- .object({
69
- manage: z
70
- .union([location_key_aliases, access_grant_key_aliases])
71
- .optional(),
72
- })
73
- .optional()
74
- .describe('Configuration for the landing page when the portal loads.'),
75
- })
75
+ export const portal_configuration_base = z.object({
76
+ features: base_features.default({}),
77
+ is_embedded: z
78
+ .boolean()
79
+ .default(false)
80
+ .describe('Whether the portal is embedded in another application.'),
81
+ landing_page: z
82
+ .object({
83
+ manage: z
84
+ .union([location_key_aliases, access_grant_key_aliases])
85
+ .optional(),
86
+ })
87
+ .optional()
88
+ .describe('Configuration for the landing page when the portal loads.'),
89
+ })
90
+
91
+ export const portal_configuration = portal_configuration_base
76
92
  .default({
77
93
  features: {
78
94
  connect: { exclude: false },
79
95
  organize: { exclude: false },
80
- manage_devices: { exclude: false },
96
+ manage_reservations: { exclude: false },
97
+ manage_devices: {
98
+ exclude: false,
99
+ },
81
100
  configure: {
82
101
  exclude: false,
83
102
  allow_instant_key_customization: false, // default
@@ -38931,7 +38931,7 @@ export default {
38931
38931
  },
38932
38932
  expires_at: {
38933
38933
  description:
38934
- 'Date and time at which the client session should expire (or at which the existing client session expires), in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
38934
+ 'Date and time at which the client session should expire in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. If the client session already exists, this will update the expiration before returning it.',
38935
38935
  format: 'date-time',
38936
38936
  type: 'string',
38937
38937
  },
@@ -40663,6 +40663,7 @@ export default {
40663
40663
  },
40664
40664
  connect: { exclude: false },
40665
40665
  manage_devices: { exclude: false },
40666
+ manage_reservations: { exclude: false },
40666
40667
  organize: { exclude: false },
40667
40668
  },
40668
40669
  is_embedded: false,
@@ -40729,12 +40730,52 @@ export default {
40729
40730
  description:
40730
40731
  'Configuration for the manage devices feature.',
40731
40732
  properties: {
40733
+ accepted_providers: {
40734
+ description:
40735
+ 'List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account.',
40736
+ items: { type: 'string' },
40737
+ type: 'array',
40738
+ },
40732
40739
  exclude: {
40733
40740
  default: false,
40734
40741
  description:
40735
40742
  'Whether to exclude this feature from the portal.',
40736
40743
  type: 'boolean',
40737
40744
  },
40745
+ excluded_providers: {
40746
+ description:
40747
+ 'List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account.',
40748
+ items: { type: 'string' },
40749
+ type: 'array',
40750
+ },
40751
+ },
40752
+ type: 'object',
40753
+ },
40754
+ manage_reservations: {
40755
+ default: {},
40756
+ description:
40757
+ 'Configuration for the manage reservations feature.',
40758
+ properties: {
40759
+ exclude: {
40760
+ default: false,
40761
+ description:
40762
+ 'Whether to exclude this feature from the portal.',
40763
+ type: 'boolean',
40764
+ },
40765
+ reservations: {
40766
+ default: { exclude: false },
40767
+ description:
40768
+ 'Configuration for the reservations feature.',
40769
+ properties: {
40770
+ exclude: {
40771
+ default: false,
40772
+ description:
40773
+ 'Indicates whether the customer can view reservations for their properties.',
40774
+ type: 'boolean',
40775
+ },
40776
+ },
40777
+ type: 'object',
40778
+ },
40738
40779
  },
40739
40780
  type: 'object',
40740
40781
  },
@@ -51952,23 +51993,58 @@ export default {
51952
51993
  type: 'string',
51953
51994
  },
51954
51995
  features: {
51996
+ default: { $ref: '#/components/schemas/access_code' },
51955
51997
  properties: {
51956
51998
  configure: {
51999
+ default: {
52000
+ $ref: '#/components/schemas/access_code',
52001
+ },
52002
+ description:
52003
+ 'Configuration for the configure feature.',
51957
52004
  properties: {
51958
52005
  allow_access_automation_rule_customization: {
52006
+ default: false,
52007
+ description:
52008
+ 'Indicates whether the customer can customize the access automation rules for their properties.',
51959
52009
  type: 'boolean',
51960
52010
  },
51961
52011
  allow_instant_key_customization: {
52012
+ default: false,
52013
+ description:
52014
+ 'Indicates whether the customer can customize the Instant Key profile for their properties.',
52015
+ type: 'boolean',
52016
+ },
52017
+ exclude: {
52018
+ default: false,
52019
+ description:
52020
+ 'Whether to exclude this feature from the portal.',
51962
52021
  type: 'boolean',
51963
52022
  },
51964
- exclude: { type: 'boolean' },
51965
52023
  },
51966
52024
  type: 'object',
51967
52025
  },
51968
52026
  connect: {
52027
+ default: {
52028
+ $ref: '#/components/schemas/access_code',
52029
+ },
52030
+ description:
52031
+ 'Configuration for the connect accounts feature.',
51969
52032
  properties: {
51970
- exclude: { type: 'boolean' },
52033
+ accepted_providers: {
52034
+ description:
52035
+ 'List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account.',
52036
+ items: { type: 'string' },
52037
+ type: 'array',
52038
+ },
52039
+ exclude: {
52040
+ default: false,
52041
+ description:
52042
+ 'Whether to exclude this feature from the portal.',
52043
+ type: 'boolean',
52044
+ },
51971
52045
  excluded_providers: {
52046
+ description:
52047
+ 'List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account.',
51972
52048
  items: { type: 'string' },
51973
52049
  type: 'array',
51974
52050
  },
@@ -51976,18 +52052,91 @@ export default {
51976
52052
  type: 'object',
51977
52053
  },
51978
52054
  manage_devices: {
51979
- properties: { exclude: { type: 'boolean' } },
52055
+ default: {
52056
+ $ref: '#/components/schemas/access_code',
52057
+ },
52058
+ description:
52059
+ 'Configuration for the manage devices feature.',
52060
+ properties: {
52061
+ accepted_providers: {
52062
+ description:
52063
+ 'List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account.',
52064
+ items: { type: 'string' },
52065
+ type: 'array',
52066
+ },
52067
+ exclude: {
52068
+ default: false,
52069
+ description:
52070
+ 'Whether to exclude this feature from the portal.',
52071
+ type: 'boolean',
52072
+ },
52073
+ excluded_providers: {
52074
+ description:
52075
+ 'List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account.',
52076
+ items: { type: 'string' },
52077
+ type: 'array',
52078
+ },
52079
+ },
52080
+ type: 'object',
52081
+ },
52082
+ manage_reservations: {
52083
+ default: {
52084
+ $ref: '#/components/schemas/access_code',
52085
+ },
52086
+ description:
52087
+ 'Configuration for the manage reservations feature.',
52088
+ properties: {
52089
+ exclude: {
52090
+ default: false,
52091
+ description:
52092
+ 'Whether to exclude this feature from the portal.',
52093
+ type: 'boolean',
52094
+ },
52095
+ reservations: {
52096
+ default: { exclude: false },
52097
+ description:
52098
+ 'Configuration for the reservations feature.',
52099
+ properties: {
52100
+ exclude: {
52101
+ default: false,
52102
+ description:
52103
+ 'Indicates whether the customer can view reservations for their properties.',
52104
+ type: 'boolean',
52105
+ },
52106
+ },
52107
+ type: 'object',
52108
+ },
52109
+ },
51980
52110
  type: 'object',
51981
52111
  },
51982
52112
  organize: {
51983
- properties: { exclude: { type: 'boolean' } },
52113
+ default: {
52114
+ $ref: '#/components/schemas/access_code',
52115
+ },
52116
+ description:
52117
+ 'Configuration for the organize feature.',
52118
+ properties: {
52119
+ exclude: {
52120
+ default: false,
52121
+ description:
52122
+ 'Whether to exclude this feature from the portal.',
52123
+ type: 'boolean',
52124
+ },
52125
+ },
51984
52126
  type: 'object',
51985
52127
  },
51986
52128
  },
51987
52129
  type: 'object',
51988
52130
  },
51989
- is_embedded: { type: 'boolean' },
52131
+ is_embedded: {
52132
+ default: false,
52133
+ description:
52134
+ 'Whether the portal is embedded in another application.',
52135
+ type: 'boolean',
52136
+ },
51990
52137
  landing_page: {
52138
+ description:
52139
+ 'Configuration for the landing page when the portal loads.',
51991
52140
  properties: {
51992
52141
  manage: {
51993
52142
  oneOf: [
@@ -52164,23 +52313,58 @@ export default {
52164
52313
  type: 'string',
52165
52314
  },
52166
52315
  features: {
52316
+ default: { $ref: '#/components/schemas/access_code' },
52167
52317
  properties: {
52168
52318
  configure: {
52319
+ default: {
52320
+ $ref: '#/components/schemas/access_code',
52321
+ },
52322
+ description:
52323
+ 'Configuration for the configure feature.',
52169
52324
  properties: {
52170
52325
  allow_access_automation_rule_customization: {
52326
+ default: false,
52327
+ description:
52328
+ 'Indicates whether the customer can customize the access automation rules for their properties.',
52171
52329
  type: 'boolean',
52172
52330
  },
52173
52331
  allow_instant_key_customization: {
52332
+ default: false,
52333
+ description:
52334
+ 'Indicates whether the customer can customize the Instant Key profile for their properties.',
52335
+ type: 'boolean',
52336
+ },
52337
+ exclude: {
52338
+ default: false,
52339
+ description:
52340
+ 'Whether to exclude this feature from the portal.',
52174
52341
  type: 'boolean',
52175
52342
  },
52176
- exclude: { type: 'boolean' },
52177
52343
  },
52178
52344
  type: 'object',
52179
52345
  },
52180
52346
  connect: {
52347
+ default: {
52348
+ $ref: '#/components/schemas/access_code',
52349
+ },
52350
+ description:
52351
+ 'Configuration for the connect accounts feature.',
52181
52352
  properties: {
52182
- exclude: { type: 'boolean' },
52353
+ accepted_providers: {
52354
+ description:
52355
+ 'List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account.',
52356
+ items: { type: 'string' },
52357
+ type: 'array',
52358
+ },
52359
+ exclude: {
52360
+ default: false,
52361
+ description:
52362
+ 'Whether to exclude this feature from the portal.',
52363
+ type: 'boolean',
52364
+ },
52183
52365
  excluded_providers: {
52366
+ description:
52367
+ 'List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account.',
52184
52368
  items: { type: 'string' },
52185
52369
  type: 'array',
52186
52370
  },
@@ -52188,18 +52372,91 @@ export default {
52188
52372
  type: 'object',
52189
52373
  },
52190
52374
  manage_devices: {
52191
- properties: { exclude: { type: 'boolean' } },
52375
+ default: {
52376
+ $ref: '#/components/schemas/access_code',
52377
+ },
52378
+ description:
52379
+ 'Configuration for the manage devices feature.',
52380
+ properties: {
52381
+ accepted_providers: {
52382
+ description:
52383
+ 'List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account.',
52384
+ items: { type: 'string' },
52385
+ type: 'array',
52386
+ },
52387
+ exclude: {
52388
+ default: false,
52389
+ description:
52390
+ 'Whether to exclude this feature from the portal.',
52391
+ type: 'boolean',
52392
+ },
52393
+ excluded_providers: {
52394
+ description:
52395
+ 'List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account.',
52396
+ items: { type: 'string' },
52397
+ type: 'array',
52398
+ },
52399
+ },
52400
+ type: 'object',
52401
+ },
52402
+ manage_reservations: {
52403
+ default: {
52404
+ $ref: '#/components/schemas/access_code',
52405
+ },
52406
+ description:
52407
+ 'Configuration for the manage reservations feature.',
52408
+ properties: {
52409
+ exclude: {
52410
+ default: false,
52411
+ description:
52412
+ 'Whether to exclude this feature from the portal.',
52413
+ type: 'boolean',
52414
+ },
52415
+ reservations: {
52416
+ default: { exclude: false },
52417
+ description:
52418
+ 'Configuration for the reservations feature.',
52419
+ properties: {
52420
+ exclude: {
52421
+ default: false,
52422
+ description:
52423
+ 'Indicates whether the customer can view reservations for their properties.',
52424
+ type: 'boolean',
52425
+ },
52426
+ },
52427
+ type: 'object',
52428
+ },
52429
+ },
52192
52430
  type: 'object',
52193
52431
  },
52194
52432
  organize: {
52195
- properties: { exclude: { type: 'boolean' } },
52433
+ default: {
52434
+ $ref: '#/components/schemas/access_code',
52435
+ },
52436
+ description:
52437
+ 'Configuration for the organize feature.',
52438
+ properties: {
52439
+ exclude: {
52440
+ default: false,
52441
+ description:
52442
+ 'Whether to exclude this feature from the portal.',
52443
+ type: 'boolean',
52444
+ },
52445
+ },
52196
52446
  type: 'object',
52197
52447
  },
52198
52448
  },
52199
52449
  type: 'object',
52200
52450
  },
52201
- is_embedded: { type: 'boolean' },
52451
+ is_embedded: {
52452
+ default: false,
52453
+ description:
52454
+ 'Whether the portal is embedded in another application.',
52455
+ type: 'boolean',
52456
+ },
52202
52457
  landing_page: {
52458
+ description:
52459
+ 'Configuration for the landing page when the portal loads.',
52203
52460
  properties: {
52204
52461
  manage: {
52205
52462
  oneOf: [