@seamapi/http 2.25.0 → 2.27.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -82,7 +82,7 @@ export type DeviceProvider = {
82
82
  /**
83
83
  * Name of the device provider.
84
84
  */
85
- device_provider_name: 'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'salto_ks_accept' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'yacan' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara';
85
+ device_provider_name: 'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'salto_ks_accept' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'yacan' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara';
86
86
  /**
87
87
  * Display name for the device provider.
88
88
  */
@@ -797,6 +797,33 @@ export type Device = {
797
797
  */
798
798
  relay_name?: string | null | undefined;
799
799
  } | undefined;
800
+ /**
801
+ * Metadata for a dormakaba Oracode Homeowner's Portal device.
802
+ */
803
+ dormakaba_oracode_iho_metadata?: {
804
+ /**
805
+ * Door ID for a dormakaba Oracode Homeowner's Portal device.
806
+ */
807
+ door_id?: number | undefined;
808
+ /**
809
+ * Name of the door for a dormakaba Oracode Homeowner's Portal device.
810
+ */
811
+ door_name?: string | undefined;
812
+ /**
813
+ * IANA time zone for a dormakaba Oracode Homeowner's Portal device.
814
+ */
815
+ iana_timezone?: string | undefined;
816
+ /**
817
+ * User levels for a dormakaba Oracode Homeowner's Portal device.
818
+ */
819
+ user_levels?: Array<{
820
+ userLevel?: number | undefined;
821
+ userLevelCheckInTime?: string | undefined;
822
+ userLevelCheckOutTime?: string | undefined;
823
+ userLevelName?: string | undefined;
824
+ userLevelType?: string | undefined;
825
+ }> | undefined;
826
+ } | undefined;
800
827
  /**
801
828
  * Metadata for a dormakaba Oracode device.
802
829
  */
@@ -36,6 +36,10 @@ export type UnmanagedAccessCode = {
36
36
  * Unique identifier for the device associated with the access code.
37
37
  */
38
38
  device_id: string;
39
+ /**
40
+ * Human-readable label for the code's state: `Active` or `Not active`, based on whether the code is set on the device. For display only. The wording is not stable and is not an enumeration — never compare against or branch on it.
41
+ */
42
+ display_status: string;
39
43
  /**
40
44
  * Metadata for a dormakaba Oracode unmanaged access code. Only present for unmanaged access codes from dormakaba Oracode devices.
41
45
  */
@@ -621,6 +625,7 @@ export type UnmanagedAccessCode = {
621
625
  starts_at?: string | null | undefined;
622
626
  /**
623
627
  * Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational. `unset` indicates that the code exists on the provider but is not usable on the device.
628
+ * @deprecated Use `display_status` to show a person the code's state.
624
629
  */
625
630
  status: 'set' | 'unset';
626
631
  /**
@@ -50,7 +50,7 @@ export type ConnectWebviewsCreateParameters = {
50
50
  /**
51
51
  * Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://docs.seam.co/api/devices/list_device_providers) with no filters.
52
52
  */
53
- accepted_providers?: Array<'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'salto_ks_accept' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'yacan' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara' | 'yale_access' | 'hid_cm' | 'google_nest' | 'slack'> | undefined;
53
+ accepted_providers?: Array<'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'salto_ks_accept' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'yacan' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara' | 'yale_access' | 'hid_cm' | 'google_nest' | 'slack'> | undefined;
54
54
  /**
55
55
  * Indicates whether newly-added devices should appear as [managed devices](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices). See also: [Customize the Behavior Settings of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews).
56
56
  */
@@ -113,7 +113,7 @@ export type DevicesListParameters = {
113
113
  /**
114
114
  * Manufacturer for which you want to list devices.
115
115
  */
116
- manufacturer?: 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'dormakaba_oracode' | 'tedee' | 'keyincode' | 'akiles' | 'aqara' | 'ecobee' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'lockly' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'slack' | 'yacan' | undefined;
116
+ manufacturer?: 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'dormakaba_oracode' | 'tedee' | 'keyincode' | 'akiles' | 'aqara' | 'ecobee' | 'dormakaba_oracode_iho' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'lockly' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'slack' | 'yacan' | undefined;
117
117
  /**
118
118
  * Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
119
119
  */
@@ -96,7 +96,7 @@ export type DevicesUnmanagedListParameters = {
96
96
  /**
97
97
  * Manufacturer for which you want to list devices.
98
98
  */
99
- manufacturer?: 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'dormakaba_oracode' | 'tedee' | 'keyincode' | 'akiles' | 'aqara' | 'ecobee' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'lockly' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'slack' | 'yacan' | undefined;
99
+ manufacturer?: 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'dormakaba_oracode' | 'tedee' | 'keyincode' | 'akiles' | 'aqara' | 'ecobee' | 'dormakaba_oracode_iho' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'lockly' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'slack' | 'yacan' | undefined;
100
100
  /**
101
101
  * Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
102
102
  */
@@ -106,7 +106,7 @@ export type LocksListParameters = {
106
106
  /**
107
107
  * Manufacturer of the locks that you want to list.
108
108
  */
109
- manufacturer?: 'akuvox' | 'august' | 'brivo' | 'butterflymx' | 'avigilon_alta' | 'doorking' | 'genie' | 'igloo' | 'linear' | 'kwikset' | 'nuki' | 'salto' | 'schlage' | 'seam' | 'wyze' | 'yale' | 'two_n' | 'controlbyweb' | 'ttlock' | 'igloohome' | 'four_suites' | 'dormakaba_oracode' | 'tedee' | 'keyincode' | 'akiles' | 'aqara' | 'korelock' | 'lockly' | 'smartthings' | 'ultraloq' | 'omnitec' | 'kisi' | 'yacan' | undefined;
109
+ manufacturer?: 'akuvox' | 'august' | 'brivo' | 'butterflymx' | 'avigilon_alta' | 'doorking' | 'genie' | 'igloo' | 'linear' | 'kwikset' | 'nuki' | 'salto' | 'schlage' | 'seam' | 'wyze' | 'yale' | 'two_n' | 'controlbyweb' | 'ttlock' | 'igloohome' | 'four_suites' | 'dormakaba_oracode' | 'tedee' | 'keyincode' | 'akiles' | 'aqara' | 'dormakaba_oracode_iho' | 'korelock' | 'lockly' | 'smartthings' | 'ultraloq' | 'omnitec' | 'kisi' | 'yacan' | undefined;
110
110
  };
111
111
  /**
112
112
  * @deprecated Use LocksListRequest instead.
package/lib/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- declare const seamapiJavascriptHttpVersion = "2.25.0";
1
+ declare const seamapiJavascriptHttpVersion = "2.27.0";
2
2
  export default seamapiJavascriptHttpVersion;
package/lib/version.js CHANGED
@@ -1,3 +1,3 @@
1
- const seamapiJavascriptHttpVersion = '2.25.0';
1
+ const seamapiJavascriptHttpVersion = '2.27.0';
2
2
  export default seamapiJavascriptHttpVersion;
3
3
  //# sourceMappingURL=version.js.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/http",
3
- "version": "2.25.0",
3
+ "version": "2.27.0",
4
4
  "description": "JavaScript HTTP client for the Seam API written in TypeScript.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -85,10 +85,10 @@
85
85
  "axios-retry": "^4.4.2"
86
86
  },
87
87
  "devDependencies": {
88
- "@seamapi/blueprint": "^1.9.1",
88
+ "@seamapi/blueprint": "^1.10.0",
89
89
  "@seamapi/fake-seam-connect": "^2.0.4",
90
90
  "@seamapi/smith": "^1.1.0",
91
- "@seamapi/types": "1.1047.0",
91
+ "@seamapi/types": "1.1056.0",
92
92
  "@types/jsonwebtoken": "^9.0.6",
93
93
  "@types/node": "^24.10.9",
94
94
  "ava": "^8.0.1",
@@ -162,13 +162,15 @@ const isFailedActionAttempt = <T extends ActionAttempt>(
162
162
  /**
163
163
  * An action attempt that has succeeded.
164
164
  */
165
- export type SucceededActionAttempt<T extends ActionAttempt> = T & {
166
- status: 'success'
167
- }
165
+ export type SucceededActionAttempt<T extends ActionAttempt> = Extract<
166
+ T,
167
+ { status: 'success' }
168
+ >
168
169
 
169
170
  /**
170
171
  * An action attempt that has failed.
171
172
  */
172
- export type FailedActionAttempt<T extends ActionAttempt> = T & {
173
- status: 'error'
174
- }
173
+ export type FailedActionAttempt<T extends ActionAttempt> = Extract<
174
+ T,
175
+ { status: 'error' }
176
+ >
@@ -38,6 +38,11 @@ export type AccessCode = {
38
38
  */
39
39
  device_id: string
40
40
 
41
+ /**
42
+ * Human-readable label for where this access code sits in its lifecycle, for example `Active`, `Issuing`, or `Expired`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `pending_mutations`, `errors`, `warnings`, `starts_at`, and `ends_at`.
43
+ */
44
+ display_status: string
45
+
41
46
  /**
42
47
  * Metadata for a dormakaba Oracode managed access code. Only present for access codes from dormakaba Oracode devices.
43
48
  */
@@ -949,6 +954,7 @@ export type AccessCode = {
949
954
  starts_at?: string | null | undefined
950
955
  /**
951
956
  * Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes).
957
+ * @deprecated Use `display_status` to show a person the code's state. To make decisions, read `pending_mutations`, `errors`, `warnings`, `starts_at`, and `ends_at`.
952
958
  */
953
959
  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown'
954
960