@seamapi/types 1.464.5 → 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.",
@@ -44634,6 +44640,99 @@ var openapi_default = {
44634
44640
  "x-title": "List Events"
44635
44641
  }
44636
44642
  },
44643
+ "/instant_keys/delete": {
44644
+ delete: {
44645
+ description: "Deletes a specified [Instant Key](https://docs.seam.co/latest/capability-guides/instant-keys).",
44646
+ operationId: "instantKeysDeleteDelete",
44647
+ parameters: [
44648
+ {
44649
+ in: "query",
44650
+ name: "instant_key_id",
44651
+ required: true,
44652
+ schema: {
44653
+ description: "ID of the Instant Key that you want to delete.",
44654
+ format: "uuid",
44655
+ type: "string"
44656
+ }
44657
+ }
44658
+ ],
44659
+ responses: {
44660
+ 200: {
44661
+ content: {
44662
+ "application/json": {
44663
+ schema: {
44664
+ properties: { ok: { type: "boolean" } },
44665
+ required: ["ok"],
44666
+ type: "object"
44667
+ }
44668
+ }
44669
+ },
44670
+ description: "OK"
44671
+ },
44672
+ 400: { description: "Bad Request" },
44673
+ 401: { description: "Unauthorized" }
44674
+ },
44675
+ security: [
44676
+ { api_key: [] },
44677
+ { pat_with_workspace: [] },
44678
+ { console_session_with_workspace: [] }
44679
+ ],
44680
+ summary: "/instant_keys/delete",
44681
+ tags: [],
44682
+ "x-fern-sdk-group-name": ["instant_keys"],
44683
+ "x-fern-sdk-method-name": "delete",
44684
+ "x-response-key": null,
44685
+ "x-title": "Delete an Instant Key"
44686
+ },
44687
+ post: {
44688
+ description: "Deletes a specified [Instant Key](https://docs.seam.co/latest/capability-guides/instant-keys).",
44689
+ operationId: "instantKeysDeletePost",
44690
+ requestBody: {
44691
+ content: {
44692
+ "application/json": {
44693
+ schema: {
44694
+ properties: {
44695
+ instant_key_id: {
44696
+ description: "ID of the Instant Key that you want to delete.",
44697
+ format: "uuid",
44698
+ type: "string"
44699
+ }
44700
+ },
44701
+ required: ["instant_key_id"],
44702
+ type: "object"
44703
+ }
44704
+ }
44705
+ }
44706
+ },
44707
+ responses: {
44708
+ 200: {
44709
+ content: {
44710
+ "application/json": {
44711
+ schema: {
44712
+ properties: { ok: { type: "boolean" } },
44713
+ required: ["ok"],
44714
+ type: "object"
44715
+ }
44716
+ }
44717
+ },
44718
+ description: "OK"
44719
+ },
44720
+ 400: { description: "Bad Request" },
44721
+ 401: { description: "Unauthorized" }
44722
+ },
44723
+ security: [
44724
+ { api_key: [] },
44725
+ { pat_with_workspace: [] },
44726
+ { console_session_with_workspace: [] }
44727
+ ],
44728
+ summary: "/instant_keys/delete",
44729
+ tags: [],
44730
+ "x-fern-sdk-group-name": ["instant_keys"],
44731
+ "x-fern-sdk-method-name": "delete",
44732
+ "x-response-key": null,
44733
+ "x-title": "Delete an Instant Key"
44734
+ }
44735
+ },
44637
44736
  "/instant_keys/get": {
44638
44737
  get: {
44639
44738
  description: "Gets an [instant key](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).",
@@ -51005,7 +51104,8 @@ var openapi_default = {
51005
51104
  "x-fern-sdk-method-name": "create",
51006
51105
  "x-fern-sdk-return-value": "thermostat_daily_program",
51007
51106
  "x-response-key": "thermostat_daily_program",
51008
- "x-title": "Create a Thermostat Daily Program"
51107
+ "x-title": "Create a Thermostat Daily Program",
51108
+ "x-undocumented": "Unreleased."
51009
51109
  }
51010
51110
  },
51011
51111
  "/thermostats/daily_programs/delete": {
@@ -51051,7 +51151,8 @@ var openapi_default = {
51051
51151
  "x-fern-sdk-group-name": ["thermostats", "daily_programs"],
51052
51152
  "x-fern-sdk-method-name": "delete",
51053
51153
  "x-response-key": null,
51054
- "x-title": "Delete a Thermostat Daily Program"
51154
+ "x-title": "Delete a Thermostat Daily Program",
51155
+ "x-undocumented": "Unreleased."
51055
51156
  },
51056
51157
  post: {
51057
51158
  description: "Deletes a thermostat daily program.",
@@ -51100,7 +51201,8 @@ var openapi_default = {
51100
51201
  "x-fern-sdk-group-name": ["thermostats", "daily_programs"],
51101
51202
  "x-fern-sdk-method-name": "delete",
51102
51203
  "x-response-key": null,
51103
- "x-title": "Delete a Thermostat Daily Program"
51204
+ "x-title": "Delete a Thermostat Daily Program",
51205
+ "x-undocumented": "Unreleased."
51104
51206
  }
51105
51207
  },
51106
51208
  "/thermostats/daily_programs/update": {
@@ -51182,7 +51284,8 @@ var openapi_default = {
51182
51284
  "x-fern-sdk-method-name": "update",
51183
51285
  "x-fern-sdk-return-value": "action_attempt",
51184
51286
  "x-response-key": "action_attempt",
51185
- "x-title": "Update a Thermostat Daily Program"
51287
+ "x-title": "Update a Thermostat Daily Program",
51288
+ "x-undocumented": "Unreleased."
51186
51289
  },
51187
51290
  post: {
51188
51291
  description: "Updates a specified thermostat daily program. The periods that you specify overwrite any existing periods for the daily program.",
@@ -51262,7 +51365,8 @@ var openapi_default = {
51262
51365
  "x-fern-sdk-method-name": "update",
51263
51366
  "x-fern-sdk-return-value": "action_attempt",
51264
51367
  "x-response-key": "action_attempt",
51265
- "x-title": "Update a Thermostat Daily Program"
51368
+ "x-title": "Update a Thermostat Daily Program",
51369
+ "x-undocumented": "Unreleased."
51266
51370
  }
51267
51371
  },
51268
51372
  "/thermostats/delete_climate_preset": {
@@ -53764,7 +53868,8 @@ var openapi_default = {
53764
53868
  "x-fern-sdk-method-name": "update_weekly_program",
53765
53869
  "x-fern-sdk-return-value": "action_attempt",
53766
53870
  "x-response-key": "action_attempt",
53767
- "x-title": "Update the Thermostat Weekly Program"
53871
+ "x-title": "Update the Thermostat Weekly Program",
53872
+ "x-undocumented": "Unreleased."
53768
53873
  }
53769
53874
  },
53770
53875
  "/unstable_access_grants/create": {
@@ -56227,11 +56332,11 @@ var openapi_default = {
56227
56332
  ],
56228
56333
  summary: "/user_identities/enrollment_automations/delete",
56229
56334
  tags: ["/user_identities"],
56230
- "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.",
56231
56335
  "x-fern-sdk-group-name": ["user_identities", "enrollment_automations"],
56232
56336
  "x-fern-sdk-method-name": "delete",
56233
56337
  "x-response-key": null,
56234
- "x-title": "Delete an Enrollment Automation"
56338
+ "x-title": "Delete an Enrollment Automation",
56339
+ "x-undocumented": "Will be removed."
56235
56340
  },
56236
56341
  post: {
56237
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).",
@@ -56276,11 +56381,11 @@ var openapi_default = {
56276
56381
  ],
56277
56382
  summary: "/user_identities/enrollment_automations/delete",
56278
56383
  tags: ["/user_identities"],
56279
- "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.",
56280
56384
  "x-fern-sdk-group-name": ["user_identities", "enrollment_automations"],
56281
56385
  "x-fern-sdk-method-name": "delete",
56282
56386
  "x-response-key": null,
56283
- "x-title": "Delete an Enrollment Automation"
56387
+ "x-title": "Delete an Enrollment Automation",
56388
+ "x-undocumented": "Will be removed."
56284
56389
  }
56285
56390
  },
56286
56391
  "/user_identities/enrollment_automations/get": {
@@ -56328,12 +56433,12 @@ var openapi_default = {
56328
56433
  ],
56329
56434
  summary: "/user_identities/enrollment_automations/get",
56330
56435
  tags: ["/user_identities"],
56331
- "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.",
56332
56436
  "x-fern-sdk-group-name": ["user_identities", "enrollment_automations"],
56333
56437
  "x-fern-sdk-method-name": "get",
56334
56438
  "x-fern-sdk-return-value": "enrollment_automation",
56335
56439
  "x-response-key": "enrollment_automation",
56336
- "x-title": "Get an Enrollment Automation"
56440
+ "x-title": "Get an Enrollment Automation",
56441
+ "x-undocumented": "Will be removed."
56337
56442
  },
56338
56443
  post: {
56339
56444
  description: "Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system/).",
@@ -56384,12 +56489,12 @@ var openapi_default = {
56384
56489
  ],
56385
56490
  summary: "/user_identities/enrollment_automations/get",
56386
56491
  tags: ["/user_identities"],
56387
- "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.",
56388
56492
  "x-fern-sdk-group-name": ["user_identities", "enrollment_automations"],
56389
56493
  "x-fern-sdk-method-name": "get",
56390
56494
  "x-fern-sdk-return-value": "enrollment_automation",
56391
56495
  "x-response-key": "enrollment_automation",
56392
- "x-title": "Get an Enrollment Automation"
56496
+ "x-title": "Get an Enrollment Automation",
56497
+ "x-undocumented": "Will be removed."
56393
56498
  }
56394
56499
  },
56395
56500
  "/user_identities/enrollment_automations/launch": {
@@ -56463,12 +56568,12 @@ var openapi_default = {
56463
56568
  ],
56464
56569
  summary: "/user_identities/enrollment_automations/launch",
56465
56570
  tags: ["/user_identities"],
56466
- "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.",
56467
56571
  "x-fern-sdk-group-name": ["user_identities", "enrollment_automations"],
56468
56572
  "x-fern-sdk-method-name": "launch",
56469
56573
  "x-fern-sdk-return-value": "enrollment_automation",
56470
56574
  "x-response-key": "enrollment_automation",
56471
- "x-title": "Launch an Enrollment Automation"
56575
+ "x-title": "Launch an Enrollment Automation",
56576
+ "x-undocumented": "Will be removed."
56472
56577
  }
56473
56578
  },
56474
56579
  "/user_identities/enrollment_automations/list": {
@@ -56519,12 +56624,12 @@ var openapi_default = {
56519
56624
  ],
56520
56625
  summary: "/user_identities/enrollment_automations/list",
56521
56626
  tags: ["/user_identities"],
56522
- "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.",
56523
56627
  "x-fern-sdk-group-name": ["user_identities", "enrollment_automations"],
56524
56628
  "x-fern-sdk-method-name": "list",
56525
56629
  "x-fern-sdk-return-value": "enrollment_automations",
56526
56630
  "x-response-key": "enrollment_automations",
56527
- "x-title": "List Enrollment Automations"
56631
+ "x-title": "List Enrollment Automations",
56632
+ "x-undocumented": "Will be removed."
56528
56633
  },
56529
56634
  post: {
56530
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).",
@@ -56578,12 +56683,12 @@ var openapi_default = {
56578
56683
  ],
56579
56684
  summary: "/user_identities/enrollment_automations/list",
56580
56685
  tags: ["/user_identities"],
56581
- "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.",
56582
56686
  "x-fern-sdk-group-name": ["user_identities", "enrollment_automations"],
56583
56687
  "x-fern-sdk-method-name": "list",
56584
56688
  "x-fern-sdk-return-value": "enrollment_automations",
56585
56689
  "x-response-key": "enrollment_automations",
56586
- "x-title": "List Enrollment Automations"
56690
+ "x-title": "List Enrollment Automations",
56691
+ "x-undocumented": "Will be removed."
56587
56692
  }
56588
56693
  },
56589
56694
  "/user_identities/generate_instant_key": {