@seamapi/types 1.272.0 → 1.273.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (13) hide show
  1. package/dist/connect.cjs +180 -39
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +90 -0
  4. package/lib/seam/connect/models/acs/acs-access-group.js +23 -8
  5. package/lib/seam/connect/models/acs/acs-access-group.js.map +1 -1
  6. package/lib/seam/connect/openapi.d.ts +45 -0
  7. package/lib/seam/connect/openapi.js +160 -31
  8. package/lib/seam/connect/openapi.js.map +1 -1
  9. package/lib/seam/connect/route-types.d.ts +45 -0
  10. package/package.json +1 -1
  11. package/src/lib/seam/connect/models/acs/acs-access-group.ts +31 -8
  12. package/src/lib/seam/connect/openapi.ts +190 -31
  13. package/src/lib/seam/connect/route-types.ts +45 -0
package/dist/connect.cjs CHANGED
@@ -1097,10 +1097,14 @@ var acs_access_group_external_type = zod.z.enum([
1097
1097
  "brivo_group"
1098
1098
  ]);
1099
1099
  var common_acs_access_group = zod.z.object({
1100
- acs_access_group_id: zod.z.string().uuid(),
1101
- acs_system_id: zod.z.string().uuid(),
1102
- workspace_id: zod.z.string().uuid(),
1103
- name: zod.z.string(),
1100
+ acs_access_group_id: zod.z.string().uuid().describe("ID of the access group."),
1101
+ acs_system_id: zod.z.string().uuid().describe(
1102
+ "ID of the access control system that contains the access group."
1103
+ ),
1104
+ workspace_id: zod.z.string().uuid().describe(
1105
+ "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group."
1106
+ ),
1107
+ name: zod.z.string().describe("Name of the access group."),
1104
1108
  access_group_type: acs_access_group_external_type.describe(`
1105
1109
  ---
1106
1110
  deprecated: use external_type
@@ -1112,13 +1116,21 @@ var common_acs_access_group = zod.z.object({
1112
1116
  ---
1113
1117
  `),
1114
1118
  display_name: zod.z.string(),
1115
- external_type: acs_access_group_external_type,
1116
- external_type_display_name: zod.z.string(),
1117
- created_at: zod.z.string().datetime()
1119
+ external_type: acs_access_group_external_type.describe(
1120
+ "Brand-specific terminology for the access group type."
1121
+ ),
1122
+ external_type_display_name: zod.z.string().describe(
1123
+ "Display name that corresponds to the brand-specific terminology for the access group type."
1124
+ ),
1125
+ created_at: zod.z.string().datetime().describe("Date and time at which the access group was created.")
1118
1126
  });
1119
1127
  var acs_access_group = common_acs_access_group.extend({
1120
1128
  is_managed: zod.z.literal(true)
1121
- });
1129
+ }).describe(`
1130
+ Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.
1131
+
1132
+ The \`acs_access_group\` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
1133
+ `);
1122
1134
  var unmanaged_acs_access_group = common_acs_access_group.extend({
1123
1135
  is_managed: zod.z.literal(false)
1124
1136
  });
@@ -2714,6 +2726,7 @@ var openapi_default = {
2714
2726
  type: "object"
2715
2727
  },
2716
2728
  acs_access_group: {
2729
+ description: "\n Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.\n \n The `acs_access_group` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n ",
2717
2730
  properties: {
2718
2731
  access_group_type: {
2719
2732
  deprecated: true,
@@ -2731,11 +2744,24 @@ var openapi_default = {
2731
2744
  type: "string",
2732
2745
  "x-deprecated": "use external_type_display_name"
2733
2746
  },
2734
- acs_access_group_id: { format: "uuid", type: "string" },
2735
- acs_system_id: { format: "uuid", type: "string" },
2736
- created_at: { format: "date-time", type: "string" },
2747
+ acs_access_group_id: {
2748
+ description: "ID of the access group.",
2749
+ format: "uuid",
2750
+ type: "string"
2751
+ },
2752
+ acs_system_id: {
2753
+ description: "ID of the access control system that contains the access group.",
2754
+ format: "uuid",
2755
+ type: "string"
2756
+ },
2757
+ created_at: {
2758
+ description: "Date and time at which the access group was created.",
2759
+ format: "date-time",
2760
+ type: "string"
2761
+ },
2737
2762
  display_name: { type: "string" },
2738
2763
  external_type: {
2764
+ description: "Brand-specific terminology for the access group type.",
2739
2765
  enum: [
2740
2766
  "pti_unit",
2741
2767
  "pti_access_level",
@@ -2744,10 +2770,17 @@ var openapi_default = {
2744
2770
  ],
2745
2771
  type: "string"
2746
2772
  },
2747
- external_type_display_name: { type: "string" },
2773
+ external_type_display_name: {
2774
+ description: "Display name that corresponds to the brand-specific terminology for the access group type.",
2775
+ type: "string"
2776
+ },
2748
2777
  is_managed: { enum: [true], type: "boolean" },
2749
- name: { type: "string" },
2750
- workspace_id: { format: "uuid", type: "string" }
2778
+ name: { description: "Name of the access group.", type: "string" },
2779
+ workspace_id: {
2780
+ description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group.",
2781
+ format: "uuid",
2782
+ type: "string"
2783
+ }
2751
2784
  },
2752
2785
  required: [
2753
2786
  "acs_access_group_id",
@@ -8973,14 +9006,23 @@ var openapi_default = {
8973
9006
  },
8974
9007
  "/acs/access_groups/add_user": {
8975
9008
  post: {
9009
+ description: "Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
8976
9010
  operationId: "acsAccessGroupsAddUserPost",
8977
9011
  requestBody: {
8978
9012
  content: {
8979
9013
  "application/json": {
8980
9014
  schema: {
8981
9015
  properties: {
8982
- acs_access_group_id: { format: "uuid", type: "string" },
8983
- acs_user_id: { format: "uuid", type: "string" }
9016
+ acs_access_group_id: {
9017
+ description: "ID of the desired access group.",
9018
+ format: "uuid",
9019
+ type: "string"
9020
+ },
9021
+ acs_user_id: {
9022
+ description: "ID of the desired user.",
9023
+ format: "uuid",
9024
+ type: "string"
9025
+ }
8984
9026
  },
8985
9027
  required: ["acs_access_group_id", "acs_user_id"],
8986
9028
  type: "object"
@@ -9016,14 +9058,23 @@ var openapi_default = {
9016
9058
  "x-response-key": null
9017
9059
  },
9018
9060
  put: {
9061
+ description: "Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
9019
9062
  operationId: "acsAccessGroupsAddUserPut",
9020
9063
  requestBody: {
9021
9064
  content: {
9022
9065
  "application/json": {
9023
9066
  schema: {
9024
9067
  properties: {
9025
- acs_access_group_id: { format: "uuid", type: "string" },
9026
- acs_user_id: { format: "uuid", type: "string" }
9068
+ acs_access_group_id: {
9069
+ description: "ID of the desired access group.",
9070
+ format: "uuid",
9071
+ type: "string"
9072
+ },
9073
+ acs_user_id: {
9074
+ description: "ID of the desired user.",
9075
+ format: "uuid",
9076
+ type: "string"
9077
+ }
9027
9078
  },
9028
9079
  required: ["acs_access_group_id", "acs_user_id"],
9029
9080
  type: "object"
@@ -9060,13 +9111,18 @@ var openapi_default = {
9060
9111
  },
9061
9112
  "/acs/access_groups/get": {
9062
9113
  post: {
9114
+ description: "Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
9063
9115
  operationId: "acsAccessGroupsGetPost",
9064
9116
  requestBody: {
9065
9117
  content: {
9066
9118
  "application/json": {
9067
9119
  schema: {
9068
9120
  properties: {
9069
- acs_access_group_id: { format: "uuid", type: "string" }
9121
+ acs_access_group_id: {
9122
+ description: "ID of the desired access group.",
9123
+ format: "uuid",
9124
+ type: "string"
9125
+ }
9070
9126
  },
9071
9127
  required: ["acs_access_group_id"],
9072
9128
  type: "object"
@@ -9110,14 +9166,23 @@ var openapi_default = {
9110
9166
  },
9111
9167
  "/acs/access_groups/list": {
9112
9168
  post: {
9169
+ description: "Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
9113
9170
  operationId: "acsAccessGroupsListPost",
9114
9171
  requestBody: {
9115
9172
  content: {
9116
9173
  "application/json": {
9117
9174
  schema: {
9118
9175
  properties: {
9119
- acs_system_id: { format: "uuid", type: "string" },
9120
- acs_user_id: { format: "uuid", type: "string" }
9176
+ acs_system_id: {
9177
+ description: "ID of the access control system for which you want to retrieve all access groups.",
9178
+ format: "uuid",
9179
+ type: "string"
9180
+ },
9181
+ acs_user_id: {
9182
+ description: "ID of the user for which you want to retrieve all access groups.",
9183
+ format: "uuid",
9184
+ type: "string"
9185
+ }
9121
9186
  },
9122
9187
  type: "object"
9123
9188
  }
@@ -9161,13 +9226,18 @@ var openapi_default = {
9161
9226
  },
9162
9227
  "/acs/access_groups/list_accessible_entrances": {
9163
9228
  post: {
9229
+ description: "Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
9164
9230
  operationId: "acsAccessGroupsListAccessibleEntrancesPost",
9165
9231
  requestBody: {
9166
9232
  content: {
9167
9233
  "application/json": {
9168
9234
  schema: {
9169
9235
  properties: {
9170
- acs_access_group_id: { format: "uuid", type: "string" }
9236
+ acs_access_group_id: {
9237
+ description: "ID of the access group for which you want to retrieve all accessible entrances.",
9238
+ format: "uuid",
9239
+ type: "string"
9240
+ }
9171
9241
  },
9172
9242
  required: ["acs_access_group_id"],
9173
9243
  type: "object"
@@ -9212,13 +9282,18 @@ var openapi_default = {
9212
9282
  },
9213
9283
  "/acs/access_groups/list_users": {
9214
9284
  post: {
9285
+ description: "Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
9215
9286
  operationId: "acsAccessGroupsListUsersPost",
9216
9287
  requestBody: {
9217
9288
  content: {
9218
9289
  "application/json": {
9219
9290
  schema: {
9220
9291
  properties: {
9221
- acs_access_group_id: { format: "uuid", type: "string" }
9292
+ acs_access_group_id: {
9293
+ description: "ID of the access group for which you want to retrieve all users.",
9294
+ format: "uuid",
9295
+ type: "string"
9296
+ }
9222
9297
  },
9223
9298
  required: ["acs_access_group_id"],
9224
9299
  type: "object"
@@ -9263,14 +9338,23 @@ var openapi_default = {
9263
9338
  },
9264
9339
  "/acs/access_groups/remove_user": {
9265
9340
  post: {
9341
+ description: "Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
9266
9342
  operationId: "acsAccessGroupsRemoveUserPost",
9267
9343
  requestBody: {
9268
9344
  content: {
9269
9345
  "application/json": {
9270
9346
  schema: {
9271
9347
  properties: {
9272
- acs_access_group_id: { format: "uuid", type: "string" },
9273
- acs_user_id: { format: "uuid", type: "string" }
9348
+ acs_access_group_id: {
9349
+ description: "ID of the desired access group.",
9350
+ format: "uuid",
9351
+ type: "string"
9352
+ },
9353
+ acs_user_id: {
9354
+ description: "ID of the desired user.",
9355
+ format: "uuid",
9356
+ type: "string"
9357
+ }
9274
9358
  },
9275
9359
  required: ["acs_access_group_id", "acs_user_id"],
9276
9360
  type: "object"
@@ -9308,13 +9392,18 @@ var openapi_default = {
9308
9392
  },
9309
9393
  "/acs/access_groups/unmanaged/get": {
9310
9394
  post: {
9395
+ description: "Returns a specified unmanaged [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
9311
9396
  operationId: "acsAccessGroupsUnmanagedGetPost",
9312
9397
  requestBody: {
9313
9398
  content: {
9314
9399
  "application/json": {
9315
9400
  schema: {
9316
9401
  properties: {
9317
- acs_access_group_id: { format: "uuid", type: "string" }
9402
+ acs_access_group_id: {
9403
+ description: "ID of the desired unmanaged access group.",
9404
+ format: "uuid",
9405
+ type: "string"
9406
+ }
9318
9407
  },
9319
9408
  required: ["acs_access_group_id"],
9320
9409
  type: "object"
@@ -9346,11 +9435,24 @@ var openapi_default = {
9346
9435
  type: "string",
9347
9436
  "x-deprecated": "use external_type_display_name"
9348
9437
  },
9349
- acs_access_group_id: { format: "uuid", type: "string" },
9350
- acs_system_id: { format: "uuid", type: "string" },
9351
- created_at: { format: "date-time", type: "string" },
9438
+ acs_access_group_id: {
9439
+ description: "ID of the access group.",
9440
+ format: "uuid",
9441
+ type: "string"
9442
+ },
9443
+ acs_system_id: {
9444
+ description: "ID of the access control system that contains the access group.",
9445
+ format: "uuid",
9446
+ type: "string"
9447
+ },
9448
+ created_at: {
9449
+ description: "Date and time at which the access group was created.",
9450
+ format: "date-time",
9451
+ type: "string"
9452
+ },
9352
9453
  display_name: { type: "string" },
9353
9454
  external_type: {
9455
+ description: "Brand-specific terminology for the access group type.",
9354
9456
  enum: [
9355
9457
  "pti_unit",
9356
9458
  "pti_access_level",
@@ -9359,10 +9461,20 @@ var openapi_default = {
9359
9461
  ],
9360
9462
  type: "string"
9361
9463
  },
9362
- external_type_display_name: { type: "string" },
9464
+ external_type_display_name: {
9465
+ description: "Display name that corresponds to the brand-specific terminology for the access group type.",
9466
+ type: "string"
9467
+ },
9363
9468
  is_managed: { enum: [false], type: "boolean" },
9364
- name: { type: "string" },
9365
- workspace_id: { format: "uuid", type: "string" }
9469
+ name: {
9470
+ description: "Name of the access group.",
9471
+ type: "string"
9472
+ },
9473
+ workspace_id: {
9474
+ description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group.",
9475
+ format: "uuid",
9476
+ type: "string"
9477
+ }
9366
9478
  },
9367
9479
  required: [
9368
9480
  "acs_access_group_id",
@@ -9406,14 +9518,23 @@ var openapi_default = {
9406
9518
  },
9407
9519
  "/acs/access_groups/unmanaged/list": {
9408
9520
  post: {
9521
+ description: "Returns a list of all unmanaged [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
9409
9522
  operationId: "acsAccessGroupsUnmanagedListPost",
9410
9523
  requestBody: {
9411
9524
  content: {
9412
9525
  "application/json": {
9413
9526
  schema: {
9414
9527
  properties: {
9415
- acs_system_id: { format: "uuid", type: "string" },
9416
- acs_user_id: { format: "uuid", type: "string" }
9528
+ acs_system_id: {
9529
+ description: "ID of the access control system for which you want to retrieve all unmanaged access groups.",
9530
+ format: "uuid",
9531
+ type: "string"
9532
+ },
9533
+ acs_user_id: {
9534
+ description: "ID of the user for which you want to retrieve all unmanaged access groups.",
9535
+ format: "uuid",
9536
+ type: "string"
9537
+ }
9417
9538
  },
9418
9539
  type: "object"
9419
9540
  }
@@ -9446,13 +9567,23 @@ var openapi_default = {
9446
9567
  "x-deprecated": "use external_type_display_name"
9447
9568
  },
9448
9569
  acs_access_group_id: {
9570
+ description: "ID of the access group.",
9449
9571
  format: "uuid",
9450
9572
  type: "string"
9451
9573
  },
9452
- acs_system_id: { format: "uuid", type: "string" },
9453
- created_at: { format: "date-time", type: "string" },
9574
+ acs_system_id: {
9575
+ description: "ID of the access control system that contains the access group.",
9576
+ format: "uuid",
9577
+ type: "string"
9578
+ },
9579
+ created_at: {
9580
+ description: "Date and time at which the access group was created.",
9581
+ format: "date-time",
9582
+ type: "string"
9583
+ },
9454
9584
  display_name: { type: "string" },
9455
9585
  external_type: {
9586
+ description: "Brand-specific terminology for the access group type.",
9456
9587
  enum: [
9457
9588
  "pti_unit",
9458
9589
  "pti_access_level",
@@ -9461,10 +9592,20 @@ var openapi_default = {
9461
9592
  ],
9462
9593
  type: "string"
9463
9594
  },
9464
- external_type_display_name: { type: "string" },
9595
+ external_type_display_name: {
9596
+ description: "Display name that corresponds to the brand-specific terminology for the access group type.",
9597
+ type: "string"
9598
+ },
9465
9599
  is_managed: { enum: [false], type: "boolean" },
9466
- name: { type: "string" },
9467
- workspace_id: { format: "uuid", type: "string" }
9600
+ name: {
9601
+ description: "Name of the access group.",
9602
+ type: "string"
9603
+ },
9604
+ workspace_id: {
9605
+ description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group.",
9606
+ format: "uuid",
9607
+ type: "string"
9608
+ }
9468
9609
  },
9469
9610
  required: [
9470
9611
  "acs_access_group_id",