@seamapi/types 1.421.1 → 1.422.1

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 (55) hide show
  1. package/dist/connect.cjs +1638 -591
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +2655 -1028
  4. package/lib/seam/connect/internal/schemas.d.ts +1 -1
  5. package/lib/seam/connect/internal/schemas.js +1 -1
  6. package/lib/seam/connect/internal/schemas.js.map +1 -1
  7. package/lib/seam/connect/models/customer/access-grant-resources.d.ts +420 -0
  8. package/lib/seam/connect/models/customer/access-grant-resources.js +111 -0
  9. package/lib/seam/connect/models/customer/access-grant-resources.js.map +1 -0
  10. package/lib/seam/connect/models/customer/business-vertical.d.ts +3 -0
  11. package/lib/seam/connect/models/customer/business-vertical.js +11 -0
  12. package/lib/seam/connect/models/customer/business-vertical.js.map +1 -0
  13. package/lib/seam/connect/models/customer/customer-data.d.ts +597 -0
  14. package/lib/seam/connect/models/customer/customer-data.js +67 -0
  15. package/lib/seam/connect/models/customer/customer-data.js.map +1 -0
  16. package/lib/seam/connect/models/customer/customer-portal.d.ts +71 -0
  17. package/lib/seam/connect/models/customer/customer-portal.js +34 -0
  18. package/lib/seam/connect/models/customer/customer-portal.js.map +1 -0
  19. package/lib/seam/connect/models/customer/index.d.ts +3 -0
  20. package/lib/seam/connect/models/customer/index.js +4 -0
  21. package/lib/seam/connect/models/customer/index.js.map +1 -0
  22. package/lib/seam/connect/models/customer/location-resources.d.ts +229 -0
  23. package/lib/seam/connect/models/customer/location-resources.js +55 -0
  24. package/lib/seam/connect/models/customer/location-resources.js.map +1 -0
  25. package/lib/seam/connect/models/customer/user-identity-resources.d.ts +205 -0
  26. package/lib/seam/connect/models/customer/user-identity-resources.js +50 -0
  27. package/lib/seam/connect/models/customer/user-identity-resources.js.map +1 -0
  28. package/lib/seam/connect/models/index.d.ts +4 -0
  29. package/lib/seam/connect/models/index.js +4 -0
  30. package/lib/seam/connect/models/index.js.map +1 -1
  31. package/lib/seam/connect/models/partner/index.d.ts +0 -1
  32. package/lib/seam/connect/models/partner/index.js +0 -1
  33. package/lib/seam/connect/models/partner/index.js.map +1 -1
  34. package/lib/seam/connect/models/partner/magic-link.d.ts +2 -2
  35. package/lib/seam/connect/openapi.d.ts +1821 -658
  36. package/lib/seam/connect/openapi.js +1647 -600
  37. package/lib/seam/connect/openapi.js.map +1 -1
  38. package/lib/seam/connect/route-types.d.ts +580 -116
  39. package/package.json +2 -2
  40. package/src/lib/seam/connect/internal/schemas.ts +21 -3
  41. package/src/lib/seam/connect/models/customer/access-grant-resources.ts +129 -0
  42. package/src/lib/seam/connect/models/customer/business-vertical.ts +13 -0
  43. package/src/lib/seam/connect/models/customer/customer-data.ts +93 -0
  44. package/src/lib/seam/connect/models/customer/customer-portal.ts +39 -0
  45. package/src/lib/seam/connect/models/customer/index.ts +3 -0
  46. package/src/lib/seam/connect/models/customer/location-resources.ts +77 -0
  47. package/src/lib/seam/connect/models/customer/user-identity-resources.ts +68 -0
  48. package/src/lib/seam/connect/models/index.ts +4 -0
  49. package/src/lib/seam/connect/models/partner/index.ts +0 -1
  50. package/src/lib/seam/connect/openapi.ts +1802 -609
  51. package/src/lib/seam/connect/route-types.ts +670 -118
  52. package/lib/seam/connect/models/partner/resources.d.ts +0 -76
  53. package/lib/seam/connect/models/partner/resources.js +0 -87
  54. package/lib/seam/connect/models/partner/resources.js.map +0 -1
  55. package/src/lib/seam/connect/models/partner/resources.ts +0 -112
@@ -6,7 +6,13 @@ export interface Routes {
6
6
  jsonBody: {
7
7
  /** ID of the device for which you want to create the new access code. */
8
8
  device_id: string;
9
- /** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
9
+ /** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
10
+
11
+ Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
12
+
13
+ To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
14
+
15
+ To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
10
16
  name?: string | undefined;
11
17
  /** Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
12
18
  starts_at?: string | undefined;
@@ -1865,7 +1871,13 @@ export interface Routes {
1865
1871
  behavior_when_code_cannot_be_shared?: 'throw' | 'create_random_code';
1866
1872
  /** Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length. */
1867
1873
  preferred_code_length?: number | undefined;
1868
- /** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
1874
+ /** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
1875
+
1876
+ Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
1877
+
1878
+ To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
1879
+
1880
+ To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
1869
1881
  name?: string | undefined;
1870
1882
  /** Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
1871
1883
  starts_at?: string | undefined;
@@ -8745,7 +8757,13 @@ export interface Routes {
8745
8757
  method: 'POST' | 'PATCH' | 'PUT';
8746
8758
  queryParams: {};
8747
8759
  jsonBody: {
8748
- /** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
8760
+ /** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
8761
+
8762
+ Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
8763
+
8764
+ To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
8765
+
8766
+ To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
8749
8767
  name?: string | undefined;
8750
8768
  /** Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
8751
8769
  starts_at?: string | undefined;
@@ -10096,7 +10114,13 @@ export interface Routes {
10096
10114
  ends_at?: string | undefined;
10097
10115
  /** Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
10098
10116
  starts_at?: string | undefined;
10099
- /** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
10117
+ /** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
10118
+
10119
+ Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
10120
+
10121
+ To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
10122
+
10123
+ To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
10100
10124
  name?: string | undefined;
10101
10125
  /** Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`. */
10102
10126
  common_code_key: string;
@@ -22486,6 +22510,512 @@ export interface Routes {
22486
22510
  };
22487
22511
  };
22488
22512
  };
22513
+ '/customers/create_portal': {
22514
+ route: '/customers/create_portal';
22515
+ method: 'POST';
22516
+ queryParams: {};
22517
+ jsonBody: {};
22518
+ commonParams: {
22519
+ features?: {
22520
+ /** Configuration for the connect accounts feature. */
22521
+ connect?: {
22522
+ /** Whether to exclude this feature from the portal. */
22523
+ exclude?: boolean;
22524
+ };
22525
+ /** Configuration for the manage devices feature. */
22526
+ manage_devices?: {
22527
+ /** Whether to exclude this feature from the portal. */
22528
+ exclude?: boolean;
22529
+ };
22530
+ /** Configuration for the organize feature. */
22531
+ organize?: {
22532
+ /** Whether to exclude this feature from the portal. */
22533
+ exclude?: boolean;
22534
+ };
22535
+ };
22536
+ } & {
22537
+ customer_data?: {
22538
+ /** Your unique identifier for the customer. */
22539
+ customer_key: string;
22540
+ /** List of general spaces or areas. */
22541
+ spaces?: Array<{
22542
+ /** Your display name for this location resource. */
22543
+ name: string;
22544
+ /** Your unique identifier for the space. */
22545
+ space_key: string;
22546
+ }> | undefined;
22547
+ /** List of short-term rental properties. */
22548
+ properties?: Array<{
22549
+ /** Your display name for this location resource. */
22550
+ name: string;
22551
+ /** Your unique identifier for the property. */
22552
+ property_key: string;
22553
+ }> | undefined;
22554
+ /** List of hotel or hospitality rooms. */
22555
+ rooms?: Array<{
22556
+ /** Your display name for this location resource. */
22557
+ name: string;
22558
+ /** Your unique identifier for the room. */
22559
+ room_key: string;
22560
+ }> | undefined;
22561
+ /** List of shared common areas. */
22562
+ common_areas?: Array<{
22563
+ /** Your display name for this location resource. */
22564
+ name: string;
22565
+ /** Your unique identifier for the common area. */
22566
+ common_area_key: string;
22567
+ }> | undefined;
22568
+ /** List of multi-family residential units. */
22569
+ units?: Array<{
22570
+ /** Your display name for this location resource. */
22571
+ name: string;
22572
+ /** Your unique identifier for the unit. */
22573
+ unit_key: string;
22574
+ }> | undefined;
22575
+ /** List of gym or fitness facilities. */
22576
+ facilities?: Array<{
22577
+ /** Your display name for this location resource. */
22578
+ name: string;
22579
+ /** Your unique identifier for the facility. */
22580
+ facility_key: string;
22581
+ }> | undefined;
22582
+ /** List of buildings. */
22583
+ buildings?: Array<{
22584
+ /** Your display name for this location resource. */
22585
+ name: string;
22586
+ /** Your unique identifier for the building. */
22587
+ building_key: string;
22588
+ }> | undefined;
22589
+ /** List of property listings. */
22590
+ listings?: Array<{
22591
+ /** Your display name for this location resource. */
22592
+ name: string;
22593
+ /** Your unique identifier for the listing. */
22594
+ listing_key: string;
22595
+ }> | undefined;
22596
+ /** List of guests. */
22597
+ guests?: Array<{
22598
+ /** Your display name for this user identity resource. */
22599
+ name: string;
22600
+ /** Email address associated with the user identity. */
22601
+ email_address?: string | undefined;
22602
+ /** Phone number associated with the user identity. */
22603
+ phone_number?: string | undefined;
22604
+ /** Your unique identifier for the guest. */
22605
+ guest_key: string;
22606
+ }> | undefined;
22607
+ /** List of tenants. */
22608
+ tenants?: Array<{
22609
+ /** Your display name for this user identity resource. */
22610
+ name: string;
22611
+ /** Email address associated with the user identity. */
22612
+ email_address?: string | undefined;
22613
+ /** Phone number associated with the user identity. */
22614
+ phone_number?: string | undefined;
22615
+ /** Your unique identifier for the tenant. */
22616
+ tenant_key: string;
22617
+ }> | undefined;
22618
+ /** List of residents. */
22619
+ residents?: Array<{
22620
+ /** Your display name for this user identity resource. */
22621
+ name: string;
22622
+ /** Email address associated with the user identity. */
22623
+ email_address?: string | undefined;
22624
+ /** Phone number associated with the user identity. */
22625
+ phone_number?: string | undefined;
22626
+ /** Your unique identifier for the resident. */
22627
+ resident_key: string;
22628
+ }> | undefined;
22629
+ /** List of users. */
22630
+ users?: Array<{
22631
+ /** Your display name for this user identity resource. */
22632
+ name: string;
22633
+ /** Email address associated with the user identity. */
22634
+ email_address?: string | undefined;
22635
+ /** Phone number associated with the user identity. */
22636
+ phone_number?: string | undefined;
22637
+ /** Your unique identifier for the user. */
22638
+ user_key: string;
22639
+ }> | undefined;
22640
+ /** List of user identities. */
22641
+ user_identities?: Array<{
22642
+ /** Your display name for this user identity resource. */
22643
+ name: string;
22644
+ /** Email address associated with the user identity. */
22645
+ email_address?: string | undefined;
22646
+ /** Phone number associated with the user identity. */
22647
+ phone_number?: string | undefined;
22648
+ /** Your unique identifier for the user identity. */
22649
+ user_identity_key: string;
22650
+ }> | undefined;
22651
+ /** List of reservations. */
22652
+ reservations?: Array<{
22653
+ /** Your display name for this access grant resource. */
22654
+ name: string;
22655
+ /** Starting date and time for the access grant. */
22656
+ starts_at?: string | undefined;
22657
+ /** Ending date and time for the access grant. */
22658
+ ends_at?: string | undefined;
22659
+ /** Your unique identifier for the reservation. */
22660
+ reservation_key: string;
22661
+ /** Guest key associated with the access grant. */
22662
+ guest_key?: string | undefined;
22663
+ /** Tenant key associated with the access grant. */
22664
+ tenant_key?: string | undefined;
22665
+ /** Resident key associated with the access grant. */
22666
+ resident_key?: string | undefined;
22667
+ /** User key associated with the access grant. */
22668
+ user_key?: string | undefined;
22669
+ /** User identity key associated with the access grant. */
22670
+ user_identity_key?: string | undefined;
22671
+ /** Space keys associated with the access grant. */
22672
+ space_keys?: string[] | undefined;
22673
+ /** Property keys associated with the access grant. */
22674
+ property_keys?: string[] | undefined;
22675
+ /** Room keys associated with the access grant. */
22676
+ room_keys?: string[] | undefined;
22677
+ /** Common area keys associated with the access grant. */
22678
+ common_area_keys?: string[] | undefined;
22679
+ /** Unit keys associated with the access grant. */
22680
+ unit_keys?: string[] | undefined;
22681
+ /** Facility keys associated with the access grant. */
22682
+ facility_keys?: string[] | undefined;
22683
+ /** Building keys associated with the access grant. */
22684
+ building_keys?: string[] | undefined;
22685
+ /** Listing keys associated with the access grant. */
22686
+ listing_keys?: string[] | undefined;
22687
+ }> | undefined;
22688
+ /** List of bookings. */
22689
+ bookings?: Array<{
22690
+ /** Your display name for this access grant resource. */
22691
+ name: string;
22692
+ /** Starting date and time for the access grant. */
22693
+ starts_at?: string | undefined;
22694
+ /** Ending date and time for the access grant. */
22695
+ ends_at?: string | undefined;
22696
+ /** Your unique identifier for the booking. */
22697
+ booking_key: string;
22698
+ /** Guest key associated with the access grant. */
22699
+ guest_key?: string | undefined;
22700
+ /** Tenant key associated with the access grant. */
22701
+ tenant_key?: string | undefined;
22702
+ /** Resident key associated with the access grant. */
22703
+ resident_key?: string | undefined;
22704
+ /** User key associated with the access grant. */
22705
+ user_key?: string | undefined;
22706
+ /** User identity key associated with the access grant. */
22707
+ user_identity_key?: string | undefined;
22708
+ /** Space keys associated with the access grant. */
22709
+ space_keys?: string[] | undefined;
22710
+ /** Property keys associated with the access grant. */
22711
+ property_keys?: string[] | undefined;
22712
+ /** Room keys associated with the access grant. */
22713
+ room_keys?: string[] | undefined;
22714
+ /** Common area keys associated with the access grant. */
22715
+ common_area_keys?: string[] | undefined;
22716
+ /** Unit keys associated with the access grant. */
22717
+ unit_keys?: string[] | undefined;
22718
+ /** Facility keys associated with the access grant. */
22719
+ facility_keys?: string[] | undefined;
22720
+ /** Building keys associated with the access grant. */
22721
+ building_keys?: string[] | undefined;
22722
+ /** Listing keys associated with the access grant. */
22723
+ listing_keys?: string[] | undefined;
22724
+ }> | undefined;
22725
+ /** List of access grants. */
22726
+ access_grants?: Array<{
22727
+ /** Your display name for this access grant resource. */
22728
+ name: string;
22729
+ /** Starting date and time for the access grant. */
22730
+ starts_at?: string | undefined;
22731
+ /** Ending date and time for the access grant. */
22732
+ ends_at?: string | undefined;
22733
+ /** Your unique identifier for the access grant. */
22734
+ access_grant_key: string;
22735
+ /** Guest key associated with the access grant. */
22736
+ guest_key?: string | undefined;
22737
+ /** Tenant key associated with the access grant. */
22738
+ tenant_key?: string | undefined;
22739
+ /** Resident key associated with the access grant. */
22740
+ resident_key?: string | undefined;
22741
+ /** User key associated with the access grant. */
22742
+ user_key?: string | undefined;
22743
+ /** User identity key associated with the access grant. */
22744
+ user_identity_key?: string | undefined;
22745
+ /** Space keys associated with the access grant. */
22746
+ space_keys?: string[] | undefined;
22747
+ /** Property keys associated with the access grant. */
22748
+ property_keys?: string[] | undefined;
22749
+ /** Room keys associated with the access grant. */
22750
+ room_keys?: string[] | undefined;
22751
+ /** Common area keys associated with the access grant. */
22752
+ common_area_keys?: string[] | undefined;
22753
+ /** Unit keys associated with the access grant. */
22754
+ unit_keys?: string[] | undefined;
22755
+ /** Facility keys associated with the access grant. */
22756
+ facility_keys?: string[] | undefined;
22757
+ /** Building keys associated with the access grant. */
22758
+ building_keys?: string[] | undefined;
22759
+ /** Listing keys associated with the access grant. */
22760
+ listing_keys?: string[] | undefined;
22761
+ }> | undefined;
22762
+ } | undefined;
22763
+ };
22764
+ formData: {};
22765
+ jsonResponse: {
22766
+ /** Represents a Customer Portal. Customer Portal is a hosted, customizable interface for managing device access. It enables you to embed secure, pre-authenticated access flows into your product—either by sharing a link with users or embedding a view in an iframe.
22767
+
22768
+ With Customer Portal, you no longer need to build out frontend experiences for physical access, thermostats, and sensors. Instead, you can ship enterprise-grade access control experiences in a fraction of the time, while maintaining your product's branding and user experience.
22769
+
22770
+ Seam hosts these flows, handling everything from account connection and device mapping to full-featured device control. */
22771
+ magic_link: {
22772
+ /** URL for the magic link. */
22773
+ url: string;
22774
+ /** Customer key for the magic link. */
22775
+ customer_key: string;
22776
+ /** Date and time at which the magic link expires. */
22777
+ expires_at: string;
22778
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the magic link. */
22779
+ workspace_id: string;
22780
+ /** Date and time at which the magic link was created. */
22781
+ created_at: string;
22782
+ };
22783
+ };
22784
+ };
22785
+ '/customers/push_data': {
22786
+ route: '/customers/push_data';
22787
+ method: 'POST';
22788
+ queryParams: {};
22789
+ jsonBody: {};
22790
+ commonParams: {
22791
+ /** Your unique identifier for the customer. */
22792
+ customer_key: string;
22793
+ /** List of general spaces or areas. */
22794
+ spaces?: Array<{
22795
+ /** Your display name for this location resource. */
22796
+ name: string;
22797
+ /** Your unique identifier for the space. */
22798
+ space_key: string;
22799
+ }> | undefined;
22800
+ /** List of short-term rental properties. */
22801
+ properties?: Array<{
22802
+ /** Your display name for this location resource. */
22803
+ name: string;
22804
+ /** Your unique identifier for the property. */
22805
+ property_key: string;
22806
+ }> | undefined;
22807
+ /** List of hotel or hospitality rooms. */
22808
+ rooms?: Array<{
22809
+ /** Your display name for this location resource. */
22810
+ name: string;
22811
+ /** Your unique identifier for the room. */
22812
+ room_key: string;
22813
+ }> | undefined;
22814
+ /** List of shared common areas. */
22815
+ common_areas?: Array<{
22816
+ /** Your display name for this location resource. */
22817
+ name: string;
22818
+ /** Your unique identifier for the common area. */
22819
+ common_area_key: string;
22820
+ }> | undefined;
22821
+ /** List of multi-family residential units. */
22822
+ units?: Array<{
22823
+ /** Your display name for this location resource. */
22824
+ name: string;
22825
+ /** Your unique identifier for the unit. */
22826
+ unit_key: string;
22827
+ }> | undefined;
22828
+ /** List of gym or fitness facilities. */
22829
+ facilities?: Array<{
22830
+ /** Your display name for this location resource. */
22831
+ name: string;
22832
+ /** Your unique identifier for the facility. */
22833
+ facility_key: string;
22834
+ }> | undefined;
22835
+ /** List of buildings. */
22836
+ buildings?: Array<{
22837
+ /** Your display name for this location resource. */
22838
+ name: string;
22839
+ /** Your unique identifier for the building. */
22840
+ building_key: string;
22841
+ }> | undefined;
22842
+ /** List of property listings. */
22843
+ listings?: Array<{
22844
+ /** Your display name for this location resource. */
22845
+ name: string;
22846
+ /** Your unique identifier for the listing. */
22847
+ listing_key: string;
22848
+ }> | undefined;
22849
+ /** List of guests. */
22850
+ guests?: Array<{
22851
+ /** Your display name for this user identity resource. */
22852
+ name: string;
22853
+ /** Email address associated with the user identity. */
22854
+ email_address?: string | undefined;
22855
+ /** Phone number associated with the user identity. */
22856
+ phone_number?: string | undefined;
22857
+ /** Your unique identifier for the guest. */
22858
+ guest_key: string;
22859
+ }> | undefined;
22860
+ /** List of tenants. */
22861
+ tenants?: Array<{
22862
+ /** Your display name for this user identity resource. */
22863
+ name: string;
22864
+ /** Email address associated with the user identity. */
22865
+ email_address?: string | undefined;
22866
+ /** Phone number associated with the user identity. */
22867
+ phone_number?: string | undefined;
22868
+ /** Your unique identifier for the tenant. */
22869
+ tenant_key: string;
22870
+ }> | undefined;
22871
+ /** List of residents. */
22872
+ residents?: Array<{
22873
+ /** Your display name for this user identity resource. */
22874
+ name: string;
22875
+ /** Email address associated with the user identity. */
22876
+ email_address?: string | undefined;
22877
+ /** Phone number associated with the user identity. */
22878
+ phone_number?: string | undefined;
22879
+ /** Your unique identifier for the resident. */
22880
+ resident_key: string;
22881
+ }> | undefined;
22882
+ /** List of users. */
22883
+ users?: Array<{
22884
+ /** Your display name for this user identity resource. */
22885
+ name: string;
22886
+ /** Email address associated with the user identity. */
22887
+ email_address?: string | undefined;
22888
+ /** Phone number associated with the user identity. */
22889
+ phone_number?: string | undefined;
22890
+ /** Your unique identifier for the user. */
22891
+ user_key: string;
22892
+ }> | undefined;
22893
+ /** List of user identities. */
22894
+ user_identities?: Array<{
22895
+ /** Your display name for this user identity resource. */
22896
+ name: string;
22897
+ /** Email address associated with the user identity. */
22898
+ email_address?: string | undefined;
22899
+ /** Phone number associated with the user identity. */
22900
+ phone_number?: string | undefined;
22901
+ /** Your unique identifier for the user identity. */
22902
+ user_identity_key: string;
22903
+ }> | undefined;
22904
+ /** List of reservations. */
22905
+ reservations?: Array<{
22906
+ /** Your display name for this access grant resource. */
22907
+ name: string;
22908
+ /** Starting date and time for the access grant. */
22909
+ starts_at?: string | undefined;
22910
+ /** Ending date and time for the access grant. */
22911
+ ends_at?: string | undefined;
22912
+ /** Your unique identifier for the reservation. */
22913
+ reservation_key: string;
22914
+ /** Guest key associated with the access grant. */
22915
+ guest_key?: string | undefined;
22916
+ /** Tenant key associated with the access grant. */
22917
+ tenant_key?: string | undefined;
22918
+ /** Resident key associated with the access grant. */
22919
+ resident_key?: string | undefined;
22920
+ /** User key associated with the access grant. */
22921
+ user_key?: string | undefined;
22922
+ /** User identity key associated with the access grant. */
22923
+ user_identity_key?: string | undefined;
22924
+ /** Space keys associated with the access grant. */
22925
+ space_keys?: string[] | undefined;
22926
+ /** Property keys associated with the access grant. */
22927
+ property_keys?: string[] | undefined;
22928
+ /** Room keys associated with the access grant. */
22929
+ room_keys?: string[] | undefined;
22930
+ /** Common area keys associated with the access grant. */
22931
+ common_area_keys?: string[] | undefined;
22932
+ /** Unit keys associated with the access grant. */
22933
+ unit_keys?: string[] | undefined;
22934
+ /** Facility keys associated with the access grant. */
22935
+ facility_keys?: string[] | undefined;
22936
+ /** Building keys associated with the access grant. */
22937
+ building_keys?: string[] | undefined;
22938
+ /** Listing keys associated with the access grant. */
22939
+ listing_keys?: string[] | undefined;
22940
+ }> | undefined;
22941
+ /** List of bookings. */
22942
+ bookings?: Array<{
22943
+ /** Your display name for this access grant resource. */
22944
+ name: string;
22945
+ /** Starting date and time for the access grant. */
22946
+ starts_at?: string | undefined;
22947
+ /** Ending date and time for the access grant. */
22948
+ ends_at?: string | undefined;
22949
+ /** Your unique identifier for the booking. */
22950
+ booking_key: string;
22951
+ /** Guest key associated with the access grant. */
22952
+ guest_key?: string | undefined;
22953
+ /** Tenant key associated with the access grant. */
22954
+ tenant_key?: string | undefined;
22955
+ /** Resident key associated with the access grant. */
22956
+ resident_key?: string | undefined;
22957
+ /** User key associated with the access grant. */
22958
+ user_key?: string | undefined;
22959
+ /** User identity key associated with the access grant. */
22960
+ user_identity_key?: string | undefined;
22961
+ /** Space keys associated with the access grant. */
22962
+ space_keys?: string[] | undefined;
22963
+ /** Property keys associated with the access grant. */
22964
+ property_keys?: string[] | undefined;
22965
+ /** Room keys associated with the access grant. */
22966
+ room_keys?: string[] | undefined;
22967
+ /** Common area keys associated with the access grant. */
22968
+ common_area_keys?: string[] | undefined;
22969
+ /** Unit keys associated with the access grant. */
22970
+ unit_keys?: string[] | undefined;
22971
+ /** Facility keys associated with the access grant. */
22972
+ facility_keys?: string[] | undefined;
22973
+ /** Building keys associated with the access grant. */
22974
+ building_keys?: string[] | undefined;
22975
+ /** Listing keys associated with the access grant. */
22976
+ listing_keys?: string[] | undefined;
22977
+ }> | undefined;
22978
+ /** List of access grants. */
22979
+ access_grants?: Array<{
22980
+ /** Your display name for this access grant resource. */
22981
+ name: string;
22982
+ /** Starting date and time for the access grant. */
22983
+ starts_at?: string | undefined;
22984
+ /** Ending date and time for the access grant. */
22985
+ ends_at?: string | undefined;
22986
+ /** Your unique identifier for the access grant. */
22987
+ access_grant_key: string;
22988
+ /** Guest key associated with the access grant. */
22989
+ guest_key?: string | undefined;
22990
+ /** Tenant key associated with the access grant. */
22991
+ tenant_key?: string | undefined;
22992
+ /** Resident key associated with the access grant. */
22993
+ resident_key?: string | undefined;
22994
+ /** User key associated with the access grant. */
22995
+ user_key?: string | undefined;
22996
+ /** User identity key associated with the access grant. */
22997
+ user_identity_key?: string | undefined;
22998
+ /** Space keys associated with the access grant. */
22999
+ space_keys?: string[] | undefined;
23000
+ /** Property keys associated with the access grant. */
23001
+ property_keys?: string[] | undefined;
23002
+ /** Room keys associated with the access grant. */
23003
+ room_keys?: string[] | undefined;
23004
+ /** Common area keys associated with the access grant. */
23005
+ common_area_keys?: string[] | undefined;
23006
+ /** Unit keys associated with the access grant. */
23007
+ unit_keys?: string[] | undefined;
23008
+ /** Facility keys associated with the access grant. */
23009
+ facility_keys?: string[] | undefined;
23010
+ /** Building keys associated with the access grant. */
23011
+ building_keys?: string[] | undefined;
23012
+ /** Listing keys associated with the access grant. */
23013
+ listing_keys?: string[] | undefined;
23014
+ }> | undefined;
23015
+ };
23016
+ formData: {};
23017
+ jsonResponse: {};
23018
+ };
22489
23019
  '/devices/delete': {
22490
23020
  route: '/devices/delete';
22491
23021
  method: 'DELETE' | 'POST';
@@ -45221,6 +45751,46 @@ export interface Routes {
45221
45751
  }>;
45222
45752
  };
45223
45753
  };
45754
+ '/seam/customer/v1/portals/get': {
45755
+ route: '/seam/customer/v1/portals/get';
45756
+ method: 'GET';
45757
+ queryParams: {};
45758
+ jsonBody: {};
45759
+ commonParams: {
45760
+ /** Customer portal ID. */
45761
+ customer_portal_id: string;
45762
+ };
45763
+ formData: {};
45764
+ jsonResponse: {
45765
+ customer_portal: {
45766
+ features?: {
45767
+ connect?: {
45768
+ exclude?: boolean | undefined;
45769
+ } | undefined;
45770
+ manage_devices?: {
45771
+ exclude?: boolean | undefined;
45772
+ } | undefined;
45773
+ organize?: {
45774
+ exclude?: boolean | undefined;
45775
+ } | undefined;
45776
+ } | undefined;
45777
+ /** Business vertical of the customer portal. */
45778
+ business_vertical?: ('short_term_rental' | 'hospitality' | 'multi_family' | 'gym_management' | 'property_tours') | undefined;
45779
+ };
45780
+ };
45781
+ };
45782
+ '/seam/customer/v1/settings/update': {
45783
+ route: '/seam/customer/v1/settings/update';
45784
+ method: 'POST' | 'PATCH';
45785
+ queryParams: {};
45786
+ jsonBody: {
45787
+ /** Business vertical to set on the workspace. */
45788
+ business_vertical?: ('short_term_rental' | 'hospitality' | 'multi_family' | 'gym_management' | 'property_tours') | undefined;
45789
+ };
45790
+ commonParams: {};
45791
+ formData: {};
45792
+ jsonResponse: {};
45793
+ };
45224
45794
  '/seam/instant_key/v1/client_sessions/exchange_short_code': {
45225
45795
  route: '/seam/instant_key/v1/client_sessions/exchange_short_code';
45226
45796
  method: 'POST';
@@ -45689,45 +46259,6 @@ export interface Routes {
45689
46259
  }>;
45690
46260
  };
45691
46261
  };
45692
- '/seam/partner/v1/resources/list': {
45693
- route: '/seam/partner/v1/resources/list';
45694
- method: 'GET' | 'POST';
45695
- queryParams: {};
45696
- jsonBody: {};
45697
- commonParams: {
45698
- /** Resource type alias by which you want to filter partner resources. */
45699
- resource_type_alias?: string | undefined;
45700
- };
45701
- formData: {};
45702
- jsonResponse: {
45703
- partner_resources: Array<{
45704
- /** Type of the partner resource. */
45705
- partner_resource_type: string;
45706
- /** Key of the partner resource. */
45707
- partner_resource_key: string;
45708
- /** Customer key associated with the partner resource. */
45709
- customer_key: string;
45710
- /** Email address associated with the user identity partner resource. */
45711
- email_address?: string | undefined;
45712
- /** Phone number associated with the user identity partner resource. */
45713
- phone_number?: string | undefined;
45714
- /** Starting date and time associated with the access grant partner resource. */
45715
- starts_at?: string | undefined;
45716
- /** Ending date and time associated with the access grant partner resource. */
45717
- ends_at?: string | undefined;
45718
- /** User identity key associated with the access grant partner resource. */
45719
- user_identity_key?: string | undefined;
45720
- /** Location keys associated with the access grant partner resource. */
45721
- location_keys?: string[] | undefined;
45722
- /** Name of the partner resource. */
45723
- name?: string | undefined;
45724
- /** Description of the partner resource. */
45725
- description?: string | undefined;
45726
- /** Custom metadata associated with the partner resource. */
45727
- custom_metadata?: Record<string, string> | undefined;
45728
- }>;
45729
- };
45730
- };
45731
46262
  '/spaces/add_acs_entrances': {
45732
46263
  route: '/spaces/add_acs_entrances';
45733
46264
  method: 'POST' | 'PUT';
@@ -62126,14 +62657,10 @@ export interface Routes {
62126
62657
  customer_key: string;
62127
62658
  /** Optional list of spaces that you want to include in the new building block magic link. */
62128
62659
  spaces?: Array<{
62129
- /** Key of the space for the resource. */
62130
- space_key: string;
62131
- /** Name of the space resource. */
62660
+ /** Your display name for this location resource. */
62132
62661
  name: string;
62133
- /** Description of the space resource. */
62134
- description?: string | undefined;
62135
- /** Custom metadata associated with the space resource. */
62136
- custom_metadata?: Record<string, string> | undefined;
62662
+ /** Your unique identifier for the space. */
62663
+ space_key: string;
62137
62664
  }> | undefined;
62138
62665
  };
62139
62666
  formData: {};
@@ -62201,14 +62728,10 @@ export interface Routes {
62201
62728
  customer_key: string;
62202
62729
  /** Optional list of spaces that you want to include in the new building block magic link. */
62203
62730
  spaces?: Array<{
62204
- /** Key of the space for the resource. */
62205
- space_key: string;
62206
- /** Name of the space resource. */
62731
+ /** Your display name for this location resource. */
62207
62732
  name: string;
62208
- /** Description of the space resource. */
62209
- description?: string | undefined;
62210
- /** Custom metadata associated with the space resource. */
62211
- custom_metadata?: Record<string, string> | undefined;
62733
+ /** Your unique identifier for the space. */
62734
+ space_key: string;
62212
62735
  }> | undefined;
62213
62736
  };
62214
62737
  formData: {};
@@ -62234,65 +62757,6 @@ export interface Routes {
62234
62757
  };
62235
62758
  };
62236
62759
  };
62237
- '/unstable_partner/resources/push': {
62238
- route: '/unstable_partner/resources/push';
62239
- method: 'POST';
62240
- queryParams: {};
62241
- jsonBody: Array<{
62242
- /** Type of the resource that you want to push to Seam. */
62243
- partner_resource_type?: string | undefined;
62244
- /** Key of the resource that you want to push to Seam. */
62245
- partner_resource_key?: string | undefined;
62246
- /** Customer key associated with the resource that you want to push to Seam. */
62247
- customer_key?: string | undefined;
62248
- /** Email address associated with the user identity partner resource. */
62249
- email_address?: string | undefined;
62250
- /** Phone number associated with the user identity partner resource. */
62251
- phone_number?: string | undefined;
62252
- /** Starting date and time associated with the access grant partner resource. */
62253
- starts_at?: string | undefined;
62254
- /** Ending date and time associated with the access grant partner resource. */
62255
- ends_at?: string | undefined;
62256
- /** User identity key associated with the access grant partner resource. */
62257
- user_identity_key?: string | undefined;
62258
- /** Location keys associated with the access grant partner resource. */
62259
- location_keys?: string[] | undefined;
62260
- /** Name of the partner resource. */
62261
- name?: string | undefined;
62262
- /** Description of the partner resource. */
62263
- description?: string | undefined;
62264
- /** Custom metadata associated with the partner resource. */
62265
- custom_metadata?: Record<string, string> | undefined;
62266
- }> | {
62267
- /** Type of the resource that you want to push to Seam. */
62268
- partner_resource_type?: string | undefined;
62269
- /** Key of the resource that you want to push to Seam. */
62270
- partner_resource_key?: string | undefined;
62271
- /** Customer key associated with the resource that you want to push to Seam. */
62272
- customer_key?: string | undefined;
62273
- /** Email address associated with the user identity partner resource. */
62274
- email_address?: string | undefined;
62275
- /** Phone number associated with the user identity partner resource. */
62276
- phone_number?: string | undefined;
62277
- /** Starting date and time associated with the access grant partner resource. */
62278
- starts_at?: string | undefined;
62279
- /** Ending date and time associated with the access grant partner resource. */
62280
- ends_at?: string | undefined;
62281
- /** User identity key associated with the access grant partner resource. */
62282
- user_identity_key?: string | undefined;
62283
- /** Location keys associated with the access grant partner resource. */
62284
- location_keys?: string[] | undefined;
62285
- /** Name of the partner resource. */
62286
- name?: string | undefined;
62287
- /** Description of the partner resource. */
62288
- description?: string | undefined;
62289
- /** Custom metadata associated with the partner resource. */
62290
- custom_metadata?: Record<string, string> | undefined;
62291
- };
62292
- commonParams: {};
62293
- formData: {};
62294
- jsonResponse: {};
62295
- };
62296
62760
  '/user_identities/add_acs_user': {
62297
62761
  route: '/user_identities/add_acs_user';
62298
62762
  method: 'POST' | 'PUT';