@seamapi/types 1.1101.0 → 1.1103.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.
Files changed (29) hide show
  1. package/lib/seam/connect/models/access-grants/access-grant.d.ts +37 -21
  2. package/lib/seam/connect/models/access-grants/access-grant.js +4 -3
  3. package/lib/seam/connect/models/access-grants/access-grant.js.map +1 -1
  4. package/lib/seam/connect/models/acs/acs-access-group.js +2 -2
  5. package/lib/seam/connect/models/acs/acs-access-group.js.map +1 -1
  6. package/lib/seam/connect/models/acs/acs-entrance.d.ts +38 -8
  7. package/lib/seam/connect/models/acs/acs-entrance.js +22 -9
  8. package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
  9. package/lib/seam/connect/models/acs/acs-users/acs-user.d.ts +75 -4
  10. package/lib/seam/connect/models/acs/acs-users/acs-user.js +32 -30
  11. package/lib/seam/connect/models/acs/acs-users/acs-user.js.map +1 -1
  12. package/lib/seam/connect/models/devices/phone.d.ts +1126 -22
  13. package/lib/seam/connect/models/devices/phone.js +4 -19
  14. package/lib/seam/connect/models/devices/phone.js.map +1 -1
  15. package/lib/seam/connect/models/phones/phone-session.d.ts +28 -26
  16. package/lib/seam/connect/models/user-identities/user-identity.js +4 -4
  17. package/lib/seam/connect/models/user-identities/user-identity.js.map +1 -1
  18. package/lib/seam/connect/openapi.js +1329 -214
  19. package/lib/seam/connect/openapi.js.map +1 -1
  20. package/lib/seam/connect/route-types.d.ts +1319 -353
  21. package/package.json +1 -1
  22. package/src/lib/seam/connect/models/access-grants/access-grant.ts +13 -5
  23. package/src/lib/seam/connect/models/acs/acs-access-group.ts +2 -2
  24. package/src/lib/seam/connect/models/acs/acs-entrance.ts +36 -17
  25. package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts +44 -34
  26. package/src/lib/seam/connect/models/devices/phone.ts +4 -27
  27. package/src/lib/seam/connect/models/user-identities/user-identity.ts +4 -4
  28. package/src/lib/seam/connect/openapi.ts +1505 -203
  29. package/src/lib/seam/connect/route-types.ts +1526 -428
@@ -14126,8 +14126,8 @@ export type Routes = {
14126
14126
  | {
14127
14127
  /** Device whose access code could not be revoked. */
14128
14128
  device_id: string
14129
- /** Reason the access code could not be revoked (e.g. `offline_access_code_not_revocable`). */
14130
- error_code: string
14129
+ /** Reason the access code could not be revoked. */
14130
+ error_code: 'offline_access_code_not_revocable'
14131
14131
  /** Human-readable description of why revocation failed. */
14132
14132
  message: string
14133
14133
  }[]
@@ -14366,8 +14366,8 @@ export type Routes = {
14366
14366
  | {
14367
14367
  /** Device whose access code could not be revoked. */
14368
14368
  device_id: string
14369
- /** Reason the access code could not be revoked (e.g. `offline_access_code_not_revocable`). */
14370
- error_code: string
14369
+ /** Reason the access code could not be revoked. */
14370
+ error_code: 'offline_access_code_not_revocable'
14371
14371
  /** Human-readable description of why revocation failed. */
14372
14372
  message: string
14373
14373
  }[]
@@ -16606,12 +16606,12 @@ export type Routes = {
16606
16606
  connected_account_id: string
16607
16607
  /** Errors associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
16608
16608
  errors: {
16609
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
16610
- error_code: string
16611
- /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
16612
- message: string
16613
16609
  /** Date and time at which Seam created the error. */
16614
16610
  created_at: string
16611
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
16612
+ message: string
16613
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
16614
+ error_code: 'entrance_removed'
16615
16615
  }[]
16616
16616
  /** Warnings associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
16617
16617
  warnings: (
@@ -17846,8 +17846,8 @@ export type Routes = {
17846
17846
  | {
17847
17847
  /** Device whose access code could not be revoked. */
17848
17848
  device_id: string
17849
- /** Reason the access code could not be revoked (e.g. `offline_access_code_not_revocable`). */
17850
- error_code: string
17849
+ /** Reason the access code could not be revoked. */
17850
+ error_code: 'offline_access_code_not_revocable'
17851
17851
  /** Human-readable description of why revocation failed. */
17852
17852
  message: string
17853
17853
  }[]
@@ -18086,8 +18086,8 @@ export type Routes = {
18086
18086
  | {
18087
18087
  /** Device whose access code could not be revoked. */
18088
18088
  device_id: string
18089
- /** Reason the access code could not be revoked (e.g. `offline_access_code_not_revocable`). */
18090
- error_code: string
18089
+ /** Reason the access code could not be revoked. */
18090
+ error_code: 'offline_access_code_not_revocable'
18091
18091
  /** Human-readable description of why revocation failed. */
18092
18092
  message: string
18093
18093
  }[]
@@ -18298,8 +18298,8 @@ export type Routes = {
18298
18298
  | {
18299
18299
  /** Device whose access code could not be revoked. */
18300
18300
  device_id: string
18301
- /** Reason the access code could not be revoked (e.g. `offline_access_code_not_revocable`). */
18302
- error_code: string
18301
+ /** Reason the access code could not be revoked. */
18302
+ error_code: 'offline_access_code_not_revocable'
18303
18303
  /** Human-readable description of why revocation failed. */
18304
18304
  message: string
18305
18305
  }[]
@@ -18519,8 +18519,8 @@ export type Routes = {
18519
18519
  | {
18520
18520
  /** Device whose access code could not be revoked. */
18521
18521
  device_id: string
18522
- /** Reason the access code could not be revoked (e.g. `offline_access_code_not_revocable`). */
18523
- error_code: string
18522
+ /** Reason the access code could not be revoked. */
18523
+ error_code: 'offline_access_code_not_revocable'
18524
18524
  /** Human-readable description of why revocation failed. */
18525
18525
  message: string
18526
18526
  }[]
@@ -25440,12 +25440,12 @@ export type Routes = {
25440
25440
  connected_account_id: string
25441
25441
  /** Errors associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
25442
25442
  errors: {
25443
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
25444
- error_code: string
25445
- /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
25446
- message: string
25447
25443
  /** Date and time at which Seam created the error. */
25448
25444
  created_at: string
25445
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
25446
+ message: string
25447
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
25448
+ error_code: 'entrance_removed'
25449
25449
  }[]
25450
25450
  /** Warnings associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
25451
25451
  warnings: (
@@ -25773,8 +25773,8 @@ export type Routes = {
25773
25773
  | {
25774
25774
  /** Device whose access code could not be revoked. */
25775
25775
  device_id: string
25776
- /** Reason the access code could not be revoked (e.g. `offline_access_code_not_revocable`). */
25777
- error_code: string
25776
+ /** Reason the access code could not be revoked. */
25777
+ error_code: 'offline_access_code_not_revocable'
25778
25778
  /** Human-readable description of why revocation failed. */
25779
25779
  message: string
25780
25780
  }[]
@@ -29624,12 +29624,12 @@ export type Routes = {
29624
29624
  connected_account_id: string
29625
29625
  /** Errors associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
29626
29626
  errors: {
29627
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
29628
- error_code: string
29629
- /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
29630
- message: string
29631
29627
  /** Date and time at which Seam created the error. */
29632
29628
  created_at: string
29629
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
29630
+ message: string
29631
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
29632
+ error_code: 'entrance_removed'
29633
29633
  }[]
29634
29634
  /** Warnings associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
29635
29635
  warnings: (
@@ -31855,12 +31855,12 @@ export type Routes = {
31855
31855
  connected_account_id: string
31856
31856
  /** Errors associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
31857
31857
  errors: {
31858
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
31859
- error_code: string
31860
- /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
31861
- message: string
31862
31858
  /** Date and time at which Seam created the error. */
31863
31859
  created_at: string
31860
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
31861
+ message: string
31862
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
31863
+ error_code: 'entrance_removed'
31864
31864
  }[]
31865
31865
  /** Warnings associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
31866
31866
  warnings: (
@@ -39805,326 +39805,326 @@ export type Routes = {
39805
39805
  connected_account_id: string
39806
39806
  /** Errors associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
39807
39807
  errors: {
39808
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
39809
- error_code: string
39810
- /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
39811
- message: string
39812
- /** Date and time at which Seam created the error. */
39813
- created_at: string
39814
- }[]
39815
- /** Warnings associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
39816
- warnings: (
39817
- | {
39818
- /** Date and time at which Seam created the warning. */
39819
- created_at: string
39820
- /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
39821
- message: string
39822
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
39823
- warning_code: 'salto_ks_entrance_access_code_support_removed'
39824
- }
39825
- | {
39826
- /** Date and time at which Seam created the warning. */
39827
- created_at: string
39828
- /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
39829
- message: string
39830
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
39831
- warning_code: 'entrance_shares_zone'
39832
- }
39833
- | {
39834
- /** Date and time at which Seam created the warning. */
39835
- created_at: string
39836
- /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
39837
- message: string
39838
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
39839
- warning_code: 'entrance_setup_required'
39840
- }
39841
- | {
39842
- /** Date and time at which Seam created the warning. */
39843
- created_at: string
39844
- /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
39845
- message: string
39846
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
39847
- warning_code: 'salto_ks_privacy_mode'
39848
- }
39849
- | {
39850
- /** Date and time at which Seam created the warning. */
39851
- created_at: string
39852
- /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
39853
- message: string
39854
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
39855
- warning_code: 'privacy_mode'
39856
- }
39857
- )[]
39858
- /** Latch-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
39859
- latch_metadata?:
39860
- | {
39861
- /** Accessibility type in the Latch access system. */
39862
- accessibility_type?: (string | undefined) | undefined
39863
- /** Name of the door in the Latch access system. */
39864
- door_name?: (string | undefined) | undefined
39865
- /** Type of the door in the Latch access system. */
39866
- door_type?: (string | undefined) | undefined
39867
- /** Indicates whether the entrance is connected. */
39868
- is_connected?: (boolean | undefined) | undefined
39869
- }
39870
- | undefined
39871
- /** Hotek-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
39872
- hotek_metadata?:
39873
- | {
39874
- /** Room number of the entrance. */
39875
- room_number?: (string | undefined) | undefined
39876
- /** Display name of the entrance. */
39877
- common_area_number?: (string | undefined) | undefined
39878
- /** Display name of the entrance. */
39879
- common_area_name?: (string | undefined) | undefined
39880
- }
39881
- | undefined
39882
- /** Visionline-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
39883
- visionline_metadata?:
39884
- | {
39885
- /** Name of the door in the Visionline access system. */
39886
- door_name?: (string | undefined) | undefined
39887
- /** Category of the door in the Visionline access system. */
39888
- door_category?:
39889
- | (
39890
- | (
39891
- | 'entrance'
39892
- | 'guest'
39893
- | 'elevator reader'
39894
- | 'common'
39895
- | 'common (PMS)'
39896
- )
39897
- | undefined
39898
- )
39899
- | undefined
39900
- /** Profile for the door in the Visionline access system. */
39901
- profiles?:
39902
- | (
39903
- | {
39904
- /** Door profile ID in the Visionline access system. */
39905
- visionline_door_profile_id?:
39906
- (string | undefined) | undefined
39907
- /** Door profile type in the Visionline access system. */
39908
- visionline_door_profile_type?:
39909
- | (('BLE' | 'commonDoor' | 'touch') | undefined)
39910
- | undefined
39911
- }[]
39912
- | undefined
39913
- )
39914
- | undefined
39915
- }
39916
- | undefined
39917
- /** Salto KS-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
39918
- salto_ks_metadata?:
39919
- | {
39920
- /** Name of the door in the Salto KS access system. */
39921
- door_name?: (string | undefined) | undefined
39922
- /** Locked state of the door in the Salto KS access system. */
39923
- locked_state?: (string | undefined) | undefined
39924
- /** Type of the lock in the Salto KS access system. */
39925
- lock_type?: (string | undefined) | undefined
39926
- /** Indicates whether the door access device is online. */
39927
- online?: (boolean | undefined) | undefined
39928
- /** Battery level of the door access device. */
39929
- battery_level?: (string | undefined) | undefined
39930
- /** Indicates whether the door is left open. */
39931
- left_open_alarm?: (boolean | undefined) | undefined
39932
- /** Indicates whether an intrusion alarm is active on the door. */
39933
- intrusion_alarm?: (boolean | undefined) | undefined
39934
- /** Indicates whether privacy mode is enabled for the lock. */
39935
- privacy_mode?: (boolean | undefined) | undefined
39936
- }
39937
- | undefined
39938
- /** dormakaba Community-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
39939
- dormakaba_community_metadata?:
39940
- | {
39941
- /** Type of access point profile in the dormakaba Community access system. */
39942
- access_point_profile?: (string | undefined) | undefined
39943
- }
39944
- | undefined
39945
- /** ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
39946
- assa_abloy_vostio_metadata?:
39947
- | {
39948
- /** Type of the door in the Vostio access system. */
39949
- door_type?:
39950
- | (
39951
- | ('CommonDoor' | 'EntranceDoor' | 'GuestDoor' | 'Elevator')
39952
- | undefined
39953
- )
39954
- | undefined
39955
- /** Name of the door in the Vostio access system. */
39956
- door_name?: (string | undefined) | undefined
39957
- /** Number of the door in the Vostio access system. */
39958
- door_number?: (number | undefined) | undefined
39959
- /** Indicates whether keys are allowed to set the door in stand open mode in the Vostio access system. */
39960
- stand_open?: (boolean | undefined) | undefined
39961
- /** PMS ID of the door in the Vostio access system. */
39962
- pms_id?: (string | undefined) | undefined
39963
- }
39964
- | undefined
39965
- /** Salto Space-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
39966
- salto_space_metadata?:
39967
- | {
39968
- /** Door ID in the Salto Space access system. */
39969
- door_id?: (string | undefined) | undefined
39970
- /** Name of the door in the Salto Space access system. */
39971
- door_name?: (string | undefined) | undefined
39972
- /** Description of the door in the Salto Space access system. */
39973
- door_description?: (string | undefined) | undefined
39974
- /** Indicates whether AuditOnKeys is enabled for the door in the Salto Space access system. */
39975
- audit_on_keys?: (boolean | undefined) | undefined
39976
- /** Name of the room in the Salto Space access system. */
39977
- room_name?: (string | undefined) | undefined
39978
- /** Description of the room in the Salto Space access system. */
39979
- room_description?: (string | undefined) | undefined
39980
- }
39981
- | undefined
39982
- /** dormakaba Ambiance-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
39983
- dormakaba_ambiance_metadata?:
39984
- | {
39985
- /** Name of the access point in the dormakaba Ambiance access system. */
39986
- access_point_name?: (string | undefined) | undefined
39987
- }
39988
- | undefined
39989
- /** Brivo-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
39990
- brivo_metadata?:
39991
- | {
39992
- /** ID of the access point in the Brivo access system. */
39993
- access_point_id?: (string | undefined) | undefined
39994
- /** ID of the site that the access point belongs to. */
39995
- site_id?: (number | undefined) | undefined
39996
- /** Name of the site that the access point belongs to. */
39997
- site_name?: (string | undefined) | undefined
39998
- }
39999
- | undefined
40000
- /** Avigilon Alta-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
40001
- avigilon_alta_metadata?:
40002
- | {
40003
- /** Entry name for an Avigilon Alta system. */
40004
- entry_name?: (string | undefined) | undefined
40005
- /** Organization name for an Avigilon Alta system. */
40006
- org_name?: (string | undefined) | undefined
40007
- /** Zone ID for an Avigilon Alta system. */
40008
- zone_id?: (number | undefined) | undefined
40009
- /** Zone name for an Avigilon Alta system. */
40010
- zone_name?: (string | undefined) | undefined
40011
- /** Site ID for an Avigilon Alta system. */
40012
- site_id?: (number | undefined) | undefined
40013
- /** Site name for an Avigilon Alta system. */
40014
- site_name?: (string | undefined) | undefined
40015
- /** Total count of entry relays for an Avigilon Alta system. */
40016
- entry_relays_total_count?: (number | undefined) | undefined
40017
- }
40018
- | undefined
40019
- /** Akiles-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
40020
- akiles_metadata?:
40021
- | {
40022
- /** ID of the Akiles gadget. */
40023
- gadget_id?: (string | undefined) | undefined
40024
- /** ID of the Akiles site the gadget belongs to. */
40025
- site_id?: (string | undefined) | undefined
40026
- /** Name of the Akiles site the gadget belongs to. */
40027
- site_name?: (string | undefined) | undefined
40028
- /** Actions the gadget exposes (for example, open). */
40029
- actions?:
40030
- | (
40031
- | {
40032
- /** ID of the gadget action. */
40033
- id?: (string | undefined) | undefined
40034
- /** Name of the gadget action. */
40035
- name?: (string | undefined) | undefined
40036
- }[]
40037
- | undefined
40038
- )
40039
- | undefined
40040
- }
40041
- | undefined
40042
- /** Indicates whether the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) is currently locked. */
40043
- is_locked?: boolean | undefined
40044
- /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
40045
- can_unlock_with_mobile_key?: boolean | undefined
40046
- /** Indicates whether the ACS entrance can be unlocked with card credentials. */
40047
- can_unlock_with_card?: boolean | undefined
40048
- /** Indicates whether the ACS entrance can be unlocked with pin codes. */
40049
- can_unlock_with_code?: boolean | undefined
40050
- /** Indicates whether the ACS entrance can be unlocked with cloud key credentials. */
40051
- can_unlock_with_cloud_key?: boolean | undefined
40052
- /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
40053
- can_belong_to_reservation?: boolean | undefined
40054
- }
40055
- }
40056
- maxDuration: undefined
40057
- }
40058
- '/acs/entrances/grant_access': {
40059
- route: '/acs/entrances/grant_access'
40060
- method: 'POST'
40061
- queryParams: {}
40062
- jsonBody: {
40063
- /** ID of the entrance to which you want to grant an access system user access. */
40064
- acs_entrance_id: string
40065
- /** ID of the user identity to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created. */
40066
- user_identity_id?: string | undefined
40067
- /** ID of the access system user to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id. */
40068
- acs_user_id?: string | undefined
40069
- }
40070
- commonParams: {}
40071
- formData: {}
40072
- jsonResponse: {}
40073
- maxDuration: undefined
40074
- }
40075
- '/acs/entrances/list': {
40076
- route: '/acs/entrances/list'
40077
- method: 'GET' | 'POST'
40078
- queryParams: {}
40079
- jsonBody: {}
40080
- commonParams: {
40081
- /** Customer key for which you want to list entrances. */
40082
- customer_key?: string | undefined
40083
- /** ID of the access system for which you want to retrieve all entrances. */
40084
- acs_system_id?: string | undefined
40085
- /** ID of the credential for which you want to retrieve all entrances. */
40086
- acs_credential_id?: string | undefined
40087
- /** ID of the access method for which you want to retrieve all entrances to which it grants access. */
40088
- access_method_id?: string | undefined
40089
- /**
40090
- * @deprecated Use `space_id`.*/
40091
- location_id?: (string | null) | undefined
40092
- /** ID of the space for which you want to list entrances. */
40093
- space_id?: string | undefined
40094
- /** ID of the connected account for which you want to retrieve all entrances. */
40095
- connected_account_id?: string | undefined
40096
- /** IDs of the entrances for which you want to retrieve all entrances. */
40097
- acs_entrance_ids?: string[] | undefined
40098
- /** String for which to search. Filters returned entrances to include all records that satisfy a partial match using `display_name`. */
40099
- search?: string | undefined
40100
- /** Maximum number of records to return per page. */
40101
- limit?: number
40102
- /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
40103
- page_cursor?: (string | undefined) | null
40104
- }
40105
- formData: {}
40106
- jsonResponse: {
40107
- acs_entrances: {
40108
- /** ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
40109
- acs_system_id: string
40110
- /** ID of the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
40111
- acs_entrance_id: string
40112
- /** IDs of the spaces that the entrance is in. */
40113
- space_ids: string[]
40114
- /** Date and time at which the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) was created. */
40115
- created_at: string
40116
- /** Display name for the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
40117
- display_name: string
40118
- /** ID of the [connected account](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
40119
- connected_account_id: string
40120
- /** Errors associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
40121
- errors: {
40122
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
40123
- error_code: string
39808
+ /** Date and time at which Seam created the error. */
39809
+ created_at: string
40124
39810
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
40125
39811
  message: string
39812
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
39813
+ error_code: 'entrance_removed'
39814
+ }[]
39815
+ /** Warnings associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
39816
+ warnings: (
39817
+ | {
39818
+ /** Date and time at which Seam created the warning. */
39819
+ created_at: string
39820
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
39821
+ message: string
39822
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
39823
+ warning_code: 'salto_ks_entrance_access_code_support_removed'
39824
+ }
39825
+ | {
39826
+ /** Date and time at which Seam created the warning. */
39827
+ created_at: string
39828
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
39829
+ message: string
39830
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
39831
+ warning_code: 'entrance_shares_zone'
39832
+ }
39833
+ | {
39834
+ /** Date and time at which Seam created the warning. */
39835
+ created_at: string
39836
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
39837
+ message: string
39838
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
39839
+ warning_code: 'entrance_setup_required'
39840
+ }
39841
+ | {
39842
+ /** Date and time at which Seam created the warning. */
39843
+ created_at: string
39844
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
39845
+ message: string
39846
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
39847
+ warning_code: 'salto_ks_privacy_mode'
39848
+ }
39849
+ | {
39850
+ /** Date and time at which Seam created the warning. */
39851
+ created_at: string
39852
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
39853
+ message: string
39854
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
39855
+ warning_code: 'privacy_mode'
39856
+ }
39857
+ )[]
39858
+ /** Latch-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
39859
+ latch_metadata?:
39860
+ | {
39861
+ /** Accessibility type in the Latch access system. */
39862
+ accessibility_type?: (string | undefined) | undefined
39863
+ /** Name of the door in the Latch access system. */
39864
+ door_name?: (string | undefined) | undefined
39865
+ /** Type of the door in the Latch access system. */
39866
+ door_type?: (string | undefined) | undefined
39867
+ /** Indicates whether the entrance is connected. */
39868
+ is_connected?: (boolean | undefined) | undefined
39869
+ }
39870
+ | undefined
39871
+ /** Hotek-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
39872
+ hotek_metadata?:
39873
+ | {
39874
+ /** Room number of the entrance. */
39875
+ room_number?: (string | undefined) | undefined
39876
+ /** Display name of the entrance. */
39877
+ common_area_number?: (string | undefined) | undefined
39878
+ /** Display name of the entrance. */
39879
+ common_area_name?: (string | undefined) | undefined
39880
+ }
39881
+ | undefined
39882
+ /** Visionline-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
39883
+ visionline_metadata?:
39884
+ | {
39885
+ /** Name of the door in the Visionline access system. */
39886
+ door_name?: (string | undefined) | undefined
39887
+ /** Category of the door in the Visionline access system. */
39888
+ door_category?:
39889
+ | (
39890
+ | (
39891
+ | 'entrance'
39892
+ | 'guest'
39893
+ | 'elevator reader'
39894
+ | 'common'
39895
+ | 'common (PMS)'
39896
+ )
39897
+ | undefined
39898
+ )
39899
+ | undefined
39900
+ /** Profile for the door in the Visionline access system. */
39901
+ profiles?:
39902
+ | (
39903
+ | {
39904
+ /** Door profile ID in the Visionline access system. */
39905
+ visionline_door_profile_id?:
39906
+ (string | undefined) | undefined
39907
+ /** Door profile type in the Visionline access system. */
39908
+ visionline_door_profile_type?:
39909
+ | (('BLE' | 'commonDoor' | 'touch') | undefined)
39910
+ | undefined
39911
+ }[]
39912
+ | undefined
39913
+ )
39914
+ | undefined
39915
+ }
39916
+ | undefined
39917
+ /** Salto KS-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
39918
+ salto_ks_metadata?:
39919
+ | {
39920
+ /** Name of the door in the Salto KS access system. */
39921
+ door_name?: (string | undefined) | undefined
39922
+ /** Locked state of the door in the Salto KS access system. */
39923
+ locked_state?: (string | undefined) | undefined
39924
+ /** Type of the lock in the Salto KS access system. */
39925
+ lock_type?: (string | undefined) | undefined
39926
+ /** Indicates whether the door access device is online. */
39927
+ online?: (boolean | undefined) | undefined
39928
+ /** Battery level of the door access device. */
39929
+ battery_level?: (string | undefined) | undefined
39930
+ /** Indicates whether the door is left open. */
39931
+ left_open_alarm?: (boolean | undefined) | undefined
39932
+ /** Indicates whether an intrusion alarm is active on the door. */
39933
+ intrusion_alarm?: (boolean | undefined) | undefined
39934
+ /** Indicates whether privacy mode is enabled for the lock. */
39935
+ privacy_mode?: (boolean | undefined) | undefined
39936
+ }
39937
+ | undefined
39938
+ /** dormakaba Community-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
39939
+ dormakaba_community_metadata?:
39940
+ | {
39941
+ /** Type of access point profile in the dormakaba Community access system. */
39942
+ access_point_profile?: (string | undefined) | undefined
39943
+ }
39944
+ | undefined
39945
+ /** ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
39946
+ assa_abloy_vostio_metadata?:
39947
+ | {
39948
+ /** Type of the door in the Vostio access system. */
39949
+ door_type?:
39950
+ | (
39951
+ | ('CommonDoor' | 'EntranceDoor' | 'GuestDoor' | 'Elevator')
39952
+ | undefined
39953
+ )
39954
+ | undefined
39955
+ /** Name of the door in the Vostio access system. */
39956
+ door_name?: (string | undefined) | undefined
39957
+ /** Number of the door in the Vostio access system. */
39958
+ door_number?: (number | undefined) | undefined
39959
+ /** Indicates whether keys are allowed to set the door in stand open mode in the Vostio access system. */
39960
+ stand_open?: (boolean | undefined) | undefined
39961
+ /** PMS ID of the door in the Vostio access system. */
39962
+ pms_id?: (string | undefined) | undefined
39963
+ }
39964
+ | undefined
39965
+ /** Salto Space-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
39966
+ salto_space_metadata?:
39967
+ | {
39968
+ /** Door ID in the Salto Space access system. */
39969
+ door_id?: (string | undefined) | undefined
39970
+ /** Name of the door in the Salto Space access system. */
39971
+ door_name?: (string | undefined) | undefined
39972
+ /** Description of the door in the Salto Space access system. */
39973
+ door_description?: (string | undefined) | undefined
39974
+ /** Indicates whether AuditOnKeys is enabled for the door in the Salto Space access system. */
39975
+ audit_on_keys?: (boolean | undefined) | undefined
39976
+ /** Name of the room in the Salto Space access system. */
39977
+ room_name?: (string | undefined) | undefined
39978
+ /** Description of the room in the Salto Space access system. */
39979
+ room_description?: (string | undefined) | undefined
39980
+ }
39981
+ | undefined
39982
+ /** dormakaba Ambiance-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
39983
+ dormakaba_ambiance_metadata?:
39984
+ | {
39985
+ /** Name of the access point in the dormakaba Ambiance access system. */
39986
+ access_point_name?: (string | undefined) | undefined
39987
+ }
39988
+ | undefined
39989
+ /** Brivo-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
39990
+ brivo_metadata?:
39991
+ | {
39992
+ /** ID of the access point in the Brivo access system. */
39993
+ access_point_id?: (string | undefined) | undefined
39994
+ /** ID of the site that the access point belongs to. */
39995
+ site_id?: (number | undefined) | undefined
39996
+ /** Name of the site that the access point belongs to. */
39997
+ site_name?: (string | undefined) | undefined
39998
+ }
39999
+ | undefined
40000
+ /** Avigilon Alta-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
40001
+ avigilon_alta_metadata?:
40002
+ | {
40003
+ /** Entry name for an Avigilon Alta system. */
40004
+ entry_name?: (string | undefined) | undefined
40005
+ /** Organization name for an Avigilon Alta system. */
40006
+ org_name?: (string | undefined) | undefined
40007
+ /** Zone ID for an Avigilon Alta system. */
40008
+ zone_id?: (number | undefined) | undefined
40009
+ /** Zone name for an Avigilon Alta system. */
40010
+ zone_name?: (string | undefined) | undefined
40011
+ /** Site ID for an Avigilon Alta system. */
40012
+ site_id?: (number | undefined) | undefined
40013
+ /** Site name for an Avigilon Alta system. */
40014
+ site_name?: (string | undefined) | undefined
40015
+ /** Total count of entry relays for an Avigilon Alta system. */
40016
+ entry_relays_total_count?: (number | undefined) | undefined
40017
+ }
40018
+ | undefined
40019
+ /** Akiles-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
40020
+ akiles_metadata?:
40021
+ | {
40022
+ /** ID of the Akiles gadget. */
40023
+ gadget_id?: (string | undefined) | undefined
40024
+ /** ID of the Akiles site the gadget belongs to. */
40025
+ site_id?: (string | undefined) | undefined
40026
+ /** Name of the Akiles site the gadget belongs to. */
40027
+ site_name?: (string | undefined) | undefined
40028
+ /** Actions the gadget exposes (for example, open). */
40029
+ actions?:
40030
+ | (
40031
+ | {
40032
+ /** ID of the gadget action. */
40033
+ id?: (string | undefined) | undefined
40034
+ /** Name of the gadget action. */
40035
+ name?: (string | undefined) | undefined
40036
+ }[]
40037
+ | undefined
40038
+ )
40039
+ | undefined
40040
+ }
40041
+ | undefined
40042
+ /** Indicates whether the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) is currently locked. */
40043
+ is_locked?: boolean | undefined
40044
+ /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
40045
+ can_unlock_with_mobile_key?: boolean | undefined
40046
+ /** Indicates whether the ACS entrance can be unlocked with card credentials. */
40047
+ can_unlock_with_card?: boolean | undefined
40048
+ /** Indicates whether the ACS entrance can be unlocked with pin codes. */
40049
+ can_unlock_with_code?: boolean | undefined
40050
+ /** Indicates whether the ACS entrance can be unlocked with cloud key credentials. */
40051
+ can_unlock_with_cloud_key?: boolean | undefined
40052
+ /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
40053
+ can_belong_to_reservation?: boolean | undefined
40054
+ }
40055
+ }
40056
+ maxDuration: undefined
40057
+ }
40058
+ '/acs/entrances/grant_access': {
40059
+ route: '/acs/entrances/grant_access'
40060
+ method: 'POST'
40061
+ queryParams: {}
40062
+ jsonBody: {
40063
+ /** ID of the entrance to which you want to grant an access system user access. */
40064
+ acs_entrance_id: string
40065
+ /** ID of the user identity to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created. */
40066
+ user_identity_id?: string | undefined
40067
+ /** ID of the access system user to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id. */
40068
+ acs_user_id?: string | undefined
40069
+ }
40070
+ commonParams: {}
40071
+ formData: {}
40072
+ jsonResponse: {}
40073
+ maxDuration: undefined
40074
+ }
40075
+ '/acs/entrances/list': {
40076
+ route: '/acs/entrances/list'
40077
+ method: 'GET' | 'POST'
40078
+ queryParams: {}
40079
+ jsonBody: {}
40080
+ commonParams: {
40081
+ /** Customer key for which you want to list entrances. */
40082
+ customer_key?: string | undefined
40083
+ /** ID of the access system for which you want to retrieve all entrances. */
40084
+ acs_system_id?: string | undefined
40085
+ /** ID of the credential for which you want to retrieve all entrances. */
40086
+ acs_credential_id?: string | undefined
40087
+ /** ID of the access method for which you want to retrieve all entrances to which it grants access. */
40088
+ access_method_id?: string | undefined
40089
+ /**
40090
+ * @deprecated Use `space_id`.*/
40091
+ location_id?: (string | null) | undefined
40092
+ /** ID of the space for which you want to list entrances. */
40093
+ space_id?: string | undefined
40094
+ /** ID of the connected account for which you want to retrieve all entrances. */
40095
+ connected_account_id?: string | undefined
40096
+ /** IDs of the entrances for which you want to retrieve all entrances. */
40097
+ acs_entrance_ids?: string[] | undefined
40098
+ /** String for which to search. Filters returned entrances to include all records that satisfy a partial match using `display_name`. */
40099
+ search?: string | undefined
40100
+ /** Maximum number of records to return per page. */
40101
+ limit?: number
40102
+ /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
40103
+ page_cursor?: (string | undefined) | null
40104
+ }
40105
+ formData: {}
40106
+ jsonResponse: {
40107
+ acs_entrances: {
40108
+ /** ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
40109
+ acs_system_id: string
40110
+ /** ID of the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
40111
+ acs_entrance_id: string
40112
+ /** IDs of the spaces that the entrance is in. */
40113
+ space_ids: string[]
40114
+ /** Date and time at which the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) was created. */
40115
+ created_at: string
40116
+ /** Display name for the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
40117
+ display_name: string
40118
+ /** ID of the [connected account](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
40119
+ connected_account_id: string
40120
+ /** Errors associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
40121
+ errors: {
40126
40122
  /** Date and time at which Seam created the error. */
40127
40123
  created_at: string
40124
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
40125
+ message: string
40126
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
40127
+ error_code: 'entrance_removed'
40128
40128
  }[]
40129
40129
  /** Warnings associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
40130
40130
  warnings: (
@@ -44593,12 +44593,12 @@ export type Routes = {
44593
44593
  connected_account_id: string
44594
44594
  /** Errors associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
44595
44595
  errors: {
44596
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
44597
- error_code: string
44598
- /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
44599
- message: string
44600
44596
  /** Date and time at which Seam created the error. */
44601
44597
  created_at: string
44598
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
44599
+ message: string
44600
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
44601
+ error_code: 'entrance_removed'
44602
44602
  }[]
44603
44603
  /** Warnings associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
44604
44604
  warnings: (
@@ -97987,24 +97987,390 @@ export type Routes = {
97987
97987
  custom_metadata: {
97988
97988
  [x: string]: string | boolean
97989
97989
  }
97990
- /** Errors associated with the phone. */
97991
- errors: {
97992
- /** Unique identifier of the type of error. */
97993
- error_code: string
97994
- /** Detailed description of the error. */
97995
- message: string
97996
- /** Date and time at which Seam created the error. */
97997
- created_at: string
97998
- }[]
97999
- /** Warnings associated with the phone. */
98000
- warnings: {
98001
- /** Unique identifier of the type of warning. */
98002
- warning_code: string
98003
- /** Detailed description of the warning. */
98004
- message: string
98005
- /** Date and time at which Seam created the warning. */
98006
- created_at: string
98007
- }[]
97990
+ /** Array of errors associated with the device. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
97991
+ errors: (
97992
+ | {
97993
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
97994
+ message: string
97995
+ /** Indicates that the error is not a device error. */
97996
+ is_device_error: false
97997
+ /** Date and time at which Seam created the error. */
97998
+ created_at: string
97999
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
98000
+ error_code: 'account_disconnected'
98001
+ /** Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */
98002
+ is_connected_account_error: true
98003
+ }
98004
+ | {
98005
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98006
+ message: string
98007
+ /** Indicates that the error is not a device error. */
98008
+ is_device_error: false
98009
+ /** Date and time at which Seam created the error. */
98010
+ created_at: string
98011
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
98012
+ error_code: 'salto_ks_subscription_limit_exceeded'
98013
+ /** Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */
98014
+ is_connected_account_error: true
98015
+ }
98016
+ | {
98017
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98018
+ message: string
98019
+ /** Indicates that the error is not a device error. */
98020
+ is_device_error: false
98021
+ /** Date and time at which Seam created the error. */
98022
+ created_at: string
98023
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
98024
+ error_code: 'insufficient_permissions'
98025
+ /** Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */
98026
+ is_connected_account_error: true
98027
+ }
98028
+ | {
98029
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98030
+ message: string
98031
+ /** Indicates that the error is not a device error. */
98032
+ is_device_error: false
98033
+ /** Date and time at which Seam created the error. */
98034
+ created_at: string
98035
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
98036
+ error_code: 'dormakaba_sites_disconnected'
98037
+ /** Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */
98038
+ is_connected_account_error: true
98039
+ }
98040
+ | {
98041
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98042
+ message: string
98043
+ /** Indicates that the error is a device error. */
98044
+ is_device_error: true
98045
+ /** Date and time at which Seam created the error. */
98046
+ created_at: string
98047
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
98048
+ error_code: 'device_offline'
98049
+ }
98050
+ | {
98051
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98052
+ message: string
98053
+ /** Indicates that the error is a device error. */
98054
+ is_device_error: true
98055
+ /** Date and time at which Seam created the error. */
98056
+ created_at: string
98057
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
98058
+ error_code: 'device_removed'
98059
+ }
98060
+ | {
98061
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98062
+ message: string
98063
+ /** Indicates that the error is a device error. */
98064
+ is_device_error: true
98065
+ /** Date and time at which Seam created the error. */
98066
+ created_at: string
98067
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
98068
+ error_code: 'hub_disconnected'
98069
+ }
98070
+ | {
98071
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98072
+ message: string
98073
+ /** Indicates that the error is a device error. */
98074
+ is_device_error: true
98075
+ /** Date and time at which Seam created the error. */
98076
+ created_at: string
98077
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
98078
+ error_code: 'device_disconnected'
98079
+ }
98080
+ | {
98081
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98082
+ message: string
98083
+ /** Indicates that the error is a device error. */
98084
+ is_device_error: true
98085
+ /** Date and time at which Seam created the error. */
98086
+ created_at: string
98087
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
98088
+ error_code: 'empty_backup_access_code_pool'
98089
+ }
98090
+ | {
98091
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98092
+ message: string
98093
+ /** Indicates that the error is a device error. */
98094
+ is_device_error: true
98095
+ /** Date and time at which Seam created the error. */
98096
+ created_at: string
98097
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
98098
+ error_code: 'august_lock_not_authorized'
98099
+ }
98100
+ | {
98101
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98102
+ message: string
98103
+ /** Indicates that the error is a device error. */
98104
+ is_device_error: true
98105
+ /** Date and time at which Seam created the error. */
98106
+ created_at: string
98107
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
98108
+ error_code: 'missing_device_credentials'
98109
+ }
98110
+ | {
98111
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98112
+ message: string
98113
+ /** Indicates that the error is a device error. */
98114
+ is_device_error: true
98115
+ /** Date and time at which Seam created the error. */
98116
+ created_at: string
98117
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
98118
+ error_code: 'auxiliary_heat_running'
98119
+ }
98120
+ | {
98121
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98122
+ message: string
98123
+ /** Indicates that the error is a device error. */
98124
+ is_device_error: true
98125
+ /** Date and time at which Seam created the error. */
98126
+ created_at: string
98127
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
98128
+ error_code: 'subscription_required'
98129
+ }
98130
+ | {
98131
+ /** Date and time at which Seam created the error. */
98132
+ created_at: string
98133
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98134
+ message: string
98135
+ /** Indicates whether the error is related specifically to the connected account. */
98136
+ is_connected_account_error?: boolean | undefined
98137
+ /** Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge). */
98138
+ is_bridge_error?: boolean | undefined
98139
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
98140
+ error_code: 'bridge_disconnected'
98141
+ }
98142
+ )[]
98143
+ /** Array of warnings associated with the device. Each warning object within the array contains two fields: `warning_code` and `message`. `warning_code` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
98144
+ warnings: (
98145
+ | {
98146
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98147
+ message: string
98148
+ /** Date and time at which Seam created the warning. */
98149
+ created_at: string
98150
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98151
+ warning_code: 'partial_backup_access_code_pool'
98152
+ }
98153
+ | {
98154
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98155
+ message: string
98156
+ /** Date and time at which Seam created the warning. */
98157
+ created_at: string
98158
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98159
+ warning_code: 'many_active_backup_codes'
98160
+ }
98161
+ | {
98162
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98163
+ message: string
98164
+ /** Date and time at which Seam created the warning. */
98165
+ created_at: string
98166
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98167
+ warning_code: 'third_party_integration_detected'
98168
+ }
98169
+ | {
98170
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98171
+ message: string
98172
+ /** Date and time at which Seam created the warning. */
98173
+ created_at: string
98174
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98175
+ warning_code: 'ttlock_lock_gateway_unlocking_not_enabled'
98176
+ }
98177
+ | {
98178
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98179
+ message: string
98180
+ /** Date and time at which Seam created the warning. */
98181
+ created_at: string
98182
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98183
+ warning_code: 'ttlock_weak_gateway_signal'
98184
+ }
98185
+ | {
98186
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98187
+ message: string
98188
+ /** Date and time at which Seam created the warning. */
98189
+ created_at: string
98190
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98191
+ warning_code: 'power_saving_mode'
98192
+ }
98193
+ | {
98194
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98195
+ message: string
98196
+ /** Date and time at which Seam created the warning. */
98197
+ created_at: string
98198
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98199
+ warning_code: 'temperature_threshold_exceeded'
98200
+ }
98201
+ | {
98202
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98203
+ message: string
98204
+ /** Date and time at which Seam created the warning. */
98205
+ created_at: string
98206
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98207
+ warning_code: 'device_communication_degraded'
98208
+ }
98209
+ | {
98210
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98211
+ message: string
98212
+ /** Date and time at which Seam created the warning. */
98213
+ created_at: string
98214
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98215
+ warning_code: 'scheduled_maintenance_window'
98216
+ }
98217
+ | {
98218
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98219
+ message: string
98220
+ /** Date and time at which Seam created the warning. */
98221
+ created_at: string
98222
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98223
+ warning_code: 'device_has_flaky_connection'
98224
+ }
98225
+ | {
98226
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98227
+ message: string
98228
+ /** Date and time at which Seam created the warning. */
98229
+ created_at: string
98230
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98231
+ warning_code: 'salto_ks_office_mode'
98232
+ }
98233
+ | {
98234
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98235
+ message: string
98236
+ /** Date and time at which Seam created the warning. */
98237
+ created_at: string
98238
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98239
+ warning_code: 'salto_ks_privacy_mode'
98240
+ }
98241
+ | {
98242
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98243
+ message: string
98244
+ /** Date and time at which Seam created the warning. */
98245
+ created_at: string
98246
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98247
+ warning_code: 'privacy_mode'
98248
+ }
98249
+ | {
98250
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98251
+ message: string
98252
+ /** Date and time at which Seam created the warning. */
98253
+ created_at: string
98254
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98255
+ warning_code: 'salto_ks_subscription_limit_almost_reached'
98256
+ }
98257
+ | {
98258
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98259
+ message: string
98260
+ /** Date and time at which Seam created the warning. */
98261
+ created_at: string
98262
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98263
+ warning_code: 'salto_ks_lock_access_code_support_removed'
98264
+ }
98265
+ | {
98266
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98267
+ message: string
98268
+ /** Date and time at which Seam created the warning. */
98269
+ created_at: string
98270
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98271
+ warning_code: 'unknown_issue_with_phone'
98272
+ }
98273
+ | {
98274
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98275
+ message: string
98276
+ /** Date and time at which Seam created the warning. */
98277
+ created_at: string
98278
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98279
+ warning_code: 'lockly_time_zone_not_configured'
98280
+ }
98281
+ | {
98282
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98283
+ message: string
98284
+ /** Date and time at which Seam created the warning. */
98285
+ created_at: string
98286
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98287
+ warning_code: 'ultraloq_time_zone_unknown'
98288
+ }
98289
+ | {
98290
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98291
+ message: string
98292
+ /** Date and time at which Seam created the warning. */
98293
+ created_at: string
98294
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98295
+ warning_code: 'time_zone_unknown'
98296
+ }
98297
+ | {
98298
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98299
+ message: string
98300
+ /** Date and time at which Seam created the warning. */
98301
+ created_at: string
98302
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98303
+ warning_code: 'time_zone_mismatch'
98304
+ }
98305
+ | {
98306
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98307
+ message: string
98308
+ /** Date and time at which Seam created the warning. */
98309
+ created_at: string
98310
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98311
+ warning_code: 'two_n_device_missing_timezone'
98312
+ }
98313
+ | {
98314
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98315
+ message: string
98316
+ /** Date and time at which Seam created the warning. */
98317
+ created_at: string
98318
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98319
+ warning_code: 'hub_required_for_additional_capabilities'
98320
+ }
98321
+ | {
98322
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98323
+ message: string
98324
+ /** Date and time at which Seam created the warning. */
98325
+ created_at: string
98326
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98327
+ warning_code: 'provider_issue'
98328
+ }
98329
+ | {
98330
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98331
+ message: string
98332
+ /** Date and time at which Seam created the warning. */
98333
+ created_at: string
98334
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98335
+ warning_code: 'keynest_unsupported_locker'
98336
+ }
98337
+ | {
98338
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98339
+ message: string
98340
+ /** Date and time at which Seam created the warning. */
98341
+ created_at: string
98342
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98343
+ warning_code: 'accessory_keypad_setup_required'
98344
+ }
98345
+ | {
98346
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98347
+ message: string
98348
+ /** Date and time at which Seam created the warning. */
98349
+ created_at: string
98350
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98351
+ warning_code: 'accessory_keypad_low_battery'
98352
+ }
98353
+ | {
98354
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98355
+ message: string
98356
+ /** Date and time at which Seam created the warning. */
98357
+ created_at: string
98358
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98359
+ warning_code: 'unreliable_online_status'
98360
+ }
98361
+ | {
98362
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98363
+ message: string
98364
+ /** Date and time at which Seam created the warning. */
98365
+ created_at: string
98366
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98367
+ warning_code: 'max_access_codes_reached'
98368
+ /** Number of active access codes on the device when the warning was set. */
98369
+ active_access_code_count: number
98370
+ /** Maximum number of active access codes supported by the device. */
98371
+ max_active_access_code_count: number
98372
+ }
98373
+ )[]
98008
98374
  /** Type of the phone device, such as `ios_phone` or `android_phone`. */
98009
98375
  device_type: 'ios_phone' | 'android_phone'
98010
98376
  /** Properties of the phone. */
@@ -98074,24 +98440,390 @@ export type Routes = {
98074
98440
  custom_metadata: {
98075
98441
  [x: string]: string | boolean
98076
98442
  }
98077
- /** Errors associated with the phone. */
98078
- errors: {
98079
- /** Unique identifier of the type of error. */
98080
- error_code: string
98081
- /** Detailed description of the error. */
98082
- message: string
98083
- /** Date and time at which Seam created the error. */
98084
- created_at: string
98085
- }[]
98086
- /** Warnings associated with the phone. */
98087
- warnings: {
98088
- /** Unique identifier of the type of warning. */
98089
- warning_code: string
98090
- /** Detailed description of the warning. */
98091
- message: string
98092
- /** Date and time at which Seam created the warning. */
98093
- created_at: string
98094
- }[]
98443
+ /** Array of errors associated with the device. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
98444
+ errors: (
98445
+ | {
98446
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98447
+ message: string
98448
+ /** Indicates that the error is not a device error. */
98449
+ is_device_error: false
98450
+ /** Date and time at which Seam created the error. */
98451
+ created_at: string
98452
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
98453
+ error_code: 'account_disconnected'
98454
+ /** Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */
98455
+ is_connected_account_error: true
98456
+ }
98457
+ | {
98458
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98459
+ message: string
98460
+ /** Indicates that the error is not a device error. */
98461
+ is_device_error: false
98462
+ /** Date and time at which Seam created the error. */
98463
+ created_at: string
98464
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
98465
+ error_code: 'salto_ks_subscription_limit_exceeded'
98466
+ /** Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */
98467
+ is_connected_account_error: true
98468
+ }
98469
+ | {
98470
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98471
+ message: string
98472
+ /** Indicates that the error is not a device error. */
98473
+ is_device_error: false
98474
+ /** Date and time at which Seam created the error. */
98475
+ created_at: string
98476
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
98477
+ error_code: 'insufficient_permissions'
98478
+ /** Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */
98479
+ is_connected_account_error: true
98480
+ }
98481
+ | {
98482
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98483
+ message: string
98484
+ /** Indicates that the error is not a device error. */
98485
+ is_device_error: false
98486
+ /** Date and time at which Seam created the error. */
98487
+ created_at: string
98488
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
98489
+ error_code: 'dormakaba_sites_disconnected'
98490
+ /** Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */
98491
+ is_connected_account_error: true
98492
+ }
98493
+ | {
98494
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98495
+ message: string
98496
+ /** Indicates that the error is a device error. */
98497
+ is_device_error: true
98498
+ /** Date and time at which Seam created the error. */
98499
+ created_at: string
98500
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
98501
+ error_code: 'device_offline'
98502
+ }
98503
+ | {
98504
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98505
+ message: string
98506
+ /** Indicates that the error is a device error. */
98507
+ is_device_error: true
98508
+ /** Date and time at which Seam created the error. */
98509
+ created_at: string
98510
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
98511
+ error_code: 'device_removed'
98512
+ }
98513
+ | {
98514
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98515
+ message: string
98516
+ /** Indicates that the error is a device error. */
98517
+ is_device_error: true
98518
+ /** Date and time at which Seam created the error. */
98519
+ created_at: string
98520
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
98521
+ error_code: 'hub_disconnected'
98522
+ }
98523
+ | {
98524
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98525
+ message: string
98526
+ /** Indicates that the error is a device error. */
98527
+ is_device_error: true
98528
+ /** Date and time at which Seam created the error. */
98529
+ created_at: string
98530
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
98531
+ error_code: 'device_disconnected'
98532
+ }
98533
+ | {
98534
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98535
+ message: string
98536
+ /** Indicates that the error is a device error. */
98537
+ is_device_error: true
98538
+ /** Date and time at which Seam created the error. */
98539
+ created_at: string
98540
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
98541
+ error_code: 'empty_backup_access_code_pool'
98542
+ }
98543
+ | {
98544
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98545
+ message: string
98546
+ /** Indicates that the error is a device error. */
98547
+ is_device_error: true
98548
+ /** Date and time at which Seam created the error. */
98549
+ created_at: string
98550
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
98551
+ error_code: 'august_lock_not_authorized'
98552
+ }
98553
+ | {
98554
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98555
+ message: string
98556
+ /** Indicates that the error is a device error. */
98557
+ is_device_error: true
98558
+ /** Date and time at which Seam created the error. */
98559
+ created_at: string
98560
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
98561
+ error_code: 'missing_device_credentials'
98562
+ }
98563
+ | {
98564
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98565
+ message: string
98566
+ /** Indicates that the error is a device error. */
98567
+ is_device_error: true
98568
+ /** Date and time at which Seam created the error. */
98569
+ created_at: string
98570
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
98571
+ error_code: 'auxiliary_heat_running'
98572
+ }
98573
+ | {
98574
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98575
+ message: string
98576
+ /** Indicates that the error is a device error. */
98577
+ is_device_error: true
98578
+ /** Date and time at which Seam created the error. */
98579
+ created_at: string
98580
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
98581
+ error_code: 'subscription_required'
98582
+ }
98583
+ | {
98584
+ /** Date and time at which Seam created the error. */
98585
+ created_at: string
98586
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98587
+ message: string
98588
+ /** Indicates whether the error is related specifically to the connected account. */
98589
+ is_connected_account_error?: boolean | undefined
98590
+ /** Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge). */
98591
+ is_bridge_error?: boolean | undefined
98592
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
98593
+ error_code: 'bridge_disconnected'
98594
+ }
98595
+ )[]
98596
+ /** Array of warnings associated with the device. Each warning object within the array contains two fields: `warning_code` and `message`. `warning_code` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
98597
+ warnings: (
98598
+ | {
98599
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98600
+ message: string
98601
+ /** Date and time at which Seam created the warning. */
98602
+ created_at: string
98603
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98604
+ warning_code: 'partial_backup_access_code_pool'
98605
+ }
98606
+ | {
98607
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98608
+ message: string
98609
+ /** Date and time at which Seam created the warning. */
98610
+ created_at: string
98611
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98612
+ warning_code: 'many_active_backup_codes'
98613
+ }
98614
+ | {
98615
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98616
+ message: string
98617
+ /** Date and time at which Seam created the warning. */
98618
+ created_at: string
98619
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98620
+ warning_code: 'third_party_integration_detected'
98621
+ }
98622
+ | {
98623
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98624
+ message: string
98625
+ /** Date and time at which Seam created the warning. */
98626
+ created_at: string
98627
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98628
+ warning_code: 'ttlock_lock_gateway_unlocking_not_enabled'
98629
+ }
98630
+ | {
98631
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98632
+ message: string
98633
+ /** Date and time at which Seam created the warning. */
98634
+ created_at: string
98635
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98636
+ warning_code: 'ttlock_weak_gateway_signal'
98637
+ }
98638
+ | {
98639
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98640
+ message: string
98641
+ /** Date and time at which Seam created the warning. */
98642
+ created_at: string
98643
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98644
+ warning_code: 'power_saving_mode'
98645
+ }
98646
+ | {
98647
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98648
+ message: string
98649
+ /** Date and time at which Seam created the warning. */
98650
+ created_at: string
98651
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98652
+ warning_code: 'temperature_threshold_exceeded'
98653
+ }
98654
+ | {
98655
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98656
+ message: string
98657
+ /** Date and time at which Seam created the warning. */
98658
+ created_at: string
98659
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98660
+ warning_code: 'device_communication_degraded'
98661
+ }
98662
+ | {
98663
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98664
+ message: string
98665
+ /** Date and time at which Seam created the warning. */
98666
+ created_at: string
98667
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98668
+ warning_code: 'scheduled_maintenance_window'
98669
+ }
98670
+ | {
98671
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98672
+ message: string
98673
+ /** Date and time at which Seam created the warning. */
98674
+ created_at: string
98675
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98676
+ warning_code: 'device_has_flaky_connection'
98677
+ }
98678
+ | {
98679
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98680
+ message: string
98681
+ /** Date and time at which Seam created the warning. */
98682
+ created_at: string
98683
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98684
+ warning_code: 'salto_ks_office_mode'
98685
+ }
98686
+ | {
98687
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98688
+ message: string
98689
+ /** Date and time at which Seam created the warning. */
98690
+ created_at: string
98691
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98692
+ warning_code: 'salto_ks_privacy_mode'
98693
+ }
98694
+ | {
98695
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98696
+ message: string
98697
+ /** Date and time at which Seam created the warning. */
98698
+ created_at: string
98699
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98700
+ warning_code: 'privacy_mode'
98701
+ }
98702
+ | {
98703
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98704
+ message: string
98705
+ /** Date and time at which Seam created the warning. */
98706
+ created_at: string
98707
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98708
+ warning_code: 'salto_ks_subscription_limit_almost_reached'
98709
+ }
98710
+ | {
98711
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98712
+ message: string
98713
+ /** Date and time at which Seam created the warning. */
98714
+ created_at: string
98715
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98716
+ warning_code: 'salto_ks_lock_access_code_support_removed'
98717
+ }
98718
+ | {
98719
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98720
+ message: string
98721
+ /** Date and time at which Seam created the warning. */
98722
+ created_at: string
98723
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98724
+ warning_code: 'unknown_issue_with_phone'
98725
+ }
98726
+ | {
98727
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98728
+ message: string
98729
+ /** Date and time at which Seam created the warning. */
98730
+ created_at: string
98731
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98732
+ warning_code: 'lockly_time_zone_not_configured'
98733
+ }
98734
+ | {
98735
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98736
+ message: string
98737
+ /** Date and time at which Seam created the warning. */
98738
+ created_at: string
98739
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98740
+ warning_code: 'ultraloq_time_zone_unknown'
98741
+ }
98742
+ | {
98743
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98744
+ message: string
98745
+ /** Date and time at which Seam created the warning. */
98746
+ created_at: string
98747
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98748
+ warning_code: 'time_zone_unknown'
98749
+ }
98750
+ | {
98751
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98752
+ message: string
98753
+ /** Date and time at which Seam created the warning. */
98754
+ created_at: string
98755
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98756
+ warning_code: 'time_zone_mismatch'
98757
+ }
98758
+ | {
98759
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98760
+ message: string
98761
+ /** Date and time at which Seam created the warning. */
98762
+ created_at: string
98763
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98764
+ warning_code: 'two_n_device_missing_timezone'
98765
+ }
98766
+ | {
98767
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98768
+ message: string
98769
+ /** Date and time at which Seam created the warning. */
98770
+ created_at: string
98771
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98772
+ warning_code: 'hub_required_for_additional_capabilities'
98773
+ }
98774
+ | {
98775
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98776
+ message: string
98777
+ /** Date and time at which Seam created the warning. */
98778
+ created_at: string
98779
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98780
+ warning_code: 'provider_issue'
98781
+ }
98782
+ | {
98783
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98784
+ message: string
98785
+ /** Date and time at which Seam created the warning. */
98786
+ created_at: string
98787
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98788
+ warning_code: 'keynest_unsupported_locker'
98789
+ }
98790
+ | {
98791
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98792
+ message: string
98793
+ /** Date and time at which Seam created the warning. */
98794
+ created_at: string
98795
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98796
+ warning_code: 'accessory_keypad_setup_required'
98797
+ }
98798
+ | {
98799
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98800
+ message: string
98801
+ /** Date and time at which Seam created the warning. */
98802
+ created_at: string
98803
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98804
+ warning_code: 'accessory_keypad_low_battery'
98805
+ }
98806
+ | {
98807
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98808
+ message: string
98809
+ /** Date and time at which Seam created the warning. */
98810
+ created_at: string
98811
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98812
+ warning_code: 'unreliable_online_status'
98813
+ }
98814
+ | {
98815
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98816
+ message: string
98817
+ /** Date and time at which Seam created the warning. */
98818
+ created_at: string
98819
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98820
+ warning_code: 'max_access_codes_reached'
98821
+ /** Number of active access codes on the device when the warning was set. */
98822
+ active_access_code_count: number
98823
+ /** Maximum number of active access codes supported by the device. */
98824
+ max_active_access_code_count: number
98825
+ }
98826
+ )[]
98095
98827
  /** Type of the phone device, such as `ios_phone` or `android_phone`. */
98096
98828
  device_type: 'ios_phone' | 'android_phone'
98097
98829
  /** Properties of the phone. */
@@ -98188,24 +98920,390 @@ export type Routes = {
98188
98920
  custom_metadata: {
98189
98921
  [x: string]: string | boolean
98190
98922
  }
98191
- /** Errors associated with the phone. */
98192
- errors: {
98193
- /** Unique identifier of the type of error. */
98194
- error_code: string
98195
- /** Detailed description of the error. */
98196
- message: string
98197
- /** Date and time at which Seam created the error. */
98198
- created_at: string
98199
- }[]
98200
- /** Warnings associated with the phone. */
98201
- warnings: {
98202
- /** Unique identifier of the type of warning. */
98203
- warning_code: string
98204
- /** Detailed description of the warning. */
98205
- message: string
98206
- /** Date and time at which Seam created the warning. */
98207
- created_at: string
98208
- }[]
98923
+ /** Array of errors associated with the device. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
98924
+ errors: (
98925
+ | {
98926
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98927
+ message: string
98928
+ /** Indicates that the error is not a device error. */
98929
+ is_device_error: false
98930
+ /** Date and time at which Seam created the error. */
98931
+ created_at: string
98932
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
98933
+ error_code: 'account_disconnected'
98934
+ /** Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */
98935
+ is_connected_account_error: true
98936
+ }
98937
+ | {
98938
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98939
+ message: string
98940
+ /** Indicates that the error is not a device error. */
98941
+ is_device_error: false
98942
+ /** Date and time at which Seam created the error. */
98943
+ created_at: string
98944
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
98945
+ error_code: 'salto_ks_subscription_limit_exceeded'
98946
+ /** Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */
98947
+ is_connected_account_error: true
98948
+ }
98949
+ | {
98950
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98951
+ message: string
98952
+ /** Indicates that the error is not a device error. */
98953
+ is_device_error: false
98954
+ /** Date and time at which Seam created the error. */
98955
+ created_at: string
98956
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
98957
+ error_code: 'insufficient_permissions'
98958
+ /** Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */
98959
+ is_connected_account_error: true
98960
+ }
98961
+ | {
98962
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98963
+ message: string
98964
+ /** Indicates that the error is not a device error. */
98965
+ is_device_error: false
98966
+ /** Date and time at which Seam created the error. */
98967
+ created_at: string
98968
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
98969
+ error_code: 'dormakaba_sites_disconnected'
98970
+ /** Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */
98971
+ is_connected_account_error: true
98972
+ }
98973
+ | {
98974
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98975
+ message: string
98976
+ /** Indicates that the error is a device error. */
98977
+ is_device_error: true
98978
+ /** Date and time at which Seam created the error. */
98979
+ created_at: string
98980
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
98981
+ error_code: 'device_offline'
98982
+ }
98983
+ | {
98984
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98985
+ message: string
98986
+ /** Indicates that the error is a device error. */
98987
+ is_device_error: true
98988
+ /** Date and time at which Seam created the error. */
98989
+ created_at: string
98990
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
98991
+ error_code: 'device_removed'
98992
+ }
98993
+ | {
98994
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98995
+ message: string
98996
+ /** Indicates that the error is a device error. */
98997
+ is_device_error: true
98998
+ /** Date and time at which Seam created the error. */
98999
+ created_at: string
99000
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
99001
+ error_code: 'hub_disconnected'
99002
+ }
99003
+ | {
99004
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
99005
+ message: string
99006
+ /** Indicates that the error is a device error. */
99007
+ is_device_error: true
99008
+ /** Date and time at which Seam created the error. */
99009
+ created_at: string
99010
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
99011
+ error_code: 'device_disconnected'
99012
+ }
99013
+ | {
99014
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
99015
+ message: string
99016
+ /** Indicates that the error is a device error. */
99017
+ is_device_error: true
99018
+ /** Date and time at which Seam created the error. */
99019
+ created_at: string
99020
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
99021
+ error_code: 'empty_backup_access_code_pool'
99022
+ }
99023
+ | {
99024
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
99025
+ message: string
99026
+ /** Indicates that the error is a device error. */
99027
+ is_device_error: true
99028
+ /** Date and time at which Seam created the error. */
99029
+ created_at: string
99030
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
99031
+ error_code: 'august_lock_not_authorized'
99032
+ }
99033
+ | {
99034
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
99035
+ message: string
99036
+ /** Indicates that the error is a device error. */
99037
+ is_device_error: true
99038
+ /** Date and time at which Seam created the error. */
99039
+ created_at: string
99040
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
99041
+ error_code: 'missing_device_credentials'
99042
+ }
99043
+ | {
99044
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
99045
+ message: string
99046
+ /** Indicates that the error is a device error. */
99047
+ is_device_error: true
99048
+ /** Date and time at which Seam created the error. */
99049
+ created_at: string
99050
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
99051
+ error_code: 'auxiliary_heat_running'
99052
+ }
99053
+ | {
99054
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
99055
+ message: string
99056
+ /** Indicates that the error is a device error. */
99057
+ is_device_error: true
99058
+ /** Date and time at which Seam created the error. */
99059
+ created_at: string
99060
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
99061
+ error_code: 'subscription_required'
99062
+ }
99063
+ | {
99064
+ /** Date and time at which Seam created the error. */
99065
+ created_at: string
99066
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
99067
+ message: string
99068
+ /** Indicates whether the error is related specifically to the connected account. */
99069
+ is_connected_account_error?: boolean | undefined
99070
+ /** Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge). */
99071
+ is_bridge_error?: boolean | undefined
99072
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
99073
+ error_code: 'bridge_disconnected'
99074
+ }
99075
+ )[]
99076
+ /** Array of warnings associated with the device. Each warning object within the array contains two fields: `warning_code` and `message`. `warning_code` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
99077
+ warnings: (
99078
+ | {
99079
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
99080
+ message: string
99081
+ /** Date and time at which Seam created the warning. */
99082
+ created_at: string
99083
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
99084
+ warning_code: 'partial_backup_access_code_pool'
99085
+ }
99086
+ | {
99087
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
99088
+ message: string
99089
+ /** Date and time at which Seam created the warning. */
99090
+ created_at: string
99091
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
99092
+ warning_code: 'many_active_backup_codes'
99093
+ }
99094
+ | {
99095
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
99096
+ message: string
99097
+ /** Date and time at which Seam created the warning. */
99098
+ created_at: string
99099
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
99100
+ warning_code: 'third_party_integration_detected'
99101
+ }
99102
+ | {
99103
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
99104
+ message: string
99105
+ /** Date and time at which Seam created the warning. */
99106
+ created_at: string
99107
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
99108
+ warning_code: 'ttlock_lock_gateway_unlocking_not_enabled'
99109
+ }
99110
+ | {
99111
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
99112
+ message: string
99113
+ /** Date and time at which Seam created the warning. */
99114
+ created_at: string
99115
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
99116
+ warning_code: 'ttlock_weak_gateway_signal'
99117
+ }
99118
+ | {
99119
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
99120
+ message: string
99121
+ /** Date and time at which Seam created the warning. */
99122
+ created_at: string
99123
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
99124
+ warning_code: 'power_saving_mode'
99125
+ }
99126
+ | {
99127
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
99128
+ message: string
99129
+ /** Date and time at which Seam created the warning. */
99130
+ created_at: string
99131
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
99132
+ warning_code: 'temperature_threshold_exceeded'
99133
+ }
99134
+ | {
99135
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
99136
+ message: string
99137
+ /** Date and time at which Seam created the warning. */
99138
+ created_at: string
99139
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
99140
+ warning_code: 'device_communication_degraded'
99141
+ }
99142
+ | {
99143
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
99144
+ message: string
99145
+ /** Date and time at which Seam created the warning. */
99146
+ created_at: string
99147
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
99148
+ warning_code: 'scheduled_maintenance_window'
99149
+ }
99150
+ | {
99151
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
99152
+ message: string
99153
+ /** Date and time at which Seam created the warning. */
99154
+ created_at: string
99155
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
99156
+ warning_code: 'device_has_flaky_connection'
99157
+ }
99158
+ | {
99159
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
99160
+ message: string
99161
+ /** Date and time at which Seam created the warning. */
99162
+ created_at: string
99163
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
99164
+ warning_code: 'salto_ks_office_mode'
99165
+ }
99166
+ | {
99167
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
99168
+ message: string
99169
+ /** Date and time at which Seam created the warning. */
99170
+ created_at: string
99171
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
99172
+ warning_code: 'salto_ks_privacy_mode'
99173
+ }
99174
+ | {
99175
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
99176
+ message: string
99177
+ /** Date and time at which Seam created the warning. */
99178
+ created_at: string
99179
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
99180
+ warning_code: 'privacy_mode'
99181
+ }
99182
+ | {
99183
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
99184
+ message: string
99185
+ /** Date and time at which Seam created the warning. */
99186
+ created_at: string
99187
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
99188
+ warning_code: 'salto_ks_subscription_limit_almost_reached'
99189
+ }
99190
+ | {
99191
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
99192
+ message: string
99193
+ /** Date and time at which Seam created the warning. */
99194
+ created_at: string
99195
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
99196
+ warning_code: 'salto_ks_lock_access_code_support_removed'
99197
+ }
99198
+ | {
99199
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
99200
+ message: string
99201
+ /** Date and time at which Seam created the warning. */
99202
+ created_at: string
99203
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
99204
+ warning_code: 'unknown_issue_with_phone'
99205
+ }
99206
+ | {
99207
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
99208
+ message: string
99209
+ /** Date and time at which Seam created the warning. */
99210
+ created_at: string
99211
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
99212
+ warning_code: 'lockly_time_zone_not_configured'
99213
+ }
99214
+ | {
99215
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
99216
+ message: string
99217
+ /** Date and time at which Seam created the warning. */
99218
+ created_at: string
99219
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
99220
+ warning_code: 'ultraloq_time_zone_unknown'
99221
+ }
99222
+ | {
99223
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
99224
+ message: string
99225
+ /** Date and time at which Seam created the warning. */
99226
+ created_at: string
99227
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
99228
+ warning_code: 'time_zone_unknown'
99229
+ }
99230
+ | {
99231
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
99232
+ message: string
99233
+ /** Date and time at which Seam created the warning. */
99234
+ created_at: string
99235
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
99236
+ warning_code: 'time_zone_mismatch'
99237
+ }
99238
+ | {
99239
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
99240
+ message: string
99241
+ /** Date and time at which Seam created the warning. */
99242
+ created_at: string
99243
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
99244
+ warning_code: 'two_n_device_missing_timezone'
99245
+ }
99246
+ | {
99247
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
99248
+ message: string
99249
+ /** Date and time at which Seam created the warning. */
99250
+ created_at: string
99251
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
99252
+ warning_code: 'hub_required_for_additional_capabilities'
99253
+ }
99254
+ | {
99255
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
99256
+ message: string
99257
+ /** Date and time at which Seam created the warning. */
99258
+ created_at: string
99259
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
99260
+ warning_code: 'provider_issue'
99261
+ }
99262
+ | {
99263
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
99264
+ message: string
99265
+ /** Date and time at which Seam created the warning. */
99266
+ created_at: string
99267
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
99268
+ warning_code: 'keynest_unsupported_locker'
99269
+ }
99270
+ | {
99271
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
99272
+ message: string
99273
+ /** Date and time at which Seam created the warning. */
99274
+ created_at: string
99275
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
99276
+ warning_code: 'accessory_keypad_setup_required'
99277
+ }
99278
+ | {
99279
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
99280
+ message: string
99281
+ /** Date and time at which Seam created the warning. */
99282
+ created_at: string
99283
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
99284
+ warning_code: 'accessory_keypad_low_battery'
99285
+ }
99286
+ | {
99287
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
99288
+ message: string
99289
+ /** Date and time at which Seam created the warning. */
99290
+ created_at: string
99291
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
99292
+ warning_code: 'unreliable_online_status'
99293
+ }
99294
+ | {
99295
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
99296
+ message: string
99297
+ /** Date and time at which Seam created the warning. */
99298
+ created_at: string
99299
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
99300
+ warning_code: 'max_access_codes_reached'
99301
+ /** Number of active access codes on the device when the warning was set. */
99302
+ active_access_code_count: number
99303
+ /** Maximum number of active access codes supported by the device. */
99304
+ max_active_access_code_count: number
99305
+ }
99306
+ )[]
98209
99307
  /** Type of the phone device, such as `ios_phone` or `android_phone`. */
98210
99308
  device_type: 'ios_phone' | 'android_phone'
98211
99309
  /** Properties of the phone. */
@@ -99790,8 +100888,8 @@ export type Routes = {
99790
100888
  | {
99791
100889
  /** Device whose access code could not be revoked. */
99792
100890
  device_id: string
99793
- /** Reason the access code could not be revoked (e.g. `offline_access_code_not_revocable`). */
99794
- error_code: string
100891
+ /** Reason the access code could not be revoked. */
100892
+ error_code: 'offline_access_code_not_revocable'
99795
100893
  /** Human-readable description of why revocation failed. */
99796
100894
  message: string
99797
100895
  }[]
@@ -108154,8 +109252,8 @@ export type Routes = {
108154
109252
  | {
108155
109253
  /** Device whose access code could not be revoked. */
108156
109254
  device_id: string
108157
- /** Reason the access code could not be revoked (e.g. `offline_access_code_not_revocable`). */
108158
- error_code: string
109255
+ /** Reason the access code could not be revoked. */
109256
+ error_code: 'offline_access_code_not_revocable'
108159
109257
  /** Human-readable description of why revocation failed. */
108160
109258
  message: string
108161
109259
  }[]
@@ -108741,8 +109839,8 @@ export type Routes = {
108741
109839
  | {
108742
109840
  /** Device whose access code could not be revoked. */
108743
109841
  device_id: string
108744
- /** Reason the access code could not be revoked (e.g. `offline_access_code_not_revocable`). */
108745
- error_code: string
109842
+ /** Reason the access code could not be revoked. */
109843
+ error_code: 'offline_access_code_not_revocable'
108746
109844
  /** Human-readable description of why revocation failed. */
108747
109845
  message: string
108748
109846
  }[]
@@ -109504,12 +110602,12 @@ export type Routes = {
109504
110602
  connected_account_id: string
109505
110603
  /** Errors associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
109506
110604
  errors: {
109507
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
109508
- error_code: string
109509
- /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
109510
- message: string
109511
110605
  /** Date and time at which Seam created the error. */
109512
110606
  created_at: string
110607
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
110608
+ message: string
110609
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
110610
+ error_code: 'entrance_removed'
109513
110611
  }[]
109514
110612
  /** Warnings associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
109515
110613
  warnings: (
@@ -116517,12 +117615,12 @@ export type Routes = {
116517
117615
  connected_account_id: string
116518
117616
  /** Errors associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
116519
117617
  errors: {
116520
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
116521
- error_code: string
116522
- /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
116523
- message: string
116524
117618
  /** Date and time at which Seam created the error. */
116525
117619
  created_at: string
117620
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
117621
+ message: string
117622
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
117623
+ error_code: 'entrance_removed'
116526
117624
  }[]
116527
117625
  /** Warnings associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
116528
117626
  warnings: (
@@ -150705,12 +151803,12 @@ export type Routes = {
150705
151803
  connected_account_id: string
150706
151804
  /** Errors associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
150707
151805
  errors: {
150708
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
150709
- error_code: string
150710
- /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
150711
- message: string
150712
151806
  /** Date and time at which Seam created the error. */
150713
151807
  created_at: string
151808
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
151809
+ message: string
151810
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
151811
+ error_code: 'entrance_removed'
150714
151812
  }[]
150715
151813
  /** Warnings associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
150716
151814
  warnings: (
@@ -154234,12 +155332,12 @@ export type Routes = {
154234
155332
  connected_account_id: string
154235
155333
  /** Errors associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
154236
155334
  errors: {
154237
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
154238
- error_code: string
154239
- /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
154240
- message: string
154241
155335
  /** Date and time at which Seam created the error. */
154242
155336
  created_at: string
155337
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
155338
+ message: string
155339
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
155340
+ error_code: 'entrance_removed'
154243
155341
  }[]
154244
155342
  /** Warnings associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */
154245
155343
  warnings: (
@@ -158972,8 +160070,8 @@ export type Routes = {
158972
160070
  | {
158973
160071
  /** Device whose access code could not be revoked. */
158974
160072
  device_id: string
158975
- /** Reason the access code could not be revoked (e.g. `offline_access_code_not_revocable`). */
158976
- error_code: string
160073
+ /** Reason the access code could not be revoked. */
160074
+ error_code: 'offline_access_code_not_revocable'
158977
160075
  /** Human-readable description of why revocation failed. */
158978
160076
  message: string
158979
160077
  }[]