@seamapi/types 1.272.0 → 1.274.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 (21) hide show
  1. package/dist/connect.cjs +210 -39
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +394 -19
  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/models/acs/acs-entrance.d.ts +19 -19
  7. package/lib/seam/connect/models/devices/device-metadata.d.ts +38 -0
  8. package/lib/seam/connect/models/devices/device-metadata.js +11 -0
  9. package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
  10. package/lib/seam/connect/models/devices/device.d.ts +54 -0
  11. package/lib/seam/connect/models/devices/phone.d.ts +38 -0
  12. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +38 -0
  13. package/lib/seam/connect/openapi.d.ts +70 -0
  14. package/lib/seam/connect/openapi.js +179 -31
  15. package/lib/seam/connect/openapi.js.map +1 -1
  16. package/lib/seam/connect/route-types.d.ts +213 -0
  17. package/package.json +1 -1
  18. package/src/lib/seam/connect/models/acs/acs-access-group.ts +31 -8
  19. package/src/lib/seam/connect/models/devices/device-metadata.ts +11 -1
  20. package/src/lib/seam/connect/openapi.ts +210 -31
  21. package/src/lib/seam/connect/route-types.ts +241 -0
package/dist/connect.cjs CHANGED
@@ -503,6 +503,17 @@ var device_metadata = zod.z.object({
503
503
  battery_level: zod.z.string(),
504
504
  locked_state: zod.z.string(),
505
505
  model: zod.z.string().optional()
506
+ }).describe(`
507
+ ---
508
+ deprecated: Use \`salto_ks_metadata \` instead.
509
+ `),
510
+ salto_ks_metadata: zod.z.object({
511
+ lock_id: zod.z.string(),
512
+ customer_reference: zod.z.string(),
513
+ lock_type: zod.z.string(),
514
+ battery_level: zod.z.string(),
515
+ locked_state: zod.z.string(),
516
+ model: zod.z.string().optional()
506
517
  }),
507
518
  genie_metadata: zod.z.object({
508
519
  device_name: zod.z.string(),
@@ -1097,10 +1108,14 @@ var acs_access_group_external_type = zod.z.enum([
1097
1108
  "brivo_group"
1098
1109
  ]);
1099
1110
  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(),
1111
+ acs_access_group_id: zod.z.string().uuid().describe("ID of the access group."),
1112
+ acs_system_id: zod.z.string().uuid().describe(
1113
+ "ID of the access control system that contains the access group."
1114
+ ),
1115
+ workspace_id: zod.z.string().uuid().describe(
1116
+ "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group."
1117
+ ),
1118
+ name: zod.z.string().describe("Name of the access group."),
1104
1119
  access_group_type: acs_access_group_external_type.describe(`
1105
1120
  ---
1106
1121
  deprecated: use external_type
@@ -1112,13 +1127,21 @@ var common_acs_access_group = zod.z.object({
1112
1127
  ---
1113
1128
  `),
1114
1129
  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()
1130
+ external_type: acs_access_group_external_type.describe(
1131
+ "Brand-specific terminology for the access group type."
1132
+ ),
1133
+ external_type_display_name: zod.z.string().describe(
1134
+ "Display name that corresponds to the brand-specific terminology for the access group type."
1135
+ ),
1136
+ created_at: zod.z.string().datetime().describe("Date and time at which the access group was created.")
1118
1137
  });
1119
1138
  var acs_access_group = common_acs_access_group.extend({
1120
1139
  is_managed: zod.z.literal(true)
1121
- });
1140
+ }).describe(`
1141
+ 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.
1142
+
1143
+ 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).
1144
+ `);
1122
1145
  var unmanaged_acs_access_group = common_acs_access_group.extend({
1123
1146
  is_managed: zod.z.literal(false)
1124
1147
  });
@@ -2714,6 +2737,7 @@ var openapi_default = {
2714
2737
  type: "object"
2715
2738
  },
2716
2739
  acs_access_group: {
2740
+ 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
2741
  properties: {
2718
2742
  access_group_type: {
2719
2743
  deprecated: true,
@@ -2731,11 +2755,24 @@ var openapi_default = {
2731
2755
  type: "string",
2732
2756
  "x-deprecated": "use external_type_display_name"
2733
2757
  },
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" },
2758
+ acs_access_group_id: {
2759
+ description: "ID of the access group.",
2760
+ format: "uuid",
2761
+ type: "string"
2762
+ },
2763
+ acs_system_id: {
2764
+ description: "ID of the access control system that contains the access group.",
2765
+ format: "uuid",
2766
+ type: "string"
2767
+ },
2768
+ created_at: {
2769
+ description: "Date and time at which the access group was created.",
2770
+ format: "date-time",
2771
+ type: "string"
2772
+ },
2737
2773
  display_name: { type: "string" },
2738
2774
  external_type: {
2775
+ description: "Brand-specific terminology for the access group type.",
2739
2776
  enum: [
2740
2777
  "pti_unit",
2741
2778
  "pti_access_level",
@@ -2744,10 +2781,17 @@ var openapi_default = {
2744
2781
  ],
2745
2782
  type: "string"
2746
2783
  },
2747
- external_type_display_name: { type: "string" },
2784
+ external_type_display_name: {
2785
+ description: "Display name that corresponds to the brand-specific terminology for the access group type.",
2786
+ type: "string"
2787
+ },
2748
2788
  is_managed: { enum: [true], type: "boolean" },
2749
- name: { type: "string" },
2750
- workspace_id: { format: "uuid", type: "string" }
2789
+ name: { description: "Name of the access group.", type: "string" },
2790
+ workspace_id: {
2791
+ description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group.",
2792
+ format: "uuid",
2793
+ type: "string"
2794
+ }
2751
2795
  },
2752
2796
  required: [
2753
2797
  "acs_access_group_id",
@@ -6304,7 +6348,26 @@ var openapi_default = {
6304
6348
  required: ["device_id", "device_name"],
6305
6349
  type: "object"
6306
6350
  },
6351
+ salto_ks_metadata: {
6352
+ properties: {
6353
+ battery_level: { type: "string" },
6354
+ customer_reference: { type: "string" },
6355
+ lock_id: { type: "string" },
6356
+ lock_type: { type: "string" },
6357
+ locked_state: { type: "string" },
6358
+ model: { type: "string" }
6359
+ },
6360
+ required: [
6361
+ "lock_id",
6362
+ "customer_reference",
6363
+ "lock_type",
6364
+ "battery_level",
6365
+ "locked_state"
6366
+ ],
6367
+ type: "object"
6368
+ },
6307
6369
  salto_metadata: {
6370
+ description: "\n ---\n deprecated: Use `salto_ks_metadata ` instead.\n ",
6308
6371
  properties: {
6309
6372
  battery_level: { type: "string" },
6310
6373
  customer_reference: { type: "string" },
@@ -8973,14 +9036,23 @@ var openapi_default = {
8973
9036
  },
8974
9037
  "/acs/access_groups/add_user": {
8975
9038
  post: {
9039
+ 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
9040
  operationId: "acsAccessGroupsAddUserPost",
8977
9041
  requestBody: {
8978
9042
  content: {
8979
9043
  "application/json": {
8980
9044
  schema: {
8981
9045
  properties: {
8982
- acs_access_group_id: { format: "uuid", type: "string" },
8983
- acs_user_id: { format: "uuid", type: "string" }
9046
+ acs_access_group_id: {
9047
+ description: "ID of the desired access group.",
9048
+ format: "uuid",
9049
+ type: "string"
9050
+ },
9051
+ acs_user_id: {
9052
+ description: "ID of the desired user.",
9053
+ format: "uuid",
9054
+ type: "string"
9055
+ }
8984
9056
  },
8985
9057
  required: ["acs_access_group_id", "acs_user_id"],
8986
9058
  type: "object"
@@ -9016,14 +9088,23 @@ var openapi_default = {
9016
9088
  "x-response-key": null
9017
9089
  },
9018
9090
  put: {
9091
+ 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
9092
  operationId: "acsAccessGroupsAddUserPut",
9020
9093
  requestBody: {
9021
9094
  content: {
9022
9095
  "application/json": {
9023
9096
  schema: {
9024
9097
  properties: {
9025
- acs_access_group_id: { format: "uuid", type: "string" },
9026
- acs_user_id: { format: "uuid", type: "string" }
9098
+ acs_access_group_id: {
9099
+ description: "ID of the desired access group.",
9100
+ format: "uuid",
9101
+ type: "string"
9102
+ },
9103
+ acs_user_id: {
9104
+ description: "ID of the desired user.",
9105
+ format: "uuid",
9106
+ type: "string"
9107
+ }
9027
9108
  },
9028
9109
  required: ["acs_access_group_id", "acs_user_id"],
9029
9110
  type: "object"
@@ -9060,13 +9141,18 @@ var openapi_default = {
9060
9141
  },
9061
9142
  "/acs/access_groups/get": {
9062
9143
  post: {
9144
+ description: "Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
9063
9145
  operationId: "acsAccessGroupsGetPost",
9064
9146
  requestBody: {
9065
9147
  content: {
9066
9148
  "application/json": {
9067
9149
  schema: {
9068
9150
  properties: {
9069
- acs_access_group_id: { format: "uuid", type: "string" }
9151
+ acs_access_group_id: {
9152
+ description: "ID of the desired access group.",
9153
+ format: "uuid",
9154
+ type: "string"
9155
+ }
9070
9156
  },
9071
9157
  required: ["acs_access_group_id"],
9072
9158
  type: "object"
@@ -9110,14 +9196,23 @@ var openapi_default = {
9110
9196
  },
9111
9197
  "/acs/access_groups/list": {
9112
9198
  post: {
9199
+ description: "Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
9113
9200
  operationId: "acsAccessGroupsListPost",
9114
9201
  requestBody: {
9115
9202
  content: {
9116
9203
  "application/json": {
9117
9204
  schema: {
9118
9205
  properties: {
9119
- acs_system_id: { format: "uuid", type: "string" },
9120
- acs_user_id: { format: "uuid", type: "string" }
9206
+ acs_system_id: {
9207
+ description: "ID of the access control system for which you want to retrieve all access groups.",
9208
+ format: "uuid",
9209
+ type: "string"
9210
+ },
9211
+ acs_user_id: {
9212
+ description: "ID of the user for which you want to retrieve all access groups.",
9213
+ format: "uuid",
9214
+ type: "string"
9215
+ }
9121
9216
  },
9122
9217
  type: "object"
9123
9218
  }
@@ -9161,13 +9256,18 @@ var openapi_default = {
9161
9256
  },
9162
9257
  "/acs/access_groups/list_accessible_entrances": {
9163
9258
  post: {
9259
+ 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
9260
  operationId: "acsAccessGroupsListAccessibleEntrancesPost",
9165
9261
  requestBody: {
9166
9262
  content: {
9167
9263
  "application/json": {
9168
9264
  schema: {
9169
9265
  properties: {
9170
- acs_access_group_id: { format: "uuid", type: "string" }
9266
+ acs_access_group_id: {
9267
+ description: "ID of the access group for which you want to retrieve all accessible entrances.",
9268
+ format: "uuid",
9269
+ type: "string"
9270
+ }
9171
9271
  },
9172
9272
  required: ["acs_access_group_id"],
9173
9273
  type: "object"
@@ -9212,13 +9312,18 @@ var openapi_default = {
9212
9312
  },
9213
9313
  "/acs/access_groups/list_users": {
9214
9314
  post: {
9315
+ 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
9316
  operationId: "acsAccessGroupsListUsersPost",
9216
9317
  requestBody: {
9217
9318
  content: {
9218
9319
  "application/json": {
9219
9320
  schema: {
9220
9321
  properties: {
9221
- acs_access_group_id: { format: "uuid", type: "string" }
9322
+ acs_access_group_id: {
9323
+ description: "ID of the access group for which you want to retrieve all users.",
9324
+ format: "uuid",
9325
+ type: "string"
9326
+ }
9222
9327
  },
9223
9328
  required: ["acs_access_group_id"],
9224
9329
  type: "object"
@@ -9263,14 +9368,23 @@ var openapi_default = {
9263
9368
  },
9264
9369
  "/acs/access_groups/remove_user": {
9265
9370
  post: {
9371
+ 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
9372
  operationId: "acsAccessGroupsRemoveUserPost",
9267
9373
  requestBody: {
9268
9374
  content: {
9269
9375
  "application/json": {
9270
9376
  schema: {
9271
9377
  properties: {
9272
- acs_access_group_id: { format: "uuid", type: "string" },
9273
- acs_user_id: { format: "uuid", type: "string" }
9378
+ acs_access_group_id: {
9379
+ description: "ID of the desired access group.",
9380
+ format: "uuid",
9381
+ type: "string"
9382
+ },
9383
+ acs_user_id: {
9384
+ description: "ID of the desired user.",
9385
+ format: "uuid",
9386
+ type: "string"
9387
+ }
9274
9388
  },
9275
9389
  required: ["acs_access_group_id", "acs_user_id"],
9276
9390
  type: "object"
@@ -9308,13 +9422,18 @@ var openapi_default = {
9308
9422
  },
9309
9423
  "/acs/access_groups/unmanaged/get": {
9310
9424
  post: {
9425
+ description: "Returns a specified unmanaged [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
9311
9426
  operationId: "acsAccessGroupsUnmanagedGetPost",
9312
9427
  requestBody: {
9313
9428
  content: {
9314
9429
  "application/json": {
9315
9430
  schema: {
9316
9431
  properties: {
9317
- acs_access_group_id: { format: "uuid", type: "string" }
9432
+ acs_access_group_id: {
9433
+ description: "ID of the desired unmanaged access group.",
9434
+ format: "uuid",
9435
+ type: "string"
9436
+ }
9318
9437
  },
9319
9438
  required: ["acs_access_group_id"],
9320
9439
  type: "object"
@@ -9346,11 +9465,24 @@ var openapi_default = {
9346
9465
  type: "string",
9347
9466
  "x-deprecated": "use external_type_display_name"
9348
9467
  },
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" },
9468
+ acs_access_group_id: {
9469
+ description: "ID of the access group.",
9470
+ format: "uuid",
9471
+ type: "string"
9472
+ },
9473
+ acs_system_id: {
9474
+ description: "ID of the access control system that contains the access group.",
9475
+ format: "uuid",
9476
+ type: "string"
9477
+ },
9478
+ created_at: {
9479
+ description: "Date and time at which the access group was created.",
9480
+ format: "date-time",
9481
+ type: "string"
9482
+ },
9352
9483
  display_name: { type: "string" },
9353
9484
  external_type: {
9485
+ description: "Brand-specific terminology for the access group type.",
9354
9486
  enum: [
9355
9487
  "pti_unit",
9356
9488
  "pti_access_level",
@@ -9359,10 +9491,20 @@ var openapi_default = {
9359
9491
  ],
9360
9492
  type: "string"
9361
9493
  },
9362
- external_type_display_name: { type: "string" },
9494
+ external_type_display_name: {
9495
+ description: "Display name that corresponds to the brand-specific terminology for the access group type.",
9496
+ type: "string"
9497
+ },
9363
9498
  is_managed: { enum: [false], type: "boolean" },
9364
- name: { type: "string" },
9365
- workspace_id: { format: "uuid", type: "string" }
9499
+ name: {
9500
+ description: "Name of the access group.",
9501
+ type: "string"
9502
+ },
9503
+ workspace_id: {
9504
+ description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group.",
9505
+ format: "uuid",
9506
+ type: "string"
9507
+ }
9366
9508
  },
9367
9509
  required: [
9368
9510
  "acs_access_group_id",
@@ -9406,14 +9548,23 @@ var openapi_default = {
9406
9548
  },
9407
9549
  "/acs/access_groups/unmanaged/list": {
9408
9550
  post: {
9551
+ description: "Returns a list of all unmanaged [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
9409
9552
  operationId: "acsAccessGroupsUnmanagedListPost",
9410
9553
  requestBody: {
9411
9554
  content: {
9412
9555
  "application/json": {
9413
9556
  schema: {
9414
9557
  properties: {
9415
- acs_system_id: { format: "uuid", type: "string" },
9416
- acs_user_id: { format: "uuid", type: "string" }
9558
+ acs_system_id: {
9559
+ description: "ID of the access control system for which you want to retrieve all unmanaged access groups.",
9560
+ format: "uuid",
9561
+ type: "string"
9562
+ },
9563
+ acs_user_id: {
9564
+ description: "ID of the user for which you want to retrieve all unmanaged access groups.",
9565
+ format: "uuid",
9566
+ type: "string"
9567
+ }
9417
9568
  },
9418
9569
  type: "object"
9419
9570
  }
@@ -9446,13 +9597,23 @@ var openapi_default = {
9446
9597
  "x-deprecated": "use external_type_display_name"
9447
9598
  },
9448
9599
  acs_access_group_id: {
9600
+ description: "ID of the access group.",
9449
9601
  format: "uuid",
9450
9602
  type: "string"
9451
9603
  },
9452
- acs_system_id: { format: "uuid", type: "string" },
9453
- created_at: { format: "date-time", type: "string" },
9604
+ acs_system_id: {
9605
+ description: "ID of the access control system that contains the access group.",
9606
+ format: "uuid",
9607
+ type: "string"
9608
+ },
9609
+ created_at: {
9610
+ description: "Date and time at which the access group was created.",
9611
+ format: "date-time",
9612
+ type: "string"
9613
+ },
9454
9614
  display_name: { type: "string" },
9455
9615
  external_type: {
9616
+ description: "Brand-specific terminology for the access group type.",
9456
9617
  enum: [
9457
9618
  "pti_unit",
9458
9619
  "pti_access_level",
@@ -9461,10 +9622,20 @@ var openapi_default = {
9461
9622
  ],
9462
9623
  type: "string"
9463
9624
  },
9464
- external_type_display_name: { type: "string" },
9625
+ external_type_display_name: {
9626
+ description: "Display name that corresponds to the brand-specific terminology for the access group type.",
9627
+ type: "string"
9628
+ },
9465
9629
  is_managed: { enum: [false], type: "boolean" },
9466
- name: { type: "string" },
9467
- workspace_id: { format: "uuid", type: "string" }
9630
+ name: {
9631
+ description: "Name of the access group.",
9632
+ type: "string"
9633
+ },
9634
+ workspace_id: {
9635
+ description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group.",
9636
+ format: "uuid",
9637
+ type: "string"
9638
+ }
9468
9639
  },
9469
9640
  required: [
9470
9641
  "acs_access_group_id",