@seamapi/types 1.590.0 → 1.591.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
@@ -41516,7 +41516,7 @@ var openapi_default = {
41516
41516
  type: "string"
41517
41517
  },
41518
41518
  customer_key: {
41519
- description: "Optional unique string key that can be used to identify the customer. If provided, the customer will be created or retrieved based on this key.",
41519
+ description: "Associate the Connect Webview, the connected account, and all resources under the connected account with a customer. If the connected account already exists, it will be associated with the customer. If the connected account already exists, but is already associated with a customer, the Connect Webview will show an error.",
41520
41520
  type: "string"
41521
41521
  },
41522
41522
  device_selection_mode: {
@@ -42421,6 +42421,93 @@ var openapi_default = {
42421
42421
  }
42422
42422
  },
42423
42423
  "/connected_accounts/update": {
42424
+ patch: {
42425
+ description: "Updates a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
42426
+ operationId: "connectedAccountsUpdatePatch",
42427
+ requestBody: {
42428
+ content: {
42429
+ "application/json": {
42430
+ schema: {
42431
+ properties: {
42432
+ accepted_capabilities: {
42433
+ description: "List of accepted device capabilities that restrict the types of devices that can be connected through this connected account. Valid values are `lock`, `thermostat`, `noise_sensor`, and `access_control`.",
42434
+ items: {
42435
+ description: "\n High-level device capabilities that can be restricted in connect webviews.\n These represent the main device categories that customers can opt into.\n",
42436
+ enum: [
42437
+ "lock",
42438
+ "thermostat",
42439
+ "noise_sensor",
42440
+ "access_control"
42441
+ ],
42442
+ type: "string"
42443
+ },
42444
+ type: "array"
42445
+ },
42446
+ automatically_manage_new_devices: {
42447
+ description: "Indicates whether newly-added devices should appear as [managed devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).",
42448
+ type: "boolean"
42449
+ },
42450
+ connected_account_id: {
42451
+ description: "ID of the connected account that you want to update.",
42452
+ format: "uuid",
42453
+ type: "string"
42454
+ },
42455
+ custom_metadata: {
42456
+ additionalProperties: {
42457
+ nullable: true,
42458
+ oneOf: [
42459
+ { maxLength: 500, type: "string" },
42460
+ { type: "boolean" }
42461
+ ]
42462
+ },
42463
+ description: "Custom metadata that you want to associate with the connected account. Entirely replaces the existing custom metadata object. If a new Connect Webview contains custom metadata and is used to reconnect a connected account, the custom metadata from the Connect Webview will entirely replace the entire custom metadata object on the connected account. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](https://docs.seam.co/latest/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata).",
42464
+ type: "object"
42465
+ },
42466
+ customer_key: {
42467
+ description: "The customer key to associate with this connected account. If provided, the connected account and all resources under the connected account will be moved to this customer. May only be provided if the connected account is not already associated with a customer.",
42468
+ minLength: 1,
42469
+ type: "string"
42470
+ }
42471
+ },
42472
+ required: ["connected_account_id"],
42473
+ type: "object"
42474
+ }
42475
+ }
42476
+ }
42477
+ },
42478
+ responses: {
42479
+ 200: {
42480
+ content: {
42481
+ "application/json": {
42482
+ schema: {
42483
+ properties: {
42484
+ connected_account: {
42485
+ $ref: "#/components/schemas/connected_account"
42486
+ },
42487
+ ok: { type: "boolean" }
42488
+ },
42489
+ required: ["connected_account", "ok"],
42490
+ type: "object"
42491
+ }
42492
+ }
42493
+ },
42494
+ description: "OK"
42495
+ },
42496
+ 400: { description: "Bad Request" },
42497
+ 401: { description: "Unauthorized" }
42498
+ },
42499
+ security: [
42500
+ { pat_with_workspace: [] },
42501
+ { console_session_with_workspace: [] },
42502
+ { api_key: [] }
42503
+ ],
42504
+ summary: "/connected_accounts/update",
42505
+ tags: ["/connected_accounts"],
42506
+ "x-fern-sdk-group-name": ["connected_accounts"],
42507
+ "x-fern-sdk-method-name": "update",
42508
+ "x-response-key": null,
42509
+ "x-title": "Update a Connected Account"
42510
+ },
42424
42511
  post: {
42425
42512
  description: "Updates a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
42426
42513
  operationId: "connectedAccountsUpdatePost",
@@ -42464,7 +42551,7 @@ var openapi_default = {
42464
42551
  type: "object"
42465
42552
  },
42466
42553
  customer_key: {
42467
- description: "The customer key to associate with this connected account. If provided, the connected account and all resources under the connected account will be moved to this customer. ",
42554
+ description: "The customer key to associate with this connected account. If provided, the connected account and all resources under the connected account will be moved to this customer. May only be provided if the connected account is not already associated with a customer.",
42468
42555
  minLength: 1,
42469
42556
  type: "string"
42470
42557
  }