@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
@@ -2109,7 +2115,13 @@ export interface Routes {
2109
2115
  behavior_when_code_cannot_be_shared?: 'throw' | 'create_random_code'
2110
2116
  /** 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. */
2111
2117
  preferred_code_length?: number | undefined
2112
- /** 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). */
2118
+ /** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
2119
+
2120
+ 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`.
2121
+
2122
+ 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.
2123
+
2124
+ 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). */
2113
2125
  name?: string | undefined
2114
2126
  /** 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. */
2115
2127
  starts_at?: string | undefined
@@ -9807,7 +9819,13 @@ export interface Routes {
9807
9819
  method: 'POST' | 'PATCH' | 'PUT'
9808
9820
  queryParams: {}
9809
9821
  jsonBody: {
9810
- /** 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). */
9822
+ /** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
9823
+
9824
+ 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`.
9825
+
9826
+ 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.
9827
+
9828
+ 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). */
9811
9829
  name?: string | undefined
9812
9830
  /** 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. */
9813
9831
  starts_at?: string | undefined
@@ -11347,7 +11365,13 @@ export interface Routes {
11347
11365
  ends_at?: string | undefined
11348
11366
  /** 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. */
11349
11367
  starts_at?: string | undefined
11350
- /** 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). */
11368
+ /** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
11369
+
11370
+ 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`.
11371
+
11372
+ 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.
11373
+
11374
+ 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). */
11351
11375
  name?: string | undefined
11352
11376
  /** Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`. */
11353
11377
  common_code_key: string
@@ -25583,6 +25607,578 @@ export interface Routes {
25583
25607
  }
25584
25608
  }
25585
25609
  }
25610
+ '/customers/create_portal': {
25611
+ route: '/customers/create_portal'
25612
+ method: 'POST'
25613
+ queryParams: {}
25614
+ jsonBody: {}
25615
+ commonParams: {
25616
+ features?: {
25617
+ /** Configuration for the connect accounts feature. */
25618
+ connect?: {
25619
+ /** Whether to exclude this feature from the portal. */
25620
+ exclude?: boolean
25621
+ }
25622
+ /** Configuration for the manage devices feature. */
25623
+ manage_devices?: {
25624
+ /** Whether to exclude this feature from the portal. */
25625
+ exclude?: boolean
25626
+ }
25627
+ /** Configuration for the organize feature. */
25628
+ organize?: {
25629
+ /** Whether to exclude this feature from the portal. */
25630
+ exclude?: boolean
25631
+ }
25632
+ }
25633
+ } & {
25634
+ customer_data?:
25635
+ | {
25636
+ /** Your unique identifier for the customer. */
25637
+ customer_key: string
25638
+ /** List of general spaces or areas. */
25639
+ spaces?:
25640
+ | Array<{
25641
+ /** Your display name for this location resource. */
25642
+ name: string
25643
+ /** Your unique identifier for the space. */
25644
+ space_key: string
25645
+ }>
25646
+ | undefined
25647
+ /** List of short-term rental properties. */
25648
+ properties?:
25649
+ | Array<{
25650
+ /** Your display name for this location resource. */
25651
+ name: string
25652
+ /** Your unique identifier for the property. */
25653
+ property_key: string
25654
+ }>
25655
+ | undefined
25656
+ /** List of hotel or hospitality rooms. */
25657
+ rooms?:
25658
+ | Array<{
25659
+ /** Your display name for this location resource. */
25660
+ name: string
25661
+ /** Your unique identifier for the room. */
25662
+ room_key: string
25663
+ }>
25664
+ | undefined
25665
+ /** List of shared common areas. */
25666
+ common_areas?:
25667
+ | Array<{
25668
+ /** Your display name for this location resource. */
25669
+ name: string
25670
+ /** Your unique identifier for the common area. */
25671
+ common_area_key: string
25672
+ }>
25673
+ | undefined
25674
+ /** List of multi-family residential units. */
25675
+ units?:
25676
+ | Array<{
25677
+ /** Your display name for this location resource. */
25678
+ name: string
25679
+ /** Your unique identifier for the unit. */
25680
+ unit_key: string
25681
+ }>
25682
+ | undefined
25683
+ /** List of gym or fitness facilities. */
25684
+ facilities?:
25685
+ | Array<{
25686
+ /** Your display name for this location resource. */
25687
+ name: string
25688
+ /** Your unique identifier for the facility. */
25689
+ facility_key: string
25690
+ }>
25691
+ | undefined
25692
+ /** List of buildings. */
25693
+ buildings?:
25694
+ | Array<{
25695
+ /** Your display name for this location resource. */
25696
+ name: string
25697
+ /** Your unique identifier for the building. */
25698
+ building_key: string
25699
+ }>
25700
+ | undefined
25701
+ /** List of property listings. */
25702
+ listings?:
25703
+ | Array<{
25704
+ /** Your display name for this location resource. */
25705
+ name: string
25706
+ /** Your unique identifier for the listing. */
25707
+ listing_key: string
25708
+ }>
25709
+ | undefined
25710
+ /** List of guests. */
25711
+ guests?:
25712
+ | Array<{
25713
+ /** Your display name for this user identity resource. */
25714
+ name: string
25715
+ /** Email address associated with the user identity. */
25716
+ email_address?: string | undefined
25717
+ /** Phone number associated with the user identity. */
25718
+ phone_number?: string | undefined
25719
+ /** Your unique identifier for the guest. */
25720
+ guest_key: string
25721
+ }>
25722
+ | undefined
25723
+ /** List of tenants. */
25724
+ tenants?:
25725
+ | Array<{
25726
+ /** Your display name for this user identity resource. */
25727
+ name: string
25728
+ /** Email address associated with the user identity. */
25729
+ email_address?: string | undefined
25730
+ /** Phone number associated with the user identity. */
25731
+ phone_number?: string | undefined
25732
+ /** Your unique identifier for the tenant. */
25733
+ tenant_key: string
25734
+ }>
25735
+ | undefined
25736
+ /** List of residents. */
25737
+ residents?:
25738
+ | Array<{
25739
+ /** Your display name for this user identity resource. */
25740
+ name: string
25741
+ /** Email address associated with the user identity. */
25742
+ email_address?: string | undefined
25743
+ /** Phone number associated with the user identity. */
25744
+ phone_number?: string | undefined
25745
+ /** Your unique identifier for the resident. */
25746
+ resident_key: string
25747
+ }>
25748
+ | undefined
25749
+ /** List of users. */
25750
+ users?:
25751
+ | Array<{
25752
+ /** Your display name for this user identity resource. */
25753
+ name: string
25754
+ /** Email address associated with the user identity. */
25755
+ email_address?: string | undefined
25756
+ /** Phone number associated with the user identity. */
25757
+ phone_number?: string | undefined
25758
+ /** Your unique identifier for the user. */
25759
+ user_key: string
25760
+ }>
25761
+ | undefined
25762
+ /** List of user identities. */
25763
+ user_identities?:
25764
+ | Array<{
25765
+ /** Your display name for this user identity resource. */
25766
+ name: string
25767
+ /** Email address associated with the user identity. */
25768
+ email_address?: string | undefined
25769
+ /** Phone number associated with the user identity. */
25770
+ phone_number?: string | undefined
25771
+ /** Your unique identifier for the user identity. */
25772
+ user_identity_key: string
25773
+ }>
25774
+ | undefined
25775
+ /** List of reservations. */
25776
+ reservations?:
25777
+ | Array<{
25778
+ /** Your display name for this access grant resource. */
25779
+ name: string
25780
+ /** Starting date and time for the access grant. */
25781
+ starts_at?: string | undefined
25782
+ /** Ending date and time for the access grant. */
25783
+ ends_at?: string | undefined
25784
+ /** Your unique identifier for the reservation. */
25785
+ reservation_key: string
25786
+ /** Guest key associated with the access grant. */
25787
+ guest_key?: string | undefined
25788
+ /** Tenant key associated with the access grant. */
25789
+ tenant_key?: string | undefined
25790
+ /** Resident key associated with the access grant. */
25791
+ resident_key?: string | undefined
25792
+ /** User key associated with the access grant. */
25793
+ user_key?: string | undefined
25794
+ /** User identity key associated with the access grant. */
25795
+ user_identity_key?: string | undefined
25796
+ /** Space keys associated with the access grant. */
25797
+ space_keys?: string[] | undefined
25798
+ /** Property keys associated with the access grant. */
25799
+ property_keys?: string[] | undefined
25800
+ /** Room keys associated with the access grant. */
25801
+ room_keys?: string[] | undefined
25802
+ /** Common area keys associated with the access grant. */
25803
+ common_area_keys?: string[] | undefined
25804
+ /** Unit keys associated with the access grant. */
25805
+ unit_keys?: string[] | undefined
25806
+ /** Facility keys associated with the access grant. */
25807
+ facility_keys?: string[] | undefined
25808
+ /** Building keys associated with the access grant. */
25809
+ building_keys?: string[] | undefined
25810
+ /** Listing keys associated with the access grant. */
25811
+ listing_keys?: string[] | undefined
25812
+ }>
25813
+ | undefined
25814
+ /** List of bookings. */
25815
+ bookings?:
25816
+ | Array<{
25817
+ /** Your display name for this access grant resource. */
25818
+ name: string
25819
+ /** Starting date and time for the access grant. */
25820
+ starts_at?: string | undefined
25821
+ /** Ending date and time for the access grant. */
25822
+ ends_at?: string | undefined
25823
+ /** Your unique identifier for the booking. */
25824
+ booking_key: string
25825
+ /** Guest key associated with the access grant. */
25826
+ guest_key?: string | undefined
25827
+ /** Tenant key associated with the access grant. */
25828
+ tenant_key?: string | undefined
25829
+ /** Resident key associated with the access grant. */
25830
+ resident_key?: string | undefined
25831
+ /** User key associated with the access grant. */
25832
+ user_key?: string | undefined
25833
+ /** User identity key associated with the access grant. */
25834
+ user_identity_key?: string | undefined
25835
+ /** Space keys associated with the access grant. */
25836
+ space_keys?: string[] | undefined
25837
+ /** Property keys associated with the access grant. */
25838
+ property_keys?: string[] | undefined
25839
+ /** Room keys associated with the access grant. */
25840
+ room_keys?: string[] | undefined
25841
+ /** Common area keys associated with the access grant. */
25842
+ common_area_keys?: string[] | undefined
25843
+ /** Unit keys associated with the access grant. */
25844
+ unit_keys?: string[] | undefined
25845
+ /** Facility keys associated with the access grant. */
25846
+ facility_keys?: string[] | undefined
25847
+ /** Building keys associated with the access grant. */
25848
+ building_keys?: string[] | undefined
25849
+ /** Listing keys associated with the access grant. */
25850
+ listing_keys?: string[] | undefined
25851
+ }>
25852
+ | undefined
25853
+ /** List of access grants. */
25854
+ access_grants?:
25855
+ | Array<{
25856
+ /** Your display name for this access grant resource. */
25857
+ name: string
25858
+ /** Starting date and time for the access grant. */
25859
+ starts_at?: string | undefined
25860
+ /** Ending date and time for the access grant. */
25861
+ ends_at?: string | undefined
25862
+ /** Your unique identifier for the access grant. */
25863
+ access_grant_key: string
25864
+ /** Guest key associated with the access grant. */
25865
+ guest_key?: string | undefined
25866
+ /** Tenant key associated with the access grant. */
25867
+ tenant_key?: string | undefined
25868
+ /** Resident key associated with the access grant. */
25869
+ resident_key?: string | undefined
25870
+ /** User key associated with the access grant. */
25871
+ user_key?: string | undefined
25872
+ /** User identity key associated with the access grant. */
25873
+ user_identity_key?: string | undefined
25874
+ /** Space keys associated with the access grant. */
25875
+ space_keys?: string[] | undefined
25876
+ /** Property keys associated with the access grant. */
25877
+ property_keys?: string[] | undefined
25878
+ /** Room keys associated with the access grant. */
25879
+ room_keys?: string[] | undefined
25880
+ /** Common area keys associated with the access grant. */
25881
+ common_area_keys?: string[] | undefined
25882
+ /** Unit keys associated with the access grant. */
25883
+ unit_keys?: string[] | undefined
25884
+ /** Facility keys associated with the access grant. */
25885
+ facility_keys?: string[] | undefined
25886
+ /** Building keys associated with the access grant. */
25887
+ building_keys?: string[] | undefined
25888
+ /** Listing keys associated with the access grant. */
25889
+ listing_keys?: string[] | undefined
25890
+ }>
25891
+ | undefined
25892
+ }
25893
+ | undefined
25894
+ }
25895
+ formData: {}
25896
+ jsonResponse: {
25897
+ /** 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.
25898
+
25899
+ 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.
25900
+
25901
+ Seam hosts these flows, handling everything from account connection and device mapping to full-featured device control. */
25902
+ magic_link: {
25903
+ /** URL for the magic link. */
25904
+ url: string
25905
+ /** Customer key for the magic link. */
25906
+ customer_key: string
25907
+ /** Date and time at which the magic link expires. */
25908
+ expires_at: string
25909
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the magic link. */
25910
+ workspace_id: string
25911
+ /** Date and time at which the magic link was created. */
25912
+ created_at: string
25913
+ }
25914
+ }
25915
+ }
25916
+ '/customers/push_data': {
25917
+ route: '/customers/push_data'
25918
+ method: 'POST'
25919
+ queryParams: {}
25920
+ jsonBody: {}
25921
+ commonParams: {
25922
+ /** Your unique identifier for the customer. */
25923
+ customer_key: string
25924
+ /** List of general spaces or areas. */
25925
+ spaces?:
25926
+ | Array<{
25927
+ /** Your display name for this location resource. */
25928
+ name: string
25929
+ /** Your unique identifier for the space. */
25930
+ space_key: string
25931
+ }>
25932
+ | undefined
25933
+ /** List of short-term rental properties. */
25934
+ properties?:
25935
+ | Array<{
25936
+ /** Your display name for this location resource. */
25937
+ name: string
25938
+ /** Your unique identifier for the property. */
25939
+ property_key: string
25940
+ }>
25941
+ | undefined
25942
+ /** List of hotel or hospitality rooms. */
25943
+ rooms?:
25944
+ | Array<{
25945
+ /** Your display name for this location resource. */
25946
+ name: string
25947
+ /** Your unique identifier for the room. */
25948
+ room_key: string
25949
+ }>
25950
+ | undefined
25951
+ /** List of shared common areas. */
25952
+ common_areas?:
25953
+ | Array<{
25954
+ /** Your display name for this location resource. */
25955
+ name: string
25956
+ /** Your unique identifier for the common area. */
25957
+ common_area_key: string
25958
+ }>
25959
+ | undefined
25960
+ /** List of multi-family residential units. */
25961
+ units?:
25962
+ | Array<{
25963
+ /** Your display name for this location resource. */
25964
+ name: string
25965
+ /** Your unique identifier for the unit. */
25966
+ unit_key: string
25967
+ }>
25968
+ | undefined
25969
+ /** List of gym or fitness facilities. */
25970
+ facilities?:
25971
+ | Array<{
25972
+ /** Your display name for this location resource. */
25973
+ name: string
25974
+ /** Your unique identifier for the facility. */
25975
+ facility_key: string
25976
+ }>
25977
+ | undefined
25978
+ /** List of buildings. */
25979
+ buildings?:
25980
+ | Array<{
25981
+ /** Your display name for this location resource. */
25982
+ name: string
25983
+ /** Your unique identifier for the building. */
25984
+ building_key: string
25985
+ }>
25986
+ | undefined
25987
+ /** List of property listings. */
25988
+ listings?:
25989
+ | Array<{
25990
+ /** Your display name for this location resource. */
25991
+ name: string
25992
+ /** Your unique identifier for the listing. */
25993
+ listing_key: string
25994
+ }>
25995
+ | undefined
25996
+ /** List of guests. */
25997
+ guests?:
25998
+ | Array<{
25999
+ /** Your display name for this user identity resource. */
26000
+ name: string
26001
+ /** Email address associated with the user identity. */
26002
+ email_address?: string | undefined
26003
+ /** Phone number associated with the user identity. */
26004
+ phone_number?: string | undefined
26005
+ /** Your unique identifier for the guest. */
26006
+ guest_key: string
26007
+ }>
26008
+ | undefined
26009
+ /** List of tenants. */
26010
+ tenants?:
26011
+ | Array<{
26012
+ /** Your display name for this user identity resource. */
26013
+ name: string
26014
+ /** Email address associated with the user identity. */
26015
+ email_address?: string | undefined
26016
+ /** Phone number associated with the user identity. */
26017
+ phone_number?: string | undefined
26018
+ /** Your unique identifier for the tenant. */
26019
+ tenant_key: string
26020
+ }>
26021
+ | undefined
26022
+ /** List of residents. */
26023
+ residents?:
26024
+ | Array<{
26025
+ /** Your display name for this user identity resource. */
26026
+ name: string
26027
+ /** Email address associated with the user identity. */
26028
+ email_address?: string | undefined
26029
+ /** Phone number associated with the user identity. */
26030
+ phone_number?: string | undefined
26031
+ /** Your unique identifier for the resident. */
26032
+ resident_key: string
26033
+ }>
26034
+ | undefined
26035
+ /** List of users. */
26036
+ users?:
26037
+ | Array<{
26038
+ /** Your display name for this user identity resource. */
26039
+ name: string
26040
+ /** Email address associated with the user identity. */
26041
+ email_address?: string | undefined
26042
+ /** Phone number associated with the user identity. */
26043
+ phone_number?: string | undefined
26044
+ /** Your unique identifier for the user. */
26045
+ user_key: string
26046
+ }>
26047
+ | undefined
26048
+ /** List of user identities. */
26049
+ user_identities?:
26050
+ | Array<{
26051
+ /** Your display name for this user identity resource. */
26052
+ name: string
26053
+ /** Email address associated with the user identity. */
26054
+ email_address?: string | undefined
26055
+ /** Phone number associated with the user identity. */
26056
+ phone_number?: string | undefined
26057
+ /** Your unique identifier for the user identity. */
26058
+ user_identity_key: string
26059
+ }>
26060
+ | undefined
26061
+ /** List of reservations. */
26062
+ reservations?:
26063
+ | Array<{
26064
+ /** Your display name for this access grant resource. */
26065
+ name: string
26066
+ /** Starting date and time for the access grant. */
26067
+ starts_at?: string | undefined
26068
+ /** Ending date and time for the access grant. */
26069
+ ends_at?: string | undefined
26070
+ /** Your unique identifier for the reservation. */
26071
+ reservation_key: string
26072
+ /** Guest key associated with the access grant. */
26073
+ guest_key?: string | undefined
26074
+ /** Tenant key associated with the access grant. */
26075
+ tenant_key?: string | undefined
26076
+ /** Resident key associated with the access grant. */
26077
+ resident_key?: string | undefined
26078
+ /** User key associated with the access grant. */
26079
+ user_key?: string | undefined
26080
+ /** User identity key associated with the access grant. */
26081
+ user_identity_key?: string | undefined
26082
+ /** Space keys associated with the access grant. */
26083
+ space_keys?: string[] | undefined
26084
+ /** Property keys associated with the access grant. */
26085
+ property_keys?: string[] | undefined
26086
+ /** Room keys associated with the access grant. */
26087
+ room_keys?: string[] | undefined
26088
+ /** Common area keys associated with the access grant. */
26089
+ common_area_keys?: string[] | undefined
26090
+ /** Unit keys associated with the access grant. */
26091
+ unit_keys?: string[] | undefined
26092
+ /** Facility keys associated with the access grant. */
26093
+ facility_keys?: string[] | undefined
26094
+ /** Building keys associated with the access grant. */
26095
+ building_keys?: string[] | undefined
26096
+ /** Listing keys associated with the access grant. */
26097
+ listing_keys?: string[] | undefined
26098
+ }>
26099
+ | undefined
26100
+ /** List of bookings. */
26101
+ bookings?:
26102
+ | Array<{
26103
+ /** Your display name for this access grant resource. */
26104
+ name: string
26105
+ /** Starting date and time for the access grant. */
26106
+ starts_at?: string | undefined
26107
+ /** Ending date and time for the access grant. */
26108
+ ends_at?: string | undefined
26109
+ /** Your unique identifier for the booking. */
26110
+ booking_key: string
26111
+ /** Guest key associated with the access grant. */
26112
+ guest_key?: string | undefined
26113
+ /** Tenant key associated with the access grant. */
26114
+ tenant_key?: string | undefined
26115
+ /** Resident key associated with the access grant. */
26116
+ resident_key?: string | undefined
26117
+ /** User key associated with the access grant. */
26118
+ user_key?: string | undefined
26119
+ /** User identity key associated with the access grant. */
26120
+ user_identity_key?: string | undefined
26121
+ /** Space keys associated with the access grant. */
26122
+ space_keys?: string[] | undefined
26123
+ /** Property keys associated with the access grant. */
26124
+ property_keys?: string[] | undefined
26125
+ /** Room keys associated with the access grant. */
26126
+ room_keys?: string[] | undefined
26127
+ /** Common area keys associated with the access grant. */
26128
+ common_area_keys?: string[] | undefined
26129
+ /** Unit keys associated with the access grant. */
26130
+ unit_keys?: string[] | undefined
26131
+ /** Facility keys associated with the access grant. */
26132
+ facility_keys?: string[] | undefined
26133
+ /** Building keys associated with the access grant. */
26134
+ building_keys?: string[] | undefined
26135
+ /** Listing keys associated with the access grant. */
26136
+ listing_keys?: string[] | undefined
26137
+ }>
26138
+ | undefined
26139
+ /** List of access grants. */
26140
+ access_grants?:
26141
+ | Array<{
26142
+ /** Your display name for this access grant resource. */
26143
+ name: string
26144
+ /** Starting date and time for the access grant. */
26145
+ starts_at?: string | undefined
26146
+ /** Ending date and time for the access grant. */
26147
+ ends_at?: string | undefined
26148
+ /** Your unique identifier for the access grant. */
26149
+ access_grant_key: string
26150
+ /** Guest key associated with the access grant. */
26151
+ guest_key?: string | undefined
26152
+ /** Tenant key associated with the access grant. */
26153
+ tenant_key?: string | undefined
26154
+ /** Resident key associated with the access grant. */
26155
+ resident_key?: string | undefined
26156
+ /** User key associated with the access grant. */
26157
+ user_key?: string | undefined
26158
+ /** User identity key associated with the access grant. */
26159
+ user_identity_key?: string | undefined
26160
+ /** Space keys associated with the access grant. */
26161
+ space_keys?: string[] | undefined
26162
+ /** Property keys associated with the access grant. */
26163
+ property_keys?: string[] | undefined
26164
+ /** Room keys associated with the access grant. */
26165
+ room_keys?: string[] | undefined
26166
+ /** Common area keys associated with the access grant. */
26167
+ common_area_keys?: string[] | undefined
26168
+ /** Unit keys associated with the access grant. */
26169
+ unit_keys?: string[] | undefined
26170
+ /** Facility keys associated with the access grant. */
26171
+ facility_keys?: string[] | undefined
26172
+ /** Building keys associated with the access grant. */
26173
+ building_keys?: string[] | undefined
26174
+ /** Listing keys associated with the access grant. */
26175
+ listing_keys?: string[] | undefined
26176
+ }>
26177
+ | undefined
26178
+ }
26179
+ formData: {}
26180
+ jsonResponse: {}
26181
+ }
25586
26182
  '/devices/delete': {
25587
26183
  route: '/devices/delete'
25588
26184
  method: 'DELETE' | 'POST'
@@ -52657,6 +53253,70 @@ export interface Routes {
52657
53253
  }>
52658
53254
  }
52659
53255
  }
53256
+ '/seam/customer/v1/portals/get': {
53257
+ route: '/seam/customer/v1/portals/get'
53258
+ method: 'GET'
53259
+ queryParams: {}
53260
+ jsonBody: {}
53261
+ commonParams: {
53262
+ /** Customer portal ID. */
53263
+ customer_portal_id: string
53264
+ }
53265
+ formData: {}
53266
+ jsonResponse: {
53267
+ customer_portal: {
53268
+ features?:
53269
+ | {
53270
+ connect?:
53271
+ | {
53272
+ exclude?: boolean | undefined
53273
+ }
53274
+ | undefined
53275
+ manage_devices?:
53276
+ | {
53277
+ exclude?: boolean | undefined
53278
+ }
53279
+ | undefined
53280
+ organize?:
53281
+ | {
53282
+ exclude?: boolean | undefined
53283
+ }
53284
+ | undefined
53285
+ }
53286
+ | undefined
53287
+ /** Business vertical of the customer portal. */
53288
+ business_vertical?:
53289
+ | (
53290
+ | 'short_term_rental'
53291
+ | 'hospitality'
53292
+ | 'multi_family'
53293
+ | 'gym_management'
53294
+ | 'property_tours'
53295
+ )
53296
+ | undefined
53297
+ }
53298
+ }
53299
+ }
53300
+ '/seam/customer/v1/settings/update': {
53301
+ route: '/seam/customer/v1/settings/update'
53302
+ method: 'POST' | 'PATCH'
53303
+ queryParams: {}
53304
+ jsonBody: {
53305
+ /** Business vertical to set on the workspace. */
53306
+ business_vertical?:
53307
+ | (
53308
+ | 'short_term_rental'
53309
+ | 'hospitality'
53310
+ | 'multi_family'
53311
+ | 'gym_management'
53312
+ | 'property_tours'
53313
+ )
53314
+ | undefined
53315
+ }
53316
+ commonParams: {}
53317
+ formData: {}
53318
+ jsonResponse: {}
53319
+ }
52660
53320
  '/seam/instant_key/v1/client_sessions/exchange_short_code': {
52661
53321
  route: '/seam/instant_key/v1/client_sessions/exchange_short_code'
52662
53322
  method: 'POST'
@@ -53205,45 +53865,6 @@ export interface Routes {
53205
53865
  }>
53206
53866
  }
53207
53867
  }
53208
- '/seam/partner/v1/resources/list': {
53209
- route: '/seam/partner/v1/resources/list'
53210
- method: 'GET' | 'POST'
53211
- queryParams: {}
53212
- jsonBody: {}
53213
- commonParams: {
53214
- /** Resource type alias by which you want to filter partner resources. */
53215
- resource_type_alias?: string | undefined
53216
- }
53217
- formData: {}
53218
- jsonResponse: {
53219
- partner_resources: Array<{
53220
- /** Type of the partner resource. */
53221
- partner_resource_type: string
53222
- /** Key of the partner resource. */
53223
- partner_resource_key: string
53224
- /** Customer key associated with the partner resource. */
53225
- customer_key: string
53226
- /** Email address associated with the user identity partner resource. */
53227
- email_address?: string | undefined
53228
- /** Phone number associated with the user identity partner resource. */
53229
- phone_number?: string | undefined
53230
- /** Starting date and time associated with the access grant partner resource. */
53231
- starts_at?: string | undefined
53232
- /** Ending date and time associated with the access grant partner resource. */
53233
- ends_at?: string | undefined
53234
- /** User identity key associated with the access grant partner resource. */
53235
- user_identity_key?: string | undefined
53236
- /** Location keys associated with the access grant partner resource. */
53237
- location_keys?: string[] | undefined
53238
- /** Name of the partner resource. */
53239
- name?: string | undefined
53240
- /** Description of the partner resource. */
53241
- description?: string | undefined
53242
- /** Custom metadata associated with the partner resource. */
53243
- custom_metadata?: Record<string, string> | undefined
53244
- }>
53245
- }
53246
- }
53247
53868
  '/spaces/add_acs_entrances': {
53248
53869
  route: '/spaces/add_acs_entrances'
53249
53870
  method: 'POST' | 'PUT'
@@ -72143,14 +72764,10 @@ export interface Routes {
72143
72764
  /** Optional list of spaces that you want to include in the new building block magic link. */
72144
72765
  spaces?:
72145
72766
  | Array<{
72146
- /** Key of the space for the resource. */
72147
- space_key: string
72148
- /** Name of the space resource. */
72767
+ /** Your display name for this location resource. */
72149
72768
  name: string
72150
- /** Description of the space resource. */
72151
- description?: string | undefined
72152
- /** Custom metadata associated with the space resource. */
72153
- custom_metadata?: Record<string, string> | undefined
72769
+ /** Your unique identifier for the space. */
72770
+ space_key: string
72154
72771
  }>
72155
72772
  | undefined
72156
72773
  }
@@ -72228,14 +72845,10 @@ export interface Routes {
72228
72845
  /** Optional list of spaces that you want to include in the new building block magic link. */
72229
72846
  spaces?:
72230
72847
  | Array<{
72231
- /** Key of the space for the resource. */
72232
- space_key: string
72233
- /** Name of the space resource. */
72848
+ /** Your display name for this location resource. */
72234
72849
  name: string
72235
- /** Description of the space resource. */
72236
- description?: string | undefined
72237
- /** Custom metadata associated with the space resource. */
72238
- custom_metadata?: Record<string, string> | undefined
72850
+ /** Your unique identifier for the space. */
72851
+ space_key: string
72239
72852
  }>
72240
72853
  | undefined
72241
72854
  }
@@ -72266,67 +72879,6 @@ export interface Routes {
72266
72879
  }
72267
72880
  }
72268
72881
  }
72269
- '/unstable_partner/resources/push': {
72270
- route: '/unstable_partner/resources/push'
72271
- method: 'POST'
72272
- queryParams: {}
72273
- jsonBody:
72274
- | Array<{
72275
- /** Type of the resource that you want to push to Seam. */
72276
- partner_resource_type?: string | undefined
72277
- /** Key of the resource that you want to push to Seam. */
72278
- partner_resource_key?: string | undefined
72279
- /** Customer key associated with the resource that you want to push to Seam. */
72280
- customer_key?: string | undefined
72281
- /** Email address associated with the user identity partner resource. */
72282
- email_address?: string | undefined
72283
- /** Phone number associated with the user identity partner resource. */
72284
- phone_number?: string | undefined
72285
- /** Starting date and time associated with the access grant partner resource. */
72286
- starts_at?: string | undefined
72287
- /** Ending date and time associated with the access grant partner resource. */
72288
- ends_at?: string | undefined
72289
- /** User identity key associated with the access grant partner resource. */
72290
- user_identity_key?: string | undefined
72291
- /** Location keys associated with the access grant partner resource. */
72292
- location_keys?: string[] | undefined
72293
- /** Name of the partner resource. */
72294
- name?: string | undefined
72295
- /** Description of the partner resource. */
72296
- description?: string | undefined
72297
- /** Custom metadata associated with the partner resource. */
72298
- custom_metadata?: Record<string, string> | undefined
72299
- }>
72300
- | {
72301
- /** Type of the resource that you want to push to Seam. */
72302
- partner_resource_type?: string | undefined
72303
- /** Key of the resource that you want to push to Seam. */
72304
- partner_resource_key?: string | undefined
72305
- /** Customer key associated with the resource that you want to push to Seam. */
72306
- customer_key?: string | undefined
72307
- /** Email address associated with the user identity partner resource. */
72308
- email_address?: string | undefined
72309
- /** Phone number associated with the user identity partner resource. */
72310
- phone_number?: string | undefined
72311
- /** Starting date and time associated with the access grant partner resource. */
72312
- starts_at?: string | undefined
72313
- /** Ending date and time associated with the access grant partner resource. */
72314
- ends_at?: string | undefined
72315
- /** User identity key associated with the access grant partner resource. */
72316
- user_identity_key?: string | undefined
72317
- /** Location keys associated with the access grant partner resource. */
72318
- location_keys?: string[] | undefined
72319
- /** Name of the partner resource. */
72320
- name?: string | undefined
72321
- /** Description of the partner resource. */
72322
- description?: string | undefined
72323
- /** Custom metadata associated with the partner resource. */
72324
- custom_metadata?: Record<string, string> | undefined
72325
- }
72326
- commonParams: {}
72327
- formData: {}
72328
- jsonResponse: {}
72329
- }
72330
72882
  '/user_identities/add_acs_user': {
72331
72883
  route: '/user_identities/add_acs_user'
72332
72884
  method: 'POST' | 'PUT'