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