@seamapi/http 2.24.1 → 2.26.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 +37 -0
- package/lib/error-interceptor.js +2 -2
- package/lib/error-interceptor.js.map +1 -1
- package/lib/resolve-action-attempt.d.ts +4 -4
- package/lib/resources/access-grant.d.ts +1 -1
- package/lib/resources/action-attempt.d.ts +871 -139
- package/lib/resources/event.d.ts +9 -4
- package/lib/routes/access-codes/access-codes.js +1 -1
- package/lib/routes/access-codes/access-codes.js.map +1 -1
- package/lib/routes/access-grants/access-grants.d.ts +25 -25
- package/lib/routes/access-methods/access-methods.d.ts +5 -5
- package/lib/routes/access-methods/access-methods.js +1 -1
- package/lib/routes/access-methods/access-methods.js.map +1 -1
- package/lib/routes/acs/encoders/simulate/simulate.d.ts +5 -5
- package/lib/routes/customers/customers.d.ts +185 -185
- package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.js +1 -1
- package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.js.map +1 -1
- package/lib/routes/thermostats/simulate/simulate.d.ts +8 -8
- package/lib/routes/thermostats/thermostats.d.ts +5 -5
- package/lib/routes/user-identities/user-identities.d.ts +5 -5
- package/lib/routes/user-identities/user-identities.js +1 -1
- package/lib/routes/user-identities/user-identities.js.map +1 -1
- package/lib/routes/workspaces/workspaces.d.ts +1 -1
- package/lib/seam-http-error.d.ts +16 -3
- package/lib/seam-http-error.js +18 -6
- package/lib/seam-http-error.js.map +1 -1
- package/lib/version.d.ts +1 -1
- package/lib/version.js +1 -1
- package/package.json +3 -3
- package/src/lib/error-interceptor.ts +6 -2
- package/src/lib/resolve-action-attempt.ts +8 -6
- package/src/lib/resources/access-grant.ts +1 -1
- package/src/lib/resources/action-attempt.ts +1101 -201
- package/src/lib/resources/event.ts +10 -5
- package/src/lib/routes/access-codes/access-codes.ts +1 -1
- package/src/lib/routes/access-grants/access-grants.ts +27 -27
- package/src/lib/routes/access-methods/access-methods.ts +6 -6
- package/src/lib/routes/acs/encoders/simulate/simulate.ts +5 -6
- package/src/lib/routes/customers/customers.ts +235 -236
- package/src/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.ts +1 -1
- package/src/lib/routes/thermostats/simulate/simulate.ts +9 -10
- package/src/lib/routes/thermostats/thermostats.ts +7 -7
- package/src/lib/routes/user-identities/user-identities.ts +6 -6
- package/src/lib/routes/workspaces/workspaces.ts +1 -1
- package/src/lib/seam-http-error.ts +43 -6
- package/src/lib/version.ts +1 -1
|
@@ -4549,14 +4549,15 @@ export type SeamEvent =
|
|
|
4549
4549
|
}
|
|
4550
4550
|
| {
|
|
4551
4551
|
/**
|
|
4552
|
-
* Number in the range 0 to 1.0 indicating the
|
|
4552
|
+
* 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
4553
|
*/
|
|
4554
|
-
|
|
4555
|
-
|
|
4554
|
+
accessory_keypad_battery_level?: number | undefined
|
|
4556
4555
|
/**
|
|
4557
|
-
*
|
|
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
4558
|
*/
|
|
4559
|
-
|
|
4559
|
+
battery_level: number
|
|
4560
|
+
|
|
4560
4561
|
/**
|
|
4561
4562
|
* Custom metadata of the connected account, present when connected_account_id is provided.
|
|
4562
4563
|
*/
|
|
@@ -4576,6 +4577,10 @@ export type SeamEvent =
|
|
|
4576
4577
|
* The customer key associated with the device, if any.
|
|
4577
4578
|
*/
|
|
4578
4579
|
customer_key?: string | undefined
|
|
4580
|
+
/**
|
|
4581
|
+
* Number in the range 0 to 1.0 indicating the affected device's own battery level, when known.
|
|
4582
|
+
*/
|
|
4583
|
+
device_battery_level?: number | undefined
|
|
4579
4584
|
/**
|
|
4580
4585
|
* Custom metadata of the device, present when device_id is provided.
|
|
4581
4586
|
*/
|
|
@@ -378,7 +378,7 @@ export class SeamHttpAccessCodes {
|
|
|
378
378
|
): AccessCodesUpdateRequest {
|
|
379
379
|
return new SeamHttpRequest(this, {
|
|
380
380
|
pathname: '/access_codes/update',
|
|
381
|
-
method: '
|
|
381
|
+
method: 'PATCH',
|
|
382
382
|
body: parameters,
|
|
383
383
|
parameters,
|
|
384
384
|
hasRequiredParameters: true,
|
|
@@ -323,33 +323,6 @@ export class SeamHttpAccessGrants {
|
|
|
323
323
|
}
|
|
324
324
|
|
|
325
325
|
export type AccessGrantsCreateParameters = {
|
|
326
|
-
/**
|
|
327
|
-
* ID of user identity for whom access is being granted.
|
|
328
|
-
*/
|
|
329
|
-
user_identity_id?: string | undefined
|
|
330
|
-
/**
|
|
331
|
-
* When used, creates a new user identity with the given details, and grants them access.
|
|
332
|
-
*/
|
|
333
|
-
user_identity?:
|
|
334
|
-
| {
|
|
335
|
-
/**
|
|
336
|
-
* Unique email address for the user identity.
|
|
337
|
-
*/
|
|
338
|
-
email_address?: string | null | undefined
|
|
339
|
-
/**
|
|
340
|
-
* Full name of the user associated with the user identity.
|
|
341
|
-
*/
|
|
342
|
-
full_name?: string | null | undefined
|
|
343
|
-
/**
|
|
344
|
-
* Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).
|
|
345
|
-
*/
|
|
346
|
-
phone_number?: string | null | undefined
|
|
347
|
-
/**
|
|
348
|
-
* Unique key for the user identity.
|
|
349
|
-
*/
|
|
350
|
-
user_identity_key?: string | null | undefined
|
|
351
|
-
}
|
|
352
|
-
| undefined
|
|
353
326
|
/**
|
|
354
327
|
* Unique key for the access grant within the workspace.
|
|
355
328
|
*/
|
|
@@ -429,6 +402,33 @@ export type AccessGrantsCreateParameters = {
|
|
|
429
402
|
* Date and time at which the validity of the new grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
|
|
430
403
|
*/
|
|
431
404
|
starts_at?: string | undefined
|
|
405
|
+
/**
|
|
406
|
+
* When used, creates a new user identity with the given details, and grants them access.
|
|
407
|
+
*/
|
|
408
|
+
user_identity?:
|
|
409
|
+
| {
|
|
410
|
+
/**
|
|
411
|
+
* Unique email address for the user identity.
|
|
412
|
+
*/
|
|
413
|
+
email_address?: string | null | undefined
|
|
414
|
+
/**
|
|
415
|
+
* Full name of the user associated with the user identity.
|
|
416
|
+
*/
|
|
417
|
+
full_name?: string | null | undefined
|
|
418
|
+
/**
|
|
419
|
+
* Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).
|
|
420
|
+
*/
|
|
421
|
+
phone_number?: string | null | undefined
|
|
422
|
+
/**
|
|
423
|
+
* Unique key for the user identity.
|
|
424
|
+
*/
|
|
425
|
+
user_identity_key?: string | null | undefined
|
|
426
|
+
}
|
|
427
|
+
| undefined
|
|
428
|
+
/**
|
|
429
|
+
* ID of user identity for whom access is being granted.
|
|
430
|
+
*/
|
|
431
|
+
user_identity_id?: string | undefined
|
|
432
432
|
}
|
|
433
433
|
|
|
434
434
|
/**
|
|
@@ -211,8 +211,8 @@ export class SeamHttpAccessMethods {
|
|
|
211
211
|
hasRequiredParameters: true,
|
|
212
212
|
requiredParameterNames: [],
|
|
213
213
|
atLeastOneParameterNames: [
|
|
214
|
-
'access_method_id',
|
|
215
214
|
'access_grant_id',
|
|
215
|
+
'access_method_id',
|
|
216
216
|
'reservation_key',
|
|
217
217
|
],
|
|
218
218
|
responseKey: undefined,
|
|
@@ -368,20 +368,20 @@ export type AccessMethodsAssignCardOptions = Pick<
|
|
|
368
368
|
|
|
369
369
|
export type AccessMethodsDeleteParameters = RequireAtLeastOne<
|
|
370
370
|
{
|
|
371
|
-
/**
|
|
372
|
-
* ID of access method to delete.
|
|
373
|
-
*/
|
|
374
|
-
access_method_id?: string | undefined
|
|
375
371
|
/**
|
|
376
372
|
* ID of access grant whose access methods should be deleted.
|
|
377
373
|
*/
|
|
378
374
|
access_grant_id?: string | undefined
|
|
375
|
+
/**
|
|
376
|
+
* ID of access method to delete.
|
|
377
|
+
*/
|
|
378
|
+
access_method_id?: string | undefined
|
|
379
379
|
/**
|
|
380
380
|
* Reservation key of the access grant whose access methods should be deleted.
|
|
381
381
|
*/
|
|
382
382
|
reservation_key?: string | undefined
|
|
383
383
|
},
|
|
384
|
-
'
|
|
384
|
+
'access_grant_id' | 'access_method_id' | 'reservation_key'
|
|
385
385
|
>
|
|
386
386
|
|
|
387
387
|
/**
|
|
@@ -242,6 +242,10 @@ export class SeamHttpAcsEncodersSimulate {
|
|
|
242
242
|
}
|
|
243
243
|
|
|
244
244
|
export type AcsEncodersSimulateNextCredentialEncodeWillFailParameters = {
|
|
245
|
+
/**
|
|
246
|
+
* ID of the `acs_credential` that will fail to be encoded onto a card in the next request.
|
|
247
|
+
*/
|
|
248
|
+
acs_credential_id?: string | undefined
|
|
245
249
|
/**
|
|
246
250
|
* ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`.
|
|
247
251
|
*/
|
|
@@ -256,10 +260,6 @@ export type AcsEncodersSimulateNextCredentialEncodeWillFailParameters = {
|
|
|
256
260
|
| 'uncategorized_error'
|
|
257
261
|
| 'action_attempt_expired'
|
|
258
262
|
| undefined
|
|
259
|
-
/**
|
|
260
|
-
* ID of the `acs_credential` that will fail to be encoded onto a card in the next request.
|
|
261
|
-
*/
|
|
262
|
-
acs_credential_id?: string | undefined
|
|
263
263
|
}
|
|
264
264
|
|
|
265
265
|
/**
|
|
@@ -295,6 +295,7 @@ export type AcsEncodersSimulateNextCredentialEncodeWillSucceedRequest =
|
|
|
295
295
|
export interface AcsEncodersSimulateNextCredentialEncodeWillSucceedOptions {}
|
|
296
296
|
|
|
297
297
|
export type AcsEncodersSimulateNextCredentialScanWillFailParameters = {
|
|
298
|
+
acs_credential_id_on_seam?: string | undefined
|
|
298
299
|
/**
|
|
299
300
|
* ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next request.
|
|
300
301
|
*/
|
|
@@ -305,8 +306,6 @@ export type AcsEncodersSimulateNextCredentialScanWillFailParameters = {
|
|
|
305
306
|
| 'uncategorized_error'
|
|
306
307
|
| 'action_attempt_expired'
|
|
307
308
|
| undefined
|
|
308
|
-
|
|
309
|
-
acs_credential_id_on_seam?: string | undefined
|
|
310
309
|
}
|
|
311
310
|
|
|
312
311
|
/**
|
|
@@ -224,242 +224,6 @@ export class SeamHttpCustomers {
|
|
|
224
224
|
}
|
|
225
225
|
|
|
226
226
|
export type CustomersCreatePortalParameters = {
|
|
227
|
-
/**
|
|
228
|
-
* Filter configuration for resources based on their custom_metadata. Each filter specifies a field, operation, and value to match against resource custom_metadata.
|
|
229
|
-
*/
|
|
230
|
-
customer_resources_filters?:
|
|
231
|
-
| Array<{
|
|
232
|
-
/**
|
|
233
|
-
* The custom_metadata field name to filter on.
|
|
234
|
-
*/
|
|
235
|
-
field?: string | undefined
|
|
236
|
-
/**
|
|
237
|
-
* The comparison operation. Currently only '=' is supported.
|
|
238
|
-
*/
|
|
239
|
-
operation?: '=' | undefined
|
|
240
|
-
/**
|
|
241
|
-
* The value to compare against.
|
|
242
|
-
*/
|
|
243
|
-
value?: string | undefined
|
|
244
|
-
}>
|
|
245
|
-
| undefined
|
|
246
|
-
/**
|
|
247
|
-
* The ID of the customization profile to use for the portal.
|
|
248
|
-
*/
|
|
249
|
-
customization_profile_id?: string | undefined
|
|
250
|
-
/**
|
|
251
|
-
* Deep link target resource for initial redirect. When set, the portal will navigate directly to the specified resource.
|
|
252
|
-
*/
|
|
253
|
-
deep_link?:
|
|
254
|
-
| {
|
|
255
|
-
resource_key?: string | undefined
|
|
256
|
-
|
|
257
|
-
resource_type?: 'reservation' | 'space' | 'device' | undefined
|
|
258
|
-
|
|
259
|
-
resource_id?: string | undefined
|
|
260
|
-
}
|
|
261
|
-
| undefined
|
|
262
|
-
/**
|
|
263
|
-
* Whether to exclude the option to select a locale within the portal UI.
|
|
264
|
-
*/
|
|
265
|
-
exclude_locale_picker?: boolean | undefined
|
|
266
|
-
|
|
267
|
-
features?:
|
|
268
|
-
| {
|
|
269
|
-
/**
|
|
270
|
-
* Configuration for the configure feature.
|
|
271
|
-
*/
|
|
272
|
-
configure?:
|
|
273
|
-
| {
|
|
274
|
-
/**
|
|
275
|
-
* Indicates whether the customer can customize the access automation rules for their properties.
|
|
276
|
-
*/
|
|
277
|
-
allow_access_automation_rule_customization?: boolean | undefined
|
|
278
|
-
/**
|
|
279
|
-
* Indicates whether the customer can customize the climate automation rules for their properties.
|
|
280
|
-
*/
|
|
281
|
-
allow_climate_automation_rule_customization?: boolean | undefined
|
|
282
|
-
/**
|
|
283
|
-
* Indicates whether the customer can customize the Instant Key profile for their properties.
|
|
284
|
-
*/
|
|
285
|
-
allow_instant_key_customization?: boolean | undefined
|
|
286
|
-
/**
|
|
287
|
-
* Whether to exclude this feature from the portal.
|
|
288
|
-
*/
|
|
289
|
-
exclude?: boolean | undefined
|
|
290
|
-
}
|
|
291
|
-
| undefined
|
|
292
|
-
/**
|
|
293
|
-
* Configuration for the connect accounts feature.
|
|
294
|
-
*/
|
|
295
|
-
connect?:
|
|
296
|
-
| {
|
|
297
|
-
/**
|
|
298
|
-
* List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account.
|
|
299
|
-
*/
|
|
300
|
-
accepted_providers?: Array<string> | undefined
|
|
301
|
-
/**
|
|
302
|
-
* Whether to exclude this feature from the portal.
|
|
303
|
-
*/
|
|
304
|
-
exclude?: boolean | undefined
|
|
305
|
-
/**
|
|
306
|
-
* List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account.
|
|
307
|
-
*/
|
|
308
|
-
excluded_providers?: Array<string> | undefined
|
|
309
|
-
}
|
|
310
|
-
| undefined
|
|
311
|
-
/**
|
|
312
|
-
* Configuration for the manage feature.
|
|
313
|
-
*/
|
|
314
|
-
manage?:
|
|
315
|
-
| {
|
|
316
|
-
/**
|
|
317
|
-
* Custom copy for the confirmation modal shown before unmanaged devices are added to a space and begin being managed (and billed). Only takes effect when the MANAGE_DEVICES_CONFIRMATION_MODAL feature flag is enabled for the workspace. Any omitted string falls back to a localized default.
|
|
318
|
-
*/
|
|
319
|
-
device_management_confirmation?:
|
|
320
|
-
| {
|
|
321
|
-
/**
|
|
322
|
-
* Custom body text for the confirmation modal. May include the {count} token, which is replaced with the number of devices that will begin being managed.
|
|
323
|
-
*/
|
|
324
|
-
body?: string | undefined
|
|
325
|
-
/**
|
|
326
|
-
* Custom label for the cancel button.
|
|
327
|
-
*/
|
|
328
|
-
cancel_button_label?: string | undefined
|
|
329
|
-
/**
|
|
330
|
-
* Custom label for the confirm button.
|
|
331
|
-
*/
|
|
332
|
-
confirm_button_label?: string | undefined
|
|
333
|
-
/**
|
|
334
|
-
* Custom title for the confirmation modal.
|
|
335
|
-
*/
|
|
336
|
-
title?: string | undefined
|
|
337
|
-
}
|
|
338
|
-
| undefined
|
|
339
|
-
/**
|
|
340
|
-
* Configuration for event type filtering in the manage feature.
|
|
341
|
-
*/
|
|
342
|
-
events?:
|
|
343
|
-
| {
|
|
344
|
-
/**
|
|
345
|
-
* List of event types to show in the events filter. When set, only these event types will be available. Leave empty to show all events.
|
|
346
|
-
*/
|
|
347
|
-
allowed_events?: Array<string> | undefined
|
|
348
|
-
/**
|
|
349
|
-
* List of event types that are pre-selected in the events filter when the user first loads the events tab.
|
|
350
|
-
*/
|
|
351
|
-
default_events?: Array<string> | undefined
|
|
352
|
-
}
|
|
353
|
-
| undefined
|
|
354
|
-
/**
|
|
355
|
-
* Whether to exclude this feature from the portal.
|
|
356
|
-
*/
|
|
357
|
-
exclude?: boolean | undefined
|
|
358
|
-
/**
|
|
359
|
-
* Indicates whether the customer can manage reservations for their properties.
|
|
360
|
-
*/
|
|
361
|
-
exclude_reservation_management?: boolean | undefined
|
|
362
|
-
/**
|
|
363
|
-
* Indicates whether to exclude technical details from reservation views.
|
|
364
|
-
*/
|
|
365
|
-
exclude_reservation_technical_details?: boolean | undefined
|
|
366
|
-
/**
|
|
367
|
-
* Indicates whether the customer can manage staff for their properties.
|
|
368
|
-
*/
|
|
369
|
-
exclude_staff_management?: boolean | undefined
|
|
370
|
-
}
|
|
371
|
-
| undefined
|
|
372
|
-
/**
|
|
373
|
-
* Configuration for the manage devices feature.
|
|
374
|
-
* ---
|
|
375
|
-
* deprecated: Use `manage` instead.
|
|
376
|
-
* ---
|
|
377
|
-
*/
|
|
378
|
-
manage_devices?:
|
|
379
|
-
| {
|
|
380
|
-
/**
|
|
381
|
-
* Whether to exclude this feature from the portal.
|
|
382
|
-
*/
|
|
383
|
-
exclude?: boolean | undefined
|
|
384
|
-
}
|
|
385
|
-
| undefined
|
|
386
|
-
/**
|
|
387
|
-
* Configuration for the organize feature.
|
|
388
|
-
*/
|
|
389
|
-
organize?:
|
|
390
|
-
| {
|
|
391
|
-
/**
|
|
392
|
-
* Whether to exclude this feature from the portal.
|
|
393
|
-
*/
|
|
394
|
-
exclude?: boolean | undefined
|
|
395
|
-
}
|
|
396
|
-
| undefined
|
|
397
|
-
}
|
|
398
|
-
| undefined
|
|
399
|
-
/**
|
|
400
|
-
* Whether the portal is embedded in another application.
|
|
401
|
-
*/
|
|
402
|
-
is_embedded?: boolean | undefined
|
|
403
|
-
/**
|
|
404
|
-
* Configuration for the landing page when the portal loads.
|
|
405
|
-
*/
|
|
406
|
-
landing_page?:
|
|
407
|
-
| {
|
|
408
|
-
manage?:
|
|
409
|
-
| {
|
|
410
|
-
space_key?: string | undefined
|
|
411
|
-
|
|
412
|
-
property_key?: string | undefined
|
|
413
|
-
|
|
414
|
-
room_key?: string | undefined
|
|
415
|
-
|
|
416
|
-
common_area_key?: string | undefined
|
|
417
|
-
|
|
418
|
-
unit_key?: string | undefined
|
|
419
|
-
|
|
420
|
-
facility_key?: string | undefined
|
|
421
|
-
|
|
422
|
-
building_key?: string | undefined
|
|
423
|
-
|
|
424
|
-
listing_key?: string | undefined
|
|
425
|
-
|
|
426
|
-
property_listing_key?: string | undefined
|
|
427
|
-
|
|
428
|
-
site_key?: string | undefined
|
|
429
|
-
|
|
430
|
-
reservation_key?: string | undefined
|
|
431
|
-
|
|
432
|
-
booking_key?: string | undefined
|
|
433
|
-
|
|
434
|
-
access_grant_key?: string | undefined
|
|
435
|
-
}
|
|
436
|
-
| undefined
|
|
437
|
-
}
|
|
438
|
-
| undefined
|
|
439
|
-
/**
|
|
440
|
-
* The locale to use for the portal.
|
|
441
|
-
*/
|
|
442
|
-
locale?:
|
|
443
|
-
| 'en-US'
|
|
444
|
-
| 'pt-PT'
|
|
445
|
-
| 'fr-FR'
|
|
446
|
-
| 'it-IT'
|
|
447
|
-
| 'es-ES'
|
|
448
|
-
| 'de-DE'
|
|
449
|
-
| 'nl-NL'
|
|
450
|
-
| 'el-GR'
|
|
451
|
-
| 'pl-PL'
|
|
452
|
-
| 'ru-RU'
|
|
453
|
-
| undefined
|
|
454
|
-
/**
|
|
455
|
-
* Navigation mode for the portal. 'restricted' tells frontend to hide navigation UI, typically used for embedded deep links.
|
|
456
|
-
*/
|
|
457
|
-
navigation_mode?: 'full' | 'restricted' | undefined
|
|
458
|
-
/**
|
|
459
|
-
* Whether the portal is read-only. When true, the customer can browse the portal but cannot perform any mutating action; write requests made with the portal's client session are rejected.
|
|
460
|
-
*/
|
|
461
|
-
read_only?: boolean | undefined
|
|
462
|
-
|
|
463
227
|
customer_data?:
|
|
464
228
|
| {
|
|
465
229
|
/**
|
|
@@ -1099,6 +863,241 @@ export type CustomersCreatePortalParameters = {
|
|
|
1099
863
|
| undefined
|
|
1100
864
|
}
|
|
1101
865
|
| undefined
|
|
866
|
+
/**
|
|
867
|
+
* Filter configuration for resources based on their custom_metadata. Each filter specifies a field, operation, and value to match against resource custom_metadata.
|
|
868
|
+
*/
|
|
869
|
+
customer_resources_filters?:
|
|
870
|
+
| Array<{
|
|
871
|
+
/**
|
|
872
|
+
* The custom_metadata field name to filter on.
|
|
873
|
+
*/
|
|
874
|
+
field?: string | undefined
|
|
875
|
+
/**
|
|
876
|
+
* The comparison operation. Currently only '=' is supported.
|
|
877
|
+
*/
|
|
878
|
+
operation?: '=' | undefined
|
|
879
|
+
/**
|
|
880
|
+
* The value to compare against.
|
|
881
|
+
*/
|
|
882
|
+
value?: string | undefined
|
|
883
|
+
}>
|
|
884
|
+
| undefined
|
|
885
|
+
/**
|
|
886
|
+
* The ID of the customization profile to use for the portal.
|
|
887
|
+
*/
|
|
888
|
+
customization_profile_id?: string | undefined
|
|
889
|
+
/**
|
|
890
|
+
* Deep link target resource for initial redirect. When set, the portal will navigate directly to the specified resource.
|
|
891
|
+
*/
|
|
892
|
+
deep_link?:
|
|
893
|
+
| {
|
|
894
|
+
resource_id?: string | undefined
|
|
895
|
+
|
|
896
|
+
resource_key?: string | undefined
|
|
897
|
+
|
|
898
|
+
resource_type?: 'reservation' | 'space' | 'device' | undefined
|
|
899
|
+
}
|
|
900
|
+
| undefined
|
|
901
|
+
/**
|
|
902
|
+
* Whether to exclude the option to select a locale within the portal UI.
|
|
903
|
+
*/
|
|
904
|
+
exclude_locale_picker?: boolean | undefined
|
|
905
|
+
|
|
906
|
+
features?:
|
|
907
|
+
| {
|
|
908
|
+
/**
|
|
909
|
+
* Configuration for the configure feature.
|
|
910
|
+
*/
|
|
911
|
+
configure?:
|
|
912
|
+
| {
|
|
913
|
+
/**
|
|
914
|
+
* Indicates whether the customer can customize the access automation rules for their properties.
|
|
915
|
+
*/
|
|
916
|
+
allow_access_automation_rule_customization?: boolean | undefined
|
|
917
|
+
/**
|
|
918
|
+
* Indicates whether the customer can customize the climate automation rules for their properties.
|
|
919
|
+
*/
|
|
920
|
+
allow_climate_automation_rule_customization?: boolean | undefined
|
|
921
|
+
/**
|
|
922
|
+
* Indicates whether the customer can customize the Instant Key profile for their properties.
|
|
923
|
+
*/
|
|
924
|
+
allow_instant_key_customization?: boolean | undefined
|
|
925
|
+
/**
|
|
926
|
+
* Whether to exclude this feature from the portal.
|
|
927
|
+
*/
|
|
928
|
+
exclude?: boolean | undefined
|
|
929
|
+
}
|
|
930
|
+
| undefined
|
|
931
|
+
/**
|
|
932
|
+
* Configuration for the connect accounts feature.
|
|
933
|
+
*/
|
|
934
|
+
connect?:
|
|
935
|
+
| {
|
|
936
|
+
/**
|
|
937
|
+
* List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account.
|
|
938
|
+
*/
|
|
939
|
+
accepted_providers?: Array<string> | undefined
|
|
940
|
+
/**
|
|
941
|
+
* Whether to exclude this feature from the portal.
|
|
942
|
+
*/
|
|
943
|
+
exclude?: boolean | undefined
|
|
944
|
+
/**
|
|
945
|
+
* List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account.
|
|
946
|
+
*/
|
|
947
|
+
excluded_providers?: Array<string> | undefined
|
|
948
|
+
}
|
|
949
|
+
| undefined
|
|
950
|
+
/**
|
|
951
|
+
* Configuration for the manage feature.
|
|
952
|
+
*/
|
|
953
|
+
manage?:
|
|
954
|
+
| {
|
|
955
|
+
/**
|
|
956
|
+
* Custom copy for the confirmation modal shown before unmanaged devices are added to a space and begin being managed (and billed). Only takes effect when the MANAGE_DEVICES_CONFIRMATION_MODAL feature flag is enabled for the workspace. Any omitted string falls back to a localized default.
|
|
957
|
+
*/
|
|
958
|
+
device_management_confirmation?:
|
|
959
|
+
| {
|
|
960
|
+
/**
|
|
961
|
+
* Custom body text for the confirmation modal. May include the {count} token, which is replaced with the number of devices that will begin being managed.
|
|
962
|
+
*/
|
|
963
|
+
body?: string | undefined
|
|
964
|
+
/**
|
|
965
|
+
* Custom label for the cancel button.
|
|
966
|
+
*/
|
|
967
|
+
cancel_button_label?: string | undefined
|
|
968
|
+
/**
|
|
969
|
+
* Custom label for the confirm button.
|
|
970
|
+
*/
|
|
971
|
+
confirm_button_label?: string | undefined
|
|
972
|
+
/**
|
|
973
|
+
* Custom title for the confirmation modal.
|
|
974
|
+
*/
|
|
975
|
+
title?: string | undefined
|
|
976
|
+
}
|
|
977
|
+
| undefined
|
|
978
|
+
/**
|
|
979
|
+
* Configuration for event type filtering in the manage feature.
|
|
980
|
+
*/
|
|
981
|
+
events?:
|
|
982
|
+
| {
|
|
983
|
+
/**
|
|
984
|
+
* List of event types to show in the events filter. When set, only these event types will be available. Leave empty to show all events.
|
|
985
|
+
*/
|
|
986
|
+
allowed_events?: Array<string> | undefined
|
|
987
|
+
/**
|
|
988
|
+
* List of event types that are pre-selected in the events filter when the user first loads the events tab.
|
|
989
|
+
*/
|
|
990
|
+
default_events?: Array<string> | undefined
|
|
991
|
+
}
|
|
992
|
+
| undefined
|
|
993
|
+
/**
|
|
994
|
+
* Whether to exclude this feature from the portal.
|
|
995
|
+
*/
|
|
996
|
+
exclude?: boolean | undefined
|
|
997
|
+
/**
|
|
998
|
+
* Indicates whether the customer can manage reservations for their properties.
|
|
999
|
+
*/
|
|
1000
|
+
exclude_reservation_management?: boolean | undefined
|
|
1001
|
+
/**
|
|
1002
|
+
* Indicates whether to exclude technical details from reservation views.
|
|
1003
|
+
*/
|
|
1004
|
+
exclude_reservation_technical_details?: boolean | undefined
|
|
1005
|
+
/**
|
|
1006
|
+
* Indicates whether the customer can manage staff for their properties.
|
|
1007
|
+
*/
|
|
1008
|
+
exclude_staff_management?: boolean | undefined
|
|
1009
|
+
}
|
|
1010
|
+
| undefined
|
|
1011
|
+
/**
|
|
1012
|
+
* Configuration for the manage devices feature.
|
|
1013
|
+
* ---
|
|
1014
|
+
* deprecated: Use `manage` instead.
|
|
1015
|
+
* ---
|
|
1016
|
+
*/
|
|
1017
|
+
manage_devices?:
|
|
1018
|
+
| {
|
|
1019
|
+
/**
|
|
1020
|
+
* Whether to exclude this feature from the portal.
|
|
1021
|
+
*/
|
|
1022
|
+
exclude?: boolean | undefined
|
|
1023
|
+
}
|
|
1024
|
+
| undefined
|
|
1025
|
+
/**
|
|
1026
|
+
* Configuration for the organize feature.
|
|
1027
|
+
*/
|
|
1028
|
+
organize?:
|
|
1029
|
+
| {
|
|
1030
|
+
/**
|
|
1031
|
+
* Whether to exclude this feature from the portal.
|
|
1032
|
+
*/
|
|
1033
|
+
exclude?: boolean | undefined
|
|
1034
|
+
}
|
|
1035
|
+
| undefined
|
|
1036
|
+
}
|
|
1037
|
+
| undefined
|
|
1038
|
+
/**
|
|
1039
|
+
* Whether the portal is embedded in another application.
|
|
1040
|
+
*/
|
|
1041
|
+
is_embedded?: boolean | undefined
|
|
1042
|
+
/**
|
|
1043
|
+
* Configuration for the landing page when the portal loads.
|
|
1044
|
+
*/
|
|
1045
|
+
landing_page?:
|
|
1046
|
+
| {
|
|
1047
|
+
manage?:
|
|
1048
|
+
| {
|
|
1049
|
+
access_grant_key?: string | undefined
|
|
1050
|
+
|
|
1051
|
+
booking_key?: string | undefined
|
|
1052
|
+
|
|
1053
|
+
building_key?: string | undefined
|
|
1054
|
+
|
|
1055
|
+
common_area_key?: string | undefined
|
|
1056
|
+
|
|
1057
|
+
facility_key?: string | undefined
|
|
1058
|
+
|
|
1059
|
+
listing_key?: string | undefined
|
|
1060
|
+
|
|
1061
|
+
property_key?: string | undefined
|
|
1062
|
+
|
|
1063
|
+
property_listing_key?: string | undefined
|
|
1064
|
+
|
|
1065
|
+
reservation_key?: string | undefined
|
|
1066
|
+
|
|
1067
|
+
room_key?: string | undefined
|
|
1068
|
+
|
|
1069
|
+
site_key?: string | undefined
|
|
1070
|
+
|
|
1071
|
+
space_key?: string | undefined
|
|
1072
|
+
|
|
1073
|
+
unit_key?: string | undefined
|
|
1074
|
+
}
|
|
1075
|
+
| undefined
|
|
1076
|
+
}
|
|
1077
|
+
| undefined
|
|
1078
|
+
/**
|
|
1079
|
+
* The locale to use for the portal.
|
|
1080
|
+
*/
|
|
1081
|
+
locale?:
|
|
1082
|
+
| 'en-US'
|
|
1083
|
+
| 'pt-PT'
|
|
1084
|
+
| 'fr-FR'
|
|
1085
|
+
| 'it-IT'
|
|
1086
|
+
| 'es-ES'
|
|
1087
|
+
| 'de-DE'
|
|
1088
|
+
| 'nl-NL'
|
|
1089
|
+
| 'el-GR'
|
|
1090
|
+
| 'pl-PL'
|
|
1091
|
+
| 'ru-RU'
|
|
1092
|
+
| undefined
|
|
1093
|
+
/**
|
|
1094
|
+
* Navigation mode for the portal. 'restricted' tells frontend to hide navigation UI, typically used for embedded deep links.
|
|
1095
|
+
*/
|
|
1096
|
+
navigation_mode?: 'full' | 'restricted' | undefined
|
|
1097
|
+
/**
|
|
1098
|
+
* Whether the portal is read-only. When true, the customer can browse the portal but cannot perform any mutating action; write requests made with the portal's client session are rejected.
|
|
1099
|
+
*/
|
|
1100
|
+
read_only?: boolean | undefined
|
|
1102
1101
|
}
|
|
1103
1102
|
|
|
1104
1103
|
/**
|
|
@@ -253,7 +253,7 @@ export class SeamHttpNoiseSensorsNoiseThresholds {
|
|
|
253
253
|
): NoiseSensorsNoiseThresholdsUpdateRequest {
|
|
254
254
|
return new SeamHttpRequest(this, {
|
|
255
255
|
pathname: '/noise_sensors/noise_thresholds/update',
|
|
256
|
-
method: '
|
|
256
|
+
method: 'PATCH',
|
|
257
257
|
body: parameters,
|
|
258
258
|
parameters,
|
|
259
259
|
hasRequiredParameters: true,
|