@seamapi/types 1.708.0 → 1.709.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.
@@ -67284,10 +67284,345 @@ export type Routes = {
67284
67284
  }[]
67285
67285
  needs_review?: boolean | undefined
67286
67286
  is_draft?: boolean | undefined
67287
+ is_common_area?: boolean | undefined
67287
67288
  }[]
67288
67289
  }
67289
67290
  maxDuration: undefined
67290
67291
  }
67292
+ '/seam/v1/customers/push_data': {
67293
+ route: '/seam/v1/customers/push_data'
67294
+ method: 'POST'
67295
+ queryParams: {}
67296
+ jsonBody: {}
67297
+ commonParams: {
67298
+ /** List of general spaces or areas. */
67299
+ spaces?:
67300
+ | {
67301
+ /** Your display name for this location resource. */
67302
+ name: string
67303
+ /** Your unique identifier for the space. */
67304
+ space_key: string
67305
+ }[]
67306
+ | undefined
67307
+ /** List of general sites or areas. */
67308
+ sites?:
67309
+ | {
67310
+ /** Your display name for this location resource. */
67311
+ name: string
67312
+ /** Your unique identifier for the site. */
67313
+ site_key: string
67314
+ }[]
67315
+ | undefined
67316
+ /** List of short-term rental properties. */
67317
+ properties?:
67318
+ | {
67319
+ /** Your display name for this location resource. */
67320
+ name: string
67321
+ /** Your unique identifier for the property. */
67322
+ property_key: string
67323
+ }[]
67324
+ | undefined
67325
+ /** List of hotel or hospitality rooms. */
67326
+ rooms?:
67327
+ | {
67328
+ /** Your display name for this location resource. */
67329
+ name: string
67330
+ /** Your unique identifier for the room. */
67331
+ room_key: string
67332
+ /** Your unique identifier for the site. */
67333
+ parent_site_key?: string | undefined
67334
+ }[]
67335
+ | undefined
67336
+ /** List of shared common areas. */
67337
+ common_areas?:
67338
+ | {
67339
+ /** Your display name for this location resource. */
67340
+ name: string
67341
+ /** Your unique identifier for the common area. */
67342
+ common_area_key: string
67343
+ /** Your unique identifier for the site. */
67344
+ parent_site_key?: string | undefined
67345
+ }[]
67346
+ | undefined
67347
+ /** List of multi-family residential units. */
67348
+ units?:
67349
+ | {
67350
+ /** Your display name for this location resource. */
67351
+ name: string
67352
+ /** Your unique identifier for the unit. */
67353
+ unit_key: string
67354
+ /** Your unique identifier for the site. */
67355
+ parent_site_key?: string | undefined
67356
+ }[]
67357
+ | undefined
67358
+ /** List of gym or fitness facilities. */
67359
+ facilities?:
67360
+ | {
67361
+ /** Your display name for this location resource. */
67362
+ name: string
67363
+ /** Your unique identifier for the facility. */
67364
+ facility_key: string
67365
+ }[]
67366
+ | undefined
67367
+ /** List of buildings. */
67368
+ buildings?:
67369
+ | {
67370
+ /** Your display name for this location resource. */
67371
+ name: string
67372
+ /** Your unique identifier for the building. */
67373
+ building_key: string
67374
+ }[]
67375
+ | undefined
67376
+ /** List of property listings. */
67377
+ listings?:
67378
+ | {
67379
+ /** Your display name for this location resource. */
67380
+ name: string
67381
+ /** Your unique identifier for the listing. */
67382
+ listing_key: string
67383
+ }[]
67384
+ | undefined
67385
+ /** List of property listings. */
67386
+ property_listings?:
67387
+ | {
67388
+ /** Your display name for this location resource. */
67389
+ name: string
67390
+ /** Your unique identifier for the property listing. */
67391
+ property_listing_key: string
67392
+ /** Set key:value pairs. Accepts string or Boolean values. Adding custom metadata to a property listing enables you to store custom information, like customer details or internal IDs from your application. */
67393
+ custom_metadata?:
67394
+ | {
67395
+ [x: string]: string | boolean | null
67396
+ }
67397
+ | undefined
67398
+ }[]
67399
+ | undefined
67400
+ /** List of guests. */
67401
+ guests?:
67402
+ | {
67403
+ /** Your display name for this user identity resource. */
67404
+ name: string
67405
+ /** Email address associated with the user identity. */
67406
+ email_address?: string | undefined
67407
+ /** Phone number associated with the user identity. */
67408
+ phone_number?: string | undefined
67409
+ /** Your unique identifier for the guest. */
67410
+ guest_key: string
67411
+ }[]
67412
+ | undefined
67413
+ /** List of tenants. */
67414
+ tenants?:
67415
+ | {
67416
+ /** Your display name for this user identity resource. */
67417
+ name: string
67418
+ /** Email address associated with the user identity. */
67419
+ email_address?: string | undefined
67420
+ /** Phone number associated with the user identity. */
67421
+ phone_number?: string | undefined
67422
+ /** Your unique identifier for the tenant. */
67423
+ tenant_key: string
67424
+ }[]
67425
+ | undefined
67426
+ /** List of residents. */
67427
+ residents?:
67428
+ | {
67429
+ /** Your display name for this user identity resource. */
67430
+ name: string
67431
+ /** Email address associated with the user identity. */
67432
+ email_address?: string | undefined
67433
+ /** Phone number associated with the user identity. */
67434
+ phone_number?: string | undefined
67435
+ /** Your unique identifier for the resident. */
67436
+ resident_key: string
67437
+ }[]
67438
+ | undefined
67439
+ /** List of users. */
67440
+ users?:
67441
+ | {
67442
+ /** Your display name for this user identity resource. */
67443
+ name: string
67444
+ /** Email address associated with the user identity. */
67445
+ email_address?: string | undefined
67446
+ /** Phone number associated with the user identity. */
67447
+ phone_number?: string | undefined
67448
+ /** Your unique identifier for the user. */
67449
+ user_key: string
67450
+ }[]
67451
+ | undefined
67452
+ /** List of user identities. */
67453
+ user_identities?:
67454
+ | {
67455
+ /** Your display name for this user identity resource. */
67456
+ name: string
67457
+ /** Email address associated with the user identity. */
67458
+ email_address?: string | undefined
67459
+ /** Phone number associated with the user identity. */
67460
+ phone_number?: string | undefined
67461
+ /** Your unique identifier for the user identity. */
67462
+ user_identity_key: string
67463
+ }[]
67464
+ | undefined
67465
+ /** List of staff members. */
67466
+ staff_members?:
67467
+ | {
67468
+ /** Your display name for this user identity resource. */
67469
+ name: string
67470
+ /** Email address associated with the user identity. */
67471
+ email_address?: string | undefined
67472
+ /** Phone number associated with the user identity. */
67473
+ phone_number?: string | undefined
67474
+ /** Your unique identifier for the staff. */
67475
+ staff_member_key: string
67476
+ /** List of unique identifiers for the spaces the staff member is associated with. */
67477
+ space_keys?: string[] | undefined
67478
+ /** List of unique identifiers for the properties the staff member is associated with. */
67479
+ property_keys?: string[] | undefined
67480
+ /** List of unique identifiers for the rooms the staff member is associated with. */
67481
+ room_keys?: string[] | undefined
67482
+ /** List of unique identifiers for the common areas the staff member is associated with. */
67483
+ common_area_keys?: string[] | undefined
67484
+ /** List of unique identifiers for the units the staff member is associated with. */
67485
+ unit_keys?: string[] | undefined
67486
+ /** List of unique identifiers for the facilities the staff member is associated with. */
67487
+ facility_keys?: string[] | undefined
67488
+ /** List of unique identifiers for the buildings the staff member is associated with. */
67489
+ building_keys?: string[] | undefined
67490
+ /** List of unique identifiers for the listings the staff member is associated with. */
67491
+ listing_keys?: string[] | undefined
67492
+ /** List of unique identifiers for the property listings the staff member is associated with. */
67493
+ property_listing_keys?: string[] | undefined
67494
+ /** List of unique identifiers for the sites the staff member is associated with. */
67495
+ site_keys?: string[] | undefined
67496
+ }[]
67497
+ | undefined
67498
+ /** List of reservations. */
67499
+ reservations?:
67500
+ | {
67501
+ /** Your name for this access grant resource. */
67502
+ name?: string | undefined
67503
+ /** Starting date and time for the access grant. */
67504
+ starts_at?: string | undefined
67505
+ /** Ending date and time for the access grant. */
67506
+ ends_at?: string | undefined
67507
+ /** Preferred PIN code to use when creating access for this reservation. */
67508
+ preferred_code?: string | undefined
67509
+ /** Your unique identifier for the reservation. */
67510
+ reservation_key: string
67511
+ /** Guest key associated with the access grant. */
67512
+ guest_key?: string | undefined
67513
+ /** Tenant key associated with the access grant. */
67514
+ tenant_key?: string | undefined
67515
+ /** Resident key associated with the access grant. */
67516
+ resident_key?: string | undefined
67517
+ /** User key associated with the access grant. */
67518
+ user_key?: string | undefined
67519
+ /** User identity key associated with the access grant. */
67520
+ user_identity_key?: string | undefined
67521
+ /** Space keys associated with the access grant. */
67522
+ space_keys?: string[] | undefined
67523
+ /** Property keys associated with the access grant. */
67524
+ property_keys?: string[] | undefined
67525
+ /** Room keys associated with the access grant. */
67526
+ room_keys?: string[] | undefined
67527
+ /** Common area keys associated with the access grant. */
67528
+ common_area_keys?: string[] | undefined
67529
+ /** Unit keys associated with the access grant. */
67530
+ unit_keys?: string[] | undefined
67531
+ /** Facility keys associated with the access grant. */
67532
+ facility_keys?: string[] | undefined
67533
+ /** Building keys associated with the access grant. */
67534
+ building_keys?: string[] | undefined
67535
+ /** Listing keys associated with the access grant. */
67536
+ listing_keys?: string[] | undefined
67537
+ }[]
67538
+ | undefined
67539
+ /** List of bookings. */
67540
+ bookings?:
67541
+ | {
67542
+ /** Your name for this access grant resource. */
67543
+ name?: string | undefined
67544
+ /** Starting date and time for the access grant. */
67545
+ starts_at?: string | undefined
67546
+ /** Ending date and time for the access grant. */
67547
+ ends_at?: string | undefined
67548
+ /** Preferred PIN code to use when creating access for this reservation. */
67549
+ preferred_code?: string | undefined
67550
+ /** Your unique identifier for the booking. */
67551
+ booking_key: string
67552
+ /** Guest key associated with the access grant. */
67553
+ guest_key?: string | undefined
67554
+ /** Tenant key associated with the access grant. */
67555
+ tenant_key?: string | undefined
67556
+ /** Resident key associated with the access grant. */
67557
+ resident_key?: string | undefined
67558
+ /** User key associated with the access grant. */
67559
+ user_key?: string | undefined
67560
+ /** User identity key associated with the access grant. */
67561
+ user_identity_key?: string | undefined
67562
+ /** Space keys associated with the access grant. */
67563
+ space_keys?: string[] | undefined
67564
+ /** Property keys associated with the access grant. */
67565
+ property_keys?: string[] | undefined
67566
+ /** Room keys associated with the access grant. */
67567
+ room_keys?: string[] | undefined
67568
+ /** Common area keys associated with the access grant. */
67569
+ common_area_keys?: string[] | undefined
67570
+ /** Unit keys associated with the access grant. */
67571
+ unit_keys?: string[] | undefined
67572
+ /** Facility keys associated with the access grant. */
67573
+ facility_keys?: string[] | undefined
67574
+ /** Building keys associated with the access grant. */
67575
+ building_keys?: string[] | undefined
67576
+ /** Listing keys associated with the access grant. */
67577
+ listing_keys?: string[] | undefined
67578
+ }[]
67579
+ | undefined
67580
+ /** List of access grants. */
67581
+ access_grants?:
67582
+ | {
67583
+ /** Your name for this access grant resource. */
67584
+ name?: string | undefined
67585
+ /** Starting date and time for the access grant. */
67586
+ starts_at?: string | undefined
67587
+ /** Ending date and time for the access grant. */
67588
+ ends_at?: string | undefined
67589
+ /** Preferred PIN code to use when creating access for this reservation. */
67590
+ preferred_code?: string | undefined
67591
+ /** Your unique identifier for the access grant. */
67592
+ access_grant_key: string
67593
+ /** Guest key associated with the access grant. */
67594
+ guest_key?: string | undefined
67595
+ /** Tenant key associated with the access grant. */
67596
+ tenant_key?: string | undefined
67597
+ /** Resident key associated with the access grant. */
67598
+ resident_key?: string | undefined
67599
+ /** User key associated with the access grant. */
67600
+ user_key?: string | undefined
67601
+ /** User identity key associated with the access grant. */
67602
+ user_identity_key?: string | undefined
67603
+ /** Space keys associated with the access grant. */
67604
+ space_keys?: string[] | undefined
67605
+ /** Property keys associated with the access grant. */
67606
+ property_keys?: string[] | undefined
67607
+ /** Room keys associated with the access grant. */
67608
+ room_keys?: string[] | undefined
67609
+ /** Common area keys associated with the access grant. */
67610
+ common_area_keys?: string[] | undefined
67611
+ /** Unit keys associated with the access grant. */
67612
+ unit_keys?: string[] | undefined
67613
+ /** Facility keys associated with the access grant. */
67614
+ facility_keys?: string[] | undefined
67615
+ /** Building keys associated with the access grant. */
67616
+ building_keys?: string[] | undefined
67617
+ /** Listing keys associated with the access grant. */
67618
+ listing_keys?: string[] | undefined
67619
+ }[]
67620
+ | undefined
67621
+ }
67622
+ formData: {}
67623
+ jsonResponse: {}
67624
+ maxDuration: undefined
67625
+ }
67291
67626
  '/spaces/add_acs_entrances': {
67292
67627
  route: '/spaces/add_acs_entrances'
67293
67628
  method: 'POST' | 'PUT'