@seamapi/types 1.587.0 → 1.589.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.
@@ -82405,6 +82405,11 @@ declare const _default: {
82405
82405
  description: string;
82406
82406
  type: string;
82407
82407
  };
82408
+ customer_key: {
82409
+ description: string;
82410
+ minLength: number;
82411
+ type: string;
82412
+ };
82408
82413
  };
82409
82414
  required: string[];
82410
82415
  type: string;
@@ -82584,6 +82589,7 @@ declare const _default: {
82584
82589
  building_key?: never;
82585
82590
  listing_key?: never;
82586
82591
  property_listing_key?: never;
82592
+ site_key?: never;
82587
82593
  };
82588
82594
  required: string[];
82589
82595
  type: string;
@@ -82600,6 +82606,7 @@ declare const _default: {
82600
82606
  building_key?: never;
82601
82607
  listing_key?: never;
82602
82608
  property_listing_key?: never;
82609
+ site_key?: never;
82603
82610
  };
82604
82611
  required: string[];
82605
82612
  type: string;
@@ -82616,6 +82623,7 @@ declare const _default: {
82616
82623
  building_key?: never;
82617
82624
  listing_key?: never;
82618
82625
  property_listing_key?: never;
82626
+ site_key?: never;
82619
82627
  };
82620
82628
  required: string[];
82621
82629
  type: string;
@@ -82632,6 +82640,7 @@ declare const _default: {
82632
82640
  building_key?: never;
82633
82641
  listing_key?: never;
82634
82642
  property_listing_key?: never;
82643
+ site_key?: never;
82635
82644
  };
82636
82645
  required: string[];
82637
82646
  type: string;
@@ -82648,6 +82657,7 @@ declare const _default: {
82648
82657
  building_key?: never;
82649
82658
  listing_key?: never;
82650
82659
  property_listing_key?: never;
82660
+ site_key?: never;
82651
82661
  };
82652
82662
  required: string[];
82653
82663
  type: string;
@@ -82664,6 +82674,7 @@ declare const _default: {
82664
82674
  building_key?: never;
82665
82675
  listing_key?: never;
82666
82676
  property_listing_key?: never;
82677
+ site_key?: never;
82667
82678
  };
82668
82679
  required: string[];
82669
82680
  type: string;
@@ -82680,6 +82691,7 @@ declare const _default: {
82680
82691
  facility_key?: never;
82681
82692
  listing_key?: never;
82682
82693
  property_listing_key?: never;
82694
+ site_key?: never;
82683
82695
  };
82684
82696
  required: string[];
82685
82697
  type: string;
@@ -82696,6 +82708,7 @@ declare const _default: {
82696
82708
  facility_key?: never;
82697
82709
  building_key?: never;
82698
82710
  property_listing_key?: never;
82711
+ site_key?: never;
82699
82712
  };
82700
82713
  required: string[];
82701
82714
  type: string;
@@ -82712,6 +82725,24 @@ declare const _default: {
82712
82725
  facility_key?: never;
82713
82726
  building_key?: never;
82714
82727
  listing_key?: never;
82728
+ site_key?: never;
82729
+ };
82730
+ required: string[];
82731
+ type: string;
82732
+ } | {
82733
+ properties: {
82734
+ site_key: {
82735
+ type: string;
82736
+ };
82737
+ space_key?: never;
82738
+ property_key?: never;
82739
+ room_key?: never;
82740
+ common_area_key?: never;
82741
+ unit_key?: never;
82742
+ facility_key?: never;
82743
+ building_key?: never;
82744
+ listing_key?: never;
82745
+ property_listing_key?: never;
82715
82746
  };
82716
82747
  required: string[];
82717
82748
  type: string;
@@ -83002,6 +83033,10 @@ declare const _default: {
83002
83033
  description: string;
83003
83034
  type: string;
83004
83035
  };
83036
+ parent_site_key: {
83037
+ description: string;
83038
+ type: string;
83039
+ };
83005
83040
  };
83006
83041
  required: string[];
83007
83042
  type: string;
@@ -83250,6 +83285,10 @@ declare const _default: {
83250
83285
  description: string;
83251
83286
  type: string;
83252
83287
  };
83288
+ parent_site_key: {
83289
+ description: string;
83290
+ type: string;
83291
+ };
83253
83292
  room_key: {
83254
83293
  description: string;
83255
83294
  type: string;
@@ -83260,6 +83299,24 @@ declare const _default: {
83260
83299
  };
83261
83300
  type: string;
83262
83301
  };
83302
+ sites: {
83303
+ description: string;
83304
+ items: {
83305
+ properties: {
83306
+ name: {
83307
+ description: string;
83308
+ type: string;
83309
+ };
83310
+ site_key: {
83311
+ description: string;
83312
+ type: string;
83313
+ };
83314
+ };
83315
+ required: string[];
83316
+ type: string;
83317
+ };
83318
+ type: string;
83319
+ };
83263
83320
  spaces: {
83264
83321
  description: string;
83265
83322
  items: {
@@ -83312,6 +83369,10 @@ declare const _default: {
83312
83369
  description: string;
83313
83370
  type: string;
83314
83371
  };
83372
+ parent_site_key: {
83373
+ description: string;
83374
+ type: string;
83375
+ };
83315
83376
  unit_key: {
83316
83377
  description: string;
83317
83378
  type: string;
@@ -83934,6 +83995,10 @@ declare const _default: {
83934
83995
  description: string;
83935
83996
  type: string;
83936
83997
  };
83998
+ parent_site_key: {
83999
+ description: string;
84000
+ type: string;
84001
+ };
83937
84002
  };
83938
84003
  required: string[];
83939
84004
  type: string;
@@ -84182,6 +84247,10 @@ declare const _default: {
84182
84247
  description: string;
84183
84248
  type: string;
84184
84249
  };
84250
+ parent_site_key: {
84251
+ description: string;
84252
+ type: string;
84253
+ };
84185
84254
  room_key: {
84186
84255
  description: string;
84187
84256
  type: string;
@@ -84192,6 +84261,24 @@ declare const _default: {
84192
84261
  };
84193
84262
  type: string;
84194
84263
  };
84264
+ sites: {
84265
+ description: string;
84266
+ items: {
84267
+ properties: {
84268
+ name: {
84269
+ description: string;
84270
+ type: string;
84271
+ };
84272
+ site_key: {
84273
+ description: string;
84274
+ type: string;
84275
+ };
84276
+ };
84277
+ required: string[];
84278
+ type: string;
84279
+ };
84280
+ type: string;
84281
+ };
84195
84282
  spaces: {
84196
84283
  description: string;
84197
84284
  items: {
@@ -84244,6 +84331,10 @@ declare const _default: {
84244
84331
  description: string;
84245
84332
  type: string;
84246
84333
  };
84334
+ parent_site_key: {
84335
+ description: string;
84336
+ type: string;
84337
+ };
84247
84338
  unit_key: {
84248
84339
  description: string;
84249
84340
  type: string;
@@ -93240,6 +93331,7 @@ declare const _default: {
93240
93331
  building_key?: never;
93241
93332
  listing_key?: never;
93242
93333
  property_listing_key?: never;
93334
+ site_key?: never;
93243
93335
  };
93244
93336
  required: string[];
93245
93337
  type: string;
@@ -93256,6 +93348,7 @@ declare const _default: {
93256
93348
  building_key?: never;
93257
93349
  listing_key?: never;
93258
93350
  property_listing_key?: never;
93351
+ site_key?: never;
93259
93352
  };
93260
93353
  required: string[];
93261
93354
  type: string;
@@ -93272,6 +93365,7 @@ declare const _default: {
93272
93365
  building_key?: never;
93273
93366
  listing_key?: never;
93274
93367
  property_listing_key?: never;
93368
+ site_key?: never;
93275
93369
  };
93276
93370
  required: string[];
93277
93371
  type: string;
@@ -93288,6 +93382,7 @@ declare const _default: {
93288
93382
  building_key?: never;
93289
93383
  listing_key?: never;
93290
93384
  property_listing_key?: never;
93385
+ site_key?: never;
93291
93386
  };
93292
93387
  required: string[];
93293
93388
  type: string;
@@ -93304,6 +93399,7 @@ declare const _default: {
93304
93399
  building_key?: never;
93305
93400
  listing_key?: never;
93306
93401
  property_listing_key?: never;
93402
+ site_key?: never;
93307
93403
  };
93308
93404
  required: string[];
93309
93405
  type: string;
@@ -93320,6 +93416,7 @@ declare const _default: {
93320
93416
  building_key?: never;
93321
93417
  listing_key?: never;
93322
93418
  property_listing_key?: never;
93419
+ site_key?: never;
93323
93420
  };
93324
93421
  required: string[];
93325
93422
  type: string;
@@ -93336,6 +93433,7 @@ declare const _default: {
93336
93433
  facility_key?: never;
93337
93434
  listing_key?: never;
93338
93435
  property_listing_key?: never;
93436
+ site_key?: never;
93339
93437
  };
93340
93438
  required: string[];
93341
93439
  type: string;
@@ -93352,6 +93450,7 @@ declare const _default: {
93352
93450
  facility_key?: never;
93353
93451
  building_key?: never;
93354
93452
  property_listing_key?: never;
93453
+ site_key?: never;
93355
93454
  };
93356
93455
  required: string[];
93357
93456
  type: string;
@@ -93368,6 +93467,24 @@ declare const _default: {
93368
93467
  facility_key?: never;
93369
93468
  building_key?: never;
93370
93469
  listing_key?: never;
93470
+ site_key?: never;
93471
+ };
93472
+ required: string[];
93473
+ type: string;
93474
+ } | {
93475
+ properties: {
93476
+ site_key: {
93477
+ type: string;
93478
+ };
93479
+ space_key?: never;
93480
+ property_key?: never;
93481
+ room_key?: never;
93482
+ common_area_key?: never;
93483
+ unit_key?: never;
93484
+ facility_key?: never;
93485
+ building_key?: never;
93486
+ listing_key?: never;
93487
+ property_listing_key?: never;
93371
93488
  };
93372
93489
  required: string[];
93373
93490
  type: string;
@@ -93544,6 +93661,7 @@ declare const _default: {
93544
93661
  building_key?: never;
93545
93662
  listing_key?: never;
93546
93663
  property_listing_key?: never;
93664
+ site_key?: never;
93547
93665
  };
93548
93666
  required: string[];
93549
93667
  type: string;
@@ -93560,6 +93678,7 @@ declare const _default: {
93560
93678
  building_key?: never;
93561
93679
  listing_key?: never;
93562
93680
  property_listing_key?: never;
93681
+ site_key?: never;
93563
93682
  };
93564
93683
  required: string[];
93565
93684
  type: string;
@@ -93576,6 +93695,7 @@ declare const _default: {
93576
93695
  building_key?: never;
93577
93696
  listing_key?: never;
93578
93697
  property_listing_key?: never;
93698
+ site_key?: never;
93579
93699
  };
93580
93700
  required: string[];
93581
93701
  type: string;
@@ -93592,6 +93712,7 @@ declare const _default: {
93592
93712
  building_key?: never;
93593
93713
  listing_key?: never;
93594
93714
  property_listing_key?: never;
93715
+ site_key?: never;
93595
93716
  };
93596
93717
  required: string[];
93597
93718
  type: string;
@@ -93608,6 +93729,7 @@ declare const _default: {
93608
93729
  building_key?: never;
93609
93730
  listing_key?: never;
93610
93731
  property_listing_key?: never;
93732
+ site_key?: never;
93611
93733
  };
93612
93734
  required: string[];
93613
93735
  type: string;
@@ -93624,6 +93746,7 @@ declare const _default: {
93624
93746
  building_key?: never;
93625
93747
  listing_key?: never;
93626
93748
  property_listing_key?: never;
93749
+ site_key?: never;
93627
93750
  };
93628
93751
  required: string[];
93629
93752
  type: string;
@@ -93640,6 +93763,7 @@ declare const _default: {
93640
93763
  facility_key?: never;
93641
93764
  listing_key?: never;
93642
93765
  property_listing_key?: never;
93766
+ site_key?: never;
93643
93767
  };
93644
93768
  required: string[];
93645
93769
  type: string;
@@ -93656,6 +93780,7 @@ declare const _default: {
93656
93780
  facility_key?: never;
93657
93781
  building_key?: never;
93658
93782
  property_listing_key?: never;
93783
+ site_key?: never;
93659
93784
  };
93660
93785
  required: string[];
93661
93786
  type: string;
@@ -93672,6 +93797,24 @@ declare const _default: {
93672
93797
  facility_key?: never;
93673
93798
  building_key?: never;
93674
93799
  listing_key?: never;
93800
+ site_key?: never;
93801
+ };
93802
+ required: string[];
93803
+ type: string;
93804
+ } | {
93805
+ properties: {
93806
+ site_key: {
93807
+ type: string;
93808
+ };
93809
+ space_key?: never;
93810
+ property_key?: never;
93811
+ room_key?: never;
93812
+ common_area_key?: never;
93813
+ unit_key?: never;
93814
+ facility_key?: never;
93815
+ building_key?: never;
93816
+ listing_key?: never;
93817
+ property_listing_key?: never;
93675
93818
  };
93676
93819
  required: string[];
93677
93820
  type: string;
@@ -95202,6 +95345,9 @@ declare const _default: {
95202
95345
  needs_review: {
95203
95346
  type: string;
95204
95347
  };
95348
+ parent_partner_resource_key: {
95349
+ type: string;
95350
+ };
95205
95351
  partner_resource_key: {
95206
95352
  type: string;
95207
95353
  };
@@ -95313,6 +95459,9 @@ declare const _default: {
95313
95459
  needs_review: {
95314
95460
  type: string;
95315
95461
  };
95462
+ parent_partner_resource_key: {
95463
+ type: string;
95464
+ };
95316
95465
  partner_resource_key: {
95317
95466
  type: string;
95318
95467
  };
@@ -137843,12 +137992,14 @@ type Routes = {
137843
137992
  connected_account_id: string;
137844
137993
  /** Indicates whether newly-added devices should appear as [managed devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices). */
137845
137994
  automatically_manage_new_devices?: boolean | undefined;
137846
- /** Custom metadata that you want to associate with the connected account. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](https://docs.seam.co/latest/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata). */
137995
+ /** Custom metadata that you want to associate with the connected account. Entirely replaces the existing custom metadata object. If a new Connect Webview contains custom metadata and is used to reconnect a connected account, the custom metadata from the Connect Webview will entirely replace the entire custom metadata object on the connected account. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](https://docs.seam.co/latest/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata). */
137847
137996
  custom_metadata?: {
137848
137997
  [x: string]: string | boolean | null;
137849
137998
  } | undefined;
137850
137999
  /** List of accepted device capabilities that restrict the types of devices that can be connected through this connected account. Valid values are `lock`, `thermostat`, `noise_sensor`, and `access_control`. */
137851
138000
  accepted_capabilities?: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control')[] | undefined;
138001
+ /** The customer key to associate with this connected account. If provided, the connected account and all resources under the connected account will be moved to this customer. */
138002
+ customer_key?: string | undefined;
137852
138003
  };
137853
138004
  commonParams: {};
137854
138005
  formData: {};
@@ -138038,6 +138189,8 @@ type Routes = {
138038
138189
  listing_key: string;
138039
138190
  } | {
138040
138191
  property_listing_key: string;
138192
+ } | {
138193
+ site_key: string;
138041
138194
  }) | ({
138042
138195
  reservation_key: string;
138043
138196
  } | {
@@ -138057,6 +138210,13 @@ type Routes = {
138057
138210
  /** Your unique identifier for the space. */
138058
138211
  space_key: string;
138059
138212
  }[] | undefined;
138213
+ /** List of general sites or areas. */
138214
+ sites?: {
138215
+ /** Your display name for this location resource. */
138216
+ name: string;
138217
+ /** Your unique identifier for the site. */
138218
+ site_key: string;
138219
+ }[] | undefined;
138060
138220
  /** List of short-term rental properties. */
138061
138221
  properties?: {
138062
138222
  /** Your display name for this location resource. */
@@ -138070,6 +138230,8 @@ type Routes = {
138070
138230
  name: string;
138071
138231
  /** Your unique identifier for the room. */
138072
138232
  room_key: string;
138233
+ /** Your unique identifier for the site. */
138234
+ parent_site_key?: string | undefined;
138073
138235
  }[] | undefined;
138074
138236
  /** List of shared common areas. */
138075
138237
  common_areas?: {
@@ -138077,6 +138239,8 @@ type Routes = {
138077
138239
  name: string;
138078
138240
  /** Your unique identifier for the common area. */
138079
138241
  common_area_key: string;
138242
+ /** Your unique identifier for the site. */
138243
+ parent_site_key?: string | undefined;
138080
138244
  }[] | undefined;
138081
138245
  /** List of multi-family residential units. */
138082
138246
  units?: {
@@ -138084,6 +138248,8 @@ type Routes = {
138084
138248
  name: string;
138085
138249
  /** Your unique identifier for the unit. */
138086
138250
  unit_key: string;
138251
+ /** Your unique identifier for the site. */
138252
+ parent_site_key?: string | undefined;
138087
138253
  }[] | undefined;
138088
138254
  /** List of gym or fitness facilities. */
138089
138255
  facilities?: {
@@ -138369,6 +138535,13 @@ type Routes = {
138369
138535
  /** Your unique identifier for the space. */
138370
138536
  space_key: string;
138371
138537
  }[] | undefined;
138538
+ /** List of general sites or areas. */
138539
+ sites?: {
138540
+ /** Your display name for this location resource. */
138541
+ name: string;
138542
+ /** Your unique identifier for the site. */
138543
+ site_key: string;
138544
+ }[] | undefined;
138372
138545
  /** List of short-term rental properties. */
138373
138546
  properties?: {
138374
138547
  /** Your display name for this location resource. */
@@ -138382,6 +138555,8 @@ type Routes = {
138382
138555
  name: string;
138383
138556
  /** Your unique identifier for the room. */
138384
138557
  room_key: string;
138558
+ /** Your unique identifier for the site. */
138559
+ parent_site_key?: string | undefined;
138385
138560
  }[] | undefined;
138386
138561
  /** List of shared common areas. */
138387
138562
  common_areas?: {
@@ -138389,6 +138564,8 @@ type Routes = {
138389
138564
  name: string;
138390
138565
  /** Your unique identifier for the common area. */
138391
138566
  common_area_key: string;
138567
+ /** Your unique identifier for the site. */
138568
+ parent_site_key?: string | undefined;
138392
138569
  }[] | undefined;
138393
138570
  /** List of multi-family residential units. */
138394
138571
  units?: {
@@ -138396,6 +138573,8 @@ type Routes = {
138396
138573
  name: string;
138397
138574
  /** Your unique identifier for the unit. */
138398
138575
  unit_key: string;
138576
+ /** Your unique identifier for the site. */
138577
+ parent_site_key?: string | undefined;
138399
138578
  }[] | undefined;
138400
138579
  /** List of gym or fitness facilities. */
138401
138580
  facilities?: {
@@ -165093,6 +165272,8 @@ type Routes = {
165093
165272
  listing_key: string;
165094
165273
  } | {
165095
165274
  property_listing_key: string;
165275
+ } | {
165276
+ site_key: string;
165096
165277
  }) | ({
165097
165278
  reservation_key: string;
165098
165279
  } | {
@@ -165808,6 +165989,7 @@ type Routes = {
165808
165989
  spaces: {
165809
165990
  name: string;
165810
165991
  partner_resource_key: string;
165992
+ parent_partner_resource_key?: string | undefined;
165811
165993
  devices: {
165812
165994
  device_id: string;
165813
165995
  device_type: 'lock' | 'thermostat' | 'sensor';