@seamapi/http 2.46.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/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 +170 -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/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 +175 -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
|
@@ -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
|
|
|
@@ -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
|
>
|
|
@@ -583,6 +583,94 @@ export type CustomersCreatePortalParameters = {
|
|
|
583
583
|
* Starting date and time for the access grant.
|
|
584
584
|
*/
|
|
585
585
|
starts_at?: string | Date | Temporal.Instant | undefined
|
|
586
|
+
/**
|
|
587
|
+
* Parts of the reservation that each get their own access, for example one per room. Each sub-reservation inherits the reservation's name, times, preferred code, guest and custom metadata unless it sets its own, and must set its own location keys. A reservation with sub-reservations must not set location keys itself. Sending this list replaces the reservation's sub-reservations: any not included are removed, and an empty list removes all of them. Omitting it leaves existing sub-reservations unchanged.
|
|
588
|
+
*/
|
|
589
|
+
sub_reservations?:
|
|
590
|
+
| Array<{
|
|
591
|
+
/**
|
|
592
|
+
* Building keys associated with the access grant.
|
|
593
|
+
*/
|
|
594
|
+
building_keys?: Array<string> | undefined
|
|
595
|
+
/**
|
|
596
|
+
* Common area keys associated with the access grant.
|
|
597
|
+
*/
|
|
598
|
+
common_area_keys?: Array<string> | undefined
|
|
599
|
+
/**
|
|
600
|
+
* Set key:value pairs for filtering sub-reservations by custom criteria. Merged over the reservation's custom metadata. Set a key to `null` or to an empty string to remove that key from the custom metadata.
|
|
601
|
+
*/
|
|
602
|
+
custom_metadata?:
|
|
603
|
+
Record<string, string | boolean> | undefined
|
|
604
|
+
/**
|
|
605
|
+
* Ending date and time for the access grant.
|
|
606
|
+
*/
|
|
607
|
+
ends_at?: string | Date | Temporal.Instant | undefined
|
|
608
|
+
/**
|
|
609
|
+
* Facility keys associated with the access grant.
|
|
610
|
+
*/
|
|
611
|
+
facility_keys?: Array<string> | undefined
|
|
612
|
+
/**
|
|
613
|
+
* Guest key associated with the access grant.
|
|
614
|
+
*/
|
|
615
|
+
guest_key?: string | undefined
|
|
616
|
+
/**
|
|
617
|
+
* Whether this is the reservation's primary sub-reservation, for example the room the guest stays in. Only the primary sub-reservation passes the guest's phone number to access systems that require a phone number to be unique per user. At most one sub-reservation of a reservation can be primary. If none is, the first sub-reservation in the list is primary.
|
|
618
|
+
*/
|
|
619
|
+
is_primary?: boolean | undefined
|
|
620
|
+
/**
|
|
621
|
+
* Listing keys associated with the access grant.
|
|
622
|
+
*/
|
|
623
|
+
listing_keys?: Array<string> | undefined
|
|
624
|
+
/**
|
|
625
|
+
* Your name for this access grant resource.
|
|
626
|
+
*/
|
|
627
|
+
name?: string | undefined
|
|
628
|
+
/**
|
|
629
|
+
* 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.
|
|
630
|
+
*/
|
|
631
|
+
preferred_code?: string | null | undefined
|
|
632
|
+
/**
|
|
633
|
+
* Property keys associated with the access grant.
|
|
634
|
+
*/
|
|
635
|
+
property_keys?: Array<string> | undefined
|
|
636
|
+
/**
|
|
637
|
+
* Resident key associated with the access grant.
|
|
638
|
+
*/
|
|
639
|
+
resident_key?: string | undefined
|
|
640
|
+
/**
|
|
641
|
+
* Room keys associated with the access grant.
|
|
642
|
+
*/
|
|
643
|
+
room_keys?: Array<string> | undefined
|
|
644
|
+
/**
|
|
645
|
+
* Space keys associated with the access grant.
|
|
646
|
+
*/
|
|
647
|
+
space_keys?: Array<string> | undefined
|
|
648
|
+
/**
|
|
649
|
+
* Starting date and time for the access grant.
|
|
650
|
+
*/
|
|
651
|
+
starts_at?: string | Date | Temporal.Instant | undefined
|
|
652
|
+
/**
|
|
653
|
+
* Your identifier for the sub-reservation. Must be unique across all your reservations and sub-reservations, and stay with the same reservation.
|
|
654
|
+
*/
|
|
655
|
+
sub_reservation_key?: string | undefined
|
|
656
|
+
/**
|
|
657
|
+
* Tenant key associated with the access grant.
|
|
658
|
+
*/
|
|
659
|
+
tenant_key?: string | undefined
|
|
660
|
+
/**
|
|
661
|
+
* Unit keys associated with the access grant.
|
|
662
|
+
*/
|
|
663
|
+
unit_keys?: Array<string> | undefined
|
|
664
|
+
/**
|
|
665
|
+
* User identity key associated with the access grant.
|
|
666
|
+
*/
|
|
667
|
+
user_identity_key?: string | undefined
|
|
668
|
+
/**
|
|
669
|
+
* User key associated with the access grant.
|
|
670
|
+
*/
|
|
671
|
+
user_key?: string | undefined
|
|
672
|
+
}>
|
|
673
|
+
| undefined
|
|
586
674
|
/**
|
|
587
675
|
* Tenant key associated with the access grant.
|
|
588
676
|
*/
|
|
@@ -1586,6 +1674,93 @@ export type CustomersPushDataParameters = {
|
|
|
1586
1674
|
* Starting date and time for the access grant.
|
|
1587
1675
|
*/
|
|
1588
1676
|
starts_at?: string | Date | Temporal.Instant | undefined
|
|
1677
|
+
/**
|
|
1678
|
+
* Parts of the reservation that each get their own access, for example one per room. Each sub-reservation inherits the reservation's name, times, preferred code, guest and custom metadata unless it sets its own, and must set its own location keys. A reservation with sub-reservations must not set location keys itself. Sending this list replaces the reservation's sub-reservations: any not included are removed, and an empty list removes all of them. Omitting it leaves existing sub-reservations unchanged.
|
|
1679
|
+
*/
|
|
1680
|
+
sub_reservations?:
|
|
1681
|
+
| Array<{
|
|
1682
|
+
/**
|
|
1683
|
+
* Building keys associated with the access grant.
|
|
1684
|
+
*/
|
|
1685
|
+
building_keys?: Array<string> | undefined
|
|
1686
|
+
/**
|
|
1687
|
+
* Common area keys associated with the access grant.
|
|
1688
|
+
*/
|
|
1689
|
+
common_area_keys?: Array<string> | undefined
|
|
1690
|
+
/**
|
|
1691
|
+
* Set key:value pairs for filtering sub-reservations by custom criteria. Merged over the reservation's custom metadata. Set a key to `null` or to an empty string to remove that key from the custom metadata.
|
|
1692
|
+
*/
|
|
1693
|
+
custom_metadata?: Record<string, string | boolean> | undefined
|
|
1694
|
+
/**
|
|
1695
|
+
* Ending date and time for the access grant.
|
|
1696
|
+
*/
|
|
1697
|
+
ends_at?: string | Date | Temporal.Instant | undefined
|
|
1698
|
+
/**
|
|
1699
|
+
* Facility keys associated with the access grant.
|
|
1700
|
+
*/
|
|
1701
|
+
facility_keys?: Array<string> | undefined
|
|
1702
|
+
/**
|
|
1703
|
+
* Guest key associated with the access grant.
|
|
1704
|
+
*/
|
|
1705
|
+
guest_key?: string | undefined
|
|
1706
|
+
/**
|
|
1707
|
+
* Whether this is the reservation's primary sub-reservation, for example the room the guest stays in. Only the primary sub-reservation passes the guest's phone number to access systems that require a phone number to be unique per user. At most one sub-reservation of a reservation can be primary. If none is, the first sub-reservation in the list is primary.
|
|
1708
|
+
*/
|
|
1709
|
+
is_primary?: boolean | undefined
|
|
1710
|
+
/**
|
|
1711
|
+
* Listing keys associated with the access grant.
|
|
1712
|
+
*/
|
|
1713
|
+
listing_keys?: Array<string> | undefined
|
|
1714
|
+
/**
|
|
1715
|
+
* Your name for this access grant resource.
|
|
1716
|
+
*/
|
|
1717
|
+
name?: string | undefined
|
|
1718
|
+
/**
|
|
1719
|
+
* 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.
|
|
1720
|
+
*/
|
|
1721
|
+
preferred_code?: string | null | undefined
|
|
1722
|
+
/**
|
|
1723
|
+
* Property keys associated with the access grant.
|
|
1724
|
+
*/
|
|
1725
|
+
property_keys?: Array<string> | undefined
|
|
1726
|
+
/**
|
|
1727
|
+
* Resident key associated with the access grant.
|
|
1728
|
+
*/
|
|
1729
|
+
resident_key?: string | undefined
|
|
1730
|
+
/**
|
|
1731
|
+
* Room keys associated with the access grant.
|
|
1732
|
+
*/
|
|
1733
|
+
room_keys?: Array<string> | undefined
|
|
1734
|
+
/**
|
|
1735
|
+
* Space keys associated with the access grant.
|
|
1736
|
+
*/
|
|
1737
|
+
space_keys?: Array<string> | undefined
|
|
1738
|
+
/**
|
|
1739
|
+
* Starting date and time for the access grant.
|
|
1740
|
+
*/
|
|
1741
|
+
starts_at?: string | Date | Temporal.Instant | undefined
|
|
1742
|
+
/**
|
|
1743
|
+
* Your identifier for the sub-reservation. Must be unique across all your reservations and sub-reservations, and stay with the same reservation.
|
|
1744
|
+
*/
|
|
1745
|
+
sub_reservation_key?: string | undefined
|
|
1746
|
+
/**
|
|
1747
|
+
* Tenant key associated with the access grant.
|
|
1748
|
+
*/
|
|
1749
|
+
tenant_key?: string | undefined
|
|
1750
|
+
/**
|
|
1751
|
+
* Unit keys associated with the access grant.
|
|
1752
|
+
*/
|
|
1753
|
+
unit_keys?: Array<string> | undefined
|
|
1754
|
+
/**
|
|
1755
|
+
* User identity key associated with the access grant.
|
|
1756
|
+
*/
|
|
1757
|
+
user_identity_key?: string | undefined
|
|
1758
|
+
/**
|
|
1759
|
+
* User key associated with the access grant.
|
|
1760
|
+
*/
|
|
1761
|
+
user_key?: string | undefined
|
|
1762
|
+
}>
|
|
1763
|
+
| undefined
|
|
1589
1764
|
/**
|
|
1590
1765
|
* Tenant key associated with the access grant.
|
|
1591
1766
|
*/
|
|
@@ -357,6 +357,8 @@ export type DevicesListParameters = {
|
|
|
357
357
|
| 'smartthings_lock'
|
|
358
358
|
| 'wyze_lock'
|
|
359
359
|
| 'yale_lock'
|
|
360
|
+
| 'yale_access_lock'
|
|
361
|
+
| 'yale_home_lock'
|
|
360
362
|
| 'two_n_intercom'
|
|
361
363
|
| 'controlbyweb_device'
|
|
362
364
|
| 'ttlock_lock'
|
|
@@ -387,6 +389,7 @@ export type DevicesListParameters = {
|
|
|
387
389
|
| 'tapo_camera'
|
|
388
390
|
| 'arlo_camera'
|
|
389
391
|
| 'reolink_camera'
|
|
392
|
+
| 'unifi_protect_camera'
|
|
390
393
|
| 'sonos_speaker'
|
|
391
394
|
| undefined
|
|
392
395
|
/**
|
|
@@ -411,6 +414,8 @@ export type DevicesListParameters = {
|
|
|
411
414
|
| 'smartthings_lock'
|
|
412
415
|
| 'wyze_lock'
|
|
413
416
|
| 'yale_lock'
|
|
417
|
+
| 'yale_access_lock'
|
|
418
|
+
| 'yale_home_lock'
|
|
414
419
|
| 'two_n_intercom'
|
|
415
420
|
| 'controlbyweb_device'
|
|
416
421
|
| 'ttlock_lock'
|
|
@@ -441,6 +446,7 @@ export type DevicesListParameters = {
|
|
|
441
446
|
| 'tapo_camera'
|
|
442
447
|
| 'arlo_camera'
|
|
443
448
|
| 'reolink_camera'
|
|
449
|
+
| 'unifi_protect_camera'
|
|
444
450
|
| 'sonos_speaker'
|
|
445
451
|
>
|
|
446
452
|
| undefined
|
|
@@ -479,6 +485,7 @@ export type DevicesListParameters = {
|
|
|
479
485
|
| 'controlbyweb'
|
|
480
486
|
| 'tedee'
|
|
481
487
|
| 'keyincode'
|
|
488
|
+
| 'ubiquiti'
|
|
482
489
|
| 'akiles'
|
|
483
490
|
| 'aqara'
|
|
484
491
|
| 'ecobee'
|
|
@@ -500,6 +507,7 @@ export type DevicesListParameters = {
|
|
|
500
507
|
| 'tapo'
|
|
501
508
|
| 'arlo'
|
|
502
509
|
| 'reolink'
|
|
510
|
+
| 'unifi_protect'
|
|
503
511
|
| 'ical'
|
|
504
512
|
| 'lodgify'
|
|
505
513
|
| 'hostaway'
|
|
@@ -304,6 +304,8 @@ export type DevicesUnmanagedListParameters = {
|
|
|
304
304
|
| 'smartthings_lock'
|
|
305
305
|
| 'wyze_lock'
|
|
306
306
|
| 'yale_lock'
|
|
307
|
+
| 'yale_access_lock'
|
|
308
|
+
| 'yale_home_lock'
|
|
307
309
|
| 'two_n_intercom'
|
|
308
310
|
| 'controlbyweb_device'
|
|
309
311
|
| 'ttlock_lock'
|
|
@@ -334,6 +336,7 @@ export type DevicesUnmanagedListParameters = {
|
|
|
334
336
|
| 'tapo_camera'
|
|
335
337
|
| 'arlo_camera'
|
|
336
338
|
| 'reolink_camera'
|
|
339
|
+
| 'unifi_protect_camera'
|
|
337
340
|
| 'sonos_speaker'
|
|
338
341
|
| undefined
|
|
339
342
|
/**
|
|
@@ -358,6 +361,8 @@ export type DevicesUnmanagedListParameters = {
|
|
|
358
361
|
| 'smartthings_lock'
|
|
359
362
|
| 'wyze_lock'
|
|
360
363
|
| 'yale_lock'
|
|
364
|
+
| 'yale_access_lock'
|
|
365
|
+
| 'yale_home_lock'
|
|
361
366
|
| 'two_n_intercom'
|
|
362
367
|
| 'controlbyweb_device'
|
|
363
368
|
| 'ttlock_lock'
|
|
@@ -388,6 +393,7 @@ export type DevicesUnmanagedListParameters = {
|
|
|
388
393
|
| 'tapo_camera'
|
|
389
394
|
| 'arlo_camera'
|
|
390
395
|
| 'reolink_camera'
|
|
396
|
+
| 'unifi_protect_camera'
|
|
391
397
|
| 'sonos_speaker'
|
|
392
398
|
>
|
|
393
399
|
| undefined
|
|
@@ -426,6 +432,7 @@ export type DevicesUnmanagedListParameters = {
|
|
|
426
432
|
| 'controlbyweb'
|
|
427
433
|
| 'tedee'
|
|
428
434
|
| 'keyincode'
|
|
435
|
+
| 'ubiquiti'
|
|
429
436
|
| 'akiles'
|
|
430
437
|
| 'aqara'
|
|
431
438
|
| 'ecobee'
|
|
@@ -447,6 +454,7 @@ export type DevicesUnmanagedListParameters = {
|
|
|
447
454
|
| 'tapo'
|
|
448
455
|
| 'arlo'
|
|
449
456
|
| 'reolink'
|
|
457
|
+
| 'unifi_protect'
|
|
450
458
|
| 'ical'
|
|
451
459
|
| 'lodgify'
|
|
452
460
|
| 'hostaway'
|