@seamapi/types 1.739.0 → 1.741.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 (28) hide show
  1. package/dist/connect.cjs +355 -4
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +1348 -61
  4. package/dist/index.cjs +355 -4
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/acs/acs-access-group.d.ts +62 -0
  7. package/lib/seam/connect/models/acs/acs-access-groups/pending-mutations.d.ts +53 -0
  8. package/lib/seam/connect/models/acs/acs-access-groups/pending-mutations.js +19 -0
  9. package/lib/seam/connect/models/acs/acs-access-groups/pending-mutations.js.map +1 -1
  10. package/lib/seam/connect/models/acs/acs-users/acs-user.d.ts +62 -0
  11. package/lib/seam/connect/models/acs/acs-users/pending-mutations.d.ts +53 -0
  12. package/lib/seam/connect/models/acs/acs-users/pending-mutations.js +19 -0
  13. package/lib/seam/connect/models/acs/acs-users/pending-mutations.js.map +1 -1
  14. package/lib/seam/connect/models/batch.d.ts +296 -0
  15. package/lib/seam/connect/models/events/devices.d.ts +156 -0
  16. package/lib/seam/connect/models/events/devices.js +25 -0
  17. package/lib/seam/connect/models/events/devices.js.map +1 -1
  18. package/lib/seam/connect/models/events/seam-event.d.ts +77 -1
  19. package/lib/seam/connect/openapi.d.ts +407 -0
  20. package/lib/seam/connect/openapi.js +305 -0
  21. package/lib/seam/connect/openapi.js.map +1 -1
  22. package/lib/seam/connect/route-types.d.ts +388 -4
  23. package/package.json +1 -1
  24. package/src/lib/seam/connect/models/acs/acs-access-groups/pending-mutations.ts +26 -0
  25. package/src/lib/seam/connect/models/acs/acs-users/pending-mutations.ts +26 -0
  26. package/src/lib/seam/connect/models/events/devices.ts +31 -0
  27. package/src/lib/seam/connect/openapi.ts +337 -0
  28. package/src/lib/seam/connect/route-types.ts +456 -0
package/dist/connect.cjs CHANGED
@@ -2906,6 +2906,17 @@ var updating_entrance_membership = common_pending_mutation3.extend({
2906
2906
  }).describe(
2907
2907
  "Seam is in the process of pushing an entrance membership update to the integrated access system."
2908
2908
  );
2909
+ var deferring_user_membership_update = common_pending_mutation3.extend({
2910
+ mutation_code: zod.z.literal("deferring_user_membership_update").describe(
2911
+ "Mutation code to indicate that a scheduled user membership change is pending for this access group."
2912
+ ),
2913
+ acs_user_id: zod.z.string().uuid().describe("ID of the user involved in the scheduled change."),
2914
+ variant: zod.z.enum(["adding", "removing"]).describe(
2915
+ "Whether the user is scheduled to be added to or removed from this access group."
2916
+ )
2917
+ }).describe(
2918
+ "A scheduled user membership change is pending for this access group."
2919
+ );
2909
2920
  var acs_access_group_pending_mutations = zod.z.discriminatedUnion(
2910
2921
  "mutation_code",
2911
2922
  [
@@ -2914,7 +2925,8 @@ var acs_access_group_pending_mutations = zod.z.discriminatedUnion(
2914
2925
  updating_group_information,
2915
2926
  updating_access_schedule,
2916
2927
  updating_user_membership,
2917
- updating_entrance_membership
2928
+ updating_entrance_membership,
2929
+ deferring_user_membership_update
2918
2930
  ]
2919
2931
  );
2920
2932
  zod.z.object({
@@ -2923,7 +2935,8 @@ zod.z.object({
2923
2935
  updating_name: updating_group_information.optional().nullable(),
2924
2936
  updating_access_schedule: updating_access_schedule.optional().nullable(),
2925
2937
  updating_user_membership: zod.z.record(zod.z.string().uuid(), updating_user_membership).optional().nullable(),
2926
- updating_entrance_membership: zod.z.record(zod.z.string().uuid(), updating_entrance_membership).optional().nullable()
2938
+ updating_entrance_membership: zod.z.record(zod.z.string().uuid(), updating_entrance_membership).optional().nullable(),
2939
+ deferring_user_membership_update: zod.z.record(zod.z.string().uuid(), deferring_user_membership_update).optional().nullable()
2927
2940
  });
2928
2941
 
2929
2942
  // src/lib/seam/connect/models/acs/acs-access-group.ts
@@ -3784,6 +3797,17 @@ var updating_group_membership_mutation = common_pending_mutation4.extend({
3784
3797
  }).describe(
3785
3798
  "Seam is in the process of pushing an access group membership update to the integrated access system."
3786
3799
  );
3800
+ var deferring_group_membership_update_mutation = common_pending_mutation4.extend({
3801
+ mutation_code: zod.z.literal("deferring_group_membership_update").describe(
3802
+ "Mutation code to indicate that a scheduled access group membership change is pending for this user."
3803
+ ),
3804
+ acs_access_group_id: zod.z.string().uuid().describe("ID of the access group involved in the scheduled change."),
3805
+ variant: zod.z.enum(["adding", "removing"]).describe(
3806
+ "Whether the user is scheduled to be added to or removed from the access group."
3807
+ )
3808
+ }).describe(
3809
+ "A scheduled access group membership change is pending for this user."
3810
+ );
3787
3811
  var acs_user_pending_mutations = zod.z.discriminatedUnion(
3788
3812
  "mutation_code",
3789
3813
  [
@@ -3793,7 +3817,8 @@ var acs_user_pending_mutations = zod.z.discriminatedUnion(
3793
3817
  updating_user_information_mutation,
3794
3818
  updating_access_schedule_mutation,
3795
3819
  updating_suspension_state_mutation,
3796
- updating_group_membership_mutation
3820
+ updating_group_membership_mutation,
3821
+ deferring_group_membership_update_mutation
3797
3822
  ]
3798
3823
  );
3799
3824
  zod.z.object({
@@ -3802,6 +3827,7 @@ zod.z.object({
3802
3827
  deferring_creation: deferring_creation.optional().nullable(),
3803
3828
  updating_access_schedule: updating_access_schedule_mutation.optional().nullable(),
3804
3829
  updating_group_membership: zod.z.record(zod.z.string().uuid(), updating_group_membership_mutation).optional().nullable(),
3830
+ deferring_group_membership_update: zod.z.record(zod.z.string().uuid(), deferring_group_membership_update_mutation).optional().nullable(),
3805
3831
  updating_suspension_state: updating_suspension_state_mutation.optional().nullable(),
3806
3832
  "updating_user_information.full_name": common_pending_mutation4.extend({
3807
3833
  mutation_code: zod.z.literal("updating_user_information"),
@@ -5876,6 +5902,24 @@ var device_name_changed_event = device_event.extend({
5876
5902
  ---
5877
5903
  The name of a [device](https://docs.seam.co/latest/core-concepts/devices) was changed.
5878
5904
  `);
5905
+ var camera_activated_event = device_event.extend({
5906
+ event_type: zod.z.literal("camera.activated"),
5907
+ activation_reason: zod.z.enum(["motion_detected"]).describe("The reason the camera was activated."),
5908
+ motion_sub_type: zod.z.enum(["human", "vehicle", "package", "other"]).optional().describe("Sub-type of motion detected, if available.")
5909
+ }).describe(`
5910
+ ---
5911
+ route_path: /devices
5912
+ ---
5913
+ A [camera](https://docs.seam.co/latest/core-concepts/devices) was activated, for example, by motion detection.
5914
+ `);
5915
+ var device_doorbell_rang_event = device_event.extend({
5916
+ event_type: zod.z.literal("device.doorbell_rang")
5917
+ }).describe(`
5918
+ ---
5919
+ route_path: /devices
5920
+ ---
5921
+ A doorbell button was pressed on a [device](https://docs.seam.co/latest/core-concepts/devices).
5922
+ `);
5879
5923
  var device_events = [
5880
5924
  device_connected_event,
5881
5925
  device_added_event,
@@ -5909,7 +5953,9 @@ var device_events = [
5909
5953
  temperature_threshold_no_longer_exceeded_event,
5910
5954
  temperature_reached_set_point_event,
5911
5955
  temperature_changed_event,
5912
- device_name_changed_event
5956
+ device_name_changed_event,
5957
+ camera_activated_event,
5958
+ device_doorbell_rang_event
5913
5959
  ];
5914
5960
  var enrollment_automation_event = common_event.extend({
5915
5961
  enrollment_automation_id: zod.z.string().uuid().describe("ID of the affected enrollment automation.")
@@ -9169,6 +9215,43 @@ var openapi_default = {
9169
9215
  "to"
9170
9216
  ],
9171
9217
  type: "object"
9218
+ },
9219
+ {
9220
+ description: "A scheduled user membership change is pending for this access group.",
9221
+ properties: {
9222
+ acs_user_id: {
9223
+ description: "ID of the user involved in the scheduled change.",
9224
+ format: "uuid",
9225
+ type: "string"
9226
+ },
9227
+ created_at: {
9228
+ description: "Date and time at which the mutation was created.",
9229
+ format: "date-time",
9230
+ type: "string"
9231
+ },
9232
+ message: {
9233
+ description: "Detailed description of the mutation.",
9234
+ type: "string"
9235
+ },
9236
+ mutation_code: {
9237
+ description: "Mutation code to indicate that a scheduled user membership change is pending for this access group.",
9238
+ enum: ["deferring_user_membership_update"],
9239
+ type: "string"
9240
+ },
9241
+ variant: {
9242
+ description: "Whether the user is scheduled to be added to or removed from this access group.",
9243
+ enum: ["adding", "removing"],
9244
+ type: "string"
9245
+ }
9246
+ },
9247
+ required: [
9248
+ "created_at",
9249
+ "message",
9250
+ "mutation_code",
9251
+ "acs_user_id",
9252
+ "variant"
9253
+ ],
9254
+ type: "object"
9172
9255
  }
9173
9256
  ]
9174
9257
  },
@@ -10934,6 +11017,43 @@ var openapi_default = {
10934
11017
  "to"
10935
11018
  ],
10936
11019
  type: "object"
11020
+ },
11021
+ {
11022
+ description: "A scheduled access group membership change is pending for this user.",
11023
+ properties: {
11024
+ acs_access_group_id: {
11025
+ description: "ID of the access group involved in the scheduled change.",
11026
+ format: "uuid",
11027
+ type: "string"
11028
+ },
11029
+ created_at: {
11030
+ description: "Date and time at which the mutation was created.",
11031
+ format: "date-time",
11032
+ type: "string"
11033
+ },
11034
+ message: {
11035
+ description: "Detailed description of the mutation.",
11036
+ type: "string"
11037
+ },
11038
+ mutation_code: {
11039
+ description: "Mutation code to indicate that a scheduled access group membership change is pending for this user.",
11040
+ enum: ["deferring_group_membership_update"],
11041
+ type: "string"
11042
+ },
11043
+ variant: {
11044
+ description: "Whether the user is scheduled to be added to or removed from the access group.",
11045
+ enum: ["adding", "removing"],
11046
+ type: "string"
11047
+ }
11048
+ },
11049
+ required: [
11050
+ "created_at",
11051
+ "message",
11052
+ "mutation_code",
11053
+ "acs_access_group_id",
11054
+ "variant"
11055
+ ],
11056
+ type: "object"
10937
11057
  }
10938
11058
  ]
10939
11059
  },
@@ -27162,6 +27282,147 @@ var openapi_default = {
27162
27282
  type: "object",
27163
27283
  "x-route-path": "/devices"
27164
27284
  },
27285
+ {
27286
+ description: "A [camera](https://docs.seam.co/latest/core-concepts/devices) was activated, for example, by motion detection.",
27287
+ properties: {
27288
+ activation_reason: {
27289
+ description: "The reason the camera was activated.",
27290
+ enum: ["motion_detected"],
27291
+ type: "string"
27292
+ },
27293
+ connected_account_custom_metadata: {
27294
+ additionalProperties: {
27295
+ oneOf: [{ type: "string" }, { type: "boolean" }]
27296
+ },
27297
+ description: "Custom metadata of the connected account, present when connected_account_id is provided.",
27298
+ type: "object"
27299
+ },
27300
+ connected_account_id: {
27301
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event.",
27302
+ format: "uuid",
27303
+ type: "string"
27304
+ },
27305
+ created_at: {
27306
+ description: "Date and time at which the event was created.",
27307
+ format: "date-time",
27308
+ type: "string"
27309
+ },
27310
+ customer_key: {
27311
+ description: "The customer key associated with the device, if any.",
27312
+ type: "string"
27313
+ },
27314
+ device_custom_metadata: {
27315
+ additionalProperties: {
27316
+ oneOf: [{ type: "string" }, { type: "boolean" }]
27317
+ },
27318
+ description: "Custom metadata of the device, present when device_id is provided.",
27319
+ type: "object"
27320
+ },
27321
+ device_id: {
27322
+ description: "ID of the affected device.",
27323
+ format: "uuid",
27324
+ type: "string"
27325
+ },
27326
+ event_id: {
27327
+ description: "ID of the event.",
27328
+ format: "uuid",
27329
+ type: "string"
27330
+ },
27331
+ event_type: { enum: ["camera.activated"], type: "string" },
27332
+ motion_sub_type: {
27333
+ description: "Sub-type of motion detected, if available.",
27334
+ enum: ["human", "vehicle", "package", "other"],
27335
+ type: "string"
27336
+ },
27337
+ occurred_at: {
27338
+ description: "Date and time at which the event occurred.",
27339
+ format: "date-time",
27340
+ type: "string"
27341
+ },
27342
+ workspace_id: {
27343
+ description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event.",
27344
+ format: "uuid",
27345
+ type: "string"
27346
+ }
27347
+ },
27348
+ required: [
27349
+ "event_id",
27350
+ "workspace_id",
27351
+ "created_at",
27352
+ "occurred_at",
27353
+ "device_id",
27354
+ "connected_account_id",
27355
+ "event_type",
27356
+ "activation_reason"
27357
+ ],
27358
+ type: "object",
27359
+ "x-route-path": "/devices"
27360
+ },
27361
+ {
27362
+ description: "A doorbell button was pressed on a [device](https://docs.seam.co/latest/core-concepts/devices).",
27363
+ properties: {
27364
+ connected_account_custom_metadata: {
27365
+ additionalProperties: {
27366
+ oneOf: [{ type: "string" }, { type: "boolean" }]
27367
+ },
27368
+ description: "Custom metadata of the connected account, present when connected_account_id is provided.",
27369
+ type: "object"
27370
+ },
27371
+ connected_account_id: {
27372
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event.",
27373
+ format: "uuid",
27374
+ type: "string"
27375
+ },
27376
+ created_at: {
27377
+ description: "Date and time at which the event was created.",
27378
+ format: "date-time",
27379
+ type: "string"
27380
+ },
27381
+ customer_key: {
27382
+ description: "The customer key associated with the device, if any.",
27383
+ type: "string"
27384
+ },
27385
+ device_custom_metadata: {
27386
+ additionalProperties: {
27387
+ oneOf: [{ type: "string" }, { type: "boolean" }]
27388
+ },
27389
+ description: "Custom metadata of the device, present when device_id is provided.",
27390
+ type: "object"
27391
+ },
27392
+ device_id: {
27393
+ description: "ID of the affected device.",
27394
+ format: "uuid",
27395
+ type: "string"
27396
+ },
27397
+ event_id: {
27398
+ description: "ID of the event.",
27399
+ format: "uuid",
27400
+ type: "string"
27401
+ },
27402
+ event_type: { enum: ["device.doorbell_rang"], type: "string" },
27403
+ occurred_at: {
27404
+ description: "Date and time at which the event occurred.",
27405
+ format: "date-time",
27406
+ type: "string"
27407
+ },
27408
+ workspace_id: {
27409
+ description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event.",
27410
+ format: "uuid",
27411
+ type: "string"
27412
+ }
27413
+ },
27414
+ required: [
27415
+ "event_id",
27416
+ "workspace_id",
27417
+ "created_at",
27418
+ "occurred_at",
27419
+ "device_id",
27420
+ "connected_account_id",
27421
+ "event_type"
27422
+ ],
27423
+ type: "object",
27424
+ "x-route-path": "/devices"
27425
+ },
27165
27426
  {
27166
27427
  description: "An [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) was deleted.",
27167
27428
  properties: {
@@ -30834,6 +31095,43 @@ var openapi_default = {
30834
31095
  "to"
30835
31096
  ],
30836
31097
  type: "object"
31098
+ },
31099
+ {
31100
+ description: "A scheduled user membership change is pending for this access group.",
31101
+ properties: {
31102
+ acs_user_id: {
31103
+ description: "ID of the user involved in the scheduled change.",
31104
+ format: "uuid",
31105
+ type: "string"
31106
+ },
31107
+ created_at: {
31108
+ description: "Date and time at which the mutation was created.",
31109
+ format: "date-time",
31110
+ type: "string"
31111
+ },
31112
+ message: {
31113
+ description: "Detailed description of the mutation.",
31114
+ type: "string"
31115
+ },
31116
+ mutation_code: {
31117
+ description: "Mutation code to indicate that a scheduled user membership change is pending for this access group.",
31118
+ enum: ["deferring_user_membership_update"],
31119
+ type: "string"
31120
+ },
31121
+ variant: {
31122
+ description: "Whether the user is scheduled to be added to or removed from this access group.",
31123
+ enum: ["adding", "removing"],
31124
+ type: "string"
31125
+ }
31126
+ },
31127
+ required: [
31128
+ "created_at",
31129
+ "message",
31130
+ "mutation_code",
31131
+ "acs_user_id",
31132
+ "variant"
31133
+ ],
31134
+ type: "object"
30837
31135
  }
30838
31136
  ]
30839
31137
  },
@@ -31799,6 +32097,43 @@ var openapi_default = {
31799
32097
  "to"
31800
32098
  ],
31801
32099
  type: "object"
32100
+ },
32101
+ {
32102
+ description: "A scheduled access group membership change is pending for this user.",
32103
+ properties: {
32104
+ acs_access_group_id: {
32105
+ description: "ID of the access group involved in the scheduled change.",
32106
+ format: "uuid",
32107
+ type: "string"
32108
+ },
32109
+ created_at: {
32110
+ description: "Date and time at which the mutation was created.",
32111
+ format: "date-time",
32112
+ type: "string"
32113
+ },
32114
+ message: {
32115
+ description: "Detailed description of the mutation.",
32116
+ type: "string"
32117
+ },
32118
+ mutation_code: {
32119
+ description: "Mutation code to indicate that a scheduled access group membership change is pending for this user.",
32120
+ enum: ["deferring_group_membership_update"],
32121
+ type: "string"
32122
+ },
32123
+ variant: {
32124
+ description: "Whether the user is scheduled to be added to or removed from the access group.",
32125
+ enum: ["adding", "removing"],
32126
+ type: "string"
32127
+ }
32128
+ },
32129
+ required: [
32130
+ "created_at",
32131
+ "message",
32132
+ "mutation_code",
32133
+ "acs_access_group_id",
32134
+ "variant"
32135
+ ],
32136
+ type: "object"
31802
32137
  }
31803
32138
  ]
31804
32139
  },
@@ -56415,6 +56750,8 @@ var openapi_default = {
56415
56750
  "thermostat.temperature_reached_set_point",
56416
56751
  "thermostat.temperature_changed",
56417
56752
  "device.name_changed",
56753
+ "camera.activated",
56754
+ "device.doorbell_rang",
56418
56755
  "enrollment_automation.deleted",
56419
56756
  "phone.deactivated",
56420
56757
  "space.device_membership_changed",
@@ -56527,6 +56864,8 @@ var openapi_default = {
56527
56864
  "thermostat.temperature_reached_set_point",
56528
56865
  "thermostat.temperature_changed",
56529
56866
  "device.name_changed",
56867
+ "camera.activated",
56868
+ "device.doorbell_rang",
56530
56869
  "enrollment_automation.deleted",
56531
56870
  "phone.deactivated",
56532
56871
  "space.device_membership_changed",
@@ -56939,6 +57278,8 @@ var openapi_default = {
56939
57278
  "thermostat.temperature_reached_set_point",
56940
57279
  "thermostat.temperature_changed",
56941
57280
  "device.name_changed",
57281
+ "camera.activated",
57282
+ "device.doorbell_rang",
56942
57283
  "enrollment_automation.deleted",
56943
57284
  "phone.deactivated",
56944
57285
  "space.device_membership_changed",
@@ -57047,6 +57388,8 @@ var openapi_default = {
57047
57388
  "thermostat.temperature_reached_set_point",
57048
57389
  "thermostat.temperature_changed",
57049
57390
  "device.name_changed",
57391
+ "camera.activated",
57392
+ "device.doorbell_rang",
57050
57393
  "enrollment_automation.deleted",
57051
57394
  "phone.deactivated",
57052
57395
  "space.device_membership_changed",
@@ -65898,6 +66241,8 @@ var openapi_default = {
65898
66241
  "thermostat.temperature_reached_set_point",
65899
66242
  "thermostat.temperature_changed",
65900
66243
  "device.name_changed",
66244
+ "camera.activated",
66245
+ "device.doorbell_rang",
65901
66246
  "enrollment_automation.deleted",
65902
66247
  "phone.deactivated",
65903
66248
  "space.device_membership_changed",
@@ -66011,6 +66356,8 @@ var openapi_default = {
66011
66356
  "thermostat.temperature_reached_set_point",
66012
66357
  "thermostat.temperature_changed",
66013
66358
  "device.name_changed",
66359
+ "camera.activated",
66360
+ "device.doorbell_rang",
66014
66361
  "enrollment_automation.deleted",
66015
66362
  "phone.deactivated",
66016
66363
  "space.device_membership_changed",
@@ -66185,6 +66532,8 @@ var openapi_default = {
66185
66532
  "thermostat.temperature_reached_set_point",
66186
66533
  "thermostat.temperature_changed",
66187
66534
  "device.name_changed",
66535
+ "camera.activated",
66536
+ "device.doorbell_rang",
66188
66537
  "enrollment_automation.deleted",
66189
66538
  "phone.deactivated",
66190
66539
  "space.device_membership_changed",
@@ -66293,6 +66642,8 @@ var openapi_default = {
66293
66642
  "thermostat.temperature_reached_set_point",
66294
66643
  "thermostat.temperature_changed",
66295
66644
  "device.name_changed",
66645
+ "camera.activated",
66646
+ "device.doorbell_rang",
66296
66647
  "enrollment_automation.deleted",
66297
66648
  "phone.deactivated",
66298
66649
  "space.device_membership_changed",