@seamapi/http 2.50.0 → 2.52.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.
- package/lib/resources/access-grant.d.ts +0 -4
- package/lib/resources/acs-access-group.d.ts +0 -8
- package/lib/resources/acs-system.d.ts +14 -16
- package/lib/resources/acs-user.d.ts +0 -4
- package/lib/resources/client-session.d.ts +0 -5
- package/lib/resources/connect-webview.d.ts +1 -1
- package/lib/resources/connected-account.d.ts +1 -27
- package/lib/resources/device-provider.d.ts +1 -1
- package/lib/resources/device.d.ts +113 -254
- package/lib/resources/event.d.ts +4 -43
- package/lib/resources/phone.d.ts +30 -0
- package/lib/resources/unmanaged-access-grant.d.ts +0 -4
- package/lib/resources/unmanaged-device.d.ts +34 -31
- package/lib/resources/workspace.d.ts +0 -5
- package/lib/routes/access-codes/access-codes.d.ts +0 -4
- package/lib/routes/access-grants/access-grants.d.ts +0 -25
- package/lib/routes/acs/entrances/entrances.d.ts +0 -4
- package/lib/routes/acs/users/users.d.ts +1 -9
- package/lib/routes/acs/users/users.js +0 -1
- package/lib/routes/acs/users/users.js.map +1 -1
- package/lib/routes/client-sessions/client-sessions.d.ts +1 -16
- package/lib/routes/client-sessions/client-sessions.js +0 -1
- package/lib/routes/client-sessions/client-sessions.js.map +1 -1
- package/lib/routes/connect-webviews/connect-webviews.d.ts +2 -2
- package/lib/routes/connected-accounts/connected-accounts.d.ts +1 -1
- package/lib/routes/customers/customers.d.ts +4 -12
- package/lib/routes/devices/devices.d.ts +3 -7
- package/lib/routes/devices/unmanaged/unmanaged.d.ts +3 -3
- package/lib/routes/locks/locks.d.ts +3 -3
- package/lib/routes/spaces/spaces.d.ts +13 -0
- package/lib/routes/thermostats/thermostats.d.ts +3 -13
- package/lib/routes/workspaces/workspaces.d.ts +0 -21
- package/lib/version.d.ts +1 -1
- package/lib/version.js +1 -1
- package/package.json +2 -2
- package/src/lib/resources/access-grant.ts +0 -5
- package/src/lib/resources/acs-access-group.ts +0 -20
- package/src/lib/resources/acs-system.ts +17 -35
- package/src/lib/resources/acs-user.ts +0 -4
- package/src/lib/resources/client-session.ts +0 -6
- package/src/lib/resources/connect-webview.ts +1 -0
- package/src/lib/resources/connected-account.ts +1 -28
- package/src/lib/resources/device-provider.ts +3 -0
- package/src/lib/resources/device.ts +2298 -2448
- package/src/lib/resources/event.ts +4 -53
- package/src/lib/resources/phone.ts +36 -0
- package/src/lib/resources/unmanaged-access-grant.ts +0 -5
- package/src/lib/resources/unmanaged-device.ts +118 -105
- package/src/lib/resources/workspace.ts +0 -6
- package/src/lib/routes/access-codes/access-codes.ts +0 -4
- package/src/lib/routes/access-grants/access-grants.ts +0 -27
- package/src/lib/routes/acs/entrances/entrances.ts +0 -4
- package/src/lib/routes/acs/users/users.ts +0 -10
- package/src/lib/routes/client-sessions/client-sessions.ts +0 -17
- package/src/lib/routes/connect-webviews/connect-webviews.ts +4 -0
- package/src/lib/routes/connected-accounts/connected-accounts.ts +1 -0
- package/src/lib/routes/customers/customers.ts +4 -14
- package/src/lib/routes/devices/devices.ts +11 -4
- package/src/lib/routes/devices/unmanaged/unmanaged.ts +11 -0
- package/src/lib/routes/locks/locks.ts +3 -0
- package/src/lib/routes/spaces/spaces.ts +16 -0
- package/src/lib/routes/thermostats/thermostats.ts +3 -10
- package/src/lib/routes/workspaces/workspaces.ts +0 -21
- package/src/lib/version.ts +1 -1
|
@@ -3181,48 +3181,6 @@ export type SeamEvent =
|
|
|
3181
3181
|
*/
|
|
3182
3182
|
occurred_at: string
|
|
3183
3183
|
|
|
3184
|
-
/**
|
|
3185
|
-
* ID of the workspace associated with the event.
|
|
3186
|
-
*/
|
|
3187
|
-
workspace_id: string
|
|
3188
|
-
}
|
|
3189
|
-
| {
|
|
3190
|
-
/**
|
|
3191
|
-
* ID of the Connect Webview associated with the event.
|
|
3192
|
-
*/
|
|
3193
|
-
connect_webview_id: string
|
|
3194
|
-
|
|
3195
|
-
/**
|
|
3196
|
-
* Custom metadata of the connected account, present when connected_account_id is provided.
|
|
3197
|
-
*/
|
|
3198
|
-
connected_account_custom_metadata?:
|
|
3199
|
-
Record<string, string | boolean> | undefined
|
|
3200
|
-
/**
|
|
3201
|
-
* ID of the affected connected account.
|
|
3202
|
-
*/
|
|
3203
|
-
connected_account_id: string
|
|
3204
|
-
|
|
3205
|
-
/**
|
|
3206
|
-
* Date and time at which the event was created.
|
|
3207
|
-
*/
|
|
3208
|
-
created_at: string
|
|
3209
|
-
|
|
3210
|
-
/**
|
|
3211
|
-
* Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.
|
|
3212
|
-
*/
|
|
3213
|
-
event_description?: string | undefined
|
|
3214
|
-
/**
|
|
3215
|
-
* ID of the event.
|
|
3216
|
-
*/
|
|
3217
|
-
event_id: string
|
|
3218
|
-
|
|
3219
|
-
event_type: 'connected_account.successful_login'
|
|
3220
|
-
|
|
3221
|
-
/**
|
|
3222
|
-
* Date and time at which the event occurred.
|
|
3223
|
-
*/
|
|
3224
|
-
occurred_at: string
|
|
3225
|
-
|
|
3226
3184
|
/**
|
|
3227
3185
|
* ID of the workspace associated with the event.
|
|
3228
3186
|
*/
|
|
@@ -4552,12 +4510,6 @@ export type SeamEvent =
|
|
|
4552
4510
|
* Number in the range 0 to 1.0 indicating the battery level of the affected device's paired accessory keypad, when the device has one and its level is known.
|
|
4553
4511
|
*/
|
|
4554
4512
|
accessory_keypad_battery_level?: number | undefined
|
|
4555
|
-
/**
|
|
4556
|
-
* Number in the range 0 to 1.0 indicating the level of the battery whose drop triggered this event.
|
|
4557
|
-
* @deprecated Use device_battery_level and accessory_keypad_battery_level, which distinguish the device's own battery from a paired accessory keypad's battery.
|
|
4558
|
-
*/
|
|
4559
|
-
battery_level: number
|
|
4560
|
-
|
|
4561
4513
|
/**
|
|
4562
4514
|
* Custom metadata of the connected account, present when connected_account_id is provided.
|
|
4563
4515
|
*/
|
|
@@ -6466,11 +6418,6 @@ export type SeamEvent =
|
|
|
6466
6418
|
workspace_id: string
|
|
6467
6419
|
}
|
|
6468
6420
|
| {
|
|
6469
|
-
/**
|
|
6470
|
-
* The reason the camera was activated.
|
|
6471
|
-
*/
|
|
6472
|
-
activation_reason: 'motion_detected'
|
|
6473
|
-
|
|
6474
6421
|
/**
|
|
6475
6422
|
* Custom metadata of the connected account, present when connected_account_id is provided.
|
|
6476
6423
|
*/
|
|
@@ -6514,6 +6461,10 @@ export type SeamEvent =
|
|
|
6514
6461
|
* URL to a thumbnail image captured at the time of activation.
|
|
6515
6462
|
*/
|
|
6516
6463
|
image_url?: string | undefined
|
|
6464
|
+
/**
|
|
6465
|
+
* Whether motion detection activated the camera, if known.
|
|
6466
|
+
*/
|
|
6467
|
+
is_motion_detected?: boolean | undefined
|
|
6517
6468
|
/**
|
|
6518
6469
|
* IDs of the media, such as a video clip and a thumbnail image, captured for this activation. Use `/media/get` to retrieve each one.
|
|
6519
6470
|
*/
|
|
@@ -832,6 +832,24 @@ export type Phone = {
|
|
|
832
832
|
*/
|
|
833
833
|
warning_code: 'hub_required_for_additional_capabilities'
|
|
834
834
|
} /**
|
|
835
|
+
* Indicates that a technician has put the pool controller in service mode. Schedules and remote changes will not run until it is switched back.
|
|
836
|
+
*/
|
|
837
|
+
| {
|
|
838
|
+
/**
|
|
839
|
+
* Date and time at which Seam created the warning.
|
|
840
|
+
*/
|
|
841
|
+
created_at: string
|
|
842
|
+
|
|
843
|
+
/**
|
|
844
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
845
|
+
*/
|
|
846
|
+
message: string
|
|
847
|
+
|
|
848
|
+
/**
|
|
849
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
850
|
+
*/
|
|
851
|
+
warning_code: 'service_mode'
|
|
852
|
+
} /**
|
|
835
853
|
* Indicates a provider-specific issue that may affect device functionality.
|
|
836
854
|
*/
|
|
837
855
|
| {
|
|
@@ -950,6 +968,24 @@ export type Phone = {
|
|
|
950
968
|
*/
|
|
951
969
|
warning_code: 'max_access_codes_reached'
|
|
952
970
|
} /**
|
|
971
|
+
* Indicates that a third-party subscription is required to enable additional device capabilities.
|
|
972
|
+
*/
|
|
973
|
+
| {
|
|
974
|
+
/**
|
|
975
|
+
* Date and time at which Seam created the warning.
|
|
976
|
+
*/
|
|
977
|
+
created_at: string
|
|
978
|
+
|
|
979
|
+
/**
|
|
980
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
981
|
+
*/
|
|
982
|
+
message: string
|
|
983
|
+
|
|
984
|
+
/**
|
|
985
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
986
|
+
*/
|
|
987
|
+
warning_code: 'subscription_required_for_additional_capabilities'
|
|
988
|
+
} /**
|
|
953
989
|
* Indicates that the camera's account plan does not include cloud recording, so event media such as motion clips is unavailable.
|
|
954
990
|
*/
|
|
955
991
|
| {
|
|
@@ -105,6 +105,7 @@ export type UnmanagedDevice = {
|
|
|
105
105
|
| 'thermostat'
|
|
106
106
|
| 'battery'
|
|
107
107
|
| 'phone'
|
|
108
|
+
| 'pool'
|
|
108
109
|
>
|
|
109
110
|
|
|
110
111
|
/**
|
|
@@ -165,6 +166,7 @@ export type UnmanagedDevice = {
|
|
|
165
166
|
| 'omnitec_lock'
|
|
166
167
|
| 'kisi_lock'
|
|
167
168
|
| 'aqara_lock'
|
|
169
|
+
| 'tuya_lock'
|
|
168
170
|
| 'eufy_lock'
|
|
169
171
|
| 'keynest_key'
|
|
170
172
|
| 'noiseaware_activity_zone'
|
|
@@ -174,6 +176,7 @@ export type UnmanagedDevice = {
|
|
|
174
176
|
| 'honeywell_resideo_thermostat'
|
|
175
177
|
| 'tado_thermostat'
|
|
176
178
|
| 'sensi_thermostat'
|
|
179
|
+
| 'sensibo_thermostat'
|
|
177
180
|
| 'smartthings_thermostat'
|
|
178
181
|
| 'ios_phone'
|
|
179
182
|
| 'android_phone'
|
|
@@ -184,6 +187,8 @@ export type UnmanagedDevice = {
|
|
|
184
187
|
| 'unifi_protect_camera'
|
|
185
188
|
| 'sonos_speaker'
|
|
186
189
|
| 'alertify_sensor'
|
|
190
|
+
| 'hayward_pool_controller'
|
|
191
|
+
| 'hayward_pool'
|
|
187
192
|
|
|
188
193
|
/**
|
|
189
194
|
* Display name of the device, defaults to nickname (if it is set) or `properties.appearance.name`, otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices.
|
|
@@ -564,127 +569,99 @@ export type UnmanagedDevice = {
|
|
|
564
569
|
* Time zone of the device location.
|
|
565
570
|
*/
|
|
566
571
|
time_zone?: string | undefined
|
|
567
|
-
/**
|
|
568
|
-
* Time zone of the device location.
|
|
569
|
-
* @deprecated Use `time_zone` instead.
|
|
570
|
-
*/
|
|
571
|
-
timezone?: string | undefined
|
|
572
572
|
}
|
|
573
573
|
| undefined
|
|
574
574
|
/**
|
|
575
575
|
* properties of the device.
|
|
576
576
|
*/
|
|
577
|
-
properties
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
577
|
+
properties?:
|
|
578
|
+
| {
|
|
579
|
+
/**
|
|
580
|
+
* Accessory keypad properties and state.
|
|
581
|
+
*/
|
|
582
|
+
accessory_keypad?:
|
|
583
|
+
| {
|
|
584
|
+
/**
|
|
585
|
+
* Keypad battery properties.
|
|
586
|
+
*/
|
|
587
|
+
battery?:
|
|
588
|
+
| {
|
|
589
|
+
level: number
|
|
590
|
+
}
|
|
591
|
+
| undefined
|
|
592
|
+
/**
|
|
593
|
+
* Indicates if an accessory keypad is connected to the device.
|
|
594
|
+
*/
|
|
595
|
+
is_connected: boolean
|
|
596
|
+
}
|
|
597
|
+
| undefined
|
|
598
|
+
/**
|
|
599
|
+
* Represents the current status of the battery charge level.
|
|
600
|
+
*/
|
|
601
|
+
battery?:
|
|
602
|
+
| {
|
|
603
|
+
/**
|
|
604
|
+
* Battery charge level as a value between 0 and 1, inclusive.
|
|
605
|
+
*/
|
|
606
|
+
level: number
|
|
607
|
+
|
|
608
|
+
/**
|
|
609
|
+
* Represents the current status of the battery charge level. Values are `critical`, which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; `low`, which signifies that the battery is under the preferred threshold and should be charged soon; `good`, which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and `full`, which represents a battery that is fully charged, providing the maximum duration of usage.
|
|
610
|
+
*/
|
|
611
|
+
status: 'critical' | 'low' | 'good' | 'full'
|
|
612
|
+
}
|
|
613
|
+
| undefined
|
|
614
|
+
/**
|
|
615
|
+
* Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.
|
|
616
|
+
*/
|
|
617
|
+
battery_level?: number | undefined
|
|
618
|
+
/**
|
|
619
|
+
* Alt text for the device image.
|
|
620
|
+
*/
|
|
621
|
+
image_alt_text?: string | undefined
|
|
622
|
+
/**
|
|
623
|
+
* Image URL for the device.
|
|
624
|
+
*/
|
|
625
|
+
image_url?: string | undefined
|
|
626
|
+
/**
|
|
627
|
+
* Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub.
|
|
628
|
+
*/
|
|
629
|
+
manufacturer?: string | undefined
|
|
630
|
+
/**
|
|
631
|
+
* Device model-related properties.
|
|
632
|
+
*/
|
|
633
|
+
model: {
|
|
583
634
|
/**
|
|
584
|
-
*
|
|
635
|
+
* Indicates whether the device can connect a accessory keypad.
|
|
585
636
|
*/
|
|
586
|
-
|
|
587
|
-
| {
|
|
588
|
-
level: number
|
|
589
|
-
}
|
|
590
|
-
| undefined
|
|
637
|
+
can_connect_accessory_keypad?: boolean | undefined
|
|
591
638
|
/**
|
|
592
|
-
*
|
|
639
|
+
* Display name of the device model.
|
|
593
640
|
*/
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
| undefined
|
|
597
|
-
/**
|
|
598
|
-
* Represents the current status of the battery charge level.
|
|
599
|
-
*/
|
|
600
|
-
battery?:
|
|
601
|
-
| {
|
|
641
|
+
display_name: string
|
|
642
|
+
|
|
602
643
|
/**
|
|
603
|
-
*
|
|
644
|
+
* Indicates whether the device has a built in accessory keypad.
|
|
604
645
|
*/
|
|
605
|
-
|
|
606
|
-
|
|
646
|
+
has_built_in_keypad?: boolean | undefined
|
|
607
647
|
/**
|
|
608
|
-
*
|
|
648
|
+
* Display name that corresponds to the manufacturer-specific terminology for the device.
|
|
609
649
|
*/
|
|
610
|
-
|
|
650
|
+
manufacturer_display_name: string
|
|
611
651
|
}
|
|
612
|
-
| undefined
|
|
613
|
-
/**
|
|
614
|
-
* Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.
|
|
615
|
-
*/
|
|
616
|
-
battery_level?: number | undefined
|
|
617
|
-
/**
|
|
618
|
-
* Alt text for the device image.
|
|
619
|
-
*/
|
|
620
|
-
image_alt_text?: string | undefined
|
|
621
|
-
/**
|
|
622
|
-
* Image URL for the device.
|
|
623
|
-
*/
|
|
624
|
-
image_url?: string | undefined
|
|
625
|
-
/**
|
|
626
|
-
* Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub.
|
|
627
|
-
*/
|
|
628
|
-
manufacturer?: string | undefined
|
|
629
|
-
/**
|
|
630
|
-
* Device model-related properties.
|
|
631
|
-
*/
|
|
632
|
-
model: {
|
|
633
|
-
/**
|
|
634
|
-
* @deprecated use device.properties.model.can_connect_accessory_keypad
|
|
635
|
-
*/
|
|
636
|
-
accessory_keypad_supported?: boolean | undefined
|
|
637
|
-
/**
|
|
638
|
-
* Indicates whether the device can connect a accessory keypad.
|
|
639
|
-
*/
|
|
640
|
-
can_connect_accessory_keypad?: boolean | undefined
|
|
641
|
-
/**
|
|
642
|
-
* Display name of the device model.
|
|
643
|
-
*/
|
|
644
|
-
display_name: string
|
|
645
|
-
|
|
646
|
-
/**
|
|
647
|
-
* Indicates whether the device has a built in accessory keypad.
|
|
648
|
-
*/
|
|
649
|
-
has_built_in_keypad?: boolean | undefined
|
|
650
|
-
/**
|
|
651
|
-
* Display name that corresponds to the manufacturer-specific terminology for the device.
|
|
652
|
-
*/
|
|
653
|
-
manufacturer_display_name: string
|
|
654
|
-
|
|
655
|
-
/**
|
|
656
|
-
* @deprecated use device.can_program_offline_access_codes.
|
|
657
|
-
*/
|
|
658
|
-
offline_access_codes_supported?: boolean | undefined
|
|
659
|
-
/**
|
|
660
|
-
* @deprecated use device.can_program_online_access_codes.
|
|
661
|
-
*/
|
|
662
|
-
online_access_codes_supported?: boolean | undefined
|
|
663
|
-
}
|
|
664
|
-
|
|
665
|
-
/**
|
|
666
|
-
* Name of the device.
|
|
667
|
-
* @deprecated use device.display_name instead
|
|
668
|
-
*/
|
|
669
|
-
name: string
|
|
670
|
-
|
|
671
|
-
/**
|
|
672
|
-
* Indicates whether it is currently possible to use offline access codes for the device.
|
|
673
|
-
* @deprecated use device.can_program_offline_access_codes
|
|
674
|
-
*/
|
|
675
|
-
offline_access_codes_enabled?: boolean | undefined
|
|
676
|
-
/**
|
|
677
|
-
* Indicates whether the device is online.
|
|
678
|
-
*/
|
|
679
|
-
online: boolean
|
|
680
652
|
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
}
|
|
653
|
+
/**
|
|
654
|
+
* Name of the device.
|
|
655
|
+
* @deprecated use device.display_name instead
|
|
656
|
+
*/
|
|
657
|
+
name: string
|
|
687
658
|
|
|
659
|
+
/**
|
|
660
|
+
* Indicates whether the device is online.
|
|
661
|
+
*/
|
|
662
|
+
online: boolean
|
|
663
|
+
}
|
|
664
|
+
| undefined
|
|
688
665
|
/**
|
|
689
666
|
* Array of warnings associated with the device. Each warning object within the array contains two fields: `warning_code` and `message`. `warning_code` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.
|
|
690
667
|
*/
|
|
@@ -1086,6 +1063,24 @@ export type UnmanagedDevice = {
|
|
|
1086
1063
|
*/
|
|
1087
1064
|
warning_code: 'hub_required_for_additional_capabilities'
|
|
1088
1065
|
} /**
|
|
1066
|
+
* Indicates that a technician has put the pool controller in service mode. Schedules and remote changes will not run until it is switched back.
|
|
1067
|
+
*/
|
|
1068
|
+
| {
|
|
1069
|
+
/**
|
|
1070
|
+
* Date and time at which Seam created the warning.
|
|
1071
|
+
*/
|
|
1072
|
+
created_at: string
|
|
1073
|
+
|
|
1074
|
+
/**
|
|
1075
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
1076
|
+
*/
|
|
1077
|
+
message: string
|
|
1078
|
+
|
|
1079
|
+
/**
|
|
1080
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
1081
|
+
*/
|
|
1082
|
+
warning_code: 'service_mode'
|
|
1083
|
+
} /**
|
|
1089
1084
|
* Indicates a provider-specific issue that may affect device functionality.
|
|
1090
1085
|
*/
|
|
1091
1086
|
| {
|
|
@@ -1204,6 +1199,24 @@ export type UnmanagedDevice = {
|
|
|
1204
1199
|
*/
|
|
1205
1200
|
warning_code: 'max_access_codes_reached'
|
|
1206
1201
|
} /**
|
|
1202
|
+
* Indicates that a third-party subscription is required to enable additional device capabilities.
|
|
1203
|
+
*/
|
|
1204
|
+
| {
|
|
1205
|
+
/**
|
|
1206
|
+
* Date and time at which Seam created the warning.
|
|
1207
|
+
*/
|
|
1208
|
+
created_at: string
|
|
1209
|
+
|
|
1210
|
+
/**
|
|
1211
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
1212
|
+
*/
|
|
1213
|
+
message: string
|
|
1214
|
+
|
|
1215
|
+
/**
|
|
1216
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
1217
|
+
*/
|
|
1218
|
+
warning_code: 'subscription_required_for_additional_capabilities'
|
|
1219
|
+
} /**
|
|
1207
1220
|
* Indicates that the camera's account plan does not include cloud recording, so event media such as motion clips is unavailable.
|
|
1208
1221
|
*/
|
|
1209
1222
|
| {
|
|
@@ -7,12 +7,6 @@
|
|
|
7
7
|
* Represents a Seam [workspace](https://www.seam.co/docs/core-concepts/workspaces). A workspace is a top-level entity that encompasses all other resources below it, such as devices, connected accounts, and Connect Webviews. Seam provides two types of workspaces. A [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces) is a special type of workspace designed for testing code. Sandbox workspaces offer test device accounts and virtual devices that you can connect and control. This ability to work with virtual devices is quite handy because it removes the need to own physical devices from multiple brands. To connect real devices and systems to Seam, use a [production workspace](https://www.seam.co/docs/core-concepts/workspaces#production-workspaces).
|
|
8
8
|
*/
|
|
9
9
|
export type Workspace = {
|
|
10
|
-
/**
|
|
11
|
-
* Company name associated with the [workspace](https://www.seam.co/docs/core-concepts/workspaces).
|
|
12
|
-
* @deprecated Use `connect_partner_name` instead.
|
|
13
|
-
*/
|
|
14
|
-
company_name: string
|
|
15
|
-
|
|
16
10
|
/**
|
|
17
11
|
* Seam Connect partner name associated with the [workspace](https://www.seam.co/docs/core-concepts/workspaces).
|
|
18
12
|
*/
|
|
@@ -471,10 +471,6 @@ export type AccessCodesCreateParameters = {
|
|
|
471
471
|
* Indicates whether to use a [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://www.seam.co/docs/api/access_codes/pull_backup_access_code).
|
|
472
472
|
*/
|
|
473
473
|
use_backup_access_code_pool?: boolean | undefined
|
|
474
|
-
/**
|
|
475
|
-
* @deprecated Use `is_offline_access_code` instead.
|
|
476
|
-
*/
|
|
477
|
-
use_offline_access_code?: boolean | undefined
|
|
478
474
|
}
|
|
479
475
|
|
|
480
476
|
/**
|
|
@@ -343,29 +343,6 @@ export type AccessGrantsCreateParameters = {
|
|
|
343
343
|
* Date and time at which the validity of the new grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
|
|
344
344
|
*/
|
|
345
345
|
ends_at?: string | null | undefined
|
|
346
|
-
/**
|
|
347
|
-
* @deprecated Create a space first, then reference it using `space_ids`.
|
|
348
|
-
*/
|
|
349
|
-
location?:
|
|
350
|
-
| {
|
|
351
|
-
/**
|
|
352
|
-
* @deprecated Use `acs_entrance_ids` at the top level.
|
|
353
|
-
*/
|
|
354
|
-
acs_entrance_ids?: Array<string> | undefined
|
|
355
|
-
/**
|
|
356
|
-
* @deprecated Use `device_ids` at the top level.
|
|
357
|
-
*/
|
|
358
|
-
device_ids?: Array<string> | undefined
|
|
359
|
-
/**
|
|
360
|
-
* Name of the location.
|
|
361
|
-
*/
|
|
362
|
-
name?: string | undefined
|
|
363
|
-
}
|
|
364
|
-
| undefined
|
|
365
|
-
/**
|
|
366
|
-
* @deprecated Use `space_ids`.
|
|
367
|
-
*/
|
|
368
|
-
location_ids?: Array<string> | undefined
|
|
369
346
|
/**
|
|
370
347
|
* Name for the access grant.
|
|
371
348
|
*/
|
|
@@ -581,10 +558,6 @@ export type AccessGrantsListParameters = {
|
|
|
581
558
|
* Numerical limit on the number of access grants to return.
|
|
582
559
|
*/
|
|
583
560
|
limit?: number | undefined
|
|
584
|
-
/**
|
|
585
|
-
* @deprecated Use `space_id`.
|
|
586
|
-
*/
|
|
587
|
-
location_id?: string | undefined
|
|
588
561
|
/**
|
|
589
562
|
* Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
|
|
590
563
|
*/
|
|
@@ -344,10 +344,6 @@ export type AcsEntrancesListParameters = {
|
|
|
344
344
|
* Maximum number of records to return per page.
|
|
345
345
|
*/
|
|
346
346
|
limit?: number | undefined
|
|
347
|
-
/**
|
|
348
|
-
* @deprecated Use `space_id`.
|
|
349
|
-
*/
|
|
350
|
-
location_id?: string | null | undefined
|
|
351
347
|
/**
|
|
352
348
|
* Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
|
|
353
349
|
*/
|
|
@@ -406,7 +406,6 @@ export class SeamHttpAcsUsers {
|
|
|
406
406
|
'access_schedule',
|
|
407
407
|
'acs_system_id',
|
|
408
408
|
'acs_user_id',
|
|
409
|
-
'email',
|
|
410
409
|
'email_address',
|
|
411
410
|
'full_name',
|
|
412
411
|
'hid_acs_system_id',
|
|
@@ -465,10 +464,6 @@ export type AcsUsersCreateParameters = {
|
|
|
465
464
|
*/
|
|
466
465
|
acs_system_id: string
|
|
467
466
|
|
|
468
|
-
/**
|
|
469
|
-
* @deprecated use email_address.
|
|
470
|
-
*/
|
|
471
|
-
email?: string | undefined
|
|
472
467
|
/**
|
|
473
468
|
* Email address of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
474
469
|
*/
|
|
@@ -774,10 +769,6 @@ export type AcsUsersUpdateParameters = RequireAtLeastOne<
|
|
|
774
769
|
* ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id.
|
|
775
770
|
*/
|
|
776
771
|
acs_user_id?: string | undefined
|
|
777
|
-
/**
|
|
778
|
-
* @deprecated use email_address.
|
|
779
|
-
*/
|
|
780
|
-
email?: string | undefined
|
|
781
772
|
/**
|
|
782
773
|
* Email address of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
783
774
|
*/
|
|
@@ -802,7 +793,6 @@ export type AcsUsersUpdateParameters = RequireAtLeastOne<
|
|
|
802
793
|
| 'access_schedule'
|
|
803
794
|
| 'acs_system_id'
|
|
804
795
|
| 'acs_user_id'
|
|
805
|
-
| 'email'
|
|
806
796
|
| 'email_address'
|
|
807
797
|
| 'full_name'
|
|
808
798
|
| 'hid_acs_system_id'
|
|
@@ -261,7 +261,6 @@ export class SeamHttpClientSessions {
|
|
|
261
261
|
'connected_account_ids',
|
|
262
262
|
'user_identifier_key',
|
|
263
263
|
'user_identity_id',
|
|
264
|
-
'user_identity_ids',
|
|
265
264
|
],
|
|
266
265
|
responseKey: undefined,
|
|
267
266
|
options,
|
|
@@ -341,11 +340,6 @@ export type ClientSessionsCreateParameters = {
|
|
|
341
340
|
* ID of the [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to create a client session.
|
|
342
341
|
*/
|
|
343
342
|
user_identity_id?: string | undefined
|
|
344
|
-
/**
|
|
345
|
-
* IDs of the [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.
|
|
346
|
-
* @deprecated Use `user_identity_id` instead.
|
|
347
|
-
*/
|
|
348
|
-
user_identity_ids?: Array<string> | undefined
|
|
349
343
|
}
|
|
350
344
|
|
|
351
345
|
/**
|
|
@@ -420,11 +414,6 @@ export type ClientSessionsGetOrCreateParameters = {
|
|
|
420
414
|
* ID of the [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session (or that are already associated with the existing client session).
|
|
421
415
|
*/
|
|
422
416
|
user_identity_id?: string | undefined
|
|
423
|
-
/**
|
|
424
|
-
* IDs of the [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.
|
|
425
|
-
* @deprecated Use `user_identity_id`.
|
|
426
|
-
*/
|
|
427
|
-
user_identity_ids?: Array<string> | undefined
|
|
428
417
|
}
|
|
429
418
|
|
|
430
419
|
/**
|
|
@@ -463,18 +452,12 @@ export type ClientSessionsGrantAccessParameters = RequireAtLeastOne<
|
|
|
463
452
|
* ID of the [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.
|
|
464
453
|
*/
|
|
465
454
|
user_identity_id?: string | undefined
|
|
466
|
-
/**
|
|
467
|
-
* IDs of the [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.
|
|
468
|
-
* @deprecated Use `user_identity_id`.
|
|
469
|
-
*/
|
|
470
|
-
user_identity_ids?: Array<string> | undefined
|
|
471
455
|
},
|
|
472
456
|
| 'client_session_id'
|
|
473
457
|
| 'connect_webview_ids'
|
|
474
458
|
| 'connected_account_ids'
|
|
475
459
|
| 'user_identifier_key'
|
|
476
460
|
| 'user_identity_id'
|
|
477
|
-
| 'user_identity_ids'
|
|
478
461
|
>
|
|
479
462
|
|
|
480
463
|
/**
|
|
@@ -265,6 +265,7 @@ export type ConnectWebviewsCreateParameters = {
|
|
|
265
265
|
| 'access_control'
|
|
266
266
|
| 'camera'
|
|
267
267
|
| 'speaker'
|
|
268
|
+
| 'pool'
|
|
268
269
|
>
|
|
269
270
|
| undefined
|
|
270
271
|
/**
|
|
@@ -321,6 +322,7 @@ export type ConnectWebviewsCreateParameters = {
|
|
|
321
322
|
| 'tado'
|
|
322
323
|
| 'salto_space'
|
|
323
324
|
| 'sensi'
|
|
325
|
+
| 'sensibo'
|
|
324
326
|
| 'keynest'
|
|
325
327
|
| 'korelock'
|
|
326
328
|
| 'keyincode'
|
|
@@ -347,6 +349,8 @@ export type ConnectWebviewsCreateParameters = {
|
|
|
347
349
|
| 'aqara'
|
|
348
350
|
| 'eufy'
|
|
349
351
|
| 'sonos'
|
|
352
|
+
| 'hayward_omnilogic'
|
|
353
|
+
| 'tuya'
|
|
350
354
|
| 'hid_cm'
|
|
351
355
|
| 'google_nest'
|
|
352
356
|
| 'slack'
|
|
@@ -1014,6 +1014,10 @@ export type CustomersCreatePortalParameters = {
|
|
|
1014
1014
|
* Indicates whether the customer can customize the access automation rules for their properties.
|
|
1015
1015
|
*/
|
|
1016
1016
|
allow_access_automation_rule_customization?: boolean | undefined
|
|
1017
|
+
/**
|
|
1018
|
+
* Indicates whether the customer can move a connected account to a new Seam Bridge when its current bridge is disconnected.
|
|
1019
|
+
*/
|
|
1020
|
+
allow_bridge_replacement?: boolean | undefined
|
|
1017
1021
|
/**
|
|
1018
1022
|
* Indicates whether the customer can customize the climate automation rules for their properties.
|
|
1019
1023
|
*/
|
|
@@ -1124,20 +1128,6 @@ export type CustomersCreatePortalParameters = {
|
|
|
1124
1128
|
exclude_staff_management?: boolean | undefined
|
|
1125
1129
|
}
|
|
1126
1130
|
| undefined
|
|
1127
|
-
/**
|
|
1128
|
-
* Configuration for the manage devices feature.
|
|
1129
|
-
* ---
|
|
1130
|
-
* deprecated: Use `manage` instead.
|
|
1131
|
-
* ---
|
|
1132
|
-
*/
|
|
1133
|
-
manage_devices?:
|
|
1134
|
-
| {
|
|
1135
|
-
/**
|
|
1136
|
-
* Whether to exclude this feature from the portal.
|
|
1137
|
-
*/
|
|
1138
|
-
exclude?: boolean | undefined
|
|
1139
|
-
}
|
|
1140
|
-
| undefined
|
|
1141
1131
|
/**
|
|
1142
1132
|
* Configuration for the organize feature.
|
|
1143
1133
|
*/
|