@seamapi/types 1.246.0 → 1.247.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/connect.cjs +301 -72
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +242 -2
- package/lib/seam/connect/models/acs/acs-user.js +72 -20
- package/lib/seam/connect/models/acs/acs-user.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +95 -2
- package/lib/seam/connect/openapi.js +253 -50
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +147 -0
- package/package.json +1 -1
- package/src/lib/seam/connect/models/acs/acs-user.ts +90 -20
- package/src/lib/seam/connect/openapi.ts +293 -50
- package/src/lib/seam/connect/route-types.ts +147 -0
package/dist/connect.cjs
CHANGED
|
@@ -1415,34 +1415,60 @@ zod.z.object({
|
|
|
1415
1415
|
});
|
|
1416
1416
|
var acs_users_warnings = zod.z.union([acs_users_being_deleted, acs_users_salto_ks_user_not_subscribed]).describe("Warning associated with the `acs_user`.");
|
|
1417
1417
|
var user_fields = zod.z.object({
|
|
1418
|
-
full_name: zod.z.string().optional(),
|
|
1418
|
+
full_name: zod.z.string().optional().describe("Full name of the `acs_user`."),
|
|
1419
1419
|
email: zod.z.string().email().optional().describe(`
|
|
1420
1420
|
---
|
|
1421
1421
|
deprecated: use email_address.
|
|
1422
1422
|
---
|
|
1423
1423
|
`),
|
|
1424
|
-
email_address: zod.z.string().email().optional(),
|
|
1425
|
-
phone_number: phone_number.optional()
|
|
1424
|
+
email_address: zod.z.string().email().optional().describe("Email address of the `acs_user`."),
|
|
1425
|
+
phone_number: phone_number.optional().describe(
|
|
1426
|
+
"Phone number of the `acs_user` in E.164 format (for example, `+15555550100`)."
|
|
1427
|
+
)
|
|
1426
1428
|
});
|
|
1427
1429
|
var common_acs_user = zod.z.object({
|
|
1428
|
-
acs_user_id: zod.z.string().uuid(),
|
|
1429
|
-
acs_system_id: zod.z.string().uuid()
|
|
1430
|
+
acs_user_id: zod.z.string().uuid().describe("ID of the `acs_user`."),
|
|
1431
|
+
acs_system_id: zod.z.string().uuid().describe(
|
|
1432
|
+
"ID of the access control system that contains the `acs_user`."
|
|
1433
|
+
),
|
|
1430
1434
|
hid_acs_system_id: zod.z.string().uuid().optional(),
|
|
1431
|
-
workspace_id: zod.z.string().uuid()
|
|
1432
|
-
|
|
1433
|
-
|
|
1434
|
-
|
|
1435
|
-
|
|
1436
|
-
|
|
1437
|
-
|
|
1438
|
-
|
|
1439
|
-
|
|
1440
|
-
|
|
1441
|
-
|
|
1442
|
-
|
|
1443
|
-
|
|
1444
|
-
|
|
1445
|
-
|
|
1435
|
+
workspace_id: zod.z.string().uuid().describe(
|
|
1436
|
+
"ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`."
|
|
1437
|
+
),
|
|
1438
|
+
created_at: zod.z.string().datetime().describe("Date and time at which the `acs_user` was created."),
|
|
1439
|
+
display_name: zod.z.string().describe("Display name for the `acs_user`."),
|
|
1440
|
+
external_type: acs_user_external_type.optional().describe("Brand-specific terminology for the `acs_user` type."),
|
|
1441
|
+
external_type_display_name: zod.z.string().optional().describe(
|
|
1442
|
+
"Display name that corresponds to the brand-specific terminology for the `acs_user` type."
|
|
1443
|
+
),
|
|
1444
|
+
is_suspended: zod.z.boolean().describe(
|
|
1445
|
+
"Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users)."
|
|
1446
|
+
),
|
|
1447
|
+
access_schedule: schedule.optional().describe(
|
|
1448
|
+
"`starts_at` and `ends_at` timestamps for the `acs_user`'s access."
|
|
1449
|
+
),
|
|
1450
|
+
user_identity_id: zod.z.string().optional().describe("ID of the user identity associated with the `acs_user`."),
|
|
1451
|
+
user_identity_full_name: zod.z.string().nullable().optional().describe(
|
|
1452
|
+
"Full name of the user identity associated with the `acs_user`."
|
|
1453
|
+
),
|
|
1454
|
+
user_identity_email_address: zod.z.string().nullable().optional().describe(
|
|
1455
|
+
"Email address of the user identity associated with the `acs_user`."
|
|
1456
|
+
),
|
|
1457
|
+
user_identity_phone_number: zod.z.string().nullable().optional().describe(
|
|
1458
|
+
"Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`)."
|
|
1459
|
+
),
|
|
1460
|
+
latest_desired_state_synced_with_provider_at: zod.z.string().datetime().optional().describe(`
|
|
1461
|
+
---
|
|
1462
|
+
undocumented: Only used internally.
|
|
1463
|
+
---
|
|
1464
|
+
`),
|
|
1465
|
+
is_latest_desired_state_synced_with_provider: zod.z.boolean().optional().describe(`
|
|
1466
|
+
---
|
|
1467
|
+
undocumented: Only used internally.
|
|
1468
|
+
---
|
|
1469
|
+
`),
|
|
1470
|
+
warnings: zod.z.array(acs_users_warnings).describe("Warnings associated with the `acs_user`."),
|
|
1471
|
+
errors: zod.z.array(acs_user_errors).describe("Errors associated with the `acs_user`.")
|
|
1446
1472
|
}).merge(user_fields);
|
|
1447
1473
|
var acs_user = common_acs_user.merge(
|
|
1448
1474
|
zod.z.object({
|
|
@@ -3050,6 +3076,7 @@ var openapi_default = {
|
|
|
3050
3076
|
acs_user: {
|
|
3051
3077
|
properties: {
|
|
3052
3078
|
access_schedule: {
|
|
3079
|
+
description: "`starts_at` and `ends_at` timestamps for the `acs_user`'s access.",
|
|
3053
3080
|
properties: {
|
|
3054
3081
|
ends_at: { format: "date-time", type: "string" },
|
|
3055
3082
|
starts_at: { format: "date-time", type: "string" }
|
|
@@ -3057,18 +3084,38 @@ var openapi_default = {
|
|
|
3057
3084
|
required: ["starts_at", "ends_at"],
|
|
3058
3085
|
type: "object"
|
|
3059
3086
|
},
|
|
3060
|
-
acs_system_id: {
|
|
3061
|
-
|
|
3062
|
-
|
|
3063
|
-
|
|
3087
|
+
acs_system_id: {
|
|
3088
|
+
description: "ID of the access control system that contains the `acs_user`.",
|
|
3089
|
+
format: "uuid",
|
|
3090
|
+
type: "string"
|
|
3091
|
+
},
|
|
3092
|
+
acs_user_id: {
|
|
3093
|
+
description: "ID of the `acs_user`.",
|
|
3094
|
+
format: "uuid",
|
|
3095
|
+
type: "string"
|
|
3096
|
+
},
|
|
3097
|
+
created_at: {
|
|
3098
|
+
description: "Date and time at which the `acs_user` was created.",
|
|
3099
|
+
format: "date-time",
|
|
3100
|
+
type: "string"
|
|
3101
|
+
},
|
|
3102
|
+
display_name: {
|
|
3103
|
+
description: "Display name for the `acs_user`.",
|
|
3104
|
+
type: "string"
|
|
3105
|
+
},
|
|
3064
3106
|
email: {
|
|
3065
3107
|
deprecated: true,
|
|
3066
3108
|
format: "email",
|
|
3067
3109
|
type: "string",
|
|
3068
3110
|
"x-deprecated": "use email_address."
|
|
3069
3111
|
},
|
|
3070
|
-
email_address: {
|
|
3112
|
+
email_address: {
|
|
3113
|
+
description: "Email address of the `acs_user`.",
|
|
3114
|
+
format: "email",
|
|
3115
|
+
type: "string"
|
|
3116
|
+
},
|
|
3071
3117
|
errors: {
|
|
3118
|
+
description: "Errors associated with the `acs_user`.",
|
|
3072
3119
|
items: {
|
|
3073
3120
|
description: "Error associated with the `acs_user`.",
|
|
3074
3121
|
oneOf: [
|
|
@@ -3177,6 +3224,7 @@ var openapi_default = {
|
|
|
3177
3224
|
type: "array"
|
|
3178
3225
|
},
|
|
3179
3226
|
external_type: {
|
|
3227
|
+
description: "Brand-specific terminology for the `acs_user` type.",
|
|
3180
3228
|
enum: [
|
|
3181
3229
|
"pti_user",
|
|
3182
3230
|
"brivo_user",
|
|
@@ -3186,22 +3234,54 @@ var openapi_default = {
|
|
|
3186
3234
|
],
|
|
3187
3235
|
type: "string"
|
|
3188
3236
|
},
|
|
3189
|
-
external_type_display_name: {
|
|
3190
|
-
|
|
3237
|
+
external_type_display_name: {
|
|
3238
|
+
description: "Display name that corresponds to the brand-specific terminology for the `acs_user` type.",
|
|
3239
|
+
type: "string"
|
|
3240
|
+
},
|
|
3241
|
+
full_name: {
|
|
3242
|
+
description: "Full name of the `acs_user`.",
|
|
3243
|
+
type: "string"
|
|
3244
|
+
},
|
|
3191
3245
|
hid_acs_system_id: { format: "uuid", type: "string" },
|
|
3192
|
-
is_latest_desired_state_synced_with_provider: {
|
|
3246
|
+
is_latest_desired_state_synced_with_provider: {
|
|
3247
|
+
type: "boolean",
|
|
3248
|
+
"x-undocumented": "Only used internally."
|
|
3249
|
+
},
|
|
3193
3250
|
is_managed: { enum: [true], type: "boolean" },
|
|
3194
|
-
is_suspended: {
|
|
3251
|
+
is_suspended: {
|
|
3252
|
+
description: "Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).",
|
|
3253
|
+
type: "boolean"
|
|
3254
|
+
},
|
|
3195
3255
|
latest_desired_state_synced_with_provider_at: {
|
|
3196
3256
|
format: "date-time",
|
|
3257
|
+
type: "string",
|
|
3258
|
+
"x-undocumented": "Only used internally."
|
|
3259
|
+
},
|
|
3260
|
+
phone_number: {
|
|
3261
|
+
description: "Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).",
|
|
3262
|
+
type: "string"
|
|
3263
|
+
},
|
|
3264
|
+
user_identity_email_address: {
|
|
3265
|
+
description: "Email address of the user identity associated with the `acs_user`.",
|
|
3266
|
+
nullable: true,
|
|
3267
|
+
type: "string"
|
|
3268
|
+
},
|
|
3269
|
+
user_identity_full_name: {
|
|
3270
|
+
description: "Full name of the user identity associated with the `acs_user`.",
|
|
3271
|
+
nullable: true,
|
|
3272
|
+
type: "string"
|
|
3273
|
+
},
|
|
3274
|
+
user_identity_id: {
|
|
3275
|
+
description: "ID of the user identity associated with the `acs_user`.",
|
|
3276
|
+
type: "string"
|
|
3277
|
+
},
|
|
3278
|
+
user_identity_phone_number: {
|
|
3279
|
+
description: "Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`).",
|
|
3280
|
+
nullable: true,
|
|
3197
3281
|
type: "string"
|
|
3198
3282
|
},
|
|
3199
|
-
phone_number: { type: "string" },
|
|
3200
|
-
user_identity_email_address: { nullable: true, type: "string" },
|
|
3201
|
-
user_identity_full_name: { nullable: true, type: "string" },
|
|
3202
|
-
user_identity_id: { type: "string" },
|
|
3203
|
-
user_identity_phone_number: { nullable: true, type: "string" },
|
|
3204
3283
|
warnings: {
|
|
3284
|
+
description: "Warnings associated with the `acs_user`.",
|
|
3205
3285
|
items: {
|
|
3206
3286
|
description: "Warning associated with the `acs_user`.",
|
|
3207
3287
|
oneOf: [
|
|
@@ -3232,7 +3312,11 @@ var openapi_default = {
|
|
|
3232
3312
|
},
|
|
3233
3313
|
type: "array"
|
|
3234
3314
|
},
|
|
3235
|
-
workspace_id: {
|
|
3315
|
+
workspace_id: {
|
|
3316
|
+
description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`.",
|
|
3317
|
+
format: "uuid",
|
|
3318
|
+
type: "string"
|
|
3319
|
+
}
|
|
3236
3320
|
},
|
|
3237
3321
|
required: [
|
|
3238
3322
|
"acs_user_id",
|
|
@@ -9899,9 +9983,19 @@ var openapi_default = {
|
|
|
9899
9983
|
type: "string",
|
|
9900
9984
|
"x-deprecated": "use email_address."
|
|
9901
9985
|
},
|
|
9902
|
-
email_address: {
|
|
9903
|
-
|
|
9904
|
-
|
|
9986
|
+
email_address: {
|
|
9987
|
+
description: "Email address of the `acs_user`.",
|
|
9988
|
+
format: "email",
|
|
9989
|
+
type: "string"
|
|
9990
|
+
},
|
|
9991
|
+
full_name: {
|
|
9992
|
+
description: "Full name of the `acs_user`.",
|
|
9993
|
+
type: "string"
|
|
9994
|
+
},
|
|
9995
|
+
phone_number: {
|
|
9996
|
+
description: "Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).",
|
|
9997
|
+
type: "string"
|
|
9998
|
+
},
|
|
9905
9999
|
user_identity_id: {
|
|
9906
10000
|
description: "ID of the user identity with which to associate the new `acs_user`.",
|
|
9907
10001
|
format: "uuid",
|
|
@@ -10355,20 +10449,46 @@ var openapi_default = {
|
|
|
10355
10449
|
acs_user: {
|
|
10356
10450
|
properties: {
|
|
10357
10451
|
access_schedule: {
|
|
10358
|
-
|
|
10452
|
+
description: "`starts_at` and `ends_at` timestamps for the `acs_user`'s access.",
|
|
10453
|
+
properties: {
|
|
10454
|
+
ends_at: { format: "date-time", type: "string" },
|
|
10455
|
+
starts_at: { format: "date-time", type: "string" }
|
|
10456
|
+
},
|
|
10457
|
+
required: ["starts_at", "ends_at"],
|
|
10458
|
+
type: "object"
|
|
10459
|
+
},
|
|
10460
|
+
acs_system_id: {
|
|
10461
|
+
description: "ID of the access control system that contains the `acs_user`.",
|
|
10462
|
+
format: "uuid",
|
|
10463
|
+
type: "string"
|
|
10464
|
+
},
|
|
10465
|
+
acs_user_id: {
|
|
10466
|
+
description: "ID of the `acs_user`.",
|
|
10467
|
+
format: "uuid",
|
|
10468
|
+
type: "string"
|
|
10469
|
+
},
|
|
10470
|
+
created_at: {
|
|
10471
|
+
description: "Date and time at which the `acs_user` was created.",
|
|
10472
|
+
format: "date-time",
|
|
10473
|
+
type: "string"
|
|
10474
|
+
},
|
|
10475
|
+
display_name: {
|
|
10476
|
+
description: "Display name for the `acs_user`.",
|
|
10477
|
+
type: "string"
|
|
10359
10478
|
},
|
|
10360
|
-
acs_system_id: { format: "uuid", type: "string" },
|
|
10361
|
-
acs_user_id: { format: "uuid", type: "string" },
|
|
10362
|
-
created_at: { format: "date-time", type: "string" },
|
|
10363
|
-
display_name: { type: "string" },
|
|
10364
10479
|
email: {
|
|
10365
10480
|
deprecated: true,
|
|
10366
10481
|
format: "email",
|
|
10367
10482
|
type: "string",
|
|
10368
10483
|
"x-deprecated": "use email_address."
|
|
10369
10484
|
},
|
|
10370
|
-
email_address: {
|
|
10485
|
+
email_address: {
|
|
10486
|
+
description: "Email address of the `acs_user`.",
|
|
10487
|
+
format: "email",
|
|
10488
|
+
type: "string"
|
|
10489
|
+
},
|
|
10371
10490
|
errors: {
|
|
10491
|
+
description: "Errors associated with the `acs_user`.",
|
|
10372
10492
|
items: {
|
|
10373
10493
|
description: "Error associated with the `acs_user`.",
|
|
10374
10494
|
oneOf: [
|
|
@@ -10499,6 +10619,7 @@ var openapi_default = {
|
|
|
10499
10619
|
type: "array"
|
|
10500
10620
|
},
|
|
10501
10621
|
external_type: {
|
|
10622
|
+
description: "Brand-specific terminology for the `acs_user` type.",
|
|
10502
10623
|
enum: [
|
|
10503
10624
|
"pti_user",
|
|
10504
10625
|
"brivo_user",
|
|
@@ -10508,33 +10629,54 @@ var openapi_default = {
|
|
|
10508
10629
|
],
|
|
10509
10630
|
type: "string"
|
|
10510
10631
|
},
|
|
10511
|
-
external_type_display_name: {
|
|
10512
|
-
|
|
10632
|
+
external_type_display_name: {
|
|
10633
|
+
description: "Display name that corresponds to the brand-specific terminology for the `acs_user` type.",
|
|
10634
|
+
type: "string"
|
|
10635
|
+
},
|
|
10636
|
+
full_name: {
|
|
10637
|
+
description: "Full name of the `acs_user`.",
|
|
10638
|
+
type: "string"
|
|
10639
|
+
},
|
|
10513
10640
|
hid_acs_system_id: { format: "uuid", type: "string" },
|
|
10514
10641
|
is_latest_desired_state_synced_with_provider: {
|
|
10515
|
-
type: "boolean"
|
|
10642
|
+
type: "boolean",
|
|
10643
|
+
"x-undocumented": "Only used internally."
|
|
10516
10644
|
},
|
|
10517
10645
|
is_managed: { enum: [false], type: "boolean" },
|
|
10518
|
-
is_suspended: {
|
|
10646
|
+
is_suspended: {
|
|
10647
|
+
description: "Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).",
|
|
10648
|
+
type: "boolean"
|
|
10649
|
+
},
|
|
10519
10650
|
latest_desired_state_synced_with_provider_at: {
|
|
10520
10651
|
format: "date-time",
|
|
10652
|
+
type: "string",
|
|
10653
|
+
"x-undocumented": "Only used internally."
|
|
10654
|
+
},
|
|
10655
|
+
phone_number: {
|
|
10656
|
+
description: "Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).",
|
|
10521
10657
|
type: "string"
|
|
10522
10658
|
},
|
|
10523
|
-
phone_number: { type: "string" },
|
|
10524
10659
|
user_identity_email_address: {
|
|
10660
|
+
description: "Email address of the user identity associated with the `acs_user`.",
|
|
10525
10661
|
nullable: true,
|
|
10526
10662
|
type: "string"
|
|
10527
10663
|
},
|
|
10528
10664
|
user_identity_full_name: {
|
|
10665
|
+
description: "Full name of the user identity associated with the `acs_user`.",
|
|
10529
10666
|
nullable: true,
|
|
10530
10667
|
type: "string"
|
|
10531
10668
|
},
|
|
10532
|
-
user_identity_id: {
|
|
10669
|
+
user_identity_id: {
|
|
10670
|
+
description: "ID of the user identity associated with the `acs_user`.",
|
|
10671
|
+
type: "string"
|
|
10672
|
+
},
|
|
10533
10673
|
user_identity_phone_number: {
|
|
10674
|
+
description: "Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`).",
|
|
10534
10675
|
nullable: true,
|
|
10535
10676
|
type: "string"
|
|
10536
10677
|
},
|
|
10537
10678
|
warnings: {
|
|
10679
|
+
description: "Warnings associated with the `acs_user`.",
|
|
10538
10680
|
items: {
|
|
10539
10681
|
description: "Warning associated with the `acs_user`.",
|
|
10540
10682
|
oneOf: [
|
|
@@ -10582,7 +10724,11 @@ var openapi_default = {
|
|
|
10582
10724
|
},
|
|
10583
10725
|
type: "array"
|
|
10584
10726
|
},
|
|
10585
|
-
workspace_id: {
|
|
10727
|
+
workspace_id: {
|
|
10728
|
+
description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`.",
|
|
10729
|
+
format: "uuid",
|
|
10730
|
+
type: "string"
|
|
10731
|
+
}
|
|
10586
10732
|
},
|
|
10587
10733
|
required: [
|
|
10588
10734
|
"acs_user_id",
|
|
@@ -10651,20 +10797,49 @@ var openapi_default = {
|
|
|
10651
10797
|
items: {
|
|
10652
10798
|
properties: {
|
|
10653
10799
|
access_schedule: {
|
|
10654
|
-
|
|
10800
|
+
description: "`starts_at` and `ends_at` timestamps for the `acs_user`'s access.",
|
|
10801
|
+
properties: {
|
|
10802
|
+
ends_at: { format: "date-time", type: "string" },
|
|
10803
|
+
starts_at: {
|
|
10804
|
+
format: "date-time",
|
|
10805
|
+
type: "string"
|
|
10806
|
+
}
|
|
10807
|
+
},
|
|
10808
|
+
required: ["starts_at", "ends_at"],
|
|
10809
|
+
type: "object"
|
|
10810
|
+
},
|
|
10811
|
+
acs_system_id: {
|
|
10812
|
+
description: "ID of the access control system that contains the `acs_user`.",
|
|
10813
|
+
format: "uuid",
|
|
10814
|
+
type: "string"
|
|
10815
|
+
},
|
|
10816
|
+
acs_user_id: {
|
|
10817
|
+
description: "ID of the `acs_user`.",
|
|
10818
|
+
format: "uuid",
|
|
10819
|
+
type: "string"
|
|
10820
|
+
},
|
|
10821
|
+
created_at: {
|
|
10822
|
+
description: "Date and time at which the `acs_user` was created.",
|
|
10823
|
+
format: "date-time",
|
|
10824
|
+
type: "string"
|
|
10825
|
+
},
|
|
10826
|
+
display_name: {
|
|
10827
|
+
description: "Display name for the `acs_user`.",
|
|
10828
|
+
type: "string"
|
|
10655
10829
|
},
|
|
10656
|
-
acs_system_id: { format: "uuid", type: "string" },
|
|
10657
|
-
acs_user_id: { format: "uuid", type: "string" },
|
|
10658
|
-
created_at: { format: "date-time", type: "string" },
|
|
10659
|
-
display_name: { type: "string" },
|
|
10660
10830
|
email: {
|
|
10661
10831
|
deprecated: true,
|
|
10662
10832
|
format: "email",
|
|
10663
10833
|
type: "string",
|
|
10664
10834
|
"x-deprecated": "use email_address."
|
|
10665
10835
|
},
|
|
10666
|
-
email_address: {
|
|
10836
|
+
email_address: {
|
|
10837
|
+
description: "Email address of the `acs_user`.",
|
|
10838
|
+
format: "email",
|
|
10839
|
+
type: "string"
|
|
10840
|
+
},
|
|
10667
10841
|
errors: {
|
|
10842
|
+
description: "Errors associated with the `acs_user`.",
|
|
10668
10843
|
items: {
|
|
10669
10844
|
description: "Error associated with the `acs_user`.",
|
|
10670
10845
|
oneOf: [
|
|
@@ -10795,6 +10970,7 @@ var openapi_default = {
|
|
|
10795
10970
|
type: "array"
|
|
10796
10971
|
},
|
|
10797
10972
|
external_type: {
|
|
10973
|
+
description: "Brand-specific terminology for the `acs_user` type.",
|
|
10798
10974
|
enum: [
|
|
10799
10975
|
"pti_user",
|
|
10800
10976
|
"brivo_user",
|
|
@@ -10804,33 +10980,54 @@ var openapi_default = {
|
|
|
10804
10980
|
],
|
|
10805
10981
|
type: "string"
|
|
10806
10982
|
},
|
|
10807
|
-
external_type_display_name: {
|
|
10808
|
-
|
|
10983
|
+
external_type_display_name: {
|
|
10984
|
+
description: "Display name that corresponds to the brand-specific terminology for the `acs_user` type.",
|
|
10985
|
+
type: "string"
|
|
10986
|
+
},
|
|
10987
|
+
full_name: {
|
|
10988
|
+
description: "Full name of the `acs_user`.",
|
|
10989
|
+
type: "string"
|
|
10990
|
+
},
|
|
10809
10991
|
hid_acs_system_id: { format: "uuid", type: "string" },
|
|
10810
10992
|
is_latest_desired_state_synced_with_provider: {
|
|
10811
|
-
type: "boolean"
|
|
10993
|
+
type: "boolean",
|
|
10994
|
+
"x-undocumented": "Only used internally."
|
|
10812
10995
|
},
|
|
10813
10996
|
is_managed: { enum: [false], type: "boolean" },
|
|
10814
|
-
is_suspended: {
|
|
10997
|
+
is_suspended: {
|
|
10998
|
+
description: "Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).",
|
|
10999
|
+
type: "boolean"
|
|
11000
|
+
},
|
|
10815
11001
|
latest_desired_state_synced_with_provider_at: {
|
|
10816
11002
|
format: "date-time",
|
|
11003
|
+
type: "string",
|
|
11004
|
+
"x-undocumented": "Only used internally."
|
|
11005
|
+
},
|
|
11006
|
+
phone_number: {
|
|
11007
|
+
description: "Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).",
|
|
10817
11008
|
type: "string"
|
|
10818
11009
|
},
|
|
10819
|
-
phone_number: { type: "string" },
|
|
10820
11010
|
user_identity_email_address: {
|
|
11011
|
+
description: "Email address of the user identity associated with the `acs_user`.",
|
|
10821
11012
|
nullable: true,
|
|
10822
11013
|
type: "string"
|
|
10823
11014
|
},
|
|
10824
11015
|
user_identity_full_name: {
|
|
11016
|
+
description: "Full name of the user identity associated with the `acs_user`.",
|
|
10825
11017
|
nullable: true,
|
|
10826
11018
|
type: "string"
|
|
10827
11019
|
},
|
|
10828
|
-
user_identity_id: {
|
|
11020
|
+
user_identity_id: {
|
|
11021
|
+
description: "ID of the user identity associated with the `acs_user`.",
|
|
11022
|
+
type: "string"
|
|
11023
|
+
},
|
|
10829
11024
|
user_identity_phone_number: {
|
|
11025
|
+
description: "Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`).",
|
|
10830
11026
|
nullable: true,
|
|
10831
11027
|
type: "string"
|
|
10832
11028
|
},
|
|
10833
11029
|
warnings: {
|
|
11030
|
+
description: "Warnings associated with the `acs_user`.",
|
|
10834
11031
|
items: {
|
|
10835
11032
|
description: "Warning associated with the `acs_user`.",
|
|
10836
11033
|
oneOf: [
|
|
@@ -10878,7 +11075,11 @@ var openapi_default = {
|
|
|
10878
11075
|
},
|
|
10879
11076
|
type: "array"
|
|
10880
11077
|
},
|
|
10881
|
-
workspace_id: {
|
|
11078
|
+
workspace_id: {
|
|
11079
|
+
description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`.",
|
|
11080
|
+
format: "uuid",
|
|
11081
|
+
type: "string"
|
|
11082
|
+
}
|
|
10882
11083
|
},
|
|
10883
11084
|
required: [
|
|
10884
11085
|
"acs_user_id",
|
|
@@ -10988,17 +11189,31 @@ var openapi_default = {
|
|
|
10988
11189
|
required: ["starts_at", "ends_at"],
|
|
10989
11190
|
type: "object"
|
|
10990
11191
|
},
|
|
10991
|
-
acs_user_id: {
|
|
11192
|
+
acs_user_id: {
|
|
11193
|
+
description: "ID of the `acs_user`.",
|
|
11194
|
+
format: "uuid",
|
|
11195
|
+
type: "string"
|
|
11196
|
+
},
|
|
10992
11197
|
email: {
|
|
10993
11198
|
deprecated: true,
|
|
10994
11199
|
format: "email",
|
|
10995
11200
|
type: "string",
|
|
10996
11201
|
"x-deprecated": "use email_address."
|
|
10997
11202
|
},
|
|
10998
|
-
email_address: {
|
|
10999
|
-
|
|
11203
|
+
email_address: {
|
|
11204
|
+
description: "Email address of the `acs_user`.",
|
|
11205
|
+
format: "email",
|
|
11206
|
+
type: "string"
|
|
11207
|
+
},
|
|
11208
|
+
full_name: {
|
|
11209
|
+
description: "Full name of the `acs_user`.",
|
|
11210
|
+
type: "string"
|
|
11211
|
+
},
|
|
11000
11212
|
hid_acs_system_id: { format: "uuid", type: "string" },
|
|
11001
|
-
phone_number: {
|
|
11213
|
+
phone_number: {
|
|
11214
|
+
description: "Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).",
|
|
11215
|
+
type: "string"
|
|
11216
|
+
}
|
|
11002
11217
|
},
|
|
11003
11218
|
required: ["acs_user_id"],
|
|
11004
11219
|
type: "object"
|
|
@@ -11050,17 +11265,31 @@ var openapi_default = {
|
|
|
11050
11265
|
required: ["starts_at", "ends_at"],
|
|
11051
11266
|
type: "object"
|
|
11052
11267
|
},
|
|
11053
|
-
acs_user_id: {
|
|
11268
|
+
acs_user_id: {
|
|
11269
|
+
description: "ID of the `acs_user`.",
|
|
11270
|
+
format: "uuid",
|
|
11271
|
+
type: "string"
|
|
11272
|
+
},
|
|
11054
11273
|
email: {
|
|
11055
11274
|
deprecated: true,
|
|
11056
11275
|
format: "email",
|
|
11057
11276
|
type: "string",
|
|
11058
11277
|
"x-deprecated": "use email_address."
|
|
11059
11278
|
},
|
|
11060
|
-
email_address: {
|
|
11061
|
-
|
|
11279
|
+
email_address: {
|
|
11280
|
+
description: "Email address of the `acs_user`.",
|
|
11281
|
+
format: "email",
|
|
11282
|
+
type: "string"
|
|
11283
|
+
},
|
|
11284
|
+
full_name: {
|
|
11285
|
+
description: "Full name of the `acs_user`.",
|
|
11286
|
+
type: "string"
|
|
11287
|
+
},
|
|
11062
11288
|
hid_acs_system_id: { format: "uuid", type: "string" },
|
|
11063
|
-
phone_number: {
|
|
11289
|
+
phone_number: {
|
|
11290
|
+
description: "Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).",
|
|
11291
|
+
type: "string"
|
|
11292
|
+
}
|
|
11064
11293
|
},
|
|
11065
11294
|
required: ["acs_user_id"],
|
|
11066
11295
|
type: "object"
|