@seamapi/http 2.34.0 → 2.36.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-code.d.ts +1 -1
- package/lib/resources/acs-system.d.ts +1 -1
- package/lib/resources/action-attempt.d.ts +63 -0
- package/lib/resources/camera-live-view-answer.d.ts +9 -0
- package/lib/resources/camera-live-view-answer.js +6 -0
- package/lib/resources/camera-live-view-answer.js.map +1 -0
- package/lib/resources/camera-live-view-session.d.ts +21 -0
- package/lib/resources/camera-live-view-session.js +6 -0
- package/lib/resources/camera-live-view-session.js.map +1 -0
- package/lib/resources/device-provider.d.ts +9 -1
- package/lib/resources/device.d.ts +27 -2
- package/lib/resources/event.d.ts +8 -0
- package/lib/resources/index.d.ts +3 -0
- package/lib/resources/media.d.ts +49 -0
- package/lib/resources/media.js +6 -0
- package/lib/resources/media.js.map +1 -0
- package/lib/resources/unmanaged-access-code.d.ts +1 -1
- package/lib/resources/unmanaged-device.d.ts +10 -2
- package/lib/routes/cameras/cameras.d.ts +19 -0
- package/lib/routes/cameras/cameras.js +89 -0
- package/lib/routes/cameras/cameras.js.map +1 -0
- package/lib/routes/cameras/index.d.ts +2 -0
- package/lib/routes/cameras/index.js +7 -0
- package/lib/routes/cameras/index.js.map +1 -0
- package/lib/routes/cameras/live-views/index.d.ts +1 -0
- package/lib/routes/cameras/live-views/index.js +6 -0
- package/lib/routes/cameras/live-views/index.js.map +1 -0
- package/lib/routes/cameras/live-views/live-views.d.ts +100 -0
- package/lib/routes/cameras/live-views/live-views.js +144 -0
- package/lib/routes/cameras/live-views/live-views.js.map +1 -0
- package/lib/routes/client-sessions/client-sessions.d.ts +2 -2
- package/lib/routes/connect-webviews/connect-webviews.d.ts +1 -1
- package/lib/routes/customers/customers.d.ts +20 -12
- package/lib/routes/devices/devices.d.ts +3 -3
- package/lib/routes/devices/unmanaged/unmanaged.d.ts +3 -3
- package/lib/routes/index.d.ts +2 -0
- package/lib/routes/index.js +2 -0
- package/lib/routes/index.js.map +1 -1
- package/lib/routes/media/index.d.ts +1 -0
- package/lib/routes/media/index.js +6 -0
- package/lib/routes/media/index.js.map +1 -0
- package/lib/routes/media/media.d.ts +41 -0
- package/lib/routes/media/media.js +102 -0
- package/lib/routes/media/media.js.map +1 -0
- package/lib/routes/seam-http-endpoints.d.ts +31 -3
- package/lib/routes/seam-http-endpoints.js +58 -0
- package/lib/routes/seam-http-endpoints.js.map +1 -1
- package/lib/routes/seam-http.d.ts +4 -0
- package/lib/routes/seam-http.js +8 -0
- package/lib/routes/seam-http.js.map +1 -1
- package/lib/routes/thermostats/thermostats.d.ts +18 -0
- package/lib/routes/thermostats/thermostats.js +20 -0
- package/lib/routes/thermostats/thermostats.js.map +1 -1
- 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 +1 -1
- package/src/lib/resources/acs-system.ts +1 -1
- package/src/lib/resources/action-attempt.ts +77 -0
- package/src/lib/resources/camera-live-view-answer.ts +14 -0
- package/src/lib/resources/camera-live-view-session.ts +29 -0
- package/src/lib/resources/device-provider.ts +9 -0
- package/src/lib/resources/device.ts +29 -1
- package/src/lib/resources/event.ts +8 -0
- package/src/lib/resources/index.ts +3 -0
- package/src/lib/resources/media.ts +58 -0
- package/src/lib/resources/unmanaged-access-code.ts +1 -1
- package/src/lib/resources/unmanaged-device.ts +10 -1
- package/src/lib/routes/cameras/cameras.ts +165 -0
- package/src/lib/routes/cameras/index.ts +7 -0
- package/src/lib/routes/cameras/live-views/index.ts +6 -0
- package/src/lib/routes/cameras/live-views/live-views.ts +316 -0
- package/src/lib/routes/client-sessions/client-sessions.ts +2 -2
- package/src/lib/routes/connect-webviews/connect-webviews.ts +1 -0
- package/src/lib/routes/customers/customers.ts +20 -12
- package/src/lib/routes/devices/devices.ts +3 -0
- package/src/lib/routes/devices/unmanaged/unmanaged.ts +3 -0
- package/src/lib/routes/index.ts +2 -0
- package/src/lib/routes/media/index.ts +6 -0
- package/src/lib/routes/media/media.ts +203 -0
- package/src/lib/routes/seam-http-endpoints.ts +112 -0
- package/src/lib/routes/seam-http.ts +10 -0
- package/src/lib/routes/thermostats/thermostats.ts +49 -0
- package/src/lib/version.ts +1 -1
|
@@ -0,0 +1,316 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Automatically generated by codegen/smith.ts.
|
|
3
|
+
* Do not edit this file or add other files to this directory.
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
import {
|
|
7
|
+
getAuthHeadersForClientSessionToken,
|
|
8
|
+
warnOnInsecureuserIdentifierKey,
|
|
9
|
+
} from 'lib/auth.js'
|
|
10
|
+
import { type Client, createClient } from 'lib/client.js'
|
|
11
|
+
import {
|
|
12
|
+
isSeamHttpOptionsWithApiKey,
|
|
13
|
+
isSeamHttpOptionsWithClient,
|
|
14
|
+
isSeamHttpOptionsWithClientSessionToken,
|
|
15
|
+
isSeamHttpOptionsWithConsoleSessionToken,
|
|
16
|
+
isSeamHttpOptionsWithPersonalAccessToken,
|
|
17
|
+
type SeamHttpFromPublishableKeyOptions,
|
|
18
|
+
SeamHttpInvalidOptionsError,
|
|
19
|
+
type SeamHttpOptions,
|
|
20
|
+
type SeamHttpOptionsWithApiKey,
|
|
21
|
+
type SeamHttpOptionsWithClient,
|
|
22
|
+
type SeamHttpOptionsWithClientSessionToken,
|
|
23
|
+
type SeamHttpOptionsWithConsoleSessionToken,
|
|
24
|
+
type SeamHttpOptionsWithPersonalAccessToken,
|
|
25
|
+
type SeamHttpRequestOptions,
|
|
26
|
+
} from 'lib/options.js'
|
|
27
|
+
import {
|
|
28
|
+
limitToSeamHttpRequestOptions,
|
|
29
|
+
parseOptions,
|
|
30
|
+
} from 'lib/parse-options.js'
|
|
31
|
+
import type { CameraLiveViewAnswer } from 'lib/resources/camera-live-view-answer.js'
|
|
32
|
+
import type { CameraLiveViewSession } from 'lib/resources/camera-live-view-session.js'
|
|
33
|
+
import { SeamHttpClientSessions } from 'lib/routes/client-sessions/index.js'
|
|
34
|
+
import {
|
|
35
|
+
SeamHttpRequest,
|
|
36
|
+
type SeamPaginatedRequest,
|
|
37
|
+
} from 'lib/seam-http-request.js'
|
|
38
|
+
import { SeamPaginator } from 'lib/seam-paginator.js'
|
|
39
|
+
|
|
40
|
+
export class SeamHttpCamerasLiveViews {
|
|
41
|
+
client: Client
|
|
42
|
+
readonly defaults: Required<SeamHttpRequestOptions>
|
|
43
|
+
|
|
44
|
+
constructor(apiKeyOrOptions: string | SeamHttpOptions = {}) {
|
|
45
|
+
const options = parseOptions(apiKeyOrOptions)
|
|
46
|
+
this.client = 'client' in options ? options.client : createClient(options)
|
|
47
|
+
this.defaults = limitToSeamHttpRequestOptions(options)
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
static fromClient(
|
|
51
|
+
client: SeamHttpOptionsWithClient['client'],
|
|
52
|
+
options: Omit<SeamHttpOptionsWithClient, 'client'> = {},
|
|
53
|
+
): SeamHttpCamerasLiveViews {
|
|
54
|
+
const constructorOptions = { ...options, client }
|
|
55
|
+
if (!isSeamHttpOptionsWithClient(constructorOptions)) {
|
|
56
|
+
throw new SeamHttpInvalidOptionsError('Missing client')
|
|
57
|
+
}
|
|
58
|
+
return new SeamHttpCamerasLiveViews(constructorOptions)
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
static fromApiKey(
|
|
62
|
+
apiKey: SeamHttpOptionsWithApiKey['apiKey'],
|
|
63
|
+
options: Omit<SeamHttpOptionsWithApiKey, 'apiKey'> = {},
|
|
64
|
+
): SeamHttpCamerasLiveViews {
|
|
65
|
+
const constructorOptions = { ...options, apiKey }
|
|
66
|
+
if (!isSeamHttpOptionsWithApiKey(constructorOptions)) {
|
|
67
|
+
throw new SeamHttpInvalidOptionsError('Missing apiKey')
|
|
68
|
+
}
|
|
69
|
+
return new SeamHttpCamerasLiveViews(constructorOptions)
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
static fromClientSessionToken(
|
|
73
|
+
clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken'],
|
|
74
|
+
options: Omit<
|
|
75
|
+
SeamHttpOptionsWithClientSessionToken,
|
|
76
|
+
'clientSessionToken'
|
|
77
|
+
> = {},
|
|
78
|
+
): SeamHttpCamerasLiveViews {
|
|
79
|
+
const constructorOptions = { ...options, clientSessionToken }
|
|
80
|
+
if (!isSeamHttpOptionsWithClientSessionToken(constructorOptions)) {
|
|
81
|
+
throw new SeamHttpInvalidOptionsError('Missing clientSessionToken')
|
|
82
|
+
}
|
|
83
|
+
return new SeamHttpCamerasLiveViews(constructorOptions)
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
static async fromPublishableKey(
|
|
87
|
+
publishableKey: string,
|
|
88
|
+
userIdentifierKey: string,
|
|
89
|
+
options: SeamHttpFromPublishableKeyOptions = {},
|
|
90
|
+
): Promise<SeamHttpCamerasLiveViews> {
|
|
91
|
+
warnOnInsecureuserIdentifierKey(userIdentifierKey)
|
|
92
|
+
const clientOptions = parseOptions({ ...options, publishableKey })
|
|
93
|
+
if (isSeamHttpOptionsWithClient(clientOptions)) {
|
|
94
|
+
throw new SeamHttpInvalidOptionsError(
|
|
95
|
+
'The client option cannot be used with SeamHttpCamerasLiveViews.fromPublishableKey',
|
|
96
|
+
)
|
|
97
|
+
}
|
|
98
|
+
const client = createClient(clientOptions)
|
|
99
|
+
const clientSessions = SeamHttpClientSessions.fromClient(client)
|
|
100
|
+
const { token } = await clientSessions.getOrCreate({
|
|
101
|
+
user_identifier_key: userIdentifierKey,
|
|
102
|
+
})
|
|
103
|
+
return SeamHttpCamerasLiveViews.fromClientSessionToken(token, options)
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
static fromConsoleSessionToken(
|
|
107
|
+
consoleSessionToken: SeamHttpOptionsWithConsoleSessionToken['consoleSessionToken'],
|
|
108
|
+
workspaceId: SeamHttpOptionsWithConsoleSessionToken['workspaceId'],
|
|
109
|
+
options: Omit<
|
|
110
|
+
SeamHttpOptionsWithConsoleSessionToken,
|
|
111
|
+
'consoleSessionToken' | 'workspaceId'
|
|
112
|
+
> = {},
|
|
113
|
+
): SeamHttpCamerasLiveViews {
|
|
114
|
+
const constructorOptions = { ...options, consoleSessionToken, workspaceId }
|
|
115
|
+
if (!isSeamHttpOptionsWithConsoleSessionToken(constructorOptions)) {
|
|
116
|
+
throw new SeamHttpInvalidOptionsError(
|
|
117
|
+
'Missing consoleSessionToken or workspaceId',
|
|
118
|
+
)
|
|
119
|
+
}
|
|
120
|
+
return new SeamHttpCamerasLiveViews(constructorOptions)
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
static fromPersonalAccessToken(
|
|
124
|
+
personalAccessToken: SeamHttpOptionsWithPersonalAccessToken['personalAccessToken'],
|
|
125
|
+
workspaceId: SeamHttpOptionsWithPersonalAccessToken['workspaceId'],
|
|
126
|
+
options: Omit<
|
|
127
|
+
SeamHttpOptionsWithPersonalAccessToken,
|
|
128
|
+
'personalAccessToken' | 'workspaceId'
|
|
129
|
+
> = {},
|
|
130
|
+
): SeamHttpCamerasLiveViews {
|
|
131
|
+
const constructorOptions = { ...options, personalAccessToken, workspaceId }
|
|
132
|
+
if (!isSeamHttpOptionsWithPersonalAccessToken(constructorOptions)) {
|
|
133
|
+
throw new SeamHttpInvalidOptionsError(
|
|
134
|
+
'Missing personalAccessToken or workspaceId',
|
|
135
|
+
)
|
|
136
|
+
}
|
|
137
|
+
return new SeamHttpCamerasLiveViews(constructorOptions)
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(
|
|
141
|
+
request: SeamPaginatedRequest<TResponse, TResponseKey>,
|
|
142
|
+
): SeamPaginator<TResponse, TResponseKey> {
|
|
143
|
+
return new SeamPaginator<TResponse, TResponseKey>(request)
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
async updateClientSessionToken(
|
|
147
|
+
clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken'],
|
|
148
|
+
): Promise<void> {
|
|
149
|
+
const { headers } = this.client.defaults
|
|
150
|
+
const authHeaders = getAuthHeadersForClientSessionToken({
|
|
151
|
+
clientSessionToken,
|
|
152
|
+
})
|
|
153
|
+
for (const key of Object.keys(authHeaders)) {
|
|
154
|
+
if (headers[key] == null) {
|
|
155
|
+
throw new Error(
|
|
156
|
+
'Cannot update a clientSessionToken on a client created without a clientSessionToken',
|
|
157
|
+
)
|
|
158
|
+
}
|
|
159
|
+
}
|
|
160
|
+
this.client.defaults.headers = { ...headers, ...authHeaders }
|
|
161
|
+
const clientSessions = SeamHttpClientSessions.fromClient(this.client)
|
|
162
|
+
await clientSessions.get()
|
|
163
|
+
}
|
|
164
|
+
|
|
165
|
+
/**
|
|
166
|
+
* Creates a short-lived live view session for a single camera. Pass the returned session ID and token to `/cameras/live_views/offer` to start a WebRTC stream, and to `/cameras/live_views/stop` to end the session.
|
|
167
|
+
*
|
|
168
|
+
* Camera live view is in beta. To enable it for your workspace, contact Seam support. To check whether a camera supports live view, use `device.can_stream_live_video`.
|
|
169
|
+
*/
|
|
170
|
+
create(
|
|
171
|
+
parameters: CamerasLiveViewsCreateParameters,
|
|
172
|
+
options: CamerasLiveViewsCreateOptions = {},
|
|
173
|
+
): CamerasLiveViewsCreateRequest {
|
|
174
|
+
return new SeamHttpRequest(this, {
|
|
175
|
+
pathname: '/cameras/live_views/create',
|
|
176
|
+
method: 'POST',
|
|
177
|
+
body: parameters,
|
|
178
|
+
parameters,
|
|
179
|
+
hasRequiredParameters: true,
|
|
180
|
+
requiredParameterNames: ['device_id'],
|
|
181
|
+
atLeastOneParameterNames: [],
|
|
182
|
+
responseKey: 'camera_live_view_session',
|
|
183
|
+
options,
|
|
184
|
+
})
|
|
185
|
+
}
|
|
186
|
+
|
|
187
|
+
/**
|
|
188
|
+
* Exchanges a WebRTC SDP offer for an SDP answer that starts streaming video from the camera, for a live view session that you created using `/cameras/live_views/create`.
|
|
189
|
+
*
|
|
190
|
+
* Camera live view is in beta. To enable it for your workspace, contact Seam support.
|
|
191
|
+
*/
|
|
192
|
+
offer(
|
|
193
|
+
parameters: CamerasLiveViewsOfferParameters,
|
|
194
|
+
options: CamerasLiveViewsOfferOptions = {},
|
|
195
|
+
): CamerasLiveViewsOfferRequest {
|
|
196
|
+
return new SeamHttpRequest(this, {
|
|
197
|
+
pathname: '/cameras/live_views/offer',
|
|
198
|
+
method: 'POST',
|
|
199
|
+
body: parameters,
|
|
200
|
+
parameters,
|
|
201
|
+
hasRequiredParameters: true,
|
|
202
|
+
requiredParameterNames: [
|
|
203
|
+
'camera_live_view_session_id',
|
|
204
|
+
'sdp_offer',
|
|
205
|
+
'token',
|
|
206
|
+
],
|
|
207
|
+
atLeastOneParameterNames: [],
|
|
208
|
+
responseKey: 'camera_live_view_answer',
|
|
209
|
+
options,
|
|
210
|
+
})
|
|
211
|
+
}
|
|
212
|
+
|
|
213
|
+
/**
|
|
214
|
+
* Stops a camera live view session that the current client session owns.
|
|
215
|
+
*
|
|
216
|
+
* Camera live view is in beta. To enable it for your workspace, contact Seam support.
|
|
217
|
+
*/
|
|
218
|
+
stop(
|
|
219
|
+
parameters: CamerasLiveViewsStopParameters,
|
|
220
|
+
options: CamerasLiveViewsStopOptions = {},
|
|
221
|
+
): CamerasLiveViewsStopRequest {
|
|
222
|
+
return new SeamHttpRequest(this, {
|
|
223
|
+
pathname: '/cameras/live_views/stop',
|
|
224
|
+
method: 'POST',
|
|
225
|
+
body: parameters,
|
|
226
|
+
parameters,
|
|
227
|
+
hasRequiredParameters: true,
|
|
228
|
+
requiredParameterNames: ['camera_live_view_session_id', 'token'],
|
|
229
|
+
atLeastOneParameterNames: [],
|
|
230
|
+
responseKey: undefined,
|
|
231
|
+
options,
|
|
232
|
+
})
|
|
233
|
+
}
|
|
234
|
+
}
|
|
235
|
+
|
|
236
|
+
export type CamerasLiveViewsCreateParameters = {
|
|
237
|
+
/**
|
|
238
|
+
* ID of the camera to view.
|
|
239
|
+
*/
|
|
240
|
+
device_id: string
|
|
241
|
+
|
|
242
|
+
/**
|
|
243
|
+
* Number of seconds for which the live view session is valid, up to 600.
|
|
244
|
+
*/
|
|
245
|
+
duration_seconds?: number | undefined
|
|
246
|
+
/**
|
|
247
|
+
* Indicates whether to include the camera's audio.
|
|
248
|
+
*/
|
|
249
|
+
include_audio?: boolean | undefined
|
|
250
|
+
}
|
|
251
|
+
|
|
252
|
+
/**
|
|
253
|
+
* @deprecated Use CamerasLiveViewsCreateRequest instead.
|
|
254
|
+
*/
|
|
255
|
+
export type CamerasLiveViewsCreateResponse = {
|
|
256
|
+
camera_live_view_session: CameraLiveViewSession
|
|
257
|
+
}
|
|
258
|
+
|
|
259
|
+
export type CamerasLiveViewsCreateRequest = SeamHttpRequest<
|
|
260
|
+
CamerasLiveViewsCreateResponse,
|
|
261
|
+
'camera_live_view_session'
|
|
262
|
+
>
|
|
263
|
+
|
|
264
|
+
export interface CamerasLiveViewsCreateOptions {}
|
|
265
|
+
|
|
266
|
+
export type CamerasLiveViewsOfferParameters = {
|
|
267
|
+
/**
|
|
268
|
+
* ID of the camera live view session.
|
|
269
|
+
*/
|
|
270
|
+
camera_live_view_session_id: string
|
|
271
|
+
|
|
272
|
+
/**
|
|
273
|
+
* WebRTC SDP offer from the viewer, limited to 64 KiB of UTF-8 data.
|
|
274
|
+
*/
|
|
275
|
+
sdp_offer: string
|
|
276
|
+
|
|
277
|
+
/**
|
|
278
|
+
* Token returned when the camera live view session was created.
|
|
279
|
+
*/
|
|
280
|
+
token: string
|
|
281
|
+
}
|
|
282
|
+
|
|
283
|
+
/**
|
|
284
|
+
* @deprecated Use CamerasLiveViewsOfferRequest instead.
|
|
285
|
+
*/
|
|
286
|
+
export type CamerasLiveViewsOfferResponse = {
|
|
287
|
+
camera_live_view_answer: CameraLiveViewAnswer
|
|
288
|
+
}
|
|
289
|
+
|
|
290
|
+
export type CamerasLiveViewsOfferRequest = SeamHttpRequest<
|
|
291
|
+
CamerasLiveViewsOfferResponse,
|
|
292
|
+
'camera_live_view_answer'
|
|
293
|
+
>
|
|
294
|
+
|
|
295
|
+
export interface CamerasLiveViewsOfferOptions {}
|
|
296
|
+
|
|
297
|
+
export type CamerasLiveViewsStopParameters = {
|
|
298
|
+
/**
|
|
299
|
+
* ID of the camera live view session.
|
|
300
|
+
*/
|
|
301
|
+
camera_live_view_session_id: string
|
|
302
|
+
|
|
303
|
+
/**
|
|
304
|
+
* Token returned when the camera live view session was created.
|
|
305
|
+
*/
|
|
306
|
+
token: string
|
|
307
|
+
}
|
|
308
|
+
|
|
309
|
+
/**
|
|
310
|
+
* @deprecated Use CamerasLiveViewsStopRequest instead.
|
|
311
|
+
*/
|
|
312
|
+
export type CamerasLiveViewsStopResponse = void
|
|
313
|
+
|
|
314
|
+
export type CamerasLiveViewsStopRequest = SeamHttpRequest<void, undefined>
|
|
315
|
+
|
|
316
|
+
export interface CamerasLiveViewsStopOptions {}
|
|
@@ -333,7 +333,7 @@ export type ClientSessionsCreateParameters = {
|
|
|
333
333
|
*/
|
|
334
334
|
expires_at?: string | Date | Temporal.Instant | undefined
|
|
335
335
|
/**
|
|
336
|
-
* Your user ID for the user for whom you want to create a client session.
|
|
336
|
+
* Your user ID for the user for whom you want to create a client session. When you authenticate with a publishable key, the `user_identifier_key` must be a high-entropy secret that only the user knows, such as a UUIDv4 or a salted hash. Do not use an email address, name, phone number, or other guessable value, because anyone who knows the `user_identifier_key` can retrieve the client session.
|
|
337
337
|
*/
|
|
338
338
|
user_identifier_key?: string | undefined
|
|
339
339
|
/**
|
|
@@ -412,7 +412,7 @@ export type ClientSessionsGetOrCreateParameters = {
|
|
|
412
412
|
*/
|
|
413
413
|
expires_at?: string | Date | Temporal.Instant | undefined
|
|
414
414
|
/**
|
|
415
|
-
* Your user ID for the user that you want to associate with the client session (or that is already associated with the existing client session).
|
|
415
|
+
* Your user ID for the user that you want to associate with the client session (or that is already associated with the existing client session). When you authenticate with a publishable key, the `user_identifier_key` must be a high-entropy secret that only the user knows, such as a UUIDv4 or a salted hash. Do not use an email address, name, phone number, or other guessable value, because anyone who knows the `user_identifier_key` can retrieve the client session.
|
|
416
416
|
*/
|
|
417
417
|
user_identifier_key?: string | undefined
|
|
418
418
|
/**
|
|
@@ -264,9 +264,9 @@ export type CustomersCreatePortalParameters = {
|
|
|
264
264
|
*/
|
|
265
265
|
name?: string | undefined
|
|
266
266
|
/**
|
|
267
|
-
* Preferred PIN code to use when creating access for this reservation.
|
|
267
|
+
* Preferred PIN code to use when creating access for this reservation. Set to `null` to remove a previously set preferred code, so that access falls back to an automatically generated code. Omitting this field keeps any previously set preferred code.
|
|
268
268
|
*/
|
|
269
|
-
preferred_code?: string | undefined
|
|
269
|
+
preferred_code?: string | null | undefined
|
|
270
270
|
/**
|
|
271
271
|
* Property keys associated with the access grant.
|
|
272
272
|
*/
|
|
@@ -343,9 +343,9 @@ export type CustomersCreatePortalParameters = {
|
|
|
343
343
|
*/
|
|
344
344
|
name?: string | undefined
|
|
345
345
|
/**
|
|
346
|
-
* Preferred PIN code to use when creating access for this reservation.
|
|
346
|
+
* Preferred PIN code to use when creating access for this reservation. Set to `null` to remove a previously set preferred code, so that access falls back to an automatically generated code. Omitting this field keeps any previously set preferred code.
|
|
347
347
|
*/
|
|
348
|
-
preferred_code?: string | undefined
|
|
348
|
+
preferred_code?: string | null | undefined
|
|
349
349
|
/**
|
|
350
350
|
* Property keys associated with the access grant.
|
|
351
351
|
*/
|
|
@@ -422,6 +422,10 @@ export type CustomersCreatePortalParameters = {
|
|
|
422
422
|
* Your unique identifier for the customer.
|
|
423
423
|
*/
|
|
424
424
|
customer_key?: string | undefined
|
|
425
|
+
/**
|
|
426
|
+
* ID of the customization profile to use for this customer. Access grants that automations create for this customer use this profile. Pass `null` to remove the customer's customization profile.
|
|
427
|
+
*/
|
|
428
|
+
customization_profile_id?: string | null | undefined
|
|
425
429
|
/**
|
|
426
430
|
* List of gym or fitness facilities.
|
|
427
431
|
*/
|
|
@@ -547,9 +551,9 @@ export type CustomersCreatePortalParameters = {
|
|
|
547
551
|
*/
|
|
548
552
|
name?: string | undefined
|
|
549
553
|
/**
|
|
550
|
-
* Preferred PIN code to use when creating access for this reservation.
|
|
554
|
+
* Preferred PIN code to use when creating access for this reservation. Set to `null` to remove a previously set preferred code, so that access falls back to an automatically generated code. Omitting this field keeps any previously set preferred code.
|
|
551
555
|
*/
|
|
552
|
-
preferred_code?: string | undefined
|
|
556
|
+
preferred_code?: string | null | undefined
|
|
553
557
|
/**
|
|
554
558
|
* Property keys associated with the access grant.
|
|
555
559
|
*/
|
|
@@ -1240,9 +1244,9 @@ export type CustomersPushDataParameters = {
|
|
|
1240
1244
|
*/
|
|
1241
1245
|
name?: string | undefined
|
|
1242
1246
|
/**
|
|
1243
|
-
* Preferred PIN code to use when creating access for this reservation.
|
|
1247
|
+
* Preferred PIN code to use when creating access for this reservation. Set to `null` to remove a previously set preferred code, so that access falls back to an automatically generated code. Omitting this field keeps any previously set preferred code.
|
|
1244
1248
|
*/
|
|
1245
|
-
preferred_code?: string | undefined
|
|
1249
|
+
preferred_code?: string | null | undefined
|
|
1246
1250
|
/**
|
|
1247
1251
|
* Property keys associated with the access grant.
|
|
1248
1252
|
*/
|
|
@@ -1319,9 +1323,9 @@ export type CustomersPushDataParameters = {
|
|
|
1319
1323
|
*/
|
|
1320
1324
|
name?: string | undefined
|
|
1321
1325
|
/**
|
|
1322
|
-
* Preferred PIN code to use when creating access for this reservation.
|
|
1326
|
+
* Preferred PIN code to use when creating access for this reservation. Set to `null` to remove a previously set preferred code, so that access falls back to an automatically generated code. Omitting this field keeps any previously set preferred code.
|
|
1323
1327
|
*/
|
|
1324
|
-
preferred_code?: string | undefined
|
|
1328
|
+
preferred_code?: string | null | undefined
|
|
1325
1329
|
/**
|
|
1326
1330
|
* Property keys associated with the access grant.
|
|
1327
1331
|
*/
|
|
@@ -1399,6 +1403,10 @@ export type CustomersPushDataParameters = {
|
|
|
1399
1403
|
*/
|
|
1400
1404
|
customer_key: string
|
|
1401
1405
|
|
|
1406
|
+
/**
|
|
1407
|
+
* ID of the customization profile to use for this customer. Access grants that automations create for this customer use this profile. Pass `null` to remove the customer's customization profile.
|
|
1408
|
+
*/
|
|
1409
|
+
customization_profile_id?: string | null | undefined
|
|
1402
1410
|
/**
|
|
1403
1411
|
* List of gym or fitness facilities.
|
|
1404
1412
|
*/
|
|
@@ -1524,9 +1532,9 @@ export type CustomersPushDataParameters = {
|
|
|
1524
1532
|
*/
|
|
1525
1533
|
name?: string | undefined
|
|
1526
1534
|
/**
|
|
1527
|
-
* Preferred PIN code to use when creating access for this reservation.
|
|
1535
|
+
* Preferred PIN code to use when creating access for this reservation. Set to `null` to remove a previously set preferred code, so that access falls back to an automatically generated code. Omitting this field keeps any previously set preferred code.
|
|
1528
1536
|
*/
|
|
1529
|
-
preferred_code?: string | undefined
|
|
1537
|
+
preferred_code?: string | null | undefined
|
|
1530
1538
|
/**
|
|
1531
1539
|
* Property keys associated with the access grant.
|
|
1532
1540
|
*/
|
|
@@ -385,6 +385,7 @@ export type DevicesListParameters = {
|
|
|
385
385
|
| 'ring_camera'
|
|
386
386
|
| 'tapo_camera'
|
|
387
387
|
| 'arlo_camera'
|
|
388
|
+
| 'reolink_camera'
|
|
388
389
|
| undefined
|
|
389
390
|
/**
|
|
390
391
|
* Array of device types for which you want to list devices.
|
|
@@ -436,6 +437,7 @@ export type DevicesListParameters = {
|
|
|
436
437
|
| 'ring_camera'
|
|
437
438
|
| 'tapo_camera'
|
|
438
439
|
| 'arlo_camera'
|
|
440
|
+
| 'reolink_camera'
|
|
439
441
|
>
|
|
440
442
|
| undefined
|
|
441
443
|
/**
|
|
@@ -493,6 +495,7 @@ export type DevicesListParameters = {
|
|
|
493
495
|
| 'ring'
|
|
494
496
|
| 'tapo'
|
|
495
497
|
| 'arlo'
|
|
498
|
+
| 'reolink'
|
|
496
499
|
| 'ical'
|
|
497
500
|
| 'lodgify'
|
|
498
501
|
| 'hostaway'
|
|
@@ -332,6 +332,7 @@ export type DevicesUnmanagedListParameters = {
|
|
|
332
332
|
| 'ring_camera'
|
|
333
333
|
| 'tapo_camera'
|
|
334
334
|
| 'arlo_camera'
|
|
335
|
+
| 'reolink_camera'
|
|
335
336
|
| undefined
|
|
336
337
|
/**
|
|
337
338
|
* Array of device types for which you want to list devices.
|
|
@@ -383,6 +384,7 @@ export type DevicesUnmanagedListParameters = {
|
|
|
383
384
|
| 'ring_camera'
|
|
384
385
|
| 'tapo_camera'
|
|
385
386
|
| 'arlo_camera'
|
|
387
|
+
| 'reolink_camera'
|
|
386
388
|
>
|
|
387
389
|
| undefined
|
|
388
390
|
/**
|
|
@@ -440,6 +442,7 @@ export type DevicesUnmanagedListParameters = {
|
|
|
440
442
|
| 'ring'
|
|
441
443
|
| 'tapo'
|
|
442
444
|
| 'arlo'
|
|
445
|
+
| 'reolink'
|
|
443
446
|
| 'ical'
|
|
444
447
|
| 'lodgify'
|
|
445
448
|
| 'hostaway'
|
package/src/lib/routes/index.ts
CHANGED
|
@@ -8,6 +8,7 @@ export * from './access-grants/index.js'
|
|
|
8
8
|
export * from './access-methods/index.js'
|
|
9
9
|
export * from './acs/index.js'
|
|
10
10
|
export * from './action-attempts/index.js'
|
|
11
|
+
export * from './cameras/index.js'
|
|
11
12
|
export * from './client-sessions/index.js'
|
|
12
13
|
export * from './connect-webviews/index.js'
|
|
13
14
|
export * from './connected-accounts/index.js'
|
|
@@ -16,6 +17,7 @@ export * from './devices/index.js'
|
|
|
16
17
|
export * from './events/index.js'
|
|
17
18
|
export * from './instant-keys/index.js'
|
|
18
19
|
export * from './locks/index.js'
|
|
20
|
+
export * from './media/index.js'
|
|
19
21
|
export * from './noise-sensors/index.js'
|
|
20
22
|
export * from './phones/index.js'
|
|
21
23
|
export * from './seam-http.js'
|