@seamapi/types 1.271.1 → 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 (20) hide show
  1. package/dist/connect.cjs +183 -40
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +119 -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/models/devices/device-metadata.d.ts +5 -0
  7. package/lib/seam/connect/models/devices/device-metadata.js +1 -0
  8. package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
  9. package/lib/seam/connect/models/devices/device.d.ts +7 -0
  10. package/lib/seam/connect/models/devices/phone.d.ts +5 -0
  11. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +5 -0
  12. package/lib/seam/connect/openapi.d.ts +48 -0
  13. package/lib/seam/connect/openapi.js +161 -31
  14. package/lib/seam/connect/openapi.js.map +1 -1
  15. package/lib/seam/connect/route-types.d.ts +59 -0
  16. package/package.json +1 -1
  17. package/src/lib/seam/connect/models/acs/acs-access-group.ts +31 -8
  18. package/src/lib/seam/connect/models/devices/device-metadata.ts +1 -0
  19. package/src/lib/seam/connect/openapi.ts +191 -31
  20. package/src/lib/seam/connect/route-types.ts +59 -0
package/dist/connect.cjs CHANGED
@@ -598,8 +598,9 @@ var device_metadata = zod.z.object({
598
598
  nest_device_id: zod.z.string(),
599
599
  device_name: zod.z.string(),
600
600
  // set by Google
601
- custom_name: zod.z.string()
601
+ custom_name: zod.z.string(),
602
602
  // set by device owner
603
+ display_name: zod.z.string().optional()
603
604
  }),
604
605
  ecobee_metadata: zod.z.object({
605
606
  ecobee_device_id: zod.z.string(),
@@ -1096,10 +1097,14 @@ var acs_access_group_external_type = zod.z.enum([
1096
1097
  "brivo_group"
1097
1098
  ]);
1098
1099
  var common_acs_access_group = zod.z.object({
1099
- acs_access_group_id: zod.z.string().uuid(),
1100
- acs_system_id: zod.z.string().uuid(),
1101
- workspace_id: zod.z.string().uuid(),
1102
- 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."),
1103
1108
  access_group_type: acs_access_group_external_type.describe(`
1104
1109
  ---
1105
1110
  deprecated: use external_type
@@ -1111,13 +1116,21 @@ var common_acs_access_group = zod.z.object({
1111
1116
  ---
1112
1117
  `),
1113
1118
  display_name: zod.z.string(),
1114
- external_type: acs_access_group_external_type,
1115
- external_type_display_name: zod.z.string(),
1116
- 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.")
1117
1126
  });
1118
1127
  var acs_access_group = common_acs_access_group.extend({
1119
1128
  is_managed: zod.z.literal(true)
1120
- });
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
+ `);
1121
1134
  var unmanaged_acs_access_group = common_acs_access_group.extend({
1122
1135
  is_managed: zod.z.literal(false)
1123
1136
  });
@@ -2713,6 +2726,7 @@ var openapi_default = {
2713
2726
  type: "object"
2714
2727
  },
2715
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 ",
2716
2730
  properties: {
2717
2731
  access_group_type: {
2718
2732
  deprecated: true,
@@ -2730,11 +2744,24 @@ var openapi_default = {
2730
2744
  type: "string",
2731
2745
  "x-deprecated": "use external_type_display_name"
2732
2746
  },
2733
- acs_access_group_id: { format: "uuid", type: "string" },
2734
- acs_system_id: { format: "uuid", type: "string" },
2735
- 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
+ },
2736
2762
  display_name: { type: "string" },
2737
2763
  external_type: {
2764
+ description: "Brand-specific terminology for the access group type.",
2738
2765
  enum: [
2739
2766
  "pti_unit",
2740
2767
  "pti_access_level",
@@ -2743,10 +2770,17 @@ var openapi_default = {
2743
2770
  ],
2744
2771
  type: "string"
2745
2772
  },
2746
- 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
+ },
2747
2777
  is_managed: { enum: [true], type: "boolean" },
2748
- name: { type: "string" },
2749
- 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
+ }
2750
2784
  },
2751
2785
  required: [
2752
2786
  "acs_access_group_id",
@@ -6259,6 +6293,7 @@ var openapi_default = {
6259
6293
  properties: {
6260
6294
  custom_name: { type: "string" },
6261
6295
  device_name: { type: "string" },
6296
+ display_name: { type: "string" },
6262
6297
  nest_device_id: { type: "string" }
6263
6298
  },
6264
6299
  required: [
@@ -8971,14 +9006,23 @@ var openapi_default = {
8971
9006
  },
8972
9007
  "/acs/access_groups/add_user": {
8973
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).",
8974
9010
  operationId: "acsAccessGroupsAddUserPost",
8975
9011
  requestBody: {
8976
9012
  content: {
8977
9013
  "application/json": {
8978
9014
  schema: {
8979
9015
  properties: {
8980
- acs_access_group_id: { format: "uuid", type: "string" },
8981
- 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
+ }
8982
9026
  },
8983
9027
  required: ["acs_access_group_id", "acs_user_id"],
8984
9028
  type: "object"
@@ -9014,14 +9058,23 @@ var openapi_default = {
9014
9058
  "x-response-key": null
9015
9059
  },
9016
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).",
9017
9062
  operationId: "acsAccessGroupsAddUserPut",
9018
9063
  requestBody: {
9019
9064
  content: {
9020
9065
  "application/json": {
9021
9066
  schema: {
9022
9067
  properties: {
9023
- acs_access_group_id: { format: "uuid", type: "string" },
9024
- 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
+ }
9025
9078
  },
9026
9079
  required: ["acs_access_group_id", "acs_user_id"],
9027
9080
  type: "object"
@@ -9058,13 +9111,18 @@ var openapi_default = {
9058
9111
  },
9059
9112
  "/acs/access_groups/get": {
9060
9113
  post: {
9114
+ description: "Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
9061
9115
  operationId: "acsAccessGroupsGetPost",
9062
9116
  requestBody: {
9063
9117
  content: {
9064
9118
  "application/json": {
9065
9119
  schema: {
9066
9120
  properties: {
9067
- 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
+ }
9068
9126
  },
9069
9127
  required: ["acs_access_group_id"],
9070
9128
  type: "object"
@@ -9108,14 +9166,23 @@ var openapi_default = {
9108
9166
  },
9109
9167
  "/acs/access_groups/list": {
9110
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).",
9111
9170
  operationId: "acsAccessGroupsListPost",
9112
9171
  requestBody: {
9113
9172
  content: {
9114
9173
  "application/json": {
9115
9174
  schema: {
9116
9175
  properties: {
9117
- acs_system_id: { format: "uuid", type: "string" },
9118
- 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
+ }
9119
9186
  },
9120
9187
  type: "object"
9121
9188
  }
@@ -9159,13 +9226,18 @@ var openapi_default = {
9159
9226
  },
9160
9227
  "/acs/access_groups/list_accessible_entrances": {
9161
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).",
9162
9230
  operationId: "acsAccessGroupsListAccessibleEntrancesPost",
9163
9231
  requestBody: {
9164
9232
  content: {
9165
9233
  "application/json": {
9166
9234
  schema: {
9167
9235
  properties: {
9168
- 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
+ }
9169
9241
  },
9170
9242
  required: ["acs_access_group_id"],
9171
9243
  type: "object"
@@ -9210,13 +9282,18 @@ var openapi_default = {
9210
9282
  },
9211
9283
  "/acs/access_groups/list_users": {
9212
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).",
9213
9286
  operationId: "acsAccessGroupsListUsersPost",
9214
9287
  requestBody: {
9215
9288
  content: {
9216
9289
  "application/json": {
9217
9290
  schema: {
9218
9291
  properties: {
9219
- 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
+ }
9220
9297
  },
9221
9298
  required: ["acs_access_group_id"],
9222
9299
  type: "object"
@@ -9261,14 +9338,23 @@ var openapi_default = {
9261
9338
  },
9262
9339
  "/acs/access_groups/remove_user": {
9263
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).",
9264
9342
  operationId: "acsAccessGroupsRemoveUserPost",
9265
9343
  requestBody: {
9266
9344
  content: {
9267
9345
  "application/json": {
9268
9346
  schema: {
9269
9347
  properties: {
9270
- acs_access_group_id: { format: "uuid", type: "string" },
9271
- 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
+ }
9272
9358
  },
9273
9359
  required: ["acs_access_group_id", "acs_user_id"],
9274
9360
  type: "object"
@@ -9306,13 +9392,18 @@ var openapi_default = {
9306
9392
  },
9307
9393
  "/acs/access_groups/unmanaged/get": {
9308
9394
  post: {
9395
+ description: "Returns a specified unmanaged [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
9309
9396
  operationId: "acsAccessGroupsUnmanagedGetPost",
9310
9397
  requestBody: {
9311
9398
  content: {
9312
9399
  "application/json": {
9313
9400
  schema: {
9314
9401
  properties: {
9315
- 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
+ }
9316
9407
  },
9317
9408
  required: ["acs_access_group_id"],
9318
9409
  type: "object"
@@ -9344,11 +9435,24 @@ var openapi_default = {
9344
9435
  type: "string",
9345
9436
  "x-deprecated": "use external_type_display_name"
9346
9437
  },
9347
- acs_access_group_id: { format: "uuid", type: "string" },
9348
- acs_system_id: { format: "uuid", type: "string" },
9349
- 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
+ },
9350
9453
  display_name: { type: "string" },
9351
9454
  external_type: {
9455
+ description: "Brand-specific terminology for the access group type.",
9352
9456
  enum: [
9353
9457
  "pti_unit",
9354
9458
  "pti_access_level",
@@ -9357,10 +9461,20 @@ var openapi_default = {
9357
9461
  ],
9358
9462
  type: "string"
9359
9463
  },
9360
- 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
+ },
9361
9468
  is_managed: { enum: [false], type: "boolean" },
9362
- name: { type: "string" },
9363
- 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
+ }
9364
9478
  },
9365
9479
  required: [
9366
9480
  "acs_access_group_id",
@@ -9404,14 +9518,23 @@ var openapi_default = {
9404
9518
  },
9405
9519
  "/acs/access_groups/unmanaged/list": {
9406
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).",
9407
9522
  operationId: "acsAccessGroupsUnmanagedListPost",
9408
9523
  requestBody: {
9409
9524
  content: {
9410
9525
  "application/json": {
9411
9526
  schema: {
9412
9527
  properties: {
9413
- acs_system_id: { format: "uuid", type: "string" },
9414
- 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
+ }
9415
9538
  },
9416
9539
  type: "object"
9417
9540
  }
@@ -9444,13 +9567,23 @@ var openapi_default = {
9444
9567
  "x-deprecated": "use external_type_display_name"
9445
9568
  },
9446
9569
  acs_access_group_id: {
9570
+ description: "ID of the access group.",
9447
9571
  format: "uuid",
9448
9572
  type: "string"
9449
9573
  },
9450
- acs_system_id: { format: "uuid", type: "string" },
9451
- 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
+ },
9452
9584
  display_name: { type: "string" },
9453
9585
  external_type: {
9586
+ description: "Brand-specific terminology for the access group type.",
9454
9587
  enum: [
9455
9588
  "pti_unit",
9456
9589
  "pti_access_level",
@@ -9459,10 +9592,20 @@ var openapi_default = {
9459
9592
  ],
9460
9593
  type: "string"
9461
9594
  },
9462
- 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
+ },
9463
9599
  is_managed: { enum: [false], type: "boolean" },
9464
- name: { type: "string" },
9465
- 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
+ }
9466
9609
  },
9467
9610
  required: [
9468
9611
  "acs_access_group_id",