@seamapi/types 1.1144.0 → 1.1146.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/seam/connect/models/access-codes/managed-access-code.d.ts +92 -92
- package/lib/seam/connect/models/access-codes/managed-access-code.js +23 -37
- package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
- package/lib/seam/connect/models/access-grants/access-grant.d.ts +44 -44
- package/lib/seam/connect/models/access-grants/access-grant.js +11 -16
- package/lib/seam/connect/models/access-grants/access-grant.js.map +1 -1
- package/lib/seam/connect/models/access-grants/access-method.d.ts +40 -40
- package/lib/seam/connect/models/access-grants/access-method.js +10 -16
- package/lib/seam/connect/models/access-grants/access-method.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-access-group.d.ts +12 -12
- package/lib/seam/connect/models/acs/acs-access-group.js +3 -5
- package/lib/seam/connect/models/acs/acs-access-group.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-credential.d.ts +32 -32
- package/lib/seam/connect/models/acs/acs-credential.js +8 -12
- package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-encoder.d.ts +4 -4
- package/lib/seam/connect/models/acs/acs-encoder.js +1 -1
- package/lib/seam/connect/models/acs/acs-encoder.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-entrance.d.ts +24 -24
- package/lib/seam/connect/models/acs/acs-entrance.js +6 -6
- package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-system.d.ts +56 -56
- package/lib/seam/connect/models/acs/acs-system.js +14 -26
- package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-users/acs-user.d.ts +44 -44
- package/lib/seam/connect/models/acs/acs-users/acs-user.js +11 -23
- package/lib/seam/connect/models/acs/acs-users/acs-user.js.map +1 -1
- package/lib/seam/connect/models/bridges/bridge-client-session.d.ts +8 -8
- package/lib/seam/connect/models/bridges/bridge-client-session.js +2 -4
- package/lib/seam/connect/models/bridges/bridge-client-session.js.map +1 -1
- package/lib/seam/connect/models/connected-accounts/connected-account.d.ts +48 -48
- package/lib/seam/connect/models/connected-accounts/connected-account.js +12 -24
- package/lib/seam/connect/models/connected-accounts/connected-account.js.map +1 -1
- package/lib/seam/connect/models/customer/access-grant-resources.d.ts +276 -0
- package/lib/seam/connect/models/customer/access-grant-resources.js +19 -0
- package/lib/seam/connect/models/customer/access-grant-resources.js.map +1 -1
- package/lib/seam/connect/models/customer/customer-data.d.ts +296 -0
- package/lib/seam/connect/models/devices/device.d.ts +168 -168
- package/lib/seam/connect/models/devices/device.js +42 -70
- package/lib/seam/connect/models/devices/device.js.map +1 -1
- package/lib/seam/connect/models/spaces/space.d.ts +8 -8
- package/lib/seam/connect/models/spaces/space.js +2 -4
- package/lib/seam/connect/models/spaces/space.js.map +1 -1
- package/lib/seam/connect/models/user-identities/user-identity.d.ts +12 -12
- package/lib/seam/connect/models/user-identities/user-identity.js +2 -3
- package/lib/seam/connect/models/user-identities/user-identity.js.map +1 -1
- package/lib/seam/connect/openapi.js +210 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +86 -0
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +26 -37
- package/src/lib/seam/connect/models/access-grants/access-grant.ts +11 -16
- package/src/lib/seam/connect/models/access-grants/access-method.ts +11 -16
- package/src/lib/seam/connect/models/acs/acs-access-group.ts +4 -5
- package/src/lib/seam/connect/models/acs/acs-credential.ts +9 -12
- package/src/lib/seam/connect/models/acs/acs-encoder.ts +1 -1
- package/src/lib/seam/connect/models/acs/acs-entrance.ts +6 -6
- package/src/lib/seam/connect/models/acs/acs-system.ts +16 -26
- package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts +16 -23
- package/src/lib/seam/connect/models/bridges/bridge-client-session.ts +2 -4
- package/src/lib/seam/connect/models/connected-accounts/connected-account.ts +15 -24
- package/src/lib/seam/connect/models/customer/access-grant-resources.ts +26 -0
- package/src/lib/seam/connect/models/devices/device.ts +43 -70
- package/src/lib/seam/connect/models/spaces/space.ts +3 -4
- package/src/lib/seam/connect/models/user-identities/user-identity.ts +2 -3
- package/src/lib/seam/connect/openapi.ts +250 -0
- package/src/lib/seam/connect/route-types.ts +94 -0
|
@@ -383,25 +383,20 @@ export const device_error = z
|
|
|
383
383
|
export type DeviceError = z.infer<typeof device_error>
|
|
384
384
|
|
|
385
385
|
export const device_error_map = z.object({
|
|
386
|
-
device_offline: device_offline.optional()
|
|
387
|
-
device_removed: device_removed.optional()
|
|
388
|
-
hub_disconnected: hub_disconnected.optional()
|
|
389
|
-
device_disconnected: device_disconnected.optional()
|
|
390
|
-
account_disconnected: account_disconnected.optional()
|
|
391
|
-
empty_backup_access_code_pool: empty_backup_access_code_pool
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
.optional()
|
|
401
|
-
.nullable(),
|
|
402
|
-
missing_device_credentials: missing_device_credentials.optional().nullable(),
|
|
403
|
-
auxiliary_heat_running: auxiliary_heat_running.optional().nullable(),
|
|
404
|
-
subscription_required: subscription_required.optional().nullable(),
|
|
386
|
+
device_offline: device_offline.optional(),
|
|
387
|
+
device_removed: device_removed.optional(),
|
|
388
|
+
hub_disconnected: hub_disconnected.optional(),
|
|
389
|
+
device_disconnected: device_disconnected.optional(),
|
|
390
|
+
account_disconnected: account_disconnected.optional(),
|
|
391
|
+
empty_backup_access_code_pool: empty_backup_access_code_pool.optional(),
|
|
392
|
+
august_lock_not_authorized: august_lock_not_authorized.optional(),
|
|
393
|
+
salto_ks_subscription_limit_exceeded:
|
|
394
|
+
salto_ks_subscription_limit_exceeded.optional(),
|
|
395
|
+
insufficient_permissions: insufficient_permissions.optional(),
|
|
396
|
+
dormakaba_sites_disconnected: dormakaba_sites_disconnected.optional(),
|
|
397
|
+
missing_device_credentials: missing_device_credentials.optional(),
|
|
398
|
+
auxiliary_heat_running: auxiliary_heat_running.optional(),
|
|
399
|
+
subscription_required: subscription_required.optional(),
|
|
405
400
|
})
|
|
406
401
|
|
|
407
402
|
export type DeviceErrorMap = z.infer<typeof device_error_map>
|
|
@@ -770,61 +765,39 @@ const device_warning = z.discriminatedUnion('warning_code', [
|
|
|
770
765
|
export type DeviceWarning = z.infer<typeof device_warning>
|
|
771
766
|
|
|
772
767
|
export const device_warning_map = z.object({
|
|
773
|
-
partial_backup_access_code_pool: partial_backup_access_code_pool
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
|
|
777
|
-
device_has_flaky_connection: device_has_flaky_connection
|
|
778
|
-
.optional()
|
|
779
|
-
.nullable(),
|
|
780
|
-
third_party_integration_detected: third_party_integration_detected
|
|
781
|
-
.optional()
|
|
782
|
-
.nullable(),
|
|
768
|
+
partial_backup_access_code_pool: partial_backup_access_code_pool.optional(),
|
|
769
|
+
many_active_backup_codes: many_active_backup_codes.optional(),
|
|
770
|
+
device_has_flaky_connection: device_has_flaky_connection.optional(),
|
|
771
|
+
third_party_integration_detected: third_party_integration_detected.optional(),
|
|
783
772
|
ttlock_lock_gateway_unlocking_not_enabled:
|
|
784
|
-
ttlock_lock_gateway_unlocking_not_enabled.optional()
|
|
785
|
-
ttlock_weak_gateway_signal: ttlock_weak_gateway_signal.optional()
|
|
786
|
-
power_saving_mode: power_saving_mode.optional()
|
|
787
|
-
temperature_threshold_exceeded: temperature_threshold_exceeded
|
|
788
|
-
|
|
789
|
-
|
|
790
|
-
|
|
791
|
-
|
|
792
|
-
|
|
793
|
-
scheduled_maintenance_window: scheduled_maintenance_window
|
|
794
|
-
.optional()
|
|
795
|
-
.nullable(),
|
|
796
|
-
salto_ks_office_mode: salto_ks_office_mode.optional().nullable(),
|
|
797
|
-
salto_ks_privacy_mode: salto_ks_privacy_mode.optional().nullable(),
|
|
798
|
-
privacy_mode: privacy_mode.optional().nullable(),
|
|
773
|
+
ttlock_lock_gateway_unlocking_not_enabled.optional(),
|
|
774
|
+
ttlock_weak_gateway_signal: ttlock_weak_gateway_signal.optional(),
|
|
775
|
+
power_saving_mode: power_saving_mode.optional(),
|
|
776
|
+
temperature_threshold_exceeded: temperature_threshold_exceeded.optional(),
|
|
777
|
+
device_communication_degraded: device_communication_degraded.optional(),
|
|
778
|
+
scheduled_maintenance_window: scheduled_maintenance_window.optional(),
|
|
779
|
+
salto_ks_office_mode: salto_ks_office_mode.optional(),
|
|
780
|
+
salto_ks_privacy_mode: salto_ks_privacy_mode.optional(),
|
|
781
|
+
privacy_mode: privacy_mode.optional(),
|
|
799
782
|
salto_ks_subscription_limit_almost_reached:
|
|
800
|
-
salto_ks_subscription_limit_almost_reached.optional()
|
|
783
|
+
salto_ks_subscription_limit_almost_reached.optional(),
|
|
801
784
|
salto_ks_lock_access_code_support_removed:
|
|
802
|
-
salto_ks_lock_access_code_support_removed.optional()
|
|
803
|
-
unknown_issue_with_phone: unknown_issue_with_phone.optional()
|
|
804
|
-
lockly_time_zone_not_configured: lockly_time_zone_not_configured
|
|
805
|
-
|
|
806
|
-
|
|
807
|
-
|
|
808
|
-
|
|
809
|
-
time_zone_mismatch: time_zone_mismatch.optional().nullable(),
|
|
810
|
-
two_n_device_missing_timezone: two_n_device_missing_timezone
|
|
811
|
-
.optional()
|
|
812
|
-
.nullable(),
|
|
785
|
+
salto_ks_lock_access_code_support_removed.optional(),
|
|
786
|
+
unknown_issue_with_phone: unknown_issue_with_phone.optional(),
|
|
787
|
+
lockly_time_zone_not_configured: lockly_time_zone_not_configured.optional(),
|
|
788
|
+
ultraloq_time_zone_unknown: ultraloq_time_zone_unknown.optional(),
|
|
789
|
+
time_zone_unknown: time_zone_unknown.optional(),
|
|
790
|
+
time_zone_mismatch: time_zone_mismatch.optional(),
|
|
791
|
+
two_n_device_missing_timezone: two_n_device_missing_timezone.optional(),
|
|
813
792
|
hub_required_for_additional_capabilities:
|
|
814
|
-
hub_required_for_additional_capabilities.optional()
|
|
815
|
-
provider_issue: provider_issue.optional()
|
|
816
|
-
keynest_unsupported_locker: keynest_unsupported_locker.optional()
|
|
817
|
-
accessory_keypad_setup_required: accessory_keypad_setup_required
|
|
818
|
-
|
|
819
|
-
|
|
820
|
-
|
|
821
|
-
|
|
822
|
-
.nullable(),
|
|
823
|
-
unreliable_online_status: unreliable_online_status.optional().nullable(),
|
|
824
|
-
max_access_codes_reached: max_access_codes_reached.optional().nullable(),
|
|
825
|
-
cloud_recording_not_enabled: cloud_recording_not_enabled
|
|
826
|
-
.optional()
|
|
827
|
-
.nullable(),
|
|
793
|
+
hub_required_for_additional_capabilities.optional(),
|
|
794
|
+
provider_issue: provider_issue.optional(),
|
|
795
|
+
keynest_unsupported_locker: keynest_unsupported_locker.optional(),
|
|
796
|
+
accessory_keypad_setup_required: accessory_keypad_setup_required.optional(),
|
|
797
|
+
accessory_keypad_low_battery: accessory_keypad_low_battery.optional(),
|
|
798
|
+
unreliable_online_status: unreliable_online_status.optional(),
|
|
799
|
+
max_access_codes_reached: max_access_codes_reached.optional(),
|
|
800
|
+
cloud_recording_not_enabled: cloud_recording_not_enabled.optional(),
|
|
828
801
|
})
|
|
829
802
|
|
|
830
803
|
export type DeviceWarningMap = z.infer<typeof device_warning_map>
|
|
@@ -82,10 +82,9 @@ const space_warning = z
|
|
|
82
82
|
.describe('Warning associated with the space.')
|
|
83
83
|
|
|
84
84
|
const _space_warning_map = z.object({
|
|
85
|
-
being_deleted: space_being_deleted.optional()
|
|
86
|
-
noise_sensor_configuration_mismatch:
|
|
87
|
-
.optional()
|
|
88
|
-
.nullable(),
|
|
85
|
+
being_deleted: space_being_deleted.optional(),
|
|
86
|
+
noise_sensor_configuration_mismatch:
|
|
87
|
+
space_noise_sensor_configuration_mismatch.optional(),
|
|
89
88
|
})
|
|
90
89
|
|
|
91
90
|
export type SpaceWarningMap = z.infer<typeof _space_warning_map>
|
|
@@ -75,7 +75,6 @@ const _user_identity_error_map = z.object({
|
|
|
75
75
|
issue_with_acs_user: z
|
|
76
76
|
.record(z.string().uuid(), user_identity_issue_with_acs_user)
|
|
77
77
|
.optional()
|
|
78
|
-
.nullable()
|
|
79
78
|
.describe(
|
|
80
79
|
'Map of access system user IDs to issues with the access system user. The key is the access system user ID, and the value is the issue with the access system user.',
|
|
81
80
|
),
|
|
@@ -91,9 +90,9 @@ const user_identity_warning = z
|
|
|
91
90
|
.describe('Warnings associated with the user identity.')
|
|
92
91
|
|
|
93
92
|
const _user_identity_warning_map = z.object({
|
|
94
|
-
being_deleted: user_identity_being_deleted.optional()
|
|
93
|
+
being_deleted: user_identity_being_deleted.optional(),
|
|
95
94
|
acs_user_profile_does_not_match_user_identity:
|
|
96
|
-
acs_user_profile_does_not_match_user_identity.optional()
|
|
95
|
+
acs_user_profile_does_not_match_user_identity.optional(),
|
|
97
96
|
})
|
|
98
97
|
|
|
99
98
|
export type UserIdentityWarningMap = z.infer<typeof _user_identity_warning_map>
|
|
@@ -53601,6 +53601,131 @@ const openapi: OpenAPISpec = {
|
|
|
53601
53601
|
format: 'date-time',
|
|
53602
53602
|
type: 'string',
|
|
53603
53603
|
},
|
|
53604
|
+
sub_reservations: {
|
|
53605
|
+
description:
|
|
53606
|
+
"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.",
|
|
53607
|
+
items: {
|
|
53608
|
+
properties: {
|
|
53609
|
+
building_keys: {
|
|
53610
|
+
description:
|
|
53611
|
+
'Building keys associated with the access grant.',
|
|
53612
|
+
items: { type: 'string' },
|
|
53613
|
+
type: 'array',
|
|
53614
|
+
},
|
|
53615
|
+
common_area_keys: {
|
|
53616
|
+
description:
|
|
53617
|
+
'Common area keys associated with the access grant.',
|
|
53618
|
+
items: { type: 'string' },
|
|
53619
|
+
type: 'array',
|
|
53620
|
+
},
|
|
53621
|
+
custom_metadata: {
|
|
53622
|
+
additionalProperties: {
|
|
53623
|
+
nullable: true,
|
|
53624
|
+
oneOf: [
|
|
53625
|
+
{ maxLength: 500, type: 'string' },
|
|
53626
|
+
{ type: 'boolean' },
|
|
53627
|
+
],
|
|
53628
|
+
},
|
|
53629
|
+
description:
|
|
53630
|
+
"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.",
|
|
53631
|
+
type: 'object',
|
|
53632
|
+
},
|
|
53633
|
+
ends_at: {
|
|
53634
|
+
description:
|
|
53635
|
+
'Ending date and time for the access grant.',
|
|
53636
|
+
format: 'date-time',
|
|
53637
|
+
type: 'string',
|
|
53638
|
+
},
|
|
53639
|
+
facility_keys: {
|
|
53640
|
+
description:
|
|
53641
|
+
'Facility keys associated with the access grant.',
|
|
53642
|
+
items: { type: 'string' },
|
|
53643
|
+
type: 'array',
|
|
53644
|
+
},
|
|
53645
|
+
guest_key: {
|
|
53646
|
+
description:
|
|
53647
|
+
'Guest key associated with the access grant.',
|
|
53648
|
+
type: 'string',
|
|
53649
|
+
},
|
|
53650
|
+
listing_keys: {
|
|
53651
|
+
description:
|
|
53652
|
+
'Listing keys associated with the access grant.',
|
|
53653
|
+
items: { type: 'string' },
|
|
53654
|
+
type: 'array',
|
|
53655
|
+
},
|
|
53656
|
+
name: {
|
|
53657
|
+
description:
|
|
53658
|
+
'Your name for this access grant resource.',
|
|
53659
|
+
type: 'string',
|
|
53660
|
+
},
|
|
53661
|
+
preferred_code: {
|
|
53662
|
+
description:
|
|
53663
|
+
'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.',
|
|
53664
|
+
nullable: true,
|
|
53665
|
+
type: 'string',
|
|
53666
|
+
},
|
|
53667
|
+
property_keys: {
|
|
53668
|
+
description:
|
|
53669
|
+
'Property keys associated with the access grant.',
|
|
53670
|
+
items: { type: 'string' },
|
|
53671
|
+
type: 'array',
|
|
53672
|
+
},
|
|
53673
|
+
resident_key: {
|
|
53674
|
+
description:
|
|
53675
|
+
'Resident key associated with the access grant.',
|
|
53676
|
+
type: 'string',
|
|
53677
|
+
},
|
|
53678
|
+
room_keys: {
|
|
53679
|
+
description:
|
|
53680
|
+
'Room keys associated with the access grant.',
|
|
53681
|
+
items: { type: 'string' },
|
|
53682
|
+
type: 'array',
|
|
53683
|
+
},
|
|
53684
|
+
space_keys: {
|
|
53685
|
+
description:
|
|
53686
|
+
'Space keys associated with the access grant.',
|
|
53687
|
+
items: { type: 'string' },
|
|
53688
|
+
type: 'array',
|
|
53689
|
+
},
|
|
53690
|
+
starts_at: {
|
|
53691
|
+
description:
|
|
53692
|
+
'Starting date and time for the access grant.',
|
|
53693
|
+
format: 'date-time',
|
|
53694
|
+
type: 'string',
|
|
53695
|
+
},
|
|
53696
|
+
sub_reservation_key: {
|
|
53697
|
+
description:
|
|
53698
|
+
'Your identifier for the sub-reservation. Must be unique within its reservation.',
|
|
53699
|
+
minLength: 1,
|
|
53700
|
+
type: 'string',
|
|
53701
|
+
},
|
|
53702
|
+
tenant_key: {
|
|
53703
|
+
description:
|
|
53704
|
+
'Tenant key associated with the access grant.',
|
|
53705
|
+
type: 'string',
|
|
53706
|
+
},
|
|
53707
|
+
unit_keys: {
|
|
53708
|
+
description:
|
|
53709
|
+
'Unit keys associated with the access grant.',
|
|
53710
|
+
items: { type: 'string' },
|
|
53711
|
+
type: 'array',
|
|
53712
|
+
},
|
|
53713
|
+
user_identity_key: {
|
|
53714
|
+
description:
|
|
53715
|
+
'User identity key associated with the access grant.',
|
|
53716
|
+
type: 'string',
|
|
53717
|
+
},
|
|
53718
|
+
user_key: {
|
|
53719
|
+
description:
|
|
53720
|
+
'User key associated with the access grant.',
|
|
53721
|
+
type: 'string',
|
|
53722
|
+
},
|
|
53723
|
+
},
|
|
53724
|
+
required: ['sub_reservation_key'],
|
|
53725
|
+
type: 'object',
|
|
53726
|
+
},
|
|
53727
|
+
type: 'array',
|
|
53728
|
+
},
|
|
53604
53729
|
tenant_key: {
|
|
53605
53730
|
description:
|
|
53606
53731
|
'Tenant key associated with the access grant.',
|
|
@@ -54793,6 +54918,131 @@ const openapi: OpenAPISpec = {
|
|
|
54793
54918
|
format: 'date-time',
|
|
54794
54919
|
type: 'string',
|
|
54795
54920
|
},
|
|
54921
|
+
sub_reservations: {
|
|
54922
|
+
description:
|
|
54923
|
+
"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.",
|
|
54924
|
+
items: {
|
|
54925
|
+
properties: {
|
|
54926
|
+
building_keys: {
|
|
54927
|
+
description:
|
|
54928
|
+
'Building keys associated with the access grant.',
|
|
54929
|
+
items: { type: 'string' },
|
|
54930
|
+
type: 'array',
|
|
54931
|
+
},
|
|
54932
|
+
common_area_keys: {
|
|
54933
|
+
description:
|
|
54934
|
+
'Common area keys associated with the access grant.',
|
|
54935
|
+
items: { type: 'string' },
|
|
54936
|
+
type: 'array',
|
|
54937
|
+
},
|
|
54938
|
+
custom_metadata: {
|
|
54939
|
+
additionalProperties: {
|
|
54940
|
+
nullable: true,
|
|
54941
|
+
oneOf: [
|
|
54942
|
+
{ maxLength: 500, type: 'string' },
|
|
54943
|
+
{ type: 'boolean' },
|
|
54944
|
+
],
|
|
54945
|
+
},
|
|
54946
|
+
description:
|
|
54947
|
+
"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.",
|
|
54948
|
+
type: 'object',
|
|
54949
|
+
},
|
|
54950
|
+
ends_at: {
|
|
54951
|
+
description:
|
|
54952
|
+
'Ending date and time for the access grant.',
|
|
54953
|
+
format: 'date-time',
|
|
54954
|
+
type: 'string',
|
|
54955
|
+
},
|
|
54956
|
+
facility_keys: {
|
|
54957
|
+
description:
|
|
54958
|
+
'Facility keys associated with the access grant.',
|
|
54959
|
+
items: { type: 'string' },
|
|
54960
|
+
type: 'array',
|
|
54961
|
+
},
|
|
54962
|
+
guest_key: {
|
|
54963
|
+
description:
|
|
54964
|
+
'Guest key associated with the access grant.',
|
|
54965
|
+
type: 'string',
|
|
54966
|
+
},
|
|
54967
|
+
listing_keys: {
|
|
54968
|
+
description:
|
|
54969
|
+
'Listing keys associated with the access grant.',
|
|
54970
|
+
items: { type: 'string' },
|
|
54971
|
+
type: 'array',
|
|
54972
|
+
},
|
|
54973
|
+
name: {
|
|
54974
|
+
description:
|
|
54975
|
+
'Your name for this access grant resource.',
|
|
54976
|
+
type: 'string',
|
|
54977
|
+
},
|
|
54978
|
+
preferred_code: {
|
|
54979
|
+
description:
|
|
54980
|
+
'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.',
|
|
54981
|
+
nullable: true,
|
|
54982
|
+
type: 'string',
|
|
54983
|
+
},
|
|
54984
|
+
property_keys: {
|
|
54985
|
+
description:
|
|
54986
|
+
'Property keys associated with the access grant.',
|
|
54987
|
+
items: { type: 'string' },
|
|
54988
|
+
type: 'array',
|
|
54989
|
+
},
|
|
54990
|
+
resident_key: {
|
|
54991
|
+
description:
|
|
54992
|
+
'Resident key associated with the access grant.',
|
|
54993
|
+
type: 'string',
|
|
54994
|
+
},
|
|
54995
|
+
room_keys: {
|
|
54996
|
+
description:
|
|
54997
|
+
'Room keys associated with the access grant.',
|
|
54998
|
+
items: { type: 'string' },
|
|
54999
|
+
type: 'array',
|
|
55000
|
+
},
|
|
55001
|
+
space_keys: {
|
|
55002
|
+
description:
|
|
55003
|
+
'Space keys associated with the access grant.',
|
|
55004
|
+
items: { type: 'string' },
|
|
55005
|
+
type: 'array',
|
|
55006
|
+
},
|
|
55007
|
+
starts_at: {
|
|
55008
|
+
description:
|
|
55009
|
+
'Starting date and time for the access grant.',
|
|
55010
|
+
format: 'date-time',
|
|
55011
|
+
type: 'string',
|
|
55012
|
+
},
|
|
55013
|
+
sub_reservation_key: {
|
|
55014
|
+
description:
|
|
55015
|
+
'Your identifier for the sub-reservation. Must be unique within its reservation.',
|
|
55016
|
+
minLength: 1,
|
|
55017
|
+
type: 'string',
|
|
55018
|
+
},
|
|
55019
|
+
tenant_key: {
|
|
55020
|
+
description:
|
|
55021
|
+
'Tenant key associated with the access grant.',
|
|
55022
|
+
type: 'string',
|
|
55023
|
+
},
|
|
55024
|
+
unit_keys: {
|
|
55025
|
+
description:
|
|
55026
|
+
'Unit keys associated with the access grant.',
|
|
55027
|
+
items: { type: 'string' },
|
|
55028
|
+
type: 'array',
|
|
55029
|
+
},
|
|
55030
|
+
user_identity_key: {
|
|
55031
|
+
description:
|
|
55032
|
+
'User identity key associated with the access grant.',
|
|
55033
|
+
type: 'string',
|
|
55034
|
+
},
|
|
55035
|
+
user_key: {
|
|
55036
|
+
description:
|
|
55037
|
+
'User key associated with the access grant.',
|
|
55038
|
+
type: 'string',
|
|
55039
|
+
},
|
|
55040
|
+
},
|
|
55041
|
+
required: ['sub_reservation_key'],
|
|
55042
|
+
type: 'object',
|
|
55043
|
+
},
|
|
55044
|
+
type: 'array',
|
|
55045
|
+
},
|
|
54796
55046
|
tenant_key: {
|
|
54797
55047
|
description:
|
|
54798
55048
|
'Tenant key associated with the access grant.',
|
|
@@ -57159,6 +57159,53 @@ export type Routes = {
|
|
|
57159
57159
|
[x: string]: string | boolean | null
|
|
57160
57160
|
}
|
|
57161
57161
|
| undefined
|
|
57162
|
+
/** 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. */
|
|
57163
|
+
sub_reservations?:
|
|
57164
|
+
| {
|
|
57165
|
+
/** Your name for this access grant resource. */
|
|
57166
|
+
name?: string | undefined
|
|
57167
|
+
/** Starting date and time for the access grant. */
|
|
57168
|
+
starts_at?: string | undefined
|
|
57169
|
+
/** Ending date and time for the access grant. */
|
|
57170
|
+
ends_at?: string | undefined
|
|
57171
|
+
/** 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. */
|
|
57172
|
+
preferred_code?: (string | null) | undefined
|
|
57173
|
+
/** Your identifier for the sub-reservation. Must be unique within its reservation. */
|
|
57174
|
+
sub_reservation_key: string
|
|
57175
|
+
/** 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. */
|
|
57176
|
+
custom_metadata?:
|
|
57177
|
+
| {
|
|
57178
|
+
[x: string]: string | boolean | null
|
|
57179
|
+
}
|
|
57180
|
+
| undefined
|
|
57181
|
+
/** Guest key associated with the access grant. */
|
|
57182
|
+
guest_key?: string | undefined
|
|
57183
|
+
/** Tenant key associated with the access grant. */
|
|
57184
|
+
tenant_key?: string | undefined
|
|
57185
|
+
/** Resident key associated with the access grant. */
|
|
57186
|
+
resident_key?: string | undefined
|
|
57187
|
+
/** User key associated with the access grant. */
|
|
57188
|
+
user_key?: string | undefined
|
|
57189
|
+
/** User identity key associated with the access grant. */
|
|
57190
|
+
user_identity_key?: string | undefined
|
|
57191
|
+
/** Space keys associated with the access grant. */
|
|
57192
|
+
space_keys?: string[] | undefined
|
|
57193
|
+
/** Property keys associated with the access grant. */
|
|
57194
|
+
property_keys?: string[] | undefined
|
|
57195
|
+
/** Room keys associated with the access grant. */
|
|
57196
|
+
room_keys?: string[] | undefined
|
|
57197
|
+
/** Common area keys associated with the access grant. */
|
|
57198
|
+
common_area_keys?: string[] | undefined
|
|
57199
|
+
/** Unit keys associated with the access grant. */
|
|
57200
|
+
unit_keys?: string[] | undefined
|
|
57201
|
+
/** Facility keys associated with the access grant. */
|
|
57202
|
+
facility_keys?: string[] | undefined
|
|
57203
|
+
/** Building keys associated with the access grant. */
|
|
57204
|
+
building_keys?: string[] | undefined
|
|
57205
|
+
/** Listing keys associated with the access grant. */
|
|
57206
|
+
listing_keys?: string[] | undefined
|
|
57207
|
+
}[]
|
|
57208
|
+
| undefined
|
|
57162
57209
|
/** Guest key associated with the access grant. */
|
|
57163
57210
|
guest_key?: string | undefined
|
|
57164
57211
|
/** Tenant key associated with the access grant. */
|
|
@@ -57617,6 +57664,53 @@ export type Routes = {
|
|
|
57617
57664
|
[x: string]: string | boolean | null
|
|
57618
57665
|
}
|
|
57619
57666
|
| undefined
|
|
57667
|
+
/** 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. */
|
|
57668
|
+
sub_reservations?:
|
|
57669
|
+
| {
|
|
57670
|
+
/** Your name for this access grant resource. */
|
|
57671
|
+
name?: string | undefined
|
|
57672
|
+
/** Starting date and time for the access grant. */
|
|
57673
|
+
starts_at?: string | undefined
|
|
57674
|
+
/** Ending date and time for the access grant. */
|
|
57675
|
+
ends_at?: string | undefined
|
|
57676
|
+
/** 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. */
|
|
57677
|
+
preferred_code?: (string | null) | undefined
|
|
57678
|
+
/** Your identifier for the sub-reservation. Must be unique within its reservation. */
|
|
57679
|
+
sub_reservation_key: string
|
|
57680
|
+
/** 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. */
|
|
57681
|
+
custom_metadata?:
|
|
57682
|
+
| {
|
|
57683
|
+
[x: string]: string | boolean | null
|
|
57684
|
+
}
|
|
57685
|
+
| undefined
|
|
57686
|
+
/** Guest key associated with the access grant. */
|
|
57687
|
+
guest_key?: string | undefined
|
|
57688
|
+
/** Tenant key associated with the access grant. */
|
|
57689
|
+
tenant_key?: string | undefined
|
|
57690
|
+
/** Resident key associated with the access grant. */
|
|
57691
|
+
resident_key?: string | undefined
|
|
57692
|
+
/** User key associated with the access grant. */
|
|
57693
|
+
user_key?: string | undefined
|
|
57694
|
+
/** User identity key associated with the access grant. */
|
|
57695
|
+
user_identity_key?: string | undefined
|
|
57696
|
+
/** Space keys associated with the access grant. */
|
|
57697
|
+
space_keys?: string[] | undefined
|
|
57698
|
+
/** Property keys associated with the access grant. */
|
|
57699
|
+
property_keys?: string[] | undefined
|
|
57700
|
+
/** Room keys associated with the access grant. */
|
|
57701
|
+
room_keys?: string[] | undefined
|
|
57702
|
+
/** Common area keys associated with the access grant. */
|
|
57703
|
+
common_area_keys?: string[] | undefined
|
|
57704
|
+
/** Unit keys associated with the access grant. */
|
|
57705
|
+
unit_keys?: string[] | undefined
|
|
57706
|
+
/** Facility keys associated with the access grant. */
|
|
57707
|
+
facility_keys?: string[] | undefined
|
|
57708
|
+
/** Building keys associated with the access grant. */
|
|
57709
|
+
building_keys?: string[] | undefined
|
|
57710
|
+
/** Listing keys associated with the access grant. */
|
|
57711
|
+
listing_keys?: string[] | undefined
|
|
57712
|
+
}[]
|
|
57713
|
+
| undefined
|
|
57620
57714
|
/** Guest key associated with the access grant. */
|
|
57621
57715
|
guest_key?: string | undefined
|
|
57622
57716
|
/** Tenant key associated with the access grant. */
|