@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
|
@@ -1105,16 +1105,28 @@ export default {
|
|
|
1105
1105
|
enum: ['invalid_credentials'],
|
|
1106
1106
|
type: 'string',
|
|
1107
1107
|
},
|
|
1108
|
-
is_bridge_error: {
|
|
1109
|
-
|
|
1110
|
-
|
|
1108
|
+
is_bridge_error: {
|
|
1109
|
+
description:
|
|
1110
|
+
'Indicates whether the error is related to Seam Bridge.',
|
|
1111
|
+
type: 'boolean',
|
|
1112
|
+
},
|
|
1113
|
+
is_connected_account_error: {
|
|
1114
|
+
description:
|
|
1115
|
+
'Indicates whether the error is related specifically to the connected account.',
|
|
1116
|
+
type: 'boolean',
|
|
1117
|
+
},
|
|
1118
|
+
message: {
|
|
1119
|
+
description:
|
|
1120
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
1121
|
+
type: 'string',
|
|
1122
|
+
},
|
|
1111
1123
|
},
|
|
1112
1124
|
required: ['created_at', 'message', 'error_code'],
|
|
1113
1125
|
type: 'object',
|
|
1114
1126
|
},
|
|
1115
1127
|
{
|
|
1116
1128
|
description:
|
|
1117
|
-
'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
|
|
1129
|
+
'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).',
|
|
1118
1130
|
properties: {
|
|
1119
1131
|
created_at: {
|
|
1120
1132
|
description:
|
|
@@ -1128,9 +1140,21 @@ export default {
|
|
|
1128
1140
|
enum: ['bridge_disconnected'],
|
|
1129
1141
|
type: 'string',
|
|
1130
1142
|
},
|
|
1131
|
-
is_bridge_error: {
|
|
1132
|
-
|
|
1133
|
-
|
|
1143
|
+
is_bridge_error: {
|
|
1144
|
+
description:
|
|
1145
|
+
'Indicates whether the error is related to Seam Bridge.',
|
|
1146
|
+
type: 'boolean',
|
|
1147
|
+
},
|
|
1148
|
+
is_connected_account_error: {
|
|
1149
|
+
description:
|
|
1150
|
+
'Indicates whether the error is related specifically to the connected account.',
|
|
1151
|
+
type: 'boolean',
|
|
1152
|
+
},
|
|
1153
|
+
message: {
|
|
1154
|
+
description:
|
|
1155
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
1156
|
+
type: 'string',
|
|
1157
|
+
},
|
|
1134
1158
|
},
|
|
1135
1159
|
required: ['created_at', 'message', 'error_code'],
|
|
1136
1160
|
type: 'object',
|
|
@@ -7308,11 +7332,30 @@ export default {
|
|
|
7308
7332
|
description:
|
|
7309
7333
|
'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.',
|
|
7310
7334
|
properties: {
|
|
7311
|
-
account_type: {
|
|
7312
|
-
|
|
7313
|
-
|
|
7314
|
-
|
|
7315
|
-
|
|
7335
|
+
account_type: {
|
|
7336
|
+
description: 'Type of connected account.',
|
|
7337
|
+
type: 'string',
|
|
7338
|
+
},
|
|
7339
|
+
account_type_display_name: {
|
|
7340
|
+
description: 'Display name for the connected account type.',
|
|
7341
|
+
type: 'string',
|
|
7342
|
+
},
|
|
7343
|
+
automatically_manage_new_devices: {
|
|
7344
|
+
description:
|
|
7345
|
+
'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.',
|
|
7346
|
+
type: 'boolean',
|
|
7347
|
+
},
|
|
7348
|
+
connected_account_id: {
|
|
7349
|
+
description: 'Unique identifier for the connected account.',
|
|
7350
|
+
format: 'uuid',
|
|
7351
|
+
type: 'string',
|
|
7352
|
+
},
|
|
7353
|
+
created_at: {
|
|
7354
|
+
description:
|
|
7355
|
+
'Date and time at which the connected account was created.',
|
|
7356
|
+
format: 'date-time',
|
|
7357
|
+
type: 'string',
|
|
7358
|
+
},
|
|
7316
7359
|
custom_metadata: {
|
|
7317
7360
|
additionalProperties: {
|
|
7318
7361
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
@@ -7322,6 +7365,7 @@ export default {
|
|
|
7322
7365
|
type: 'object',
|
|
7323
7366
|
},
|
|
7324
7367
|
errors: {
|
|
7368
|
+
description: 'Errors associated with the connected account.',
|
|
7325
7369
|
items: {
|
|
7326
7370
|
discriminator: { propertyName: 'error_code' },
|
|
7327
7371
|
oneOf: [
|
|
@@ -7340,9 +7384,21 @@ export default {
|
|
|
7340
7384
|
enum: ['account_disconnected'],
|
|
7341
7385
|
type: 'string',
|
|
7342
7386
|
},
|
|
7343
|
-
is_bridge_error: {
|
|
7344
|
-
|
|
7345
|
-
|
|
7387
|
+
is_bridge_error: {
|
|
7388
|
+
description:
|
|
7389
|
+
'Indicates whether the error is related to Seam Bridge.',
|
|
7390
|
+
type: 'boolean',
|
|
7391
|
+
},
|
|
7392
|
+
is_connected_account_error: {
|
|
7393
|
+
description:
|
|
7394
|
+
'Indicates whether the error is related specifically to the connected account.',
|
|
7395
|
+
type: 'boolean',
|
|
7396
|
+
},
|
|
7397
|
+
message: {
|
|
7398
|
+
description:
|
|
7399
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
7400
|
+
type: 'string',
|
|
7401
|
+
},
|
|
7346
7402
|
},
|
|
7347
7403
|
required: ['created_at', 'message', 'error_code'],
|
|
7348
7404
|
type: 'object',
|
|
@@ -7362,16 +7418,28 @@ export default {
|
|
|
7362
7418
|
enum: ['invalid_credentials'],
|
|
7363
7419
|
type: 'string',
|
|
7364
7420
|
},
|
|
7365
|
-
is_bridge_error: {
|
|
7366
|
-
|
|
7367
|
-
|
|
7421
|
+
is_bridge_error: {
|
|
7422
|
+
description:
|
|
7423
|
+
'Indicates whether the error is related to Seam Bridge.',
|
|
7424
|
+
type: 'boolean',
|
|
7425
|
+
},
|
|
7426
|
+
is_connected_account_error: {
|
|
7427
|
+
description:
|
|
7428
|
+
'Indicates whether the error is related specifically to the connected account.',
|
|
7429
|
+
type: 'boolean',
|
|
7430
|
+
},
|
|
7431
|
+
message: {
|
|
7432
|
+
description:
|
|
7433
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
7434
|
+
type: 'string',
|
|
7435
|
+
},
|
|
7368
7436
|
},
|
|
7369
7437
|
required: ['created_at', 'message', 'error_code'],
|
|
7370
7438
|
type: 'object',
|
|
7371
7439
|
},
|
|
7372
7440
|
{
|
|
7373
7441
|
description:
|
|
7374
|
-
'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
|
|
7442
|
+
'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).',
|
|
7375
7443
|
properties: {
|
|
7376
7444
|
created_at: {
|
|
7377
7445
|
description:
|
|
@@ -7385,9 +7453,21 @@ export default {
|
|
|
7385
7453
|
enum: ['bridge_disconnected'],
|
|
7386
7454
|
type: 'string',
|
|
7387
7455
|
},
|
|
7388
|
-
is_bridge_error: {
|
|
7389
|
-
|
|
7390
|
-
|
|
7456
|
+
is_bridge_error: {
|
|
7457
|
+
description:
|
|
7458
|
+
'Indicates whether the error is related to Seam Bridge.',
|
|
7459
|
+
type: 'boolean',
|
|
7460
|
+
},
|
|
7461
|
+
is_connected_account_error: {
|
|
7462
|
+
description:
|
|
7463
|
+
'Indicates whether the error is related specifically to the connected account.',
|
|
7464
|
+
type: 'boolean',
|
|
7465
|
+
},
|
|
7466
|
+
message: {
|
|
7467
|
+
description:
|
|
7468
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
7469
|
+
type: 'string',
|
|
7470
|
+
},
|
|
7391
7471
|
},
|
|
7392
7472
|
required: ['created_at', 'message', 'error_code'],
|
|
7393
7473
|
type: 'object',
|
|
@@ -7408,21 +7488,51 @@ export default {
|
|
|
7408
7488
|
enum: ['salto_ks_subscription_limit_exceeded'],
|
|
7409
7489
|
type: 'string',
|
|
7410
7490
|
},
|
|
7411
|
-
is_bridge_error: {
|
|
7412
|
-
|
|
7413
|
-
|
|
7491
|
+
is_bridge_error: {
|
|
7492
|
+
description:
|
|
7493
|
+
'Indicates whether the error is related to Seam Bridge.',
|
|
7494
|
+
type: 'boolean',
|
|
7495
|
+
},
|
|
7496
|
+
is_connected_account_error: {
|
|
7497
|
+
description:
|
|
7498
|
+
'Indicates whether the error is related specifically to the connected account.',
|
|
7499
|
+
type: 'boolean',
|
|
7500
|
+
},
|
|
7501
|
+
message: {
|
|
7502
|
+
description:
|
|
7503
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
7504
|
+
type: 'string',
|
|
7505
|
+
},
|
|
7414
7506
|
salto_ks_metadata: {
|
|
7507
|
+
description:
|
|
7508
|
+
'Salto KS metadata associated with the connected account that has an error.',
|
|
7415
7509
|
properties: {
|
|
7416
7510
|
sites: {
|
|
7511
|
+
description:
|
|
7512
|
+
'Salto sites associated with the connected account that has an error.',
|
|
7417
7513
|
items: {
|
|
7514
|
+
description:
|
|
7515
|
+
'Salto site associated with the connected account that has an error.',
|
|
7418
7516
|
properties: {
|
|
7419
|
-
site_id: {
|
|
7420
|
-
|
|
7517
|
+
site_id: {
|
|
7518
|
+
description:
|
|
7519
|
+
'ID of a Salto site associated with the connected account that has an error.',
|
|
7520
|
+
type: 'string',
|
|
7521
|
+
},
|
|
7522
|
+
site_name: {
|
|
7523
|
+
description:
|
|
7524
|
+
'Name of a Salto site associated with the connected account that has an error.',
|
|
7525
|
+
type: 'string',
|
|
7526
|
+
},
|
|
7421
7527
|
site_user_subscription_limit: {
|
|
7528
|
+
description:
|
|
7529
|
+
'Subscription limit of site users for a Salto site associated with the connected account that has an error.',
|
|
7422
7530
|
minimum: 0,
|
|
7423
7531
|
type: 'integer',
|
|
7424
7532
|
},
|
|
7425
7533
|
subscribed_site_user_count: {
|
|
7534
|
+
description:
|
|
7535
|
+
'Count of subscribed site users for a Salto site associated with the connected account that has an error.',
|
|
7426
7536
|
minimum: 0,
|
|
7427
7537
|
type: 'integer',
|
|
7428
7538
|
},
|
|
@@ -7455,22 +7565,46 @@ export default {
|
|
|
7455
7565
|
type: 'array',
|
|
7456
7566
|
},
|
|
7457
7567
|
user_identifier: {
|
|
7568
|
+
description:
|
|
7569
|
+
'User identifier associated with the connected account.',
|
|
7458
7570
|
properties: {
|
|
7459
|
-
api_url: {
|
|
7460
|
-
|
|
7461
|
-
|
|
7462
|
-
|
|
7463
|
-
|
|
7571
|
+
api_url: {
|
|
7572
|
+
description:
|
|
7573
|
+
'API URL for the user identifier associated with the connected account.',
|
|
7574
|
+
type: 'string',
|
|
7575
|
+
},
|
|
7576
|
+
email: {
|
|
7577
|
+
description:
|
|
7578
|
+
'Email address of the user identifier associated with the connected account.',
|
|
7579
|
+
type: 'string',
|
|
7580
|
+
},
|
|
7581
|
+
exclusive: {
|
|
7582
|
+
description:
|
|
7583
|
+
'Indicates whether the user identifier associated with the connected account is exclusive.',
|
|
7584
|
+
type: 'boolean',
|
|
7585
|
+
},
|
|
7586
|
+
phone: {
|
|
7587
|
+
description:
|
|
7588
|
+
'Phone number of the user identifier associated with the connected account.',
|
|
7589
|
+
type: 'string',
|
|
7590
|
+
},
|
|
7591
|
+
username: {
|
|
7592
|
+
description:
|
|
7593
|
+
'Username of the user identifier associated with the connected account.',
|
|
7594
|
+
type: 'string',
|
|
7595
|
+
},
|
|
7464
7596
|
},
|
|
7465
7597
|
type: 'object',
|
|
7466
7598
|
},
|
|
7467
7599
|
warnings: {
|
|
7600
|
+
description: 'Warnings associated with the connected account.',
|
|
7468
7601
|
items: {
|
|
7469
|
-
description: 'Warning associated with the
|
|
7602
|
+
description: 'Warning associated with the connected account.',
|
|
7470
7603
|
discriminator: { propertyName: 'warning_code' },
|
|
7471
7604
|
oneOf: [
|
|
7472
7605
|
{
|
|
7473
|
-
description:
|
|
7606
|
+
description:
|
|
7607
|
+
'Scheduled downtime planned for the connected account.',
|
|
7474
7608
|
properties: {
|
|
7475
7609
|
created_at: {
|
|
7476
7610
|
description:
|
|
@@ -7478,7 +7612,11 @@ export default {
|
|
|
7478
7612
|
format: 'date-time',
|
|
7479
7613
|
type: 'string',
|
|
7480
7614
|
},
|
|
7481
|
-
message: {
|
|
7615
|
+
message: {
|
|
7616
|
+
description:
|
|
7617
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
7618
|
+
type: 'string',
|
|
7619
|
+
},
|
|
7482
7620
|
warning_code: {
|
|
7483
7621
|
description:
|
|
7484
7622
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -7491,7 +7629,7 @@ export default {
|
|
|
7491
7629
|
},
|
|
7492
7630
|
{
|
|
7493
7631
|
description:
|
|
7494
|
-
'An unknown issue occurred while syncing the state of
|
|
7632
|
+
'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.',
|
|
7495
7633
|
properties: {
|
|
7496
7634
|
created_at: {
|
|
7497
7635
|
description:
|
|
@@ -7499,7 +7637,11 @@ export default {
|
|
|
7499
7637
|
format: 'date-time',
|
|
7500
7638
|
type: 'string',
|
|
7501
7639
|
},
|
|
7502
|
-
message: {
|
|
7640
|
+
message: {
|
|
7641
|
+
description:
|
|
7642
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
7643
|
+
type: 'string',
|
|
7644
|
+
},
|
|
7503
7645
|
warning_code: {
|
|
7504
7646
|
description:
|
|
7505
7647
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -7512,7 +7654,7 @@ export default {
|
|
|
7512
7654
|
},
|
|
7513
7655
|
{
|
|
7514
7656
|
description:
|
|
7515
|
-
'Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users.
|
|
7657
|
+
'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.',
|
|
7516
7658
|
properties: {
|
|
7517
7659
|
created_at: {
|
|
7518
7660
|
description:
|
|
@@ -7520,19 +7662,41 @@ export default {
|
|
|
7520
7662
|
format: 'date-time',
|
|
7521
7663
|
type: 'string',
|
|
7522
7664
|
},
|
|
7523
|
-
message: {
|
|
7665
|
+
message: {
|
|
7666
|
+
description:
|
|
7667
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
7668
|
+
type: 'string',
|
|
7669
|
+
},
|
|
7524
7670
|
salto_ks_metadata: {
|
|
7671
|
+
description:
|
|
7672
|
+
'Salto KS metadata associated with the connected account that has a warning.',
|
|
7525
7673
|
properties: {
|
|
7526
7674
|
sites: {
|
|
7675
|
+
description:
|
|
7676
|
+
'Salto sites associated with the connected account that has a warning.',
|
|
7527
7677
|
items: {
|
|
7678
|
+
description:
|
|
7679
|
+
'Salto site associated with the connected account that has a warning.',
|
|
7528
7680
|
properties: {
|
|
7529
|
-
site_id: {
|
|
7530
|
-
|
|
7681
|
+
site_id: {
|
|
7682
|
+
description:
|
|
7683
|
+
'ID of a Salto site associated with the connected account that has a warning.',
|
|
7684
|
+
type: 'string',
|
|
7685
|
+
},
|
|
7686
|
+
site_name: {
|
|
7687
|
+
description:
|
|
7688
|
+
'Name of a Salto site associated with the connected account that has a warning.',
|
|
7689
|
+
type: 'string',
|
|
7690
|
+
},
|
|
7531
7691
|
site_user_subscription_limit: {
|
|
7692
|
+
description:
|
|
7693
|
+
'Subscription limit of site users for a Salto site associated with the connected account that has a warning.',
|
|
7532
7694
|
minimum: 0,
|
|
7533
7695
|
type: 'integer',
|
|
7534
7696
|
},
|
|
7535
7697
|
subscribed_site_user_count: {
|
|
7698
|
+
description:
|
|
7699
|
+
'Count of subscribed site users for a Salto site associated with the connected account that has a warning.',
|
|
7536
7700
|
minimum: 0,
|
|
7537
7701
|
type: 'integer',
|
|
7538
7702
|
},
|
|
@@ -8003,16 +8167,28 @@ export default {
|
|
|
8003
8167
|
enum: ['invalid_credentials'],
|
|
8004
8168
|
type: 'string',
|
|
8005
8169
|
},
|
|
8006
|
-
is_bridge_error: {
|
|
8007
|
-
|
|
8008
|
-
|
|
8170
|
+
is_bridge_error: {
|
|
8171
|
+
description:
|
|
8172
|
+
'Indicates whether the error is related to Seam Bridge.',
|
|
8173
|
+
type: 'boolean',
|
|
8174
|
+
},
|
|
8175
|
+
is_connected_account_error: {
|
|
8176
|
+
description:
|
|
8177
|
+
'Indicates whether the error is related specifically to the connected account.',
|
|
8178
|
+
type: 'boolean',
|
|
8179
|
+
},
|
|
8180
|
+
message: {
|
|
8181
|
+
description:
|
|
8182
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
8183
|
+
type: 'string',
|
|
8184
|
+
},
|
|
8009
8185
|
},
|
|
8010
8186
|
required: ['created_at', 'message', 'error_code'],
|
|
8011
8187
|
type: 'object',
|
|
8012
8188
|
},
|
|
8013
8189
|
{
|
|
8014
8190
|
description:
|
|
8015
|
-
'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
|
|
8191
|
+
'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).',
|
|
8016
8192
|
properties: {
|
|
8017
8193
|
created_at: {
|
|
8018
8194
|
description:
|
|
@@ -8026,9 +8202,21 @@ export default {
|
|
|
8026
8202
|
enum: ['bridge_disconnected'],
|
|
8027
8203
|
type: 'string',
|
|
8028
8204
|
},
|
|
8029
|
-
is_bridge_error: {
|
|
8030
|
-
|
|
8031
|
-
|
|
8205
|
+
is_bridge_error: {
|
|
8206
|
+
description:
|
|
8207
|
+
'Indicates whether the error is related to Seam Bridge.',
|
|
8208
|
+
type: 'boolean',
|
|
8209
|
+
},
|
|
8210
|
+
is_connected_account_error: {
|
|
8211
|
+
description:
|
|
8212
|
+
'Indicates whether the error is related specifically to the connected account.',
|
|
8213
|
+
type: 'boolean',
|
|
8214
|
+
},
|
|
8215
|
+
message: {
|
|
8216
|
+
description:
|
|
8217
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
8218
|
+
type: 'string',
|
|
8219
|
+
},
|
|
8032
8220
|
},
|
|
8033
8221
|
required: ['created_at', 'message', 'error_code'],
|
|
8034
8222
|
type: 'object',
|
|
@@ -17007,16 +17195,28 @@ export default {
|
|
|
17007
17195
|
enum: ['invalid_credentials'],
|
|
17008
17196
|
type: 'string',
|
|
17009
17197
|
},
|
|
17010
|
-
is_bridge_error: {
|
|
17011
|
-
|
|
17012
|
-
|
|
17198
|
+
is_bridge_error: {
|
|
17199
|
+
description:
|
|
17200
|
+
'Indicates whether the error is related to Seam Bridge.',
|
|
17201
|
+
type: 'boolean',
|
|
17202
|
+
},
|
|
17203
|
+
is_connected_account_error: {
|
|
17204
|
+
description:
|
|
17205
|
+
'Indicates whether the error is related specifically to the connected account.',
|
|
17206
|
+
type: 'boolean',
|
|
17207
|
+
},
|
|
17208
|
+
message: {
|
|
17209
|
+
description:
|
|
17210
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
17211
|
+
type: 'string',
|
|
17212
|
+
},
|
|
17013
17213
|
},
|
|
17014
17214
|
required: ['created_at', 'message', 'error_code'],
|
|
17015
17215
|
type: 'object',
|
|
17016
17216
|
},
|
|
17017
17217
|
{
|
|
17018
17218
|
description:
|
|
17019
|
-
'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
|
|
17219
|
+
'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).',
|
|
17020
17220
|
properties: {
|
|
17021
17221
|
created_at: {
|
|
17022
17222
|
description:
|
|
@@ -17030,9 +17230,21 @@ export default {
|
|
|
17030
17230
|
enum: ['bridge_disconnected'],
|
|
17031
17231
|
type: 'string',
|
|
17032
17232
|
},
|
|
17033
|
-
is_bridge_error: {
|
|
17034
|
-
|
|
17035
|
-
|
|
17233
|
+
is_bridge_error: {
|
|
17234
|
+
description:
|
|
17235
|
+
'Indicates whether the error is related to Seam Bridge.',
|
|
17236
|
+
type: 'boolean',
|
|
17237
|
+
},
|
|
17238
|
+
is_connected_account_error: {
|
|
17239
|
+
description:
|
|
17240
|
+
'Indicates whether the error is related specifically to the connected account.',
|
|
17241
|
+
type: 'boolean',
|
|
17242
|
+
},
|
|
17243
|
+
message: {
|
|
17244
|
+
description:
|
|
17245
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
17246
|
+
type: 'string',
|
|
17247
|
+
},
|
|
17036
17248
|
},
|
|
17037
17249
|
required: ['created_at', 'message', 'error_code'],
|
|
17038
17250
|
type: 'object',
|
|
@@ -18923,16 +19135,28 @@ export default {
|
|
|
18923
19135
|
enum: ['invalid_credentials'],
|
|
18924
19136
|
type: 'string',
|
|
18925
19137
|
},
|
|
18926
|
-
is_bridge_error: {
|
|
18927
|
-
|
|
18928
|
-
|
|
19138
|
+
is_bridge_error: {
|
|
19139
|
+
description:
|
|
19140
|
+
'Indicates whether the error is related to Seam Bridge.',
|
|
19141
|
+
type: 'boolean',
|
|
19142
|
+
},
|
|
19143
|
+
is_connected_account_error: {
|
|
19144
|
+
description:
|
|
19145
|
+
'Indicates whether the error is related specifically to the connected account.',
|
|
19146
|
+
type: 'boolean',
|
|
19147
|
+
},
|
|
19148
|
+
message: {
|
|
19149
|
+
description:
|
|
19150
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
19151
|
+
type: 'string',
|
|
19152
|
+
},
|
|
18929
19153
|
},
|
|
18930
19154
|
required: ['created_at', 'message', 'error_code'],
|
|
18931
19155
|
type: 'object',
|
|
18932
19156
|
},
|
|
18933
19157
|
{
|
|
18934
19158
|
description:
|
|
18935
|
-
'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
|
|
19159
|
+
'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).',
|
|
18936
19160
|
properties: {
|
|
18937
19161
|
created_at: {
|
|
18938
19162
|
description:
|
|
@@ -18946,9 +19170,21 @@ export default {
|
|
|
18946
19170
|
enum: ['bridge_disconnected'],
|
|
18947
19171
|
type: 'string',
|
|
18948
19172
|
},
|
|
18949
|
-
is_bridge_error: {
|
|
18950
|
-
|
|
18951
|
-
|
|
19173
|
+
is_bridge_error: {
|
|
19174
|
+
description:
|
|
19175
|
+
'Indicates whether the error is related to Seam Bridge.',
|
|
19176
|
+
type: 'boolean',
|
|
19177
|
+
},
|
|
19178
|
+
is_connected_account_error: {
|
|
19179
|
+
description:
|
|
19180
|
+
'Indicates whether the error is related specifically to the connected account.',
|
|
19181
|
+
type: 'boolean',
|
|
19182
|
+
},
|
|
19183
|
+
message: {
|
|
19184
|
+
description:
|
|
19185
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
19186
|
+
type: 'string',
|
|
19187
|
+
},
|
|
18952
19188
|
},
|
|
18953
19189
|
required: ['created_at', 'message', 'error_code'],
|
|
18954
19190
|
type: 'object',
|
|
@@ -24733,14 +24969,25 @@ export default {
|
|
|
24733
24969
|
'application/json': {
|
|
24734
24970
|
schema: {
|
|
24735
24971
|
properties: {
|
|
24972
|
+
acs_system_id: {
|
|
24973
|
+
description:
|
|
24974
|
+
'ID of the access system that you want to delete. You must provide acs_system_id with user_identity_id.',
|
|
24975
|
+
format: 'uuid',
|
|
24976
|
+
type: 'string',
|
|
24977
|
+
},
|
|
24736
24978
|
acs_user_id: {
|
|
24737
24979
|
description:
|
|
24738
|
-
'ID of the access system user that you want to delete.',
|
|
24980
|
+
'ID of the access system user that you want to delete. You must provide either acs_user_id or user_identity_id',
|
|
24981
|
+
format: 'uuid',
|
|
24982
|
+
type: 'string',
|
|
24983
|
+
},
|
|
24984
|
+
user_identity_id: {
|
|
24985
|
+
description:
|
|
24986
|
+
'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.',
|
|
24739
24987
|
format: 'uuid',
|
|
24740
24988
|
type: 'string',
|
|
24741
24989
|
},
|
|
24742
24990
|
},
|
|
24743
|
-
required: ['acs_user_id'],
|
|
24744
24991
|
type: 'object',
|
|
24745
24992
|
},
|
|
24746
24993
|
},
|
|
@@ -24785,14 +25032,25 @@ export default {
|
|
|
24785
25032
|
'application/json': {
|
|
24786
25033
|
schema: {
|
|
24787
25034
|
properties: {
|
|
25035
|
+
acs_system_id: {
|
|
25036
|
+
description:
|
|
25037
|
+
'ID of the access system that you want to get. You can only provide acs_user_id or user_identity_id.',
|
|
25038
|
+
format: 'uuid',
|
|
25039
|
+
type: 'string',
|
|
25040
|
+
},
|
|
24788
25041
|
acs_user_id: {
|
|
24789
25042
|
description:
|
|
24790
|
-
'ID of the access system user that you want to get.',
|
|
25043
|
+
'ID of the access system user that you want to get. You can only provide acs_user_id or user_identity_id.',
|
|
25044
|
+
format: 'uuid',
|
|
25045
|
+
type: 'string',
|
|
25046
|
+
},
|
|
25047
|
+
user_identity_id: {
|
|
25048
|
+
description:
|
|
25049
|
+
'ID of the user identity that you want to get. You can only provide acs_user_id or user_identity_id.',
|
|
24791
25050
|
format: 'uuid',
|
|
24792
25051
|
type: 'string',
|
|
24793
25052
|
},
|
|
24794
25053
|
},
|
|
24795
|
-
required: ['acs_user_id'],
|
|
24796
25054
|
type: 'object',
|
|
24797
25055
|
},
|
|
24798
25056
|
},
|
|
@@ -25078,14 +25336,25 @@ export default {
|
|
|
25078
25336
|
'application/json': {
|
|
25079
25337
|
schema: {
|
|
25080
25338
|
properties: {
|
|
25339
|
+
acs_system_id: {
|
|
25340
|
+
description:
|
|
25341
|
+
'ID of the access system for which you want to revoke access. You can only provide acs_system_id with user_identity_id.',
|
|
25342
|
+
format: 'uuid',
|
|
25343
|
+
type: 'string',
|
|
25344
|
+
},
|
|
25081
25345
|
acs_user_id: {
|
|
25082
25346
|
description:
|
|
25083
|
-
'ID of the access system user for whom you want to revoke access.',
|
|
25347
|
+
'ID of the access system user for whom you want to revoke access. You can only provide acs_user_id or user_identity_id.',
|
|
25348
|
+
format: 'uuid',
|
|
25349
|
+
type: 'string',
|
|
25350
|
+
},
|
|
25351
|
+
user_identity_id: {
|
|
25352
|
+
description:
|
|
25353
|
+
'ID of the user identity for whom you want to revoke access. You can only provide acs_user_id or user_identity_id.',
|
|
25084
25354
|
format: 'uuid',
|
|
25085
25355
|
type: 'string',
|
|
25086
25356
|
},
|
|
25087
25357
|
},
|
|
25088
|
-
required: ['acs_user_id'],
|
|
25089
25358
|
type: 'object',
|
|
25090
25359
|
},
|
|
25091
25360
|
},
|
|
@@ -25130,14 +25399,25 @@ export default {
|
|
|
25130
25399
|
'application/json': {
|
|
25131
25400
|
schema: {
|
|
25132
25401
|
properties: {
|
|
25402
|
+
acs_system_id: {
|
|
25403
|
+
description:
|
|
25404
|
+
'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.',
|
|
25405
|
+
format: 'uuid',
|
|
25406
|
+
type: 'string',
|
|
25407
|
+
},
|
|
25133
25408
|
acs_user_id: {
|
|
25134
25409
|
description:
|
|
25135
|
-
'ID of the access system user that you want to suspend.',
|
|
25410
|
+
'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.',
|
|
25411
|
+
format: 'uuid',
|
|
25412
|
+
type: 'string',
|
|
25413
|
+
},
|
|
25414
|
+
user_identity_id: {
|
|
25415
|
+
description:
|
|
25416
|
+
'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.',
|
|
25136
25417
|
format: 'uuid',
|
|
25137
25418
|
type: 'string',
|
|
25138
25419
|
},
|
|
25139
25420
|
},
|
|
25140
|
-
required: ['acs_user_id'],
|
|
25141
25421
|
type: 'object',
|
|
25142
25422
|
},
|
|
25143
25423
|
},
|
|
@@ -25325,14 +25605,25 @@ export default {
|
|
|
25325
25605
|
'application/json': {
|
|
25326
25606
|
schema: {
|
|
25327
25607
|
properties: {
|
|
25608
|
+
acs_system_id: {
|
|
25609
|
+
description:
|
|
25610
|
+
'ID of the access system of the user that you want to unsuspend. You can only provide acs_system_id with user_identity_id.',
|
|
25611
|
+
format: 'uuid',
|
|
25612
|
+
type: 'string',
|
|
25613
|
+
},
|
|
25328
25614
|
acs_user_id: {
|
|
25329
25615
|
description:
|
|
25330
|
-
'ID of the access system user that you want to unsuspend.',
|
|
25616
|
+
'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.',
|
|
25617
|
+
format: 'uuid',
|
|
25618
|
+
type: 'string',
|
|
25619
|
+
},
|
|
25620
|
+
user_identity_id: {
|
|
25621
|
+
description:
|
|
25622
|
+
'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.',
|
|
25331
25623
|
format: 'uuid',
|
|
25332
25624
|
type: 'string',
|
|
25333
25625
|
},
|
|
25334
25626
|
},
|
|
25335
|
-
required: ['acs_user_id'],
|
|
25336
25627
|
type: 'object',
|
|
25337
25628
|
},
|
|
25338
25629
|
},
|
|
@@ -25398,9 +25689,15 @@ export default {
|
|
|
25398
25689
|
required: ['starts_at', 'ends_at'],
|
|
25399
25690
|
type: 'object',
|
|
25400
25691
|
},
|
|
25692
|
+
acs_system_id: {
|
|
25693
|
+
description:
|
|
25694
|
+
'ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id.',
|
|
25695
|
+
format: 'uuid',
|
|
25696
|
+
type: 'string',
|
|
25697
|
+
},
|
|
25401
25698
|
acs_user_id: {
|
|
25402
25699
|
description:
|
|
25403
|
-
'ID of the
|
|
25700
|
+
'ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id.',
|
|
25404
25701
|
format: 'uuid',
|
|
25405
25702
|
type: 'string',
|
|
25406
25703
|
},
|
|
@@ -25428,8 +25725,13 @@ export default {
|
|
|
25428
25725
|
'Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).',
|
|
25429
25726
|
type: 'string',
|
|
25430
25727
|
},
|
|
25728
|
+
user_identity_id: {
|
|
25729
|
+
description:
|
|
25730
|
+
'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.',
|
|
25731
|
+
format: 'uuid',
|
|
25732
|
+
type: 'string',
|
|
25733
|
+
},
|
|
25431
25734
|
},
|
|
25432
|
-
required: ['acs_user_id'],
|
|
25433
25735
|
type: 'object',
|
|
25434
25736
|
},
|
|
25435
25737
|
},
|
|
@@ -25492,9 +25794,15 @@ export default {
|
|
|
25492
25794
|
required: ['starts_at', 'ends_at'],
|
|
25493
25795
|
type: 'object',
|
|
25494
25796
|
},
|
|
25797
|
+
acs_system_id: {
|
|
25798
|
+
description:
|
|
25799
|
+
'ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id.',
|
|
25800
|
+
format: 'uuid',
|
|
25801
|
+
type: 'string',
|
|
25802
|
+
},
|
|
25495
25803
|
acs_user_id: {
|
|
25496
25804
|
description:
|
|
25497
|
-
'ID of the
|
|
25805
|
+
'ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id.',
|
|
25498
25806
|
format: 'uuid',
|
|
25499
25807
|
type: 'string',
|
|
25500
25808
|
},
|
|
@@ -25522,8 +25830,13 @@ export default {
|
|
|
25522
25830
|
'Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).',
|
|
25523
25831
|
type: 'string',
|
|
25524
25832
|
},
|
|
25833
|
+
user_identity_id: {
|
|
25834
|
+
description:
|
|
25835
|
+
'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.',
|
|
25836
|
+
format: 'uuid',
|
|
25837
|
+
type: 'string',
|
|
25838
|
+
},
|
|
25525
25839
|
},
|
|
25526
|
-
required: ['acs_user_id'],
|
|
25527
25840
|
type: 'object',
|
|
25528
25841
|
},
|
|
25529
25842
|
},
|