@seamapi/types 1.586.0 → 1.588.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 (21) hide show
  1. package/dist/connect.cjs +95 -0
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +191 -0
  4. package/dist/index.cjs +95 -0
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/customer/customer-data.d.ts +34 -0
  7. package/lib/seam/connect/models/customer/customer-data.js +5 -1
  8. package/lib/seam/connect/models/customer/customer-data.js.map +1 -1
  9. package/lib/seam/connect/models/customer/customer-portal.d.ts +14 -0
  10. package/lib/seam/connect/models/customer/location-resources.d.ts +46 -0
  11. package/lib/seam/connect/models/customer/location-resources.js +17 -0
  12. package/lib/seam/connect/models/customer/location-resources.js.map +1 -1
  13. package/lib/seam/connect/openapi.d.ts +156 -0
  14. package/lib/seam/connect/openapi.js +95 -0
  15. package/lib/seam/connect/openapi.js.map +1 -1
  16. package/lib/seam/connect/route-types.d.ts +35 -0
  17. package/package.json +1 -1
  18. package/src/lib/seam/connect/models/customer/customer-data.ts +5 -0
  19. package/src/lib/seam/connect/models/customer/location-resources.ts +19 -0
  20. package/src/lib/seam/connect/openapi.ts +104 -0
  21. package/src/lib/seam/connect/route-types.ts +41 -0
package/lib/seam/connect/route-types.d.ts CHANGED
@@ -31381,6 +31381,8 @@ export type Routes = {
31381
31381
  listing_key: string;
31382
31382
  } | {
31383
31383
  property_listing_key: string;
31384
+ } | {
31385
+ site_key: string;
31384
31386
  }) | ({
31385
31387
  reservation_key: string;
31386
31388
  } | {
@@ -31400,6 +31402,13 @@ export type Routes = {
31400
31402
  /** Your unique identifier for the space. */
31401
31403
  space_key: string;
31402
31404
  }[] | undefined;
31405
+ /** List of general sites or areas. */
31406
+ sites?: {
31407
+ /** Your display name for this location resource. */
31408
+ name: string;
31409
+ /** Your unique identifier for the site. */
31410
+ site_key: string;
31411
+ }[] | undefined;
31403
31412
  /** List of short-term rental properties. */
31404
31413
  properties?: {
31405
31414
  /** Your display name for this location resource. */
@@ -31413,6 +31422,8 @@ export type Routes = {
31413
31422
  name: string;
31414
31423
  /** Your unique identifier for the room. */
31415
31424
  room_key: string;
31425
+ /** Your unique identifier for the site. */
31426
+ parent_site_key?: string | undefined;
31416
31427
  }[] | undefined;
31417
31428
  /** List of shared common areas. */
31418
31429
  common_areas?: {
@@ -31420,6 +31431,8 @@ export type Routes = {
31420
31431
  name: string;
31421
31432
  /** Your unique identifier for the common area. */
31422
31433
  common_area_key: string;
31434
+ /** Your unique identifier for the site. */
31435
+ parent_site_key?: string | undefined;
31423
31436
  }[] | undefined;
31424
31437
  /** List of multi-family residential units. */
31425
31438
  units?: {
@@ -31427,6 +31440,8 @@ export type Routes = {
31427
31440
  name: string;
31428
31441
  /** Your unique identifier for the unit. */
31429
31442
  unit_key: string;
31443
+ /** Your unique identifier for the site. */
31444
+ parent_site_key?: string | undefined;
31430
31445
  }[] | undefined;
31431
31446
  /** List of gym or fitness facilities. */
31432
31447
  facilities?: {
@@ -31712,6 +31727,13 @@ export type Routes = {
31712
31727
  /** Your unique identifier for the space. */
31713
31728
  space_key: string;
31714
31729
  }[] | undefined;
31730
+ /** List of general sites or areas. */
31731
+ sites?: {
31732
+ /** Your display name for this location resource. */
31733
+ name: string;
31734
+ /** Your unique identifier for the site. */
31735
+ site_key: string;
31736
+ }[] | undefined;
31715
31737
  /** List of short-term rental properties. */
31716
31738
  properties?: {
31717
31739
  /** Your display name for this location resource. */
@@ -31725,6 +31747,8 @@ export type Routes = {
31725
31747
  name: string;
31726
31748
  /** Your unique identifier for the room. */
31727
31749
  room_key: string;
31750
+ /** Your unique identifier for the site. */
31751
+ parent_site_key?: string | undefined;
31728
31752
  }[] | undefined;
31729
31753
  /** List of shared common areas. */
31730
31754
  common_areas?: {
@@ -31732,6 +31756,8 @@ export type Routes = {
31732
31756
  name: string;
31733
31757
  /** Your unique identifier for the common area. */
31734
31758
  common_area_key: string;
31759
+ /** Your unique identifier for the site. */
31760
+ parent_site_key?: string | undefined;
31735
31761
  }[] | undefined;
31736
31762
  /** List of multi-family residential units. */
31737
31763
  units?: {
@@ -31739,6 +31765,8 @@ export type Routes = {
31739
31765
  name: string;
31740
31766
  /** Your unique identifier for the unit. */
31741
31767
  unit_key: string;
31768
+ /** Your unique identifier for the site. */
31769
+ parent_site_key?: string | undefined;
31742
31770
  }[] | undefined;
31743
31771
  /** List of gym or fitness facilities. */
31744
31772
  facilities?: {
@@ -58436,6 +58464,8 @@ export type Routes = {
58436
58464
  listing_key: string;
58437
58465
  } | {
58438
58466
  property_listing_key: string;
58467
+ } | {
58468
+ site_key: string;
58439
58469
  }) | ({
58440
58470
  reservation_key: string;
58441
58471
  } | {
@@ -59151,6 +59181,7 @@ export type Routes = {
59151
59181
  spaces: {
59152
59182
  name: string;
59153
59183
  partner_resource_key: string;
59184
+ parent_partner_resource_key?: string | undefined;
59154
59185
  devices: {
59155
59186
  device_id: string;
59156
59187
  device_type: 'lock' | 'thermostat' | 'sensor';
@@ -59206,6 +59237,8 @@ export type Routes = {
59206
59237
  device_ids?: string[] | undefined;
59207
59238
  /** IDs of the entrances that you want to add to the new space. */
59208
59239
  acs_entrance_ids?: string[] | undefined;
59240
+ /** Customer key for which you want to create the space. */
59241
+ customer_key?: string | undefined;
59209
59242
  };
59210
59243
  commonParams: {};
59211
59244
  formData: {};
@@ -60966,6 +60999,8 @@ export type Routes = {
60966
60999
  device_ids?: string[] | undefined;
60967
61000
  /** IDs of the entrances that you want to set for the space. If specified, this will replace all existing entrances. */
60968
61001
  acs_entrance_ids?: string[] | undefined;
61002
+ /** Customer key for which you want to update the space. */
61003
+ customer_key?: string | undefined;
60969
61004
  };
60970
61005
  commonParams: {};
60971
61006
  formData: {};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.586.0",
3
+ "version": "1.588.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
package/src/lib/seam/connect/models/customer/customer-data.ts CHANGED
@@ -14,6 +14,7 @@ import {
14
14
  property_listing_resource,
15
15
  property_resource,
16
16
  room_resource,
17
+ site_resource,
17
18
  unit_resource,
18
19
  } from './location-resources.js'
19
20
  import {
@@ -32,6 +33,10 @@ export const customer_data = z.object({
32
33
  .array(neutral_resource)
33
34
  .optional()
34
35
  .describe('List of general spaces or areas.'),
36
+ sites: z
37
+ .array(site_resource)
38
+ .optional()
39
+ .describe('List of general sites or areas.'),
35
40
  properties: z
36
41
  .array(property_resource)
37
42
  .optional()
package/src/lib/seam/connect/models/customer/location-resources.ts CHANGED
@@ -16,16 +16,28 @@ export const property_resource = base_location_resource.extend({
16
16
 
17
17
  export const room_resource = base_location_resource.extend({
18
18
  room_key: z.string().describe('Your unique identifier for the room.'),
19
+ parent_site_key: z
20
+ .string()
21
+ .optional()
22
+ .describe('Your unique identifier for the site.'),
19
23
  })
20
24
 
21
25
  export const common_area_resource = base_location_resource.extend({
22
26
  common_area_key: z
23
27
  .string()
24
28
  .describe('Your unique identifier for the common area.'),
29
+ parent_site_key: z
30
+ .string()
31
+ .optional()
32
+ .describe('Your unique identifier for the site.'),
25
33
  })
26
34
 
27
35
  export const unit_resource = base_location_resource.extend({
28
36
  unit_key: z.string().describe('Your unique identifier for the unit.'),
37
+ parent_site_key: z
38
+ .string()
39
+ .optional()
40
+ .describe('Your unique identifier for the site.'),
29
41
  })
30
42
 
31
43
  export const facility_resource = base_location_resource.extend({
@@ -46,6 +58,10 @@ export const property_listing_resource = base_location_resource.extend({
46
58
  .describe('Your unique identifier for the property listing.'),
47
59
  })
48
60
 
61
+ export const site_resource = base_location_resource.extend({
62
+ site_key: z.string().describe('Your unique identifier for the site.'),
63
+ })
64
+
49
65
  // Union of all location resource types
50
66
  export const location_resource = z.union([
51
67
  neutral_resource,
@@ -57,6 +73,7 @@ export const location_resource = z.union([
57
73
  building_resource,
58
74
  listing_resource,
59
75
  property_listing_resource,
76
+ site_resource,
60
77
  ])
61
78
 
62
79
  // All location key aliases for use in references
@@ -70,6 +87,7 @@ export const location_key_aliases = z.union([
70
87
  z.object({ building_key: z.string() }),
71
88
  z.object({ listing_key: z.string() }),
72
89
  z.object({ property_listing_key: z.string() }),
90
+ z.object({ site_key: z.string() }),
73
91
  ])
74
92
 
75
93
  // Export types
@@ -84,3 +102,4 @@ export type ListingResource = z.infer<typeof listing_resource>
84
102
  export type PropertyListingResource = z.infer<typeof property_listing_resource>
85
103
  export type LocationResource = z.infer<typeof location_resource>
86
104
  export type LocationKeyAliases = z.infer<typeof location_key_aliases>
105
+ export type SiteResource = z.infer<typeof site_resource>
package/src/lib/seam/connect/openapi.ts CHANGED
@@ -40494,6 +40494,13 @@ export default {
40494
40494
  required: ['property_listing_key'],
40495
40495
  type: 'object',
40496
40496
  },
40497
+ {
40498
+ properties: {
40499
+ site_key: { type: 'string' },
40500
+ },
40501
+ required: ['site_key'],
40502
+ type: 'object',
40503
+ },
40497
40504
  ],
40498
40505
  },
40499
40506
  {
@@ -40783,6 +40790,11 @@ export default {
40783
40790
  'Your display name for this location resource.',
40784
40791
  type: 'string',
40785
40792
  },
40793
+ parent_site_key: {
40794
+ description:
40795
+ 'Your unique identifier for the site.',
40796
+ type: 'string',
40797
+ },
40786
40798
  },
40787
40799
  required: ['name', 'common_area_key'],
40788
40800
  type: 'object',
@@ -41052,6 +41064,11 @@ export default {
41052
41064
  'Your display name for this location resource.',
41053
41065
  type: 'string',
41054
41066
  },
41067
+ parent_site_key: {
41068
+ description:
41069
+ 'Your unique identifier for the site.',
41070
+ type: 'string',
41071
+ },
41055
41072
  room_key: {
41056
41073
  description:
41057
41074
  'Your unique identifier for the room.',
@@ -41063,6 +41080,26 @@ export default {
41063
41080
  },
41064
41081
  type: 'array',
41065
41082
  },
41083
+ sites: {
41084
+ description: 'List of general sites or areas.',
41085
+ items: {
41086
+ properties: {
41087
+ name: {
41088
+ description:
41089
+ 'Your display name for this location resource.',
41090
+ type: 'string',
41091
+ },
41092
+ site_key: {
41093
+ description:
41094
+ 'Your unique identifier for the site.',
41095
+ type: 'string',
41096
+ },
41097
+ },
41098
+ required: ['name', 'site_key'],
41099
+ type: 'object',
41100
+ },
41101
+ type: 'array',
41102
+ },
41066
41103
  spaces: {
41067
41104
  description: 'List of general spaces or areas.',
41068
41105
  items: {
@@ -41123,6 +41160,11 @@ export default {
41123
41160
  'Your display name for this location resource.',
41124
41161
  type: 'string',
41125
41162
  },
41163
+ parent_site_key: {
41164
+ description:
41165
+ 'Your unique identifier for the site.',
41166
+ type: 'string',
41167
+ },
41126
41168
  unit_key: {
41127
41169
  description:
41128
41170
  'Your unique identifier for the unit.',
@@ -41831,6 +41873,10 @@ export default {
41831
41873
  'Your display name for this location resource.',
41832
41874
  type: 'string',
41833
41875
  },
41876
+ parent_site_key: {
41877
+ description: 'Your unique identifier for the site.',
41878
+ type: 'string',
41879
+ },
41834
41880
  },
41835
41881
  required: ['name', 'common_area_key'],
41836
41882
  type: 'object',
@@ -42097,6 +42143,10 @@ export default {
42097
42143
  'Your display name for this location resource.',
42098
42144
  type: 'string',
42099
42145
  },
42146
+ parent_site_key: {
42147
+ description: 'Your unique identifier for the site.',
42148
+ type: 'string',
42149
+ },
42100
42150
  room_key: {
42101
42151
  description: 'Your unique identifier for the room.',
42102
42152
  type: 'string',
@@ -42107,6 +42157,25 @@ export default {
42107
42157
  },
42108
42158
  type: 'array',
42109
42159
  },
42160
+ sites: {
42161
+ description: 'List of general sites or areas.',
42162
+ items: {
42163
+ properties: {
42164
+ name: {
42165
+ description:
42166
+ 'Your display name for this location resource.',
42167
+ type: 'string',
42168
+ },
42169
+ site_key: {
42170
+ description: 'Your unique identifier for the site.',
42171
+ type: 'string',
42172
+ },
42173
+ },
42174
+ required: ['name', 'site_key'],
42175
+ type: 'object',
42176
+ },
42177
+ type: 'array',
42178
+ },
42110
42179
  spaces: {
42111
42180
  description: 'List of general spaces or areas.',
42112
42181
  items: {
@@ -42164,6 +42233,10 @@ export default {
42164
42233
  'Your display name for this location resource.',
42165
42234
  type: 'string',
42166
42235
  },
42236
+ parent_site_key: {
42237
+ description: 'Your unique identifier for the site.',
42238
+ type: 'string',
42239
+ },
42167
42240
  unit_key: {
42168
42241
  description: 'Your unique identifier for the unit.',
42169
42242
  type: 'string',
@@ -51641,6 +51714,13 @@ export default {
51641
51714
  required: ['property_listing_key'],
51642
51715
  type: 'object',
51643
51716
  },
51717
+ {
51718
+ properties: {
51719
+ site_key: { type: 'string' },
51720
+ },
51721
+ required: ['site_key'],
51722
+ type: 'object',
51723
+ },
51644
51724
  ],
51645
51725
  },
51646
51726
  {
@@ -51846,6 +51926,13 @@ export default {
51846
51926
  required: ['property_listing_key'],
51847
51927
  type: 'object',
51848
51928
  },
51929
+ {
51930
+ properties: {
51931
+ site_key: { type: 'string' },
51932
+ },
51933
+ required: ['site_key'],
51934
+ type: 'object',
51935
+ },
51849
51936
  ],
51850
51937
  },
51851
51938
  {
@@ -53139,6 +53226,7 @@ export default {
53139
53226
  is_draft: { type: 'boolean' },
53140
53227
  name: { type: 'string' },
53141
53228
  needs_review: { type: 'boolean' },
53229
+ parent_partner_resource_key: { type: 'string' },
53142
53230
  partner_resource_key: { type: 'string' },
53143
53231
  },
53144
53232
  required: [
@@ -53239,6 +53327,7 @@ export default {
53239
53327
  is_draft: { type: 'boolean' },
53240
53328
  name: { type: 'string' },
53241
53329
  needs_review: { type: 'boolean' },
53330
+ parent_partner_resource_key: { type: 'string' },
53242
53331
  partner_resource_key: { type: 'string' },
53243
53332
  },
53244
53333
  required: [
@@ -53532,6 +53621,11 @@ export default {
53532
53621
  items: { format: 'uuid', type: 'string' },
53533
53622
  type: 'array',
53534
53623
  },
53624
+ customer_key: {
53625
+ description:
53626
+ 'Customer key for which you want to create the space.',
53627
+ type: 'string',
53628
+ },
53535
53629
  device_ids: {
53536
53630
  description:
53537
53631
  'IDs of the devices that you want to add to the new space.',
@@ -54445,6 +54539,11 @@ export default {
54445
54539
  items: { format: 'uuid', type: 'string' },
54446
54540
  type: 'array',
54447
54541
  },
54542
+ customer_key: {
54543
+ description:
54544
+ 'Customer key for which you want to update the space.',
54545
+ type: 'string',
54546
+ },
54448
54547
  device_ids: {
54449
54548
  description:
54450
54549
  'IDs of the devices that you want to set for the space. If specified, this will replace all existing devices.',
@@ -54516,6 +54615,11 @@ export default {
54516
54615
  items: { format: 'uuid', type: 'string' },
54517
54616
  type: 'array',
54518
54617
  },
54618
+ customer_key: {
54619
+ description:
54620
+ 'Customer key for which you want to update the space.',
54621
+ type: 'string',
54622
+ },
54519
54623
  device_ids: {
54520
54624
  description:
54521
54625
  'IDs of the devices that you want to set for the space. If specified, this will replace all existing devices.',
package/src/lib/seam/connect/route-types.ts CHANGED
@@ -36471,6 +36471,9 @@ export type Routes = {
36471
36471
  | {
36472
36472
  property_listing_key: string
36473
36473
  }
36474
+ | {
36475
+ site_key: string
36476
+ }
36474
36477
  )
36475
36478
  | (
36476
36479
  | {
@@ -36501,6 +36504,15 @@ export type Routes = {
36501
36504
  space_key: string
36502
36505
  }[]
36503
36506
  | undefined
36507
+ /** List of general sites or areas. */
36508
+ sites?:
36509
+ | {
36510
+ /** Your display name for this location resource. */
36511
+ name: string
36512
+ /** Your unique identifier for the site. */
36513
+ site_key: string
36514
+ }[]
36515
+ | undefined
36504
36516
  /** List of short-term rental properties. */
36505
36517
  properties?:
36506
36518
  | {
@@ -36517,6 +36529,8 @@ export type Routes = {
36517
36529
  name: string
36518
36530
  /** Your unique identifier for the room. */
36519
36531
  room_key: string
36532
+ /** Your unique identifier for the site. */
36533
+ parent_site_key?: string | undefined
36520
36534
  }[]
36521
36535
  | undefined
36522
36536
  /** List of shared common areas. */
@@ -36526,6 +36540,8 @@ export type Routes = {
36526
36540
  name: string
36527
36541
  /** Your unique identifier for the common area. */
36528
36542
  common_area_key: string
36543
+ /** Your unique identifier for the site. */
36544
+ parent_site_key?: string | undefined
36529
36545
  }[]
36530
36546
  | undefined
36531
36547
  /** List of multi-family residential units. */
@@ -36535,6 +36551,8 @@ export type Routes = {
36535
36551
  name: string
36536
36552
  /** Your unique identifier for the unit. */
36537
36553
  unit_key: string
36554
+ /** Your unique identifier for the site. */
36555
+ parent_site_key?: string | undefined
36538
36556
  }[]
36539
36557
  | undefined
36540
36558
  /** List of gym or fitness facilities. */
@@ -36848,6 +36866,15 @@ export type Routes = {
36848
36866
  space_key: string
36849
36867
  }[]
36850
36868
  | undefined
36869
+ /** List of general sites or areas. */
36870
+ sites?:
36871
+ | {
36872
+ /** Your display name for this location resource. */
36873
+ name: string
36874
+ /** Your unique identifier for the site. */
36875
+ site_key: string
36876
+ }[]
36877
+ | undefined
36851
36878
  /** List of short-term rental properties. */
36852
36879
  properties?:
36853
36880
  | {
@@ -36864,6 +36891,8 @@ export type Routes = {
36864
36891
  name: string
36865
36892
  /** Your unique identifier for the room. */
36866
36893
  room_key: string
36894
+ /** Your unique identifier for the site. */
36895
+ parent_site_key?: string | undefined
36867
36896
  }[]
36868
36897
  | undefined
36869
36898
  /** List of shared common areas. */
@@ -36873,6 +36902,8 @@ export type Routes = {
36873
36902
  name: string
36874
36903
  /** Your unique identifier for the common area. */
36875
36904
  common_area_key: string
36905
+ /** Your unique identifier for the site. */
36906
+ parent_site_key?: string | undefined
36876
36907
  }[]
36877
36908
  | undefined
36878
36909
  /** List of multi-family residential units. */
@@ -36882,6 +36913,8 @@ export type Routes = {
36882
36913
  name: string
36883
36914
  /** Your unique identifier for the unit. */
36884
36915
  unit_key: string
36916
+ /** Your unique identifier for the site. */
36917
+ parent_site_key?: string | undefined
36885
36918
  }[]
36886
36919
  | undefined
36887
36920
  /** List of gym or fitness facilities. */
@@ -69647,6 +69680,9 @@ export type Routes = {
69647
69680
  | {
69648
69681
  property_listing_key: string
69649
69682
  }
69683
+ | {
69684
+ site_key: string
69685
+ }
69650
69686
  )
69651
69687
  | (
69652
69688
  | {
@@ -70485,6 +70521,7 @@ export type Routes = {
70485
70521
  spaces: {
70486
70522
  name: string
70487
70523
  partner_resource_key: string
70524
+ parent_partner_resource_key?: string | undefined
70488
70525
  devices: {
70489
70526
  device_id: string
70490
70527
  device_type: 'lock' | 'thermostat' | 'sensor'
@@ -70540,6 +70577,8 @@ export type Routes = {
70540
70577
  device_ids?: string[] | undefined
70541
70578
  /** IDs of the entrances that you want to add to the new space. */
70542
70579
  acs_entrance_ids?: string[] | undefined
70580
+ /** Customer key for which you want to create the space. */
70581
+ customer_key?: string | undefined
70543
70582
  }
70544
70583
  commonParams: {}
70545
70584
  formData: {}
@@ -72756,6 +72795,8 @@ export type Routes = {
72756
72795
  device_ids?: string[] | undefined
72757
72796
  /** IDs of the entrances that you want to set for the space. If specified, this will replace all existing entrances. */
72758
72797
  acs_entrance_ids?: string[] | undefined
72798
+ /** Customer key for which you want to update the space. */
72799
+ customer_key?: string | undefined
72759
72800
  }
72760
72801
  commonParams: {}
72761
72802
  formData: {}