@seamapi/types 1.550.0 → 1.552.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 (34) hide show
  1. package/dist/connect.cjs +182 -1
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +1429 -125
  4. package/dist/index.cjs +182 -1
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/acs/acs-credential.d.ts +8 -8
  7. package/lib/seam/connect/models/acs/metadata/assa-abloy-vostio.d.ts +2 -2
  8. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +28 -28
  9. package/lib/seam/connect/models/action-attempts/encode-credential.d.ts +12 -12
  10. package/lib/seam/connect/models/action-attempts/scan-credential.d.ts +16 -16
  11. package/lib/seam/connect/models/batch.d.ts +1196 -131
  12. package/lib/seam/connect/models/devices/device-metadata.d.ts +95 -0
  13. package/lib/seam/connect/models/devices/device-metadata.js +62 -0
  14. package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
  15. package/lib/seam/connect/models/devices/device-type.d.ts +8 -1
  16. package/lib/seam/connect/models/devices/device-type.js +8 -0
  17. package/lib/seam/connect/models/devices/device-type.js.map +1 -1
  18. package/lib/seam/connect/models/devices/device.d.ts +136 -3
  19. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +98 -3
  20. package/lib/seam/connect/models/events/access-methods.d.ts +12 -0
  21. package/lib/seam/connect/models/events/access-methods.js +8 -0
  22. package/lib/seam/connect/models/events/access-methods.js.map +1 -1
  23. package/lib/seam/connect/models/events/seam-event.d.ts +6 -0
  24. package/lib/seam/connect/models/phones/phone-session.d.ts +14 -14
  25. package/lib/seam/connect/openapi.d.ts +128 -0
  26. package/lib/seam/connect/openapi.js +148 -0
  27. package/lib/seam/connect/openapi.js.map +1 -1
  28. package/lib/seam/connect/route-types.d.ts +691 -25
  29. package/package.json +1 -1
  30. package/src/lib/seam/connect/models/devices/device-metadata.ts +62 -0
  31. package/src/lib/seam/connect/models/devices/device-type.ts +18 -0
  32. package/src/lib/seam/connect/models/events/access-methods.ts +12 -0
  33. package/src/lib/seam/connect/openapi.ts +162 -0
  34. package/src/lib/seam/connect/route-types.ts +691 -0
package/dist/index.cjs CHANGED
@@ -1031,7 +1031,26 @@ var device_metadata = zod.z.object({
1031
1031
  product_type: zod.z.string().describe(`Product type for a Sensi device.`)
1032
1032
  }).describe(`Metadata for a Sensi device.`),
1033
1033
  keynest_metadata: zod.z.object({
1034
- device_name: zod.z.string().describe(`Device name for a KeyNest device.`)
1034
+ key_id: zod.z.string().describe(`Key ID for a KeyNest device.`),
1035
+ device_name: zod.z.string().describe(`Device name for a KeyNest device.`),
1036
+ property_id: zod.z.string().nullable().describe(`Property ID for a KeyNest device.`),
1037
+ property_postcode: zod.z.string().nullable().describe(`Property postcode for a KeyNest device.`),
1038
+ key_notes: zod.z.string().nullable().describe(`Key notes for a KeyNest device.`),
1039
+ subscription_plan: zod.z.string().describe(`Subscription plan for a KeyNest device.`),
1040
+ status_type: zod.z.string().describe(`Status type for a KeyNest device.`),
1041
+ current_or_last_store_id: zod.z.number().describe(`Current or last store ID for a KeyNest device.`),
1042
+ last_movement: zod.z.string().describe(`Last movement timestamp for a KeyNest device.`),
1043
+ address: zod.z.string().nullable().describe(`Address for a KeyNest device.`),
1044
+ current_status: zod.z.string().nullable().describe(`Current status for a KeyNest device.`),
1045
+ current_user_name: zod.z.string().nullable().describe(`Current user name for a KeyNest device.`),
1046
+ current_user_email: zod.z.string().nullable().describe(`Current user email for a KeyNest device.`),
1047
+ current_user_phone_number: zod.z.string().nullable().describe(`Current user phone number for a KeyNest device.`),
1048
+ current_user_company: zod.z.string().nullable().describe(`Current user company for a KeyNest device.`),
1049
+ handover_method: zod.z.string().nullable().describe(`Handover method for a KeyNest device.`),
1050
+ keynest_app_user: zod.z.string().nullable().describe(`KeyNest app user for a KeyNest device.`),
1051
+ default_office_id: zod.z.number().describe(`Default office ID for a KeyNest device.`),
1052
+ fob_id: zod.z.number().describe(`Fob ID for a KeyNest device.`),
1053
+ has_photo: zod.z.boolean().describe(`Whether the KeyNest device has a photo.`)
1035
1054
  }).partial().describe(`Metadata for a KeyNest device.`)
1036
1055
  }).partial().describe(`
1037
1056
  ---
@@ -1072,6 +1091,13 @@ var lock_device_type = zod.z.enum(
1072
1091
  Object.values(LOCK_DEVICE_TYPE)
1073
1092
  ).describe(`Device type for smartlocks.
1074
1093
  `);
1094
+ var KEY_DEVICE_TYPE = {
1095
+ KEYNEST_KEY: "keynest_key"
1096
+ };
1097
+ var key_device_type = zod.z.enum(
1098
+ Object.values(KEY_DEVICE_TYPE)
1099
+ ).describe(`Device type for keys.
1100
+ `);
1075
1101
  var NOISE_SENSOR_DEVICE_TYPE = {
1076
1102
  NOISEAWARE_ACTIVITY_ZONE: "noiseaware_activity_zone",
1077
1103
  MINUT_SENSOR: "minut_sensor"
@@ -1105,6 +1131,7 @@ var phone_device_type = zod.z.enum(
1105
1131
  `);
1106
1132
  var any_device_type = zod.z.union([
1107
1133
  lock_device_type,
1134
+ key_device_type,
1108
1135
  noise_sensor_device_type,
1109
1136
  thermostat_device_type,
1110
1137
  phone_device_type
@@ -4306,6 +4333,9 @@ var access_method_issued_event = access_method_event.extend({
4306
4333
  event_type: zod.z.literal("access_method.issued"),
4307
4334
  code: zod.z.string().optional().describe(
4308
4335
  "The actual PIN code for code access methods (only present when mode is 'code')."
4336
+ ),
4337
+ is_backup_code: zod.z.boolean().optional().describe(
4338
+ "Indicates whether the code is a backup code (only present when mode is 'code' and a backup code was used)."
4309
4339
  )
4310
4340
  }).describe(`
4311
4341
  ---
@@ -4341,6 +4371,9 @@ var access_method_reissued_event = access_method_event.extend({
4341
4371
  event_type: zod.z.literal("access_method.reissued"),
4342
4372
  code: zod.z.string().optional().describe(
4343
4373
  "The actual PIN code for code access methods (only present when mode is 'code')."
4374
+ ),
4375
+ is_backup_code: zod.z.boolean().optional().describe(
4376
+ "Indicates whether the code is a backup code (only present when mode is 'code' and a backup code was used)."
4344
4377
  )
4345
4378
  }).describe(`
4346
4379
  ---
@@ -13881,6 +13914,11 @@ var openapi_default = {
13881
13914
  ],
13882
13915
  type: "string"
13883
13916
  },
13917
+ {
13918
+ description: "Device type for keys.\n ",
13919
+ enum: ["keynest_key"],
13920
+ type: "string"
13921
+ },
13884
13922
  {
13885
13923
  description: "Device type for noise sensors.\n ",
13886
13924
  enum: ["noiseaware_activity_zone", "minut_sensor"],
@@ -15116,9 +15154,99 @@ var openapi_default = {
15116
15154
  keynest_metadata: {
15117
15155
  description: "Metadata for a KeyNest device.",
15118
15156
  properties: {
15157
+ address: {
15158
+ description: "Address for a KeyNest device.",
15159
+ nullable: true,
15160
+ type: "string"
15161
+ },
15162
+ current_or_last_store_id: {
15163
+ description: "Current or last store ID for a KeyNest device.",
15164
+ format: "float",
15165
+ type: "number"
15166
+ },
15167
+ current_status: {
15168
+ description: "Current status for a KeyNest device.",
15169
+ nullable: true,
15170
+ type: "string"
15171
+ },
15172
+ current_user_company: {
15173
+ description: "Current user company for a KeyNest device.",
15174
+ nullable: true,
15175
+ type: "string"
15176
+ },
15177
+ current_user_email: {
15178
+ description: "Current user email for a KeyNest device.",
15179
+ nullable: true,
15180
+ type: "string"
15181
+ },
15182
+ current_user_name: {
15183
+ description: "Current user name for a KeyNest device.",
15184
+ nullable: true,
15185
+ type: "string"
15186
+ },
15187
+ current_user_phone_number: {
15188
+ description: "Current user phone number for a KeyNest device.",
15189
+ nullable: true,
15190
+ type: "string"
15191
+ },
15192
+ default_office_id: {
15193
+ description: "Default office ID for a KeyNest device.",
15194
+ format: "float",
15195
+ type: "number"
15196
+ },
15119
15197
  device_name: {
15120
15198
  description: "Device name for a KeyNest device.",
15121
15199
  type: "string"
15200
+ },
15201
+ fob_id: {
15202
+ description: "Fob ID for a KeyNest device.",
15203
+ format: "float",
15204
+ type: "number"
15205
+ },
15206
+ handover_method: {
15207
+ description: "Handover method for a KeyNest device.",
15208
+ nullable: true,
15209
+ type: "string"
15210
+ },
15211
+ has_photo: {
15212
+ description: "Whether the KeyNest device has a photo.",
15213
+ type: "boolean"
15214
+ },
15215
+ key_id: {
15216
+ description: "Key ID for a KeyNest device.",
15217
+ type: "string"
15218
+ },
15219
+ key_notes: {
15220
+ description: "Key notes for a KeyNest device.",
15221
+ nullable: true,
15222
+ type: "string"
15223
+ },
15224
+ keynest_app_user: {
15225
+ description: "KeyNest app user for a KeyNest device.",
15226
+ nullable: true,
15227
+ type: "string"
15228
+ },
15229
+ last_movement: {
15230
+ description: "Last movement timestamp for a KeyNest device.",
15231
+ type: "string"
15232
+ },
15233
+ property_id: {
15234
+ description: "Property ID for a KeyNest device.",
15235
+ nullable: true,
15236
+ type: "string"
15237
+ },
15238
+ property_postcode: {
15239
+ description: "Property postcode for a KeyNest device.",
15240
+ nullable: true,
15241
+ type: "string"
15242
+ },
15243
+ status_type: {
15244
+ description: "Status type for a KeyNest device.",
15245
+ type: "string"
15246
+ },
15247
+ subscription_plan: {
15248
+ description: "Subscription plan for a KeyNest device.",
15249
+ type: "string"
15122
15250
  }
15123
15251
  },
15124
15252
  type: "object"
@@ -18643,6 +18771,10 @@ var openapi_default = {
18643
18771
  type: "string"
18644
18772
  },
18645
18773
  event_type: { enum: ["access_method.issued"], type: "string" },
18774
+ is_backup_code: {
18775
+ description: "Indicates whether the code is a backup code (only present when mode is 'code' and a backup code was used).",
18776
+ type: "boolean"
18777
+ },
18646
18778
  occurred_at: {
18647
18779
  description: "Date and time at which the event occurred.",
18648
18780
  format: "date-time",
@@ -18858,6 +18990,10 @@ var openapi_default = {
18858
18990
  type: "string"
18859
18991
  },
18860
18992
  event_type: { enum: ["access_method.reissued"], type: "string" },
18993
+ is_backup_code: {
18994
+ description: "Indicates whether the code is a backup code (only present when mode is 'code' and a backup code was used).",
18995
+ type: "boolean"
18996
+ },
18861
18997
  occurred_at: {
18862
18998
  description: "Date and time at which the event occurred.",
18863
18999
  format: "date-time",
@@ -26937,6 +27073,11 @@ var openapi_default = {
26937
27073
  ],
26938
27074
  type: "string"
26939
27075
  },
27076
+ {
27077
+ description: "Device type for keys.\n ",
27078
+ enum: ["keynest_key"],
27079
+ type: "string"
27080
+ },
26940
27081
  {
26941
27082
  description: "Device type for noise sensors.\n ",
26942
27083
  enum: ["noiseaware_activity_zone", "minut_sensor"],
@@ -42647,6 +42788,11 @@ var openapi_default = {
42647
42788
  ],
42648
42789
  type: "string"
42649
42790
  },
42791
+ {
42792
+ description: "Device type for keys.\n ",
42793
+ enum: ["keynest_key"],
42794
+ type: "string"
42795
+ },
42650
42796
  {
42651
42797
  description: "Device type for noise sensors.\n ",
42652
42798
  enum: ["noiseaware_activity_zone", "minut_sensor"],
@@ -42712,6 +42858,11 @@ var openapi_default = {
42712
42858
  ],
42713
42859
  type: "string"
42714
42860
  },
42861
+ {
42862
+ description: "Device type for keys.\n ",
42863
+ enum: ["keynest_key"],
42864
+ type: "string"
42865
+ },
42715
42866
  {
42716
42867
  description: "Device type for noise sensors.\n ",
42717
42868
  enum: ["noiseaware_activity_zone", "minut_sensor"],
@@ -43051,6 +43202,11 @@ var openapi_default = {
43051
43202
  ],
43052
43203
  type: "string"
43053
43204
  },
43205
+ {
43206
+ description: "Device type for keys.\n ",
43207
+ enum: ["keynest_key"],
43208
+ type: "string"
43209
+ },
43054
43210
  {
43055
43211
  description: "Device type for noise sensors.\n ",
43056
43212
  enum: ["noiseaware_activity_zone", "minut_sensor"],
@@ -43112,6 +43268,11 @@ var openapi_default = {
43112
43268
  ],
43113
43269
  type: "string"
43114
43270
  },
43271
+ {
43272
+ description: "Device type for keys.\n ",
43273
+ enum: ["keynest_key"],
43274
+ type: "string"
43275
+ },
43115
43276
  {
43116
43277
  description: "Device type for noise sensors.\n ",
43117
43278
  enum: ["noiseaware_activity_zone", "minut_sensor"],
@@ -43925,6 +44086,11 @@ var openapi_default = {
43925
44086
  ],
43926
44087
  type: "string"
43927
44088
  },
44089
+ {
44090
+ description: "Device type for keys.\n ",
44091
+ enum: ["keynest_key"],
44092
+ type: "string"
44093
+ },
43928
44094
  {
43929
44095
  description: "Device type for noise sensors.\n ",
43930
44096
  enum: ["noiseaware_activity_zone", "minut_sensor"],
@@ -43990,6 +44156,11 @@ var openapi_default = {
43990
44156
  ],
43991
44157
  type: "string"
43992
44158
  },
44159
+ {
44160
+ description: "Device type for keys.\n ",
44161
+ enum: ["keynest_key"],
44162
+ type: "string"
44163
+ },
43993
44164
  {
43994
44165
  description: "Device type for noise sensors.\n ",
43995
44166
  enum: ["noiseaware_activity_zone", "minut_sensor"],
@@ -44326,6 +44497,11 @@ var openapi_default = {
44326
44497
  ],
44327
44498
  type: "string"
44328
44499
  },
44500
+ {
44501
+ description: "Device type for keys.\n ",
44502
+ enum: ["keynest_key"],
44503
+ type: "string"
44504
+ },
44329
44505
  {
44330
44506
  description: "Device type for noise sensors.\n ",
44331
44507
  enum: ["noiseaware_activity_zone", "minut_sensor"],
@@ -44387,6 +44563,11 @@ var openapi_default = {
44387
44563
  ],
44388
44564
  type: "string"
44389
44565
  },
44566
+ {
44567
+ description: "Device type for keys.\n ",
44568
+ enum: ["keynest_key"],
44569
+ type: "string"
44570
+ },
44390
44571
  {
44391
44572
  description: "Device type for noise sensors.\n ",
44392
44573
  enum: ["noiseaware_activity_zone", "minut_sensor"],