@seamapi/types 1.465.0 → 1.466.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.
package/dist/connect.cjs CHANGED
@@ -249,6 +249,7 @@ var thermostat_daily_program = zod.z.object({
249
249
  }).describe(`
250
250
  ---
251
251
  route_path: /thermostats/daily_programs
252
+ undocumented: Unreleased.
252
253
  ---
253
254
  Represents a thermostat daily program, consisting of a set of periods, each of which has a starting time and the key that identifies the climate preset to apply at the starting time.
254
255
  `);
@@ -429,12 +430,14 @@ var thermostat_capability_properties = zod.z.object({
429
430
  thermostat_daily_programs: zod.z.array(thermostat_daily_program).optional().describe(`
430
431
  ---
431
432
  property_group_key: thermostats
433
+ undocumented: Unreleased.
432
434
  ---
433
435
  Configured [daily programs](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat.
434
436
  `),
435
437
  thermostat_weekly_program: thermostat_weekly_program.nullable().optional().describe(`
436
438
  ---
437
439
  property_group_key: thermostats
440
+ undocumented: Unreleased.
438
441
  ---
439
442
  Current [weekly program](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat.
440
443
  `),
@@ -16349,10 +16352,12 @@ var openapi_default = {
16349
16352
  "created_at"
16350
16353
  ],
16351
16354
  type: "object",
16352
- "x-route-path": "/thermostats/daily_programs"
16355
+ "x-route-path": "/thermostats/daily_programs",
16356
+ "x-undocumented": "Unreleased."
16353
16357
  },
16354
16358
  type: "array",
16355
- "x-property-group-key": "thermostats"
16359
+ "x-property-group-key": "thermostats",
16360
+ "x-undocumented": "Unreleased."
16356
16361
  },
16357
16362
  thermostat_weekly_program: {
16358
16363
  description: "Current [weekly program](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat.",
@@ -16417,7 +16422,8 @@ var openapi_default = {
16417
16422
  "created_at"
16418
16423
  ],
16419
16424
  type: "object",
16420
- "x-property-group-key": "thermostats"
16425
+ "x-property-group-key": "thermostats",
16426
+ "x-undocumented": "Unreleased."
16421
16427
  }
16422
16428
  },
16423
16429
  type: "object"
@@ -16945,7 +16951,6 @@ var openapi_default = {
16945
16951
  "x-route-path": "/devices"
16946
16952
  },
16947
16953
  enrollment_automation: {
16948
- deprecated: true,
16949
16954
  description: "Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access/).",
16950
16955
  properties: {
16951
16956
  created_at: {
@@ -16982,8 +16987,8 @@ var openapi_default = {
16982
16987
  "workspace_id"
16983
16988
  ],
16984
16989
  type: "object",
16985
- "x-deprecated": "Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.",
16986
- "x-route-path": "/user_identities/enrollment_automations"
16990
+ "x-route-path": "/user_identities/enrollment_automations",
16991
+ "x-undocumented": "Will be removed."
16987
16992
  },
16988
16993
  event: {
16989
16994
  description: "Represents an event. Events let you know when something interesting happens in your workspace. For example, when a lock is unlocked, Seam creates a `lock.unlocked` event. When a device's battery level is low, Seam creates a `device.battery_low` event.\n\nAs with other API resources, you can retrieve an individual event or a list of events. Seam also provides a separate [webhook](https://docs.seam.co/latest/developer-tools/webhooks) system for sending the event objects directly to an endpoint on your sever. Manage webhooks through [Seam Console](https://console.seam.co). You can also use the webhooks sandbox in Seam Console to see the different payloads for each event and test them against your own endpoints.",
@@ -23836,7 +23841,8 @@ var openapi_default = {
23836
23841
  "created_at"
23837
23842
  ],
23838
23843
  type: "object",
23839
- "x-route-path": "/thermostats/daily_programs"
23844
+ "x-route-path": "/thermostats/daily_programs",
23845
+ "x-undocumented": "Unreleased."
23840
23846
  },
23841
23847
  thermostat_schedule: {
23842
23848
  description: "Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.",
@@ -51098,7 +51104,8 @@ var openapi_default = {
51098
51104
  "x-fern-sdk-method-name": "create",
51099
51105
  "x-fern-sdk-return-value": "thermostat_daily_program",
51100
51106
  "x-response-key": "thermostat_daily_program",
51101
- "x-title": "Create a Thermostat Daily Program"
51107
+ "x-title": "Create a Thermostat Daily Program",
51108
+ "x-undocumented": "Unreleased."
51102
51109
  }
51103
51110
  },
51104
51111
  "/thermostats/daily_programs/delete": {
@@ -51144,7 +51151,8 @@ var openapi_default = {
51144
51151
  "x-fern-sdk-group-name": ["thermostats", "daily_programs"],
51145
51152
  "x-fern-sdk-method-name": "delete",
51146
51153
  "x-response-key": null,
51147
- "x-title": "Delete a Thermostat Daily Program"
51154
+ "x-title": "Delete a Thermostat Daily Program",
51155
+ "x-undocumented": "Unreleased."
51148
51156
  },
51149
51157
  post: {
51150
51158
  description: "Deletes a thermostat daily program.",
@@ -51193,7 +51201,8 @@ var openapi_default = {
51193
51201
  "x-fern-sdk-group-name": ["thermostats", "daily_programs"],
51194
51202
  "x-fern-sdk-method-name": "delete",
51195
51203
  "x-response-key": null,
51196
- "x-title": "Delete a Thermostat Daily Program"
51204
+ "x-title": "Delete a Thermostat Daily Program",
51205
+ "x-undocumented": "Unreleased."
51197
51206
  }
51198
51207
  },
51199
51208
  "/thermostats/daily_programs/update": {
@@ -51275,7 +51284,8 @@ var openapi_default = {
51275
51284
  "x-fern-sdk-method-name": "update",
51276
51285
  "x-fern-sdk-return-value": "action_attempt",
51277
51286
  "x-response-key": "action_attempt",
51278
- "x-title": "Update a Thermostat Daily Program"
51287
+ "x-title": "Update a Thermostat Daily Program",
51288
+ "x-undocumented": "Unreleased."
51279
51289
  },
51280
51290
  post: {
51281
51291
  description: "Updates a specified thermostat daily program. The periods that you specify overwrite any existing periods for the daily program.",
@@ -51355,7 +51365,8 @@ var openapi_default = {
51355
51365
  "x-fern-sdk-method-name": "update",
51356
51366
  "x-fern-sdk-return-value": "action_attempt",
51357
51367
  "x-response-key": "action_attempt",
51358
- "x-title": "Update a Thermostat Daily Program"
51368
+ "x-title": "Update a Thermostat Daily Program",
51369
+ "x-undocumented": "Unreleased."
51359
51370
  }
51360
51371
  },
51361
51372
  "/thermostats/delete_climate_preset": {
@@ -53857,7 +53868,8 @@ var openapi_default = {
53857
53868
  "x-fern-sdk-method-name": "update_weekly_program",
53858
53869
  "x-fern-sdk-return-value": "action_attempt",
53859
53870
  "x-response-key": "action_attempt",
53860
- "x-title": "Update the Thermostat Weekly Program"
53871
+ "x-title": "Update the Thermostat Weekly Program",
53872
+ "x-undocumented": "Unreleased."
53861
53873
  }
53862
53874
  },
53863
53875
  "/unstable_access_grants/create": {
@@ -56320,11 +56332,11 @@ var openapi_default = {
56320
56332
  ],
56321
56333
  summary: "/user_identities/enrollment_automations/delete",
56322
56334
  tags: ["/user_identities"],
56323
- "x-deprecated": "Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.",
56324
56335
  "x-fern-sdk-group-name": ["user_identities", "enrollment_automations"],
56325
56336
  "x-fern-sdk-method-name": "delete",
56326
56337
  "x-response-key": null,
56327
- "x-title": "Delete an Enrollment Automation"
56338
+ "x-title": "Delete an Enrollment Automation",
56339
+ "x-undocumented": "Will be removed."
56328
56340
  },
56329
56341
  post: {
56330
56342
  description: "Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system). You must delete all enrollment automations associated with a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) before [deleting the user identity](https://docs.seam.co/latest/api/user_identities/delete).",
@@ -56369,11 +56381,11 @@ var openapi_default = {
56369
56381
  ],
56370
56382
  summary: "/user_identities/enrollment_automations/delete",
56371
56383
  tags: ["/user_identities"],
56372
- "x-deprecated": "Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.",
56373
56384
  "x-fern-sdk-group-name": ["user_identities", "enrollment_automations"],
56374
56385
  "x-fern-sdk-method-name": "delete",
56375
56386
  "x-response-key": null,
56376
- "x-title": "Delete an Enrollment Automation"
56387
+ "x-title": "Delete an Enrollment Automation",
56388
+ "x-undocumented": "Will be removed."
56377
56389
  }
56378
56390
  },
56379
56391
  "/user_identities/enrollment_automations/get": {
@@ -56421,12 +56433,12 @@ var openapi_default = {
56421
56433
  ],
56422
56434
  summary: "/user_identities/enrollment_automations/get",
56423
56435
  tags: ["/user_identities"],
56424
- "x-deprecated": "Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.",
56425
56436
  "x-fern-sdk-group-name": ["user_identities", "enrollment_automations"],
56426
56437
  "x-fern-sdk-method-name": "get",
56427
56438
  "x-fern-sdk-return-value": "enrollment_automation",
56428
56439
  "x-response-key": "enrollment_automation",
56429
- "x-title": "Get an Enrollment Automation"
56440
+ "x-title": "Get an Enrollment Automation",
56441
+ "x-undocumented": "Will be removed."
56430
56442
  },
56431
56443
  post: {
56432
56444
  description: "Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system/).",
@@ -56477,12 +56489,12 @@ var openapi_default = {
56477
56489
  ],
56478
56490
  summary: "/user_identities/enrollment_automations/get",
56479
56491
  tags: ["/user_identities"],
56480
- "x-deprecated": "Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.",
56481
56492
  "x-fern-sdk-group-name": ["user_identities", "enrollment_automations"],
56482
56493
  "x-fern-sdk-method-name": "get",
56483
56494
  "x-fern-sdk-return-value": "enrollment_automation",
56484
56495
  "x-response-key": "enrollment_automation",
56485
- "x-title": "Get an Enrollment Automation"
56496
+ "x-title": "Get an Enrollment Automation",
56497
+ "x-undocumented": "Will be removed."
56486
56498
  }
56487
56499
  },
56488
56500
  "/user_identities/enrollment_automations/launch": {
@@ -56556,12 +56568,12 @@ var openapi_default = {
56556
56568
  ],
56557
56569
  summary: "/user_identities/enrollment_automations/launch",
56558
56570
  tags: ["/user_identities"],
56559
- "x-deprecated": "Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.",
56560
56571
  "x-fern-sdk-group-name": ["user_identities", "enrollment_automations"],
56561
56572
  "x-fern-sdk-method-name": "launch",
56562
56573
  "x-fern-sdk-return-value": "enrollment_automation",
56563
56574
  "x-response-key": "enrollment_automation",
56564
- "x-title": "Launch an Enrollment Automation"
56575
+ "x-title": "Launch an Enrollment Automation",
56576
+ "x-undocumented": "Will be removed."
56565
56577
  }
56566
56578
  },
56567
56579
  "/user_identities/enrollment_automations/list": {
@@ -56612,12 +56624,12 @@ var openapi_default = {
56612
56624
  ],
56613
56625
  summary: "/user_identities/enrollment_automations/list",
56614
56626
  tags: ["/user_identities"],
56615
- "x-deprecated": "Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.",
56616
56627
  "x-fern-sdk-group-name": ["user_identities", "enrollment_automations"],
56617
56628
  "x-fern-sdk-method-name": "list",
56618
56629
  "x-fern-sdk-return-value": "enrollment_automations",
56619
56630
  "x-response-key": "enrollment_automations",
56620
- "x-title": "List Enrollment Automations"
56631
+ "x-title": "List Enrollment Automations",
56632
+ "x-undocumented": "Will be removed."
56621
56633
  },
56622
56634
  post: {
56623
56635
  description: "Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).",
@@ -56671,12 +56683,12 @@ var openapi_default = {
56671
56683
  ],
56672
56684
  summary: "/user_identities/enrollment_automations/list",
56673
56685
  tags: ["/user_identities"],
56674
- "x-deprecated": "Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.",
56675
56686
  "x-fern-sdk-group-name": ["user_identities", "enrollment_automations"],
56676
56687
  "x-fern-sdk-method-name": "list",
56677
56688
  "x-fern-sdk-return-value": "enrollment_automations",
56678
56689
  "x-response-key": "enrollment_automations",
56679
- "x-title": "List Enrollment Automations"
56690
+ "x-title": "List Enrollment Automations",
56691
+ "x-undocumented": "Will be removed."
56680
56692
  }
56681
56693
  },
56682
56694
  "/user_identities/generate_instant_key": {