@seamapi/types 1.404.1 → 1.404.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/connect.cjs +395 -111
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +425 -21
- package/lib/seam/connect/models/connected-accounts/connected-account.js +121 -41
- package/lib/seam/connect/models/connected-accounts/connected-account.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +125 -9
- package/lib/seam/connect/openapi.js +313 -76
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +300 -12
- package/package.json +1 -1
- package/src/lib/seam/connect/models/connected-accounts/connected-account.ts +172 -44
- package/src/lib/seam/connect/openapi.ts +389 -76
- package/src/lib/seam/connect/route-types.ts +300 -12
|
@@ -977,15 +977,24 @@ export default {
|
|
|
977
977
|
enum: ['invalid_credentials'],
|
|
978
978
|
type: 'string',
|
|
979
979
|
},
|
|
980
|
-
is_bridge_error: {
|
|
981
|
-
|
|
982
|
-
|
|
980
|
+
is_bridge_error: {
|
|
981
|
+
description: 'Indicates whether the error is related to Seam Bridge.',
|
|
982
|
+
type: 'boolean',
|
|
983
|
+
},
|
|
984
|
+
is_connected_account_error: {
|
|
985
|
+
description: 'Indicates whether the error is related specifically to the connected account.',
|
|
986
|
+
type: 'boolean',
|
|
987
|
+
},
|
|
988
|
+
message: {
|
|
989
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
990
|
+
type: 'string',
|
|
991
|
+
},
|
|
983
992
|
},
|
|
984
993
|
required: ['created_at', 'message', 'error_code'],
|
|
985
994
|
type: 'object',
|
|
986
995
|
},
|
|
987
996
|
{
|
|
988
|
-
description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline
|
|
997
|
+
description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).',
|
|
989
998
|
properties: {
|
|
990
999
|
created_at: {
|
|
991
1000
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -997,9 +1006,18 @@ export default {
|
|
|
997
1006
|
enum: ['bridge_disconnected'],
|
|
998
1007
|
type: 'string',
|
|
999
1008
|
},
|
|
1000
|
-
is_bridge_error: {
|
|
1001
|
-
|
|
1002
|
-
|
|
1009
|
+
is_bridge_error: {
|
|
1010
|
+
description: 'Indicates whether the error is related to Seam Bridge.',
|
|
1011
|
+
type: 'boolean',
|
|
1012
|
+
},
|
|
1013
|
+
is_connected_account_error: {
|
|
1014
|
+
description: 'Indicates whether the error is related specifically to the connected account.',
|
|
1015
|
+
type: 'boolean',
|
|
1016
|
+
},
|
|
1017
|
+
message: {
|
|
1018
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
1019
|
+
type: 'string',
|
|
1020
|
+
},
|
|
1003
1021
|
},
|
|
1004
1022
|
required: ['created_at', 'message', 'error_code'],
|
|
1005
1023
|
type: 'object',
|
|
@@ -6570,11 +6588,28 @@ export default {
|
|
|
6570
6588
|
connected_account: {
|
|
6571
6589
|
description: 'Represents a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks.',
|
|
6572
6590
|
properties: {
|
|
6573
|
-
account_type: {
|
|
6574
|
-
|
|
6575
|
-
|
|
6576
|
-
|
|
6577
|
-
|
|
6591
|
+
account_type: {
|
|
6592
|
+
description: 'Type of connected account.',
|
|
6593
|
+
type: 'string',
|
|
6594
|
+
},
|
|
6595
|
+
account_type_display_name: {
|
|
6596
|
+
description: 'Display name for the connected account type.',
|
|
6597
|
+
type: 'string',
|
|
6598
|
+
},
|
|
6599
|
+
automatically_manage_new_devices: {
|
|
6600
|
+
description: 'Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API.',
|
|
6601
|
+
type: 'boolean',
|
|
6602
|
+
},
|
|
6603
|
+
connected_account_id: {
|
|
6604
|
+
description: 'Unique identifier for the connected account.',
|
|
6605
|
+
format: 'uuid',
|
|
6606
|
+
type: 'string',
|
|
6607
|
+
},
|
|
6608
|
+
created_at: {
|
|
6609
|
+
description: 'Date and time at which the connected account was created.',
|
|
6610
|
+
format: 'date-time',
|
|
6611
|
+
type: 'string',
|
|
6612
|
+
},
|
|
6578
6613
|
custom_metadata: {
|
|
6579
6614
|
additionalProperties: {
|
|
6580
6615
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
@@ -6583,6 +6618,7 @@ export default {
|
|
|
6583
6618
|
type: 'object',
|
|
6584
6619
|
},
|
|
6585
6620
|
errors: {
|
|
6621
|
+
description: 'Errors associated with the connected account.',
|
|
6586
6622
|
items: {
|
|
6587
6623
|
discriminator: { propertyName: 'error_code' },
|
|
6588
6624
|
oneOf: [
|
|
@@ -6599,9 +6635,18 @@ export default {
|
|
|
6599
6635
|
enum: ['account_disconnected'],
|
|
6600
6636
|
type: 'string',
|
|
6601
6637
|
},
|
|
6602
|
-
is_bridge_error: {
|
|
6603
|
-
|
|
6604
|
-
|
|
6638
|
+
is_bridge_error: {
|
|
6639
|
+
description: 'Indicates whether the error is related to Seam Bridge.',
|
|
6640
|
+
type: 'boolean',
|
|
6641
|
+
},
|
|
6642
|
+
is_connected_account_error: {
|
|
6643
|
+
description: 'Indicates whether the error is related specifically to the connected account.',
|
|
6644
|
+
type: 'boolean',
|
|
6645
|
+
},
|
|
6646
|
+
message: {
|
|
6647
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
6648
|
+
type: 'string',
|
|
6649
|
+
},
|
|
6605
6650
|
},
|
|
6606
6651
|
required: ['created_at', 'message', 'error_code'],
|
|
6607
6652
|
type: 'object',
|
|
@@ -6619,15 +6664,24 @@ export default {
|
|
|
6619
6664
|
enum: ['invalid_credentials'],
|
|
6620
6665
|
type: 'string',
|
|
6621
6666
|
},
|
|
6622
|
-
is_bridge_error: {
|
|
6623
|
-
|
|
6624
|
-
|
|
6667
|
+
is_bridge_error: {
|
|
6668
|
+
description: 'Indicates whether the error is related to Seam Bridge.',
|
|
6669
|
+
type: 'boolean',
|
|
6670
|
+
},
|
|
6671
|
+
is_connected_account_error: {
|
|
6672
|
+
description: 'Indicates whether the error is related specifically to the connected account.',
|
|
6673
|
+
type: 'boolean',
|
|
6674
|
+
},
|
|
6675
|
+
message: {
|
|
6676
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
6677
|
+
type: 'string',
|
|
6678
|
+
},
|
|
6625
6679
|
},
|
|
6626
6680
|
required: ['created_at', 'message', 'error_code'],
|
|
6627
6681
|
type: 'object',
|
|
6628
6682
|
},
|
|
6629
6683
|
{
|
|
6630
|
-
description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline
|
|
6684
|
+
description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).',
|
|
6631
6685
|
properties: {
|
|
6632
6686
|
created_at: {
|
|
6633
6687
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -6639,9 +6693,18 @@ export default {
|
|
|
6639
6693
|
enum: ['bridge_disconnected'],
|
|
6640
6694
|
type: 'string',
|
|
6641
6695
|
},
|
|
6642
|
-
is_bridge_error: {
|
|
6643
|
-
|
|
6644
|
-
|
|
6696
|
+
is_bridge_error: {
|
|
6697
|
+
description: 'Indicates whether the error is related to Seam Bridge.',
|
|
6698
|
+
type: 'boolean',
|
|
6699
|
+
},
|
|
6700
|
+
is_connected_account_error: {
|
|
6701
|
+
description: 'Indicates whether the error is related specifically to the connected account.',
|
|
6702
|
+
type: 'boolean',
|
|
6703
|
+
},
|
|
6704
|
+
message: {
|
|
6705
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
6706
|
+
type: 'string',
|
|
6707
|
+
},
|
|
6645
6708
|
},
|
|
6646
6709
|
required: ['created_at', 'message', 'error_code'],
|
|
6647
6710
|
type: 'object',
|
|
@@ -6659,21 +6722,41 @@ export default {
|
|
|
6659
6722
|
enum: ['salto_ks_subscription_limit_exceeded'],
|
|
6660
6723
|
type: 'string',
|
|
6661
6724
|
},
|
|
6662
|
-
is_bridge_error: {
|
|
6663
|
-
|
|
6664
|
-
|
|
6725
|
+
is_bridge_error: {
|
|
6726
|
+
description: 'Indicates whether the error is related to Seam Bridge.',
|
|
6727
|
+
type: 'boolean',
|
|
6728
|
+
},
|
|
6729
|
+
is_connected_account_error: {
|
|
6730
|
+
description: 'Indicates whether the error is related specifically to the connected account.',
|
|
6731
|
+
type: 'boolean',
|
|
6732
|
+
},
|
|
6733
|
+
message: {
|
|
6734
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
6735
|
+
type: 'string',
|
|
6736
|
+
},
|
|
6665
6737
|
salto_ks_metadata: {
|
|
6738
|
+
description: 'Salto KS metadata associated with the connected account that has an error.',
|
|
6666
6739
|
properties: {
|
|
6667
6740
|
sites: {
|
|
6741
|
+
description: 'Salto sites associated with the connected account that has an error.',
|
|
6668
6742
|
items: {
|
|
6743
|
+
description: 'Salto site associated with the connected account that has an error.',
|
|
6669
6744
|
properties: {
|
|
6670
|
-
site_id: {
|
|
6671
|
-
|
|
6745
|
+
site_id: {
|
|
6746
|
+
description: 'ID of a Salto site associated with the connected account that has an error.',
|
|
6747
|
+
type: 'string',
|
|
6748
|
+
},
|
|
6749
|
+
site_name: {
|
|
6750
|
+
description: 'Name of a Salto site associated with the connected account that has an error.',
|
|
6751
|
+
type: 'string',
|
|
6752
|
+
},
|
|
6672
6753
|
site_user_subscription_limit: {
|
|
6754
|
+
description: 'Subscription limit of site users for a Salto site associated with the connected account that has an error.',
|
|
6673
6755
|
minimum: 0,
|
|
6674
6756
|
type: 'integer',
|
|
6675
6757
|
},
|
|
6676
6758
|
subscribed_site_user_count: {
|
|
6759
|
+
description: 'Count of subscribed site users for a Salto site associated with the connected account that has an error.',
|
|
6677
6760
|
minimum: 0,
|
|
6678
6761
|
type: 'integer',
|
|
6679
6762
|
},
|
|
@@ -6706,29 +6789,49 @@ export default {
|
|
|
6706
6789
|
type: 'array',
|
|
6707
6790
|
},
|
|
6708
6791
|
user_identifier: {
|
|
6792
|
+
description: 'User identifier associated with the connected account.',
|
|
6709
6793
|
properties: {
|
|
6710
|
-
api_url: {
|
|
6711
|
-
|
|
6712
|
-
|
|
6713
|
-
|
|
6714
|
-
|
|
6794
|
+
api_url: {
|
|
6795
|
+
description: 'API URL for the user identifier associated with the connected account.',
|
|
6796
|
+
type: 'string',
|
|
6797
|
+
},
|
|
6798
|
+
email: {
|
|
6799
|
+
description: 'Email address of the user identifier associated with the connected account.',
|
|
6800
|
+
type: 'string',
|
|
6801
|
+
},
|
|
6802
|
+
exclusive: {
|
|
6803
|
+
description: 'Indicates whether the user identifier associated with the connected account is exclusive.',
|
|
6804
|
+
type: 'boolean',
|
|
6805
|
+
},
|
|
6806
|
+
phone: {
|
|
6807
|
+
description: 'Phone number of the user identifier associated with the connected account.',
|
|
6808
|
+
type: 'string',
|
|
6809
|
+
},
|
|
6810
|
+
username: {
|
|
6811
|
+
description: 'Username of the user identifier associated with the connected account.',
|
|
6812
|
+
type: 'string',
|
|
6813
|
+
},
|
|
6715
6814
|
},
|
|
6716
6815
|
type: 'object',
|
|
6717
6816
|
},
|
|
6718
6817
|
warnings: {
|
|
6818
|
+
description: 'Warnings associated with the connected account.',
|
|
6719
6819
|
items: {
|
|
6720
|
-
description: 'Warning associated with the
|
|
6820
|
+
description: 'Warning associated with the connected account.',
|
|
6721
6821
|
discriminator: { propertyName: 'warning_code' },
|
|
6722
6822
|
oneOf: [
|
|
6723
6823
|
{
|
|
6724
|
-
description: 'Scheduled downtime for account
|
|
6824
|
+
description: 'Scheduled downtime planned for the connected account.',
|
|
6725
6825
|
properties: {
|
|
6726
6826
|
created_at: {
|
|
6727
6827
|
description: 'Date and time at which Seam created the warning.',
|
|
6728
6828
|
format: 'date-time',
|
|
6729
6829
|
type: 'string',
|
|
6730
6830
|
},
|
|
6731
|
-
message: {
|
|
6831
|
+
message: {
|
|
6832
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
6833
|
+
type: 'string',
|
|
6834
|
+
},
|
|
6732
6835
|
warning_code: {
|
|
6733
6836
|
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
6734
6837
|
enum: ['scheduled_maintenance_window'],
|
|
@@ -6739,14 +6842,17 @@ export default {
|
|
|
6739
6842
|
type: 'object',
|
|
6740
6843
|
},
|
|
6741
6844
|
{
|
|
6742
|
-
description: 'An unknown issue occurred while syncing the state of
|
|
6845
|
+
description: 'An unknown issue occurred while syncing the state of the connected account with the provider. This issue may affect the proper functioning of one or more resources in the account.',
|
|
6743
6846
|
properties: {
|
|
6744
6847
|
created_at: {
|
|
6745
6848
|
description: 'Date and time at which Seam created the warning.',
|
|
6746
6849
|
format: 'date-time',
|
|
6747
6850
|
type: 'string',
|
|
6748
6851
|
},
|
|
6749
|
-
message: {
|
|
6852
|
+
message: {
|
|
6853
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
6854
|
+
type: 'string',
|
|
6855
|
+
},
|
|
6750
6856
|
warning_code: {
|
|
6751
6857
|
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
6752
6858
|
enum: ['unknown_issue_with_connected_account'],
|
|
@@ -6757,26 +6863,40 @@ export default {
|
|
|
6757
6863
|
type: 'object',
|
|
6758
6864
|
},
|
|
6759
6865
|
{
|
|
6760
|
-
description: 'Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users.
|
|
6866
|
+
description: 'Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site.',
|
|
6761
6867
|
properties: {
|
|
6762
6868
|
created_at: {
|
|
6763
6869
|
description: 'Date and time at which Seam created the warning.',
|
|
6764
6870
|
format: 'date-time',
|
|
6765
6871
|
type: 'string',
|
|
6766
6872
|
},
|
|
6767
|
-
message: {
|
|
6873
|
+
message: {
|
|
6874
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
6875
|
+
type: 'string',
|
|
6876
|
+
},
|
|
6768
6877
|
salto_ks_metadata: {
|
|
6878
|
+
description: 'Salto KS metadata associated with the connected account that has a warning.',
|
|
6769
6879
|
properties: {
|
|
6770
6880
|
sites: {
|
|
6881
|
+
description: 'Salto sites associated with the connected account that has a warning.',
|
|
6771
6882
|
items: {
|
|
6883
|
+
description: 'Salto site associated with the connected account that has a warning.',
|
|
6772
6884
|
properties: {
|
|
6773
|
-
site_id: {
|
|
6774
|
-
|
|
6885
|
+
site_id: {
|
|
6886
|
+
description: 'ID of a Salto site associated with the connected account that has a warning.',
|
|
6887
|
+
type: 'string',
|
|
6888
|
+
},
|
|
6889
|
+
site_name: {
|
|
6890
|
+
description: 'Name of a Salto site associated with the connected account that has a warning.',
|
|
6891
|
+
type: 'string',
|
|
6892
|
+
},
|
|
6775
6893
|
site_user_subscription_limit: {
|
|
6894
|
+
description: 'Subscription limit of site users for a Salto site associated with the connected account that has a warning.',
|
|
6776
6895
|
minimum: 0,
|
|
6777
6896
|
type: 'integer',
|
|
6778
6897
|
},
|
|
6779
6898
|
subscribed_site_user_count: {
|
|
6899
|
+
description: 'Count of subscribed site users for a Salto site associated with the connected account that has a warning.',
|
|
6780
6900
|
minimum: 0,
|
|
6781
6901
|
type: 'integer',
|
|
6782
6902
|
},
|
|
@@ -7224,15 +7344,24 @@ export default {
|
|
|
7224
7344
|
enum: ['invalid_credentials'],
|
|
7225
7345
|
type: 'string',
|
|
7226
7346
|
},
|
|
7227
|
-
is_bridge_error: {
|
|
7228
|
-
|
|
7229
|
-
|
|
7347
|
+
is_bridge_error: {
|
|
7348
|
+
description: 'Indicates whether the error is related to Seam Bridge.',
|
|
7349
|
+
type: 'boolean',
|
|
7350
|
+
},
|
|
7351
|
+
is_connected_account_error: {
|
|
7352
|
+
description: 'Indicates whether the error is related specifically to the connected account.',
|
|
7353
|
+
type: 'boolean',
|
|
7354
|
+
},
|
|
7355
|
+
message: {
|
|
7356
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
7357
|
+
type: 'string',
|
|
7358
|
+
},
|
|
7230
7359
|
},
|
|
7231
7360
|
required: ['created_at', 'message', 'error_code'],
|
|
7232
7361
|
type: 'object',
|
|
7233
7362
|
},
|
|
7234
7363
|
{
|
|
7235
|
-
description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline
|
|
7364
|
+
description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).',
|
|
7236
7365
|
properties: {
|
|
7237
7366
|
created_at: {
|
|
7238
7367
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -7244,9 +7373,18 @@ export default {
|
|
|
7244
7373
|
enum: ['bridge_disconnected'],
|
|
7245
7374
|
type: 'string',
|
|
7246
7375
|
},
|
|
7247
|
-
is_bridge_error: {
|
|
7248
|
-
|
|
7249
|
-
|
|
7376
|
+
is_bridge_error: {
|
|
7377
|
+
description: 'Indicates whether the error is related to Seam Bridge.',
|
|
7378
|
+
type: 'boolean',
|
|
7379
|
+
},
|
|
7380
|
+
is_connected_account_error: {
|
|
7381
|
+
description: 'Indicates whether the error is related specifically to the connected account.',
|
|
7382
|
+
type: 'boolean',
|
|
7383
|
+
},
|
|
7384
|
+
message: {
|
|
7385
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
7386
|
+
type: 'string',
|
|
7387
|
+
},
|
|
7250
7388
|
},
|
|
7251
7389
|
required: ['created_at', 'message', 'error_code'],
|
|
7252
7390
|
type: 'object',
|
|
@@ -15517,15 +15655,24 @@ export default {
|
|
|
15517
15655
|
enum: ['invalid_credentials'],
|
|
15518
15656
|
type: 'string',
|
|
15519
15657
|
},
|
|
15520
|
-
is_bridge_error: {
|
|
15521
|
-
|
|
15522
|
-
|
|
15658
|
+
is_bridge_error: {
|
|
15659
|
+
description: 'Indicates whether the error is related to Seam Bridge.',
|
|
15660
|
+
type: 'boolean',
|
|
15661
|
+
},
|
|
15662
|
+
is_connected_account_error: {
|
|
15663
|
+
description: 'Indicates whether the error is related specifically to the connected account.',
|
|
15664
|
+
type: 'boolean',
|
|
15665
|
+
},
|
|
15666
|
+
message: {
|
|
15667
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
15668
|
+
type: 'string',
|
|
15669
|
+
},
|
|
15523
15670
|
},
|
|
15524
15671
|
required: ['created_at', 'message', 'error_code'],
|
|
15525
15672
|
type: 'object',
|
|
15526
15673
|
},
|
|
15527
15674
|
{
|
|
15528
|
-
description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline
|
|
15675
|
+
description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).',
|
|
15529
15676
|
properties: {
|
|
15530
15677
|
created_at: {
|
|
15531
15678
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -15537,9 +15684,18 @@ export default {
|
|
|
15537
15684
|
enum: ['bridge_disconnected'],
|
|
15538
15685
|
type: 'string',
|
|
15539
15686
|
},
|
|
15540
|
-
is_bridge_error: {
|
|
15541
|
-
|
|
15542
|
-
|
|
15687
|
+
is_bridge_error: {
|
|
15688
|
+
description: 'Indicates whether the error is related to Seam Bridge.',
|
|
15689
|
+
type: 'boolean',
|
|
15690
|
+
},
|
|
15691
|
+
is_connected_account_error: {
|
|
15692
|
+
description: 'Indicates whether the error is related specifically to the connected account.',
|
|
15693
|
+
type: 'boolean',
|
|
15694
|
+
},
|
|
15695
|
+
message: {
|
|
15696
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
15697
|
+
type: 'string',
|
|
15698
|
+
},
|
|
15543
15699
|
},
|
|
15544
15700
|
required: ['created_at', 'message', 'error_code'],
|
|
15545
15701
|
type: 'object',
|
|
@@ -17239,15 +17395,24 @@ export default {
|
|
|
17239
17395
|
enum: ['invalid_credentials'],
|
|
17240
17396
|
type: 'string',
|
|
17241
17397
|
},
|
|
17242
|
-
is_bridge_error: {
|
|
17243
|
-
|
|
17244
|
-
|
|
17398
|
+
is_bridge_error: {
|
|
17399
|
+
description: 'Indicates whether the error is related to Seam Bridge.',
|
|
17400
|
+
type: 'boolean',
|
|
17401
|
+
},
|
|
17402
|
+
is_connected_account_error: {
|
|
17403
|
+
description: 'Indicates whether the error is related specifically to the connected account.',
|
|
17404
|
+
type: 'boolean',
|
|
17405
|
+
},
|
|
17406
|
+
message: {
|
|
17407
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
17408
|
+
type: 'string',
|
|
17409
|
+
},
|
|
17245
17410
|
},
|
|
17246
17411
|
required: ['created_at', 'message', 'error_code'],
|
|
17247
17412
|
type: 'object',
|
|
17248
17413
|
},
|
|
17249
17414
|
{
|
|
17250
|
-
description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline
|
|
17415
|
+
description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).',
|
|
17251
17416
|
properties: {
|
|
17252
17417
|
created_at: {
|
|
17253
17418
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -17259,9 +17424,18 @@ export default {
|
|
|
17259
17424
|
enum: ['bridge_disconnected'],
|
|
17260
17425
|
type: 'string',
|
|
17261
17426
|
},
|
|
17262
|
-
is_bridge_error: {
|
|
17263
|
-
|
|
17264
|
-
|
|
17427
|
+
is_bridge_error: {
|
|
17428
|
+
description: 'Indicates whether the error is related to Seam Bridge.',
|
|
17429
|
+
type: 'boolean',
|
|
17430
|
+
},
|
|
17431
|
+
is_connected_account_error: {
|
|
17432
|
+
description: 'Indicates whether the error is related specifically to the connected account.',
|
|
17433
|
+
type: 'boolean',
|
|
17434
|
+
},
|
|
17435
|
+
message: {
|
|
17436
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
17437
|
+
type: 'string',
|
|
17438
|
+
},
|
|
17265
17439
|
},
|
|
17266
17440
|
required: ['created_at', 'message', 'error_code'],
|
|
17267
17441
|
type: 'object',
|
|
@@ -22680,13 +22854,22 @@ export default {
|
|
|
22680
22854
|
'application/json': {
|
|
22681
22855
|
schema: {
|
|
22682
22856
|
properties: {
|
|
22857
|
+
acs_system_id: {
|
|
22858
|
+
description: 'ID of the access system that you want to delete. You must provide acs_system_id with user_identity_id.',
|
|
22859
|
+
format: 'uuid',
|
|
22860
|
+
type: 'string',
|
|
22861
|
+
},
|
|
22683
22862
|
acs_user_id: {
|
|
22684
|
-
description: 'ID of the access system user that you want to delete.',
|
|
22863
|
+
description: 'ID of the access system user that you want to delete. You must provide either acs_user_id or user_identity_id',
|
|
22864
|
+
format: 'uuid',
|
|
22865
|
+
type: 'string',
|
|
22866
|
+
},
|
|
22867
|
+
user_identity_id: {
|
|
22868
|
+
description: 'ID of the user identity that you want to delete. You must provide either acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id.',
|
|
22685
22869
|
format: 'uuid',
|
|
22686
22870
|
type: 'string',
|
|
22687
22871
|
},
|
|
22688
22872
|
},
|
|
22689
|
-
required: ['acs_user_id'],
|
|
22690
22873
|
type: 'object',
|
|
22691
22874
|
},
|
|
22692
22875
|
},
|
|
@@ -22730,13 +22913,22 @@ export default {
|
|
|
22730
22913
|
'application/json': {
|
|
22731
22914
|
schema: {
|
|
22732
22915
|
properties: {
|
|
22916
|
+
acs_system_id: {
|
|
22917
|
+
description: 'ID of the access system that you want to get. You can only provide acs_user_id or user_identity_id.',
|
|
22918
|
+
format: 'uuid',
|
|
22919
|
+
type: 'string',
|
|
22920
|
+
},
|
|
22733
22921
|
acs_user_id: {
|
|
22734
|
-
description: 'ID of the access system user that you want to get.',
|
|
22922
|
+
description: 'ID of the access system user that you want to get. You can only provide acs_user_id or user_identity_id.',
|
|
22923
|
+
format: 'uuid',
|
|
22924
|
+
type: 'string',
|
|
22925
|
+
},
|
|
22926
|
+
user_identity_id: {
|
|
22927
|
+
description: 'ID of the user identity that you want to get. You can only provide acs_user_id or user_identity_id.',
|
|
22735
22928
|
format: 'uuid',
|
|
22736
22929
|
type: 'string',
|
|
22737
22930
|
},
|
|
22738
22931
|
},
|
|
22739
|
-
required: ['acs_user_id'],
|
|
22740
22932
|
type: 'object',
|
|
22741
22933
|
},
|
|
22742
22934
|
},
|
|
@@ -23004,13 +23196,22 @@ export default {
|
|
|
23004
23196
|
'application/json': {
|
|
23005
23197
|
schema: {
|
|
23006
23198
|
properties: {
|
|
23199
|
+
acs_system_id: {
|
|
23200
|
+
description: 'ID of the access system for which you want to revoke access. You can only provide acs_system_id with user_identity_id.',
|
|
23201
|
+
format: 'uuid',
|
|
23202
|
+
type: 'string',
|
|
23203
|
+
},
|
|
23007
23204
|
acs_user_id: {
|
|
23008
|
-
description: 'ID of the access system user for whom you want to revoke access.',
|
|
23205
|
+
description: 'ID of the access system user for whom you want to revoke access. You can only provide acs_user_id or user_identity_id.',
|
|
23206
|
+
format: 'uuid',
|
|
23207
|
+
type: 'string',
|
|
23208
|
+
},
|
|
23209
|
+
user_identity_id: {
|
|
23210
|
+
description: 'ID of the user identity for whom you want to revoke access. You can only provide acs_user_id or user_identity_id.',
|
|
23009
23211
|
format: 'uuid',
|
|
23010
23212
|
type: 'string',
|
|
23011
23213
|
},
|
|
23012
23214
|
},
|
|
23013
|
-
required: ['acs_user_id'],
|
|
23014
23215
|
type: 'object',
|
|
23015
23216
|
},
|
|
23016
23217
|
},
|
|
@@ -23054,13 +23255,22 @@ export default {
|
|
|
23054
23255
|
'application/json': {
|
|
23055
23256
|
schema: {
|
|
23056
23257
|
properties: {
|
|
23258
|
+
acs_system_id: {
|
|
23259
|
+
description: 'ID of the access system that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.',
|
|
23260
|
+
format: 'uuid',
|
|
23261
|
+
type: 'string',
|
|
23262
|
+
},
|
|
23057
23263
|
acs_user_id: {
|
|
23058
|
-
description: 'ID of the access system user that you want to suspend.',
|
|
23264
|
+
description: 'ID of the access system user that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.',
|
|
23265
|
+
format: 'uuid',
|
|
23266
|
+
type: 'string',
|
|
23267
|
+
},
|
|
23268
|
+
user_identity_id: {
|
|
23269
|
+
description: 'ID of the user identity that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.',
|
|
23059
23270
|
format: 'uuid',
|
|
23060
23271
|
type: 'string',
|
|
23061
23272
|
},
|
|
23062
23273
|
},
|
|
23063
|
-
required: ['acs_user_id'],
|
|
23064
23274
|
type: 'object',
|
|
23065
23275
|
},
|
|
23066
23276
|
},
|
|
@@ -23239,13 +23449,22 @@ export default {
|
|
|
23239
23449
|
'application/json': {
|
|
23240
23450
|
schema: {
|
|
23241
23451
|
properties: {
|
|
23452
|
+
acs_system_id: {
|
|
23453
|
+
description: 'ID of the access system of the user that you want to unsuspend. You can only provide acs_system_id with user_identity_id.',
|
|
23454
|
+
format: 'uuid',
|
|
23455
|
+
type: 'string',
|
|
23456
|
+
},
|
|
23242
23457
|
acs_user_id: {
|
|
23243
|
-
description: 'ID of the access system user that you want to unsuspend.',
|
|
23458
|
+
description: 'ID of the access system user that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.',
|
|
23459
|
+
format: 'uuid',
|
|
23460
|
+
type: 'string',
|
|
23461
|
+
},
|
|
23462
|
+
user_identity_id: {
|
|
23463
|
+
description: 'ID of the user identity that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.',
|
|
23244
23464
|
format: 'uuid',
|
|
23245
23465
|
type: 'string',
|
|
23246
23466
|
},
|
|
23247
23467
|
},
|
|
23248
|
-
required: ['acs_user_id'],
|
|
23249
23468
|
type: 'object',
|
|
23250
23469
|
},
|
|
23251
23470
|
},
|
|
@@ -23307,8 +23526,13 @@ export default {
|
|
|
23307
23526
|
required: ['starts_at', 'ends_at'],
|
|
23308
23527
|
type: 'object',
|
|
23309
23528
|
},
|
|
23529
|
+
acs_system_id: {
|
|
23530
|
+
description: 'ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id.',
|
|
23531
|
+
format: 'uuid',
|
|
23532
|
+
type: 'string',
|
|
23533
|
+
},
|
|
23310
23534
|
acs_user_id: {
|
|
23311
|
-
description: 'ID of the
|
|
23535
|
+
description: 'ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id.',
|
|
23312
23536
|
format: 'uuid',
|
|
23313
23537
|
type: 'string',
|
|
23314
23538
|
},
|
|
@@ -23333,8 +23557,12 @@ export default {
|
|
|
23333
23557
|
description: 'Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).',
|
|
23334
23558
|
type: 'string',
|
|
23335
23559
|
},
|
|
23560
|
+
user_identity_id: {
|
|
23561
|
+
description: 'ID of the user identity that you want to update. You can only provide acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id.',
|
|
23562
|
+
format: 'uuid',
|
|
23563
|
+
type: 'string',
|
|
23564
|
+
},
|
|
23336
23565
|
},
|
|
23337
|
-
required: ['acs_user_id'],
|
|
23338
23566
|
type: 'object',
|
|
23339
23567
|
},
|
|
23340
23568
|
},
|
|
@@ -23393,8 +23621,13 @@ export default {
|
|
|
23393
23621
|
required: ['starts_at', 'ends_at'],
|
|
23394
23622
|
type: 'object',
|
|
23395
23623
|
},
|
|
23624
|
+
acs_system_id: {
|
|
23625
|
+
description: 'ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id.',
|
|
23626
|
+
format: 'uuid',
|
|
23627
|
+
type: 'string',
|
|
23628
|
+
},
|
|
23396
23629
|
acs_user_id: {
|
|
23397
|
-
description: 'ID of the
|
|
23630
|
+
description: 'ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id.',
|
|
23398
23631
|
format: 'uuid',
|
|
23399
23632
|
type: 'string',
|
|
23400
23633
|
},
|
|
@@ -23419,8 +23652,12 @@ export default {
|
|
|
23419
23652
|
description: 'Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).',
|
|
23420
23653
|
type: 'string',
|
|
23421
23654
|
},
|
|
23655
|
+
user_identity_id: {
|
|
23656
|
+
description: 'ID of the user identity that you want to update. You can only provide acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id.',
|
|
23657
|
+
format: 'uuid',
|
|
23658
|
+
type: 'string',
|
|
23659
|
+
},
|
|
23422
23660
|
},
|
|
23423
|
-
required: ['acs_user_id'],
|
|
23424
23661
|
type: 'object',
|
|
23425
23662
|
},
|
|
23426
23663
|
},
|