@seamapi/http 2.45.0 → 2.47.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/README.md +12 -0
- package/lib/resources/access-code.d.ts +19 -0
- package/lib/resources/acs-entrance.d.ts +1 -1
- package/lib/resources/device-provider.d.ts +2 -2
- package/lib/resources/device.d.ts +48 -4
- package/lib/resources/phone.d.ts +16 -1
- package/lib/resources/space.d.ts +19 -0
- package/lib/resources/unmanaged-access-code.d.ts +19 -0
- package/lib/resources/unmanaged-device.d.ts +19 -4
- package/lib/routes/access-codes/access-codes.d.ts +9 -9
- package/lib/routes/access-codes/access-codes.js +3 -12
- package/lib/routes/access-codes/access-codes.js.map +1 -1
- package/lib/routes/access-grants/unmanaged/unmanaged.d.ts +4 -0
- package/lib/routes/access-methods/access-methods.d.ts +5 -1
- package/lib/routes/access-methods/access-methods.js +1 -0
- package/lib/routes/access-methods/access-methods.js.map +1 -1
- package/lib/routes/client-sessions/client-sessions.d.ts +13 -1
- package/lib/routes/client-sessions/client-sessions.js +1 -0
- package/lib/routes/client-sessions/client-sessions.js.map +1 -1
- package/lib/routes/connect-webviews/connect-webviews.d.ts +1 -1
- package/lib/routes/customers/customers.d.ts +174 -0
- package/lib/routes/devices/devices.d.ts +3 -3
- package/lib/routes/devices/unmanaged/unmanaged.d.ts +3 -3
- package/lib/routes/events/events.d.ts +4 -4
- package/lib/routes/events/events.js +2 -2
- package/lib/routes/locks/locks.d.ts +2 -2
- package/lib/routes/seam-http-endpoints.d.ts +5 -5
- package/lib/routes/seam-http-endpoints.js +3 -3
- package/lib/routes/user-identities/user-identities.d.ts +4 -0
- package/lib/version.d.ts +1 -1
- package/lib/version.js +1 -1
- package/package.json +2 -2
- package/src/lib/resources/access-code.ts +22 -0
- package/src/lib/resources/acs-entrance.ts +1 -1
- package/src/lib/resources/device-provider.ts +2 -1
- package/src/lib/resources/device.ts +55 -3
- package/src/lib/resources/phone.ts +19 -1
- package/src/lib/resources/space.ts +37 -14
- package/src/lib/resources/unmanaged-access-code.ts +22 -0
- package/src/lib/resources/unmanaged-device.ts +24 -3
- package/src/lib/routes/access-codes/access-codes.ts +46 -65
- package/src/lib/routes/access-grants/unmanaged/unmanaged.ts +4 -0
- package/src/lib/routes/access-methods/access-methods.ts +6 -0
- package/src/lib/routes/client-sessions/client-sessions.ts +14 -1
- package/src/lib/routes/connect-webviews/connect-webviews.ts +1 -0
- package/src/lib/routes/customers/customers.ts +179 -0
- package/src/lib/routes/devices/devices.ts +8 -0
- package/src/lib/routes/devices/unmanaged/unmanaged.ts +8 -0
- package/src/lib/routes/events/events.ts +4 -4
- package/src/lib/routes/locks/locks.ts +4 -0
- package/src/lib/routes/seam-http-endpoints.ts +5 -4
- package/src/lib/routes/user-identities/user-identities.ts +4 -0
- package/src/lib/version.ts +1 -1
|
@@ -84,7 +84,7 @@ export type Device = {
|
|
|
84
84
|
*/
|
|
85
85
|
can_simulate_removal?: boolean | undefined
|
|
86
86
|
/**
|
|
87
|
-
* Indicates whether the camera
|
|
87
|
+
* Indicates whether the camera can stream live video through a camera live view session. `false` while the camera is offline.
|
|
88
88
|
*/
|
|
89
89
|
can_stream_live_video?: boolean | undefined
|
|
90
90
|
/**
|
|
@@ -173,7 +173,7 @@ export type Device = {
|
|
|
173
173
|
}
|
|
174
174
|
| undefined
|
|
175
175
|
/**
|
|
176
|
-
* Type of the device.
|
|
176
|
+
* Type of the device. The `august_lock` and `yale_lock` values are deprecated. Use `yale_access_lock` in place of `august_lock`, and `yale_access_lock` or `yale_home_lock` in place of `yale_lock`.
|
|
177
177
|
*/
|
|
178
178
|
device_type:
|
|
179
179
|
| 'akuvox_lock'
|
|
@@ -193,6 +193,8 @@ export type Device = {
|
|
|
193
193
|
| 'smartthings_lock'
|
|
194
194
|
| 'wyze_lock'
|
|
195
195
|
| 'yale_lock'
|
|
196
|
+
| 'yale_access_lock'
|
|
197
|
+
| 'yale_home_lock'
|
|
196
198
|
| 'two_n_intercom'
|
|
197
199
|
| 'controlbyweb_device'
|
|
198
200
|
| 'ttlock_lock'
|
|
@@ -223,6 +225,7 @@ export type Device = {
|
|
|
223
225
|
| 'tapo_camera'
|
|
224
226
|
| 'arlo_camera'
|
|
225
227
|
| 'reolink_camera'
|
|
228
|
+
| 'unifi_protect_camera'
|
|
226
229
|
| 'sonos_speaker'
|
|
227
230
|
|
|
228
231
|
/**
|
|
@@ -2059,6 +2062,37 @@ export type Device = {
|
|
|
2059
2062
|
time_zone?: string | null | undefined
|
|
2060
2063
|
}
|
|
2061
2064
|
| undefined
|
|
2065
|
+
/**
|
|
2066
|
+
* Metadata for a UniFi Protect camera.
|
|
2067
|
+
*/
|
|
2068
|
+
unifi_protect_metadata?:
|
|
2069
|
+
| {
|
|
2070
|
+
/**
|
|
2071
|
+
* Camera ID reported by UniFi Protect.
|
|
2072
|
+
*/
|
|
2073
|
+
camera_id?: string | undefined
|
|
2074
|
+
/**
|
|
2075
|
+
* Camera name reported by UniFi Protect.
|
|
2076
|
+
*/
|
|
2077
|
+
camera_name?: string | undefined
|
|
2078
|
+
/**
|
|
2079
|
+
* Whether the camera has a microphone.
|
|
2080
|
+
*/
|
|
2081
|
+
has_mic?: boolean | undefined
|
|
2082
|
+
/**
|
|
2083
|
+
* MAC address reported by the UniFi Protect camera.
|
|
2084
|
+
*/
|
|
2085
|
+
mac?: string | undefined
|
|
2086
|
+
/**
|
|
2087
|
+
* Model reported by the UniFi Protect camera.
|
|
2088
|
+
*/
|
|
2089
|
+
model?: string | undefined
|
|
2090
|
+
/**
|
|
2091
|
+
* Name of the UniFi Protect console that manages the camera.
|
|
2092
|
+
*/
|
|
2093
|
+
nvr_name?: string | undefined
|
|
2094
|
+
}
|
|
2095
|
+
| undefined
|
|
2062
2096
|
/**
|
|
2063
2097
|
* Metadata for an ASSA ABLOY Visionline system.
|
|
2064
2098
|
*/
|
|
@@ -3159,7 +3193,7 @@ export type Device = {
|
|
|
3159
3193
|
*/
|
|
3160
3194
|
warning_code: 'salto_ks_subscription_limit_almost_reached'
|
|
3161
3195
|
} /**
|
|
3162
|
-
* Indicates that a change in the reported device model has been detected for this Salto KS lock, which may occur after an IQ hub reset. Access code support may be affected. See https://
|
|
3196
|
+
* Indicates that a change in the reported device model has been detected for this Salto KS lock, which may occur after an IQ hub reset. Access code support may be affected. See https://www.seam.co/help/salto-ks-lock-loses-access-code-support for troubleshooting steps.
|
|
3163
3197
|
*/
|
|
3164
3198
|
| {
|
|
3165
3199
|
/**
|
|
@@ -3420,6 +3454,24 @@ export type Device = {
|
|
|
3420
3454
|
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
3421
3455
|
*/
|
|
3422
3456
|
warning_code: 'max_access_codes_reached'
|
|
3457
|
+
} /**
|
|
3458
|
+
* Indicates that the camera's account plan does not include cloud recording, so event media such as motion clips is unavailable.
|
|
3459
|
+
*/
|
|
3460
|
+
| {
|
|
3461
|
+
/**
|
|
3462
|
+
* Date and time at which Seam created the warning.
|
|
3463
|
+
*/
|
|
3464
|
+
created_at: string
|
|
3465
|
+
|
|
3466
|
+
/**
|
|
3467
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
3468
|
+
*/
|
|
3469
|
+
message: string
|
|
3470
|
+
|
|
3471
|
+
/**
|
|
3472
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
3473
|
+
*/
|
|
3474
|
+
warning_code: 'cloud_recording_not_enabled'
|
|
3423
3475
|
}
|
|
3424
3476
|
>
|
|
3425
3477
|
|
|
@@ -688,7 +688,7 @@ export type Phone = {
|
|
|
688
688
|
*/
|
|
689
689
|
warning_code: 'salto_ks_subscription_limit_almost_reached'
|
|
690
690
|
} /**
|
|
691
|
-
* Indicates that a change in the reported device model has been detected for this Salto KS lock, which may occur after an IQ hub reset. Access code support may be affected. See https://
|
|
691
|
+
* Indicates that a change in the reported device model has been detected for this Salto KS lock, which may occur after an IQ hub reset. Access code support may be affected. See https://www.seam.co/help/salto-ks-lock-loses-access-code-support for troubleshooting steps.
|
|
692
692
|
*/
|
|
693
693
|
| {
|
|
694
694
|
/**
|
|
@@ -949,6 +949,24 @@ export type Phone = {
|
|
|
949
949
|
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
950
950
|
*/
|
|
951
951
|
warning_code: 'max_access_codes_reached'
|
|
952
|
+
} /**
|
|
953
|
+
* Indicates that the camera's account plan does not include cloud recording, so event media such as motion clips is unavailable.
|
|
954
|
+
*/
|
|
955
|
+
| {
|
|
956
|
+
/**
|
|
957
|
+
* Date and time at which Seam created the warning.
|
|
958
|
+
*/
|
|
959
|
+
created_at: string
|
|
960
|
+
|
|
961
|
+
/**
|
|
962
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
963
|
+
*/
|
|
964
|
+
message: string
|
|
965
|
+
|
|
966
|
+
/**
|
|
967
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
968
|
+
*/
|
|
969
|
+
warning_code: 'cloud_recording_not_enabled'
|
|
952
970
|
}
|
|
953
971
|
>
|
|
954
972
|
|
|
@@ -92,22 +92,45 @@ export type Space = {
|
|
|
92
92
|
/**
|
|
93
93
|
* Indicates that the space is being deleted. Seam removes it, revokes its access grants, and detaches its devices and entrances shortly.
|
|
94
94
|
*/
|
|
95
|
-
{
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
95
|
+
| {
|
|
96
|
+
/**
|
|
97
|
+
* Date and time at which Seam created the warning.
|
|
98
|
+
*/
|
|
99
|
+
created_at: string
|
|
100
100
|
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
101
|
+
/**
|
|
102
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
103
|
+
*/
|
|
104
|
+
message: string
|
|
105
105
|
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
106
|
+
/**
|
|
107
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
108
|
+
*/
|
|
109
|
+
warning_code: 'being_deleted'
|
|
110
|
+
} /**
|
|
111
|
+
* Indicates that Seam could not apply the noise sensor automation to one or more noise sensors in the space, for example because their settings keep changing back after Seam re-applies it, Seam does not know the sensor's time zone yet, or the sensor is shared with spaces that configure it differently.
|
|
112
|
+
*/
|
|
113
|
+
| {
|
|
114
|
+
/**
|
|
115
|
+
* Date and time at which Seam created the warning.
|
|
116
|
+
*/
|
|
117
|
+
created_at: string
|
|
118
|
+
|
|
119
|
+
/**
|
|
120
|
+
* IDs of the noise sensors in the space that Seam could not bring in line with the noise sensor automation.
|
|
121
|
+
*/
|
|
122
|
+
device_ids: Array<string>
|
|
123
|
+
|
|
124
|
+
/**
|
|
125
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
126
|
+
*/
|
|
127
|
+
message: string
|
|
128
|
+
|
|
129
|
+
/**
|
|
130
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
131
|
+
*/
|
|
132
|
+
warning_code: 'noise_sensor_configuration_mismatch'
|
|
133
|
+
}
|
|
111
134
|
>
|
|
112
135
|
|
|
113
136
|
/**
|
|
@@ -961,6 +961,28 @@ export type UnmanagedAccessCode = {
|
|
|
961
961
|
*/
|
|
962
962
|
warning_code: 'being_deleted'
|
|
963
963
|
} /**
|
|
964
|
+
* Seam had been unable to reach the device for an extended period when this access code was created, so the code is unlikely to be set until the device reconnects. Check the device's connection. This warning clears automatically when the device comes back online or the code is set on the device.
|
|
965
|
+
*/
|
|
966
|
+
| {
|
|
967
|
+
/**
|
|
968
|
+
* Date and time at which Seam created the warning.
|
|
969
|
+
*/
|
|
970
|
+
created_at?: string | undefined
|
|
971
|
+
/**
|
|
972
|
+
* Date and time since which Seam has been unable to reach the device.
|
|
973
|
+
*/
|
|
974
|
+
device_unreachable_since: string
|
|
975
|
+
|
|
976
|
+
/**
|
|
977
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
978
|
+
*/
|
|
979
|
+
message: string
|
|
980
|
+
|
|
981
|
+
/**
|
|
982
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
983
|
+
*/
|
|
984
|
+
warning_code: 'device_unreachable_for_extended_period'
|
|
985
|
+
} /**
|
|
964
986
|
* An unknown issue occurred with the access code.
|
|
965
987
|
*/
|
|
966
988
|
| {
|
|
@@ -84,7 +84,7 @@ export type UnmanagedDevice = {
|
|
|
84
84
|
*/
|
|
85
85
|
can_simulate_removal?: boolean | undefined
|
|
86
86
|
/**
|
|
87
|
-
* Indicates whether the camera
|
|
87
|
+
* Indicates whether the camera can stream live video through a camera live view session. `false` while the camera is offline.
|
|
88
88
|
*/
|
|
89
89
|
can_stream_live_video?: boolean | undefined
|
|
90
90
|
/**
|
|
@@ -128,7 +128,7 @@ export type UnmanagedDevice = {
|
|
|
128
128
|
device_id: string
|
|
129
129
|
|
|
130
130
|
/**
|
|
131
|
-
* Type of the device.
|
|
131
|
+
* Type of the device. The `august_lock` and `yale_lock` values are deprecated. Use `yale_access_lock` in place of `august_lock`, and `yale_access_lock` or `yale_home_lock` in place of `yale_lock`.
|
|
132
132
|
*/
|
|
133
133
|
device_type:
|
|
134
134
|
| 'akuvox_lock'
|
|
@@ -148,6 +148,8 @@ export type UnmanagedDevice = {
|
|
|
148
148
|
| 'smartthings_lock'
|
|
149
149
|
| 'wyze_lock'
|
|
150
150
|
| 'yale_lock'
|
|
151
|
+
| 'yale_access_lock'
|
|
152
|
+
| 'yale_home_lock'
|
|
151
153
|
| 'two_n_intercom'
|
|
152
154
|
| 'controlbyweb_device'
|
|
153
155
|
| 'ttlock_lock'
|
|
@@ -178,6 +180,7 @@ export type UnmanagedDevice = {
|
|
|
178
180
|
| 'tapo_camera'
|
|
179
181
|
| 'arlo_camera'
|
|
180
182
|
| 'reolink_camera'
|
|
183
|
+
| 'unifi_protect_camera'
|
|
181
184
|
| 'sonos_speaker'
|
|
182
185
|
|
|
183
186
|
/**
|
|
@@ -937,7 +940,7 @@ export type UnmanagedDevice = {
|
|
|
937
940
|
*/
|
|
938
941
|
warning_code: 'salto_ks_subscription_limit_almost_reached'
|
|
939
942
|
} /**
|
|
940
|
-
* Indicates that a change in the reported device model has been detected for this Salto KS lock, which may occur after an IQ hub reset. Access code support may be affected. See https://
|
|
943
|
+
* Indicates that a change in the reported device model has been detected for this Salto KS lock, which may occur after an IQ hub reset. Access code support may be affected. See https://www.seam.co/help/salto-ks-lock-loses-access-code-support for troubleshooting steps.
|
|
941
944
|
*/
|
|
942
945
|
| {
|
|
943
946
|
/**
|
|
@@ -1198,6 +1201,24 @@ export type UnmanagedDevice = {
|
|
|
1198
1201
|
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
1199
1202
|
*/
|
|
1200
1203
|
warning_code: 'max_access_codes_reached'
|
|
1204
|
+
} /**
|
|
1205
|
+
* Indicates that the camera's account plan does not include cloud recording, so event media such as motion clips is unavailable.
|
|
1206
|
+
*/
|
|
1207
|
+
| {
|
|
1208
|
+
/**
|
|
1209
|
+
* Date and time at which Seam created the warning.
|
|
1210
|
+
*/
|
|
1211
|
+
created_at: string
|
|
1212
|
+
|
|
1213
|
+
/**
|
|
1214
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
1215
|
+
*/
|
|
1216
|
+
message: string
|
|
1217
|
+
|
|
1218
|
+
/**
|
|
1219
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
1220
|
+
*/
|
|
1221
|
+
warning_code: 'cloud_recording_not_enabled'
|
|
1201
1222
|
}
|
|
1202
1223
|
>
|
|
1203
1224
|
|
|
@@ -288,10 +288,10 @@ export class SeamHttpAccessCodes {
|
|
|
288
288
|
/**
|
|
289
289
|
* Returns a list of all [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
290
290
|
*
|
|
291
|
-
*
|
|
291
|
+
* Without `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`, returns access codes across the workspace, or across the customer when `customer_key` is set. Use `limit` and `page_cursor` to page through them.
|
|
292
292
|
*/
|
|
293
293
|
list(
|
|
294
|
-
parameters
|
|
294
|
+
parameters?: AccessCodesListParameters,
|
|
295
295
|
options: AccessCodesListOptions = {},
|
|
296
296
|
): AccessCodesListRequest {
|
|
297
297
|
return new SeamHttpRequest(this, {
|
|
@@ -299,18 +299,9 @@ export class SeamHttpAccessCodes {
|
|
|
299
299
|
method: 'GET',
|
|
300
300
|
params: parameters,
|
|
301
301
|
parameters,
|
|
302
|
-
hasRequiredParameters:
|
|
302
|
+
hasRequiredParameters: false,
|
|
303
303
|
requiredParameterNames: [],
|
|
304
|
-
atLeastOneParameterNames: [
|
|
305
|
-
'access_code_ids',
|
|
306
|
-
'access_grant_id',
|
|
307
|
-
'access_grant_key',
|
|
308
|
-
'access_method_id',
|
|
309
|
-
'customer_key',
|
|
310
|
-
'device_id',
|
|
311
|
-
'search',
|
|
312
|
-
'user_identifier_key',
|
|
313
|
-
],
|
|
304
|
+
atLeastOneParameterNames: [],
|
|
314
305
|
responseKey: 'access_codes',
|
|
315
306
|
hasPagination: true,
|
|
316
307
|
options,
|
|
@@ -639,58 +630,48 @@ export type AccessCodesGetRequest = SeamHttpRequest<
|
|
|
639
630
|
|
|
640
631
|
export interface AccessCodesGetOptions {}
|
|
641
632
|
|
|
642
|
-
export type AccessCodesListParameters =
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
},
|
|
685
|
-
| 'access_code_ids'
|
|
686
|
-
| 'access_grant_id'
|
|
687
|
-
| 'access_grant_key'
|
|
688
|
-
| 'access_method_id'
|
|
689
|
-
| 'customer_key'
|
|
690
|
-
| 'device_id'
|
|
691
|
-
| 'search'
|
|
692
|
-
| 'user_identifier_key'
|
|
693
|
-
>
|
|
633
|
+
export type AccessCodesListParameters = {
|
|
634
|
+
/**
|
|
635
|
+
* IDs of the access codes that you want to retrieve.
|
|
636
|
+
*/
|
|
637
|
+
access_code_ids?: Array<string> | undefined
|
|
638
|
+
/**
|
|
639
|
+
* ID of the access grant for which you want to list access codes.
|
|
640
|
+
*/
|
|
641
|
+
access_grant_id?: string | undefined
|
|
642
|
+
/**
|
|
643
|
+
* Key of the access grant for which you want to list access codes.
|
|
644
|
+
*/
|
|
645
|
+
access_grant_key?: string | undefined
|
|
646
|
+
/**
|
|
647
|
+
* ID of the access method for which you want to list access codes.
|
|
648
|
+
*/
|
|
649
|
+
access_method_id?: string | undefined
|
|
650
|
+
/**
|
|
651
|
+
* Customer key for which you want to list access codes.
|
|
652
|
+
*/
|
|
653
|
+
customer_key?: string | undefined
|
|
654
|
+
/**
|
|
655
|
+
* ID of the device for which you want to list access codes.
|
|
656
|
+
*/
|
|
657
|
+
device_id?: string | undefined
|
|
658
|
+
/**
|
|
659
|
+
* Numerical limit on the number of access codes to return.
|
|
660
|
+
*/
|
|
661
|
+
limit?: number | undefined
|
|
662
|
+
/**
|
|
663
|
+
* Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
|
|
664
|
+
*/
|
|
665
|
+
page_cursor?: string | null | undefined
|
|
666
|
+
/**
|
|
667
|
+
* String for which to search. Filters returned access codes to include all records that satisfy a partial match using `name`, `code` or `access_code_id`.
|
|
668
|
+
*/
|
|
669
|
+
search?: string | undefined
|
|
670
|
+
/**
|
|
671
|
+
* Your user ID for the user by which to filter access codes.
|
|
672
|
+
*/
|
|
673
|
+
user_identifier_key?: string | undefined
|
|
674
|
+
}
|
|
694
675
|
|
|
695
676
|
/**
|
|
696
677
|
* @deprecated Use AccessCodesListRequest instead.
|
|
@@ -257,6 +257,10 @@ export type AccessGrantsUnmanagedListParameters = {
|
|
|
257
257
|
* ID of the access system by which you want to filter the list of unmanaged Access Grants.
|
|
258
258
|
*/
|
|
259
259
|
acs_system_id?: string | undefined
|
|
260
|
+
/**
|
|
261
|
+
* Customer key for which you want to list unmanaged Access Grants.
|
|
262
|
+
*/
|
|
263
|
+
customer_key?: string | undefined
|
|
260
264
|
/**
|
|
261
265
|
* Numerical limit on the number of unmanaged access grants to return.
|
|
262
266
|
*/
|
|
@@ -304,6 +304,7 @@ export class SeamHttpAccessMethods {
|
|
|
304
304
|
'access_grant_id',
|
|
305
305
|
'access_grant_key',
|
|
306
306
|
'acs_entrance_id',
|
|
307
|
+
'customer_key',
|
|
307
308
|
'device_id',
|
|
308
309
|
'space_id',
|
|
309
310
|
],
|
|
@@ -513,6 +514,10 @@ export type AccessMethodsListParameters = RequireAtLeastOne<
|
|
|
513
514
|
* ID of the entrance for which you want to retrieve all access methods that grant access to it.
|
|
514
515
|
*/
|
|
515
516
|
acs_entrance_id?: string | undefined
|
|
517
|
+
/**
|
|
518
|
+
* Customer key for which you want to list access methods.
|
|
519
|
+
*/
|
|
520
|
+
customer_key?: string | undefined
|
|
516
521
|
/**
|
|
517
522
|
* ID of the device by which to filter the returned access methods. Must be combined with `access_grant_id`, `access_grant_key`, or `acs_entrance_id`.
|
|
518
523
|
*/
|
|
@@ -534,6 +539,7 @@ export type AccessMethodsListParameters = RequireAtLeastOne<
|
|
|
534
539
|
| 'access_grant_id'
|
|
535
540
|
| 'access_grant_key'
|
|
536
541
|
| 'acs_entrance_id'
|
|
542
|
+
| 'customer_key'
|
|
537
543
|
| 'device_id'
|
|
538
544
|
| 'space_id'
|
|
539
545
|
>
|
|
@@ -284,6 +284,7 @@ export class SeamHttpClientSessions {
|
|
|
284
284
|
requiredParameterNames: [],
|
|
285
285
|
atLeastOneParameterNames: [],
|
|
286
286
|
responseKey: 'client_sessions',
|
|
287
|
+
hasPagination: true,
|
|
287
288
|
options,
|
|
288
289
|
})
|
|
289
290
|
}
|
|
@@ -494,6 +495,18 @@ export type ClientSessionsListParameters = {
|
|
|
494
495
|
* ID of the [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews) for which you want to retrieve client sessions. Specify `null` to retrieve client sessions that are not associated with a Connect Webview.
|
|
495
496
|
*/
|
|
496
497
|
connect_webview_id?: string | null | undefined
|
|
498
|
+
/**
|
|
499
|
+
* Customer key for which you want to list client sessions.
|
|
500
|
+
*/
|
|
501
|
+
customer_key?: string | undefined
|
|
502
|
+
/**
|
|
503
|
+
* Maximum number of records to return per page.
|
|
504
|
+
*/
|
|
505
|
+
limit?: number | undefined
|
|
506
|
+
/**
|
|
507
|
+
* Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
|
|
508
|
+
*/
|
|
509
|
+
page_cursor?: string | null | undefined
|
|
497
510
|
/**
|
|
498
511
|
* Your user ID for the user by which you want to filter client sessions.
|
|
499
512
|
*/
|
|
@@ -515,7 +528,7 @@ export type ClientSessionsListResponse = {
|
|
|
515
528
|
client_sessions: Array<ClientSession>
|
|
516
529
|
}
|
|
517
530
|
|
|
518
|
-
export type ClientSessionsListRequest =
|
|
531
|
+
export type ClientSessionsListRequest = SeamPaginatedRequest<
|
|
519
532
|
ClientSessionsListResponse,
|
|
520
533
|
'client_sessions'
|
|
521
534
|
>
|