@seamapi/types 1.597.0 → 1.599.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.
@@ -31453,7 +31453,17 @@ 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 devices feature. */
31456
+ /** Configuration for the manage feature. */
31457
+ manage?: {
31458
+ /** Whether to exclude this feature from the portal. */
31459
+ exclude?: boolean;
31460
+ /** Indicates whether the customer can manage reservations for their properties. */
31461
+ exclude_reservation_management?: boolean;
31462
+ };
31463
+ /** Configuration for the manage devices feature.
31464
+ ---
31465
+ deprecated: Use `manage` instead.
31466
+ --- */
31457
31467
  manage_devices?: {
31458
31468
  /** Whether to exclude this feature from the portal. */
31459
31469
  exclude?: boolean;
@@ -58582,23 +58592,48 @@ export type Routes = {
58582
58592
  jsonResponse: {
58583
58593
  customer_portal: {
58584
58594
  features?: {
58595
+ /** Configuration for the connect accounts feature. */
58585
58596
  connect?: {
58586
- exclude?: boolean | undefined;
58597
+ /** Whether to exclude this feature from the portal. */
58598
+ exclude?: boolean;
58599
+ /** List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account. */
58600
+ accepted_providers?: string[] | undefined;
58601
+ /** 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
58602
  excluded_providers?: string[] | undefined;
58588
- } | undefined;
58603
+ };
58604
+ /** Configuration for the manage feature. */
58605
+ manage?: {
58606
+ /** Whether to exclude this feature from the portal. */
58607
+ exclude?: boolean;
58608
+ /** Indicates whether the customer can manage reservations for their properties. */
58609
+ exclude_reservation_management?: boolean;
58610
+ };
58611
+ /** Configuration for the manage devices feature.
58612
+ ---
58613
+ deprecated: Use `manage` instead.
58614
+ --- */
58589
58615
  manage_devices?: {
58590
- exclude?: boolean | undefined;
58591
- } | undefined;
58616
+ /** Whether to exclude this feature from the portal. */
58617
+ exclude?: boolean;
58618
+ };
58619
+ /** Configuration for the organize feature. */
58592
58620
  organize?: {
58593
- exclude?: boolean | undefined;
58594
- } | undefined;
58621
+ /** Whether to exclude this feature from the portal. */
58622
+ exclude?: boolean;
58623
+ };
58624
+ /** Configuration for the configure feature. */
58595
58625
  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;
58626
+ /** Whether to exclude this feature from the portal. */
58627
+ exclude?: boolean;
58628
+ /** Indicates whether the customer can customize the access automation rules for their properties. */
58629
+ allow_access_automation_rule_customization?: boolean;
58630
+ /** Indicates whether the customer can customize the Instant Key profile for their properties. */
58631
+ allow_instant_key_customization?: boolean;
58632
+ };
58633
+ };
58634
+ /** Whether the portal is embedded in another application. */
58635
+ is_embedded?: boolean;
58636
+ /** Configuration for the landing page when the portal loads. */
58602
58637
  landing_page?: {
58603
58638
  manage?: (({
58604
58639
  space_key: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.597.0",
3
+ "version": "1.599.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -25,6 +25,16 @@ const base_connect_feature = base_feature.extend({
25
25
  ),
26
26
  })
27
27
  const base_manage_devices_feature = base_feature
28
+
29
+ const base_manage_feature = base_feature.extend({
30
+ exclude_reservation_management: z
31
+ .boolean()
32
+ .default(false)
33
+ .describe(
34
+ 'Indicates whether the customer can manage reservations for their properties.',
35
+ ),
36
+ })
37
+
28
38
  const base_organize_feature = base_feature
29
39
 
30
40
  const base_configure_feature = base_feature.extend({
@@ -46,9 +56,15 @@ const base_features = z.object({
46
56
  connect: base_connect_feature
47
57
  .default({})
48
58
  .describe('Configuration for the connect accounts feature.'),
49
- manage_devices: base_manage_devices_feature
59
+ manage: base_manage_feature
50
60
  .default({})
51
- .describe('Configuration for the manage devices feature.'),
61
+ .describe('Configuration for the manage feature.'),
62
+ manage_devices: base_manage_devices_feature.default({}).describe(`
63
+ Configuration for the manage devices feature.
64
+ ---
65
+ deprecated: Use \`manage\` instead.
66
+ ---
67
+ `),
52
68
  organize: base_organize_feature
53
69
  .default({})
54
70
  .describe('Configuration for the organize feature.'),
@@ -57,27 +73,31 @@ const base_features = z.object({
57
73
  .describe('Configuration for the configure feature.'),
58
74
  })
59
75
 
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
- })
76
+ export const portal_configuration_base = z.object({
77
+ features: base_features.default({}),
78
+ is_embedded: z
79
+ .boolean()
80
+ .default(false)
81
+ .describe('Whether the portal is embedded in another application.'),
82
+ landing_page: z
83
+ .object({
84
+ manage: z
85
+ .union([location_key_aliases, access_grant_key_aliases])
86
+ .optional(),
87
+ })
88
+ .optional()
89
+ .describe('Configuration for the landing page when the portal loads.'),
90
+ })
91
+
92
+ export const portal_configuration = portal_configuration_base
76
93
  .default({
77
94
  features: {
78
95
  connect: { exclude: false },
79
96
  organize: { exclude: false },
80
- manage_devices: { exclude: false },
97
+ manage: { exclude: false, exclude_reservation_management: false },
98
+ manage_devices: {
99
+ exclude: false,
100
+ },
81
101
  configure: {
82
102
  exclude: false,
83
103
  allow_instant_key_customization: false, // default
@@ -40662,6 +40662,10 @@ export default {
40662
40662
  exclude: false,
40663
40663
  },
40664
40664
  connect: { exclude: false },
40665
+ manage: {
40666
+ exclude: false,
40667
+ exclude_reservation_management: false,
40668
+ },
40665
40669
  manage_devices: { exclude: false },
40666
40670
  organize: { exclude: false },
40667
40671
  },
@@ -40724,10 +40728,30 @@ export default {
40724
40728
  },
40725
40729
  type: 'object',
40726
40730
  },
40731
+ manage: {
40732
+ default: {},
40733
+ description:
40734
+ 'Configuration for the manage feature.',
40735
+ properties: {
40736
+ exclude: {
40737
+ default: false,
40738
+ description:
40739
+ 'Whether to exclude this feature from the portal.',
40740
+ type: 'boolean',
40741
+ },
40742
+ exclude_reservation_management: {
40743
+ default: false,
40744
+ description:
40745
+ 'Indicates whether the customer can manage reservations for their properties.',
40746
+ type: 'boolean',
40747
+ },
40748
+ },
40749
+ type: 'object',
40750
+ },
40727
40751
  manage_devices: {
40728
40752
  default: {},
40729
40753
  description:
40730
- 'Configuration for the manage devices feature.',
40754
+ 'Configuration for the manage devices feature.\n---\ndeprecated: Use `manage` instead.\n---',
40731
40755
  properties: {
40732
40756
  exclude: {
40733
40757
  default: false,
@@ -51952,42 +51976,130 @@ export default {
51952
51976
  type: 'string',
51953
51977
  },
51954
51978
  features: {
51979
+ default: { $ref: '#/components/schemas/access_code' },
51955
51980
  properties: {
51956
51981
  configure: {
51982
+ default: {
51983
+ $ref: '#/components/schemas/access_code',
51984
+ },
51985
+ description:
51986
+ 'Configuration for the configure feature.',
51957
51987
  properties: {
51958
51988
  allow_access_automation_rule_customization: {
51989
+ default: false,
51990
+ description:
51991
+ 'Indicates whether the customer can customize the access automation rules for their properties.',
51959
51992
  type: 'boolean',
51960
51993
  },
51961
51994
  allow_instant_key_customization: {
51995
+ default: false,
51996
+ description:
51997
+ 'Indicates whether the customer can customize the Instant Key profile for their properties.',
51998
+ type: 'boolean',
51999
+ },
52000
+ exclude: {
52001
+ default: false,
52002
+ description:
52003
+ 'Whether to exclude this feature from the portal.',
51962
52004
  type: 'boolean',
51963
52005
  },
51964
- exclude: { type: 'boolean' },
51965
52006
  },
51966
52007
  type: 'object',
51967
52008
  },
51968
52009
  connect: {
52010
+ default: {
52011
+ $ref: '#/components/schemas/access_code',
52012
+ },
52013
+ description:
52014
+ 'Configuration for the connect accounts feature.',
51969
52015
  properties: {
51970
- exclude: { type: 'boolean' },
52016
+ accepted_providers: {
52017
+ description:
52018
+ 'List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account.',
52019
+ items: { type: 'string' },
52020
+ type: 'array',
52021
+ },
52022
+ exclude: {
52023
+ default: false,
52024
+ description:
52025
+ 'Whether to exclude this feature from the portal.',
52026
+ type: 'boolean',
52027
+ },
51971
52028
  excluded_providers: {
52029
+ description:
52030
+ '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
52031
  items: { type: 'string' },
51973
52032
  type: 'array',
51974
52033
  },
51975
52034
  },
51976
52035
  type: 'object',
51977
52036
  },
52037
+ manage: {
52038
+ default: {
52039
+ $ref: '#/components/schemas/access_code',
52040
+ },
52041
+ description:
52042
+ 'Configuration for the manage feature.',
52043
+ properties: {
52044
+ exclude: {
52045
+ default: false,
52046
+ description:
52047
+ 'Whether to exclude this feature from the portal.',
52048
+ type: 'boolean',
52049
+ },
52050
+ exclude_reservation_management: {
52051
+ default: false,
52052
+ description:
52053
+ 'Indicates whether the customer can manage reservations for their properties.',
52054
+ type: 'boolean',
52055
+ },
52056
+ },
52057
+ type: 'object',
52058
+ },
51978
52059
  manage_devices: {
51979
- properties: { exclude: { type: 'boolean' } },
52060
+ default: {
52061
+ $ref: '#/components/schemas/access_code',
52062
+ },
52063
+ description:
52064
+ 'Configuration for the manage devices feature.\n---\ndeprecated: Use `manage` instead.\n---',
52065
+ properties: {
52066
+ exclude: {
52067
+ default: false,
52068
+ description:
52069
+ 'Whether to exclude this feature from the portal.',
52070
+ type: 'boolean',
52071
+ },
52072
+ },
51980
52073
  type: 'object',
51981
52074
  },
51982
52075
  organize: {
51983
- properties: { exclude: { type: 'boolean' } },
52076
+ default: {
52077
+ $ref: '#/components/schemas/access_code',
52078
+ },
52079
+ description:
52080
+ 'Configuration for the organize feature.',
52081
+ properties: {
52082
+ exclude: {
52083
+ default: false,
52084
+ description:
52085
+ 'Whether to exclude this feature from the portal.',
52086
+ type: 'boolean',
52087
+ },
52088
+ },
51984
52089
  type: 'object',
51985
52090
  },
51986
52091
  },
51987
52092
  type: 'object',
51988
52093
  },
51989
- is_embedded: { type: 'boolean' },
52094
+ is_embedded: {
52095
+ default: false,
52096
+ description:
52097
+ 'Whether the portal is embedded in another application.',
52098
+ type: 'boolean',
52099
+ },
51990
52100
  landing_page: {
52101
+ description:
52102
+ 'Configuration for the landing page when the portal loads.',
51991
52103
  properties: {
51992
52104
  manage: {
51993
52105
  oneOf: [
@@ -52164,42 +52276,130 @@ export default {
52164
52276
  type: 'string',
52165
52277
  },
52166
52278
  features: {
52279
+ default: { $ref: '#/components/schemas/access_code' },
52167
52280
  properties: {
52168
52281
  configure: {
52282
+ default: {
52283
+ $ref: '#/components/schemas/access_code',
52284
+ },
52285
+ description:
52286
+ 'Configuration for the configure feature.',
52169
52287
  properties: {
52170
52288
  allow_access_automation_rule_customization: {
52289
+ default: false,
52290
+ description:
52291
+ 'Indicates whether the customer can customize the access automation rules for their properties.',
52171
52292
  type: 'boolean',
52172
52293
  },
52173
52294
  allow_instant_key_customization: {
52295
+ default: false,
52296
+ description:
52297
+ 'Indicates whether the customer can customize the Instant Key profile for their properties.',
52298
+ type: 'boolean',
52299
+ },
52300
+ exclude: {
52301
+ default: false,
52302
+ description:
52303
+ 'Whether to exclude this feature from the portal.',
52174
52304
  type: 'boolean',
52175
52305
  },
52176
- exclude: { type: 'boolean' },
52177
52306
  },
52178
52307
  type: 'object',
52179
52308
  },
52180
52309
  connect: {
52310
+ default: {
52311
+ $ref: '#/components/schemas/access_code',
52312
+ },
52313
+ description:
52314
+ 'Configuration for the connect accounts feature.',
52181
52315
  properties: {
52182
- exclude: { type: 'boolean' },
52316
+ accepted_providers: {
52317
+ description:
52318
+ 'List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account.',
52319
+ items: { type: 'string' },
52320
+ type: 'array',
52321
+ },
52322
+ exclude: {
52323
+ default: false,
52324
+ description:
52325
+ 'Whether to exclude this feature from the portal.',
52326
+ type: 'boolean',
52327
+ },
52183
52328
  excluded_providers: {
52329
+ description:
52330
+ '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
52331
  items: { type: 'string' },
52185
52332
  type: 'array',
52186
52333
  },
52187
52334
  },
52188
52335
  type: 'object',
52189
52336
  },
52337
+ manage: {
52338
+ default: {
52339
+ $ref: '#/components/schemas/access_code',
52340
+ },
52341
+ description:
52342
+ 'Configuration for the manage feature.',
52343
+ properties: {
52344
+ exclude: {
52345
+ default: false,
52346
+ description:
52347
+ 'Whether to exclude this feature from the portal.',
52348
+ type: 'boolean',
52349
+ },
52350
+ exclude_reservation_management: {
52351
+ default: false,
52352
+ description:
52353
+ 'Indicates whether the customer can manage reservations for their properties.',
52354
+ type: 'boolean',
52355
+ },
52356
+ },
52357
+ type: 'object',
52358
+ },
52190
52359
  manage_devices: {
52191
- properties: { exclude: { type: 'boolean' } },
52360
+ default: {
52361
+ $ref: '#/components/schemas/access_code',
52362
+ },
52363
+ description:
52364
+ 'Configuration for the manage devices feature.\n---\ndeprecated: Use `manage` instead.\n---',
52365
+ properties: {
52366
+ exclude: {
52367
+ default: false,
52368
+ description:
52369
+ 'Whether to exclude this feature from the portal.',
52370
+ type: 'boolean',
52371
+ },
52372
+ },
52192
52373
  type: 'object',
52193
52374
  },
52194
52375
  organize: {
52195
- properties: { exclude: { type: 'boolean' } },
52376
+ default: {
52377
+ $ref: '#/components/schemas/access_code',
52378
+ },
52379
+ description:
52380
+ 'Configuration for the organize feature.',
52381
+ properties: {
52382
+ exclude: {
52383
+ default: false,
52384
+ description:
52385
+ 'Whether to exclude this feature from the portal.',
52386
+ type: 'boolean',
52387
+ },
52388
+ },
52196
52389
  type: 'object',
52197
52390
  },
52198
52391
  },
52199
52392
  type: 'object',
52200
52393
  },
52201
- is_embedded: { type: 'boolean' },
52394
+ is_embedded: {
52395
+ default: false,
52396
+ description:
52397
+ 'Whether the portal is embedded in another application.',
52398
+ type: 'boolean',
52399
+ },
52202
52400
  landing_page: {
52401
+ description:
52402
+ 'Configuration for the landing page when the portal loads.',
52203
52403
  properties: {
52204
52404
  manage: {
52205
52405
  oneOf: [
@@ -36535,7 +36535,17 @@ export type Routes = {
36535
36535
  /** List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account. */
36536
36536
  excluded_providers?: string[] | undefined
36537
36537
  }
36538
- /** Configuration for the manage devices feature. */
36538
+ /** Configuration for the manage feature. */
36539
+ manage?: {
36540
+ /** Whether to exclude this feature from the portal. */
36541
+ exclude?: boolean
36542
+ /** Indicates whether the customer can manage reservations for their properties. */
36543
+ exclude_reservation_management?: boolean
36544
+ }
36545
+ /** Configuration for the manage devices feature.
36546
+ ---
36547
+ deprecated: Use `manage` instead.
36548
+ --- */
36539
36549
  manage_devices?: {
36540
36550
  /** Whether to exclude this feature from the portal. */
36541
36551
  exclude?: boolean
@@ -69797,36 +69807,49 @@ export type Routes = {
69797
69807
  formData: {}
69798
69808
  jsonResponse: {
69799
69809
  customer_portal: {
69800
- features?:
69801
- | {
69802
- connect?:
69803
- | {
69804
- exclude?: boolean | undefined
69805
- excluded_providers?: string[] | undefined
69806
- }
69807
- | undefined
69808
- manage_devices?:
69809
- | {
69810
- exclude?: boolean | undefined
69811
- }
69812
- | undefined
69813
- organize?:
69814
- | {
69815
- exclude?: boolean | undefined
69816
- }
69817
- | undefined
69818
- configure?:
69819
- | {
69820
- exclude?: boolean | undefined
69821
- allow_access_automation_rule_customization?:
69822
- | boolean
69823
- | undefined
69824
- allow_instant_key_customization?: boolean | undefined
69825
- }
69826
- | undefined
69827
- }
69828
- | undefined
69829
- is_embedded?: boolean | undefined
69810
+ features?: {
69811
+ /** Configuration for the connect accounts feature. */
69812
+ connect?: {
69813
+ /** Whether to exclude this feature from the portal. */
69814
+ exclude?: boolean
69815
+ /** List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account. */
69816
+ accepted_providers?: string[] | undefined
69817
+ /** List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account. */
69818
+ excluded_providers?: string[] | undefined
69819
+ }
69820
+ /** Configuration for the manage feature. */
69821
+ manage?: {
69822
+ /** Whether to exclude this feature from the portal. */
69823
+ exclude?: boolean
69824
+ /** Indicates whether the customer can manage reservations for their properties. */
69825
+ exclude_reservation_management?: boolean
69826
+ }
69827
+ /** Configuration for the manage devices feature.
69828
+ ---
69829
+ deprecated: Use `manage` instead.
69830
+ --- */
69831
+ manage_devices?: {
69832
+ /** Whether to exclude this feature from the portal. */
69833
+ exclude?: boolean
69834
+ }
69835
+ /** Configuration for the organize feature. */
69836
+ organize?: {
69837
+ /** Whether to exclude this feature from the portal. */
69838
+ exclude?: boolean
69839
+ }
69840
+ /** Configuration for the configure feature. */
69841
+ configure?: {
69842
+ /** Whether to exclude this feature from the portal. */
69843
+ exclude?: boolean
69844
+ /** Indicates whether the customer can customize the access automation rules for their properties. */
69845
+ allow_access_automation_rule_customization?: boolean
69846
+ /** Indicates whether the customer can customize the Instant Key profile for their properties. */
69847
+ allow_instant_key_customization?: boolean
69848
+ }
69849
+ }
69850
+ /** Whether the portal is embedded in another application. */
69851
+ is_embedded?: boolean
69852
+ /** Configuration for the landing page when the portal loads. */
69830
69853
  landing_page?:
69831
69854
  | {
69832
69855
  manage?: