@seamapi/types 1.589.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
@@ -5347,7 +5347,17 @@ var space = zod.z.object({
5347
5347
  display_name: zod.z.string().describe("Display name for the space."),
5348
5348
  created_at: zod.z.string().datetime().describe("Date and time at which the space was created."),
5349
5349
  device_count: zod.z.number().describe("Number of devices in the space."),
5350
- acs_entrance_count: zod.z.number().describe("Number of entrances in the space.")
5350
+ acs_entrance_count: zod.z.number().describe("Number of entrances in the space."),
5351
+ parent_space_id: zod.z.string().uuid().optional().describe(`
5352
+ ---
5353
+ undocumented: Only used internally.
5354
+ ---
5355
+ `),
5356
+ parent_space_key: zod.z.string().optional().describe(`
5357
+ ---
5358
+ undocumented: Only used internally.
5359
+ ---
5360
+ `)
5351
5361
  }).describe(`
5352
5362
  ---
5353
5363
  draft: Early access.
@@ -24415,6 +24425,15 @@ var openapi_default = {
24415
24425
  type: "string"
24416
24426
  },
24417
24427
  name: { description: "Name of the space.", type: "string" },
24428
+ parent_space_id: {
24429
+ format: "uuid",
24430
+ type: "string",
24431
+ "x-undocumented": "Only used internally."
24432
+ },
24433
+ parent_space_key: {
24434
+ type: "string",
24435
+ "x-undocumented": "Only used internally."
24436
+ },
24418
24437
  space_id: {
24419
24438
  description: "ID of the space.",
24420
24439
  format: "uuid",
@@ -41497,7 +41516,7 @@ var openapi_default = {
41497
41516
  type: "string"
41498
41517
  },
41499
41518
  customer_key: {
41500
- 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.",
41501
41520
  type: "string"
41502
41521
  },
41503
41522
  device_selection_mode: {
@@ -42402,6 +42421,93 @@ var openapi_default = {
42402
42421
  }
42403
42422
  },
42404
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
+ },
42405
42511
  post: {
42406
42512
  description: "Updates a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
42407
42513
  operationId: "connectedAccountsUpdatePost",
@@ -42445,7 +42551,7 @@ var openapi_default = {
42445
42551
  type: "object"
42446
42552
  },
42447
42553
  customer_key: {
42448
- 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.",
42449
42555
  minLength: 1,
42450
42556
  type: "string"
42451
42557
  }
@@ -54293,6 +54399,78 @@ var openapi_default = {
54293
54399
  "x-undocumented": "Internal endpoint for customer portals."
54294
54400
  }
54295
54401
  },
54402
+ "/seam/customer/v1/spaces/create": {
54403
+ post: {
54404
+ description: "Creates a new space with optional parent space support.",
54405
+ operationId: "seamCustomerV1SpacesCreatePost",
54406
+ requestBody: {
54407
+ content: {
54408
+ "application/json": {
54409
+ schema: {
54410
+ properties: {
54411
+ acs_entrance_ids: {
54412
+ description: "IDs of the entrances that you want to add to the new space.",
54413
+ items: { format: "uuid", type: "string" },
54414
+ type: "array"
54415
+ },
54416
+ device_ids: {
54417
+ description: "IDs of the devices that you want to add to the new space.",
54418
+ items: { format: "uuid", type: "string" },
54419
+ type: "array"
54420
+ },
54421
+ name: {
54422
+ description: "Name of the space that you want to create.",
54423
+ type: "string"
54424
+ },
54425
+ parent_space_key: {
54426
+ description: "Space key of the parent space for this space.",
54427
+ type: "string"
54428
+ },
54429
+ parent_space_name: {
54430
+ description: "Name of the parent space for this space.",
54431
+ type: "string"
54432
+ },
54433
+ space_key: {
54434
+ description: "Unique key for the space within the workspace.",
54435
+ type: "string"
54436
+ }
54437
+ },
54438
+ required: ["name"],
54439
+ type: "object"
54440
+ }
54441
+ }
54442
+ }
54443
+ },
54444
+ responses: {
54445
+ 200: {
54446
+ content: {
54447
+ "application/json": {
54448
+ schema: {
54449
+ properties: {
54450
+ ok: { type: "boolean" },
54451
+ space: { $ref: "#/components/schemas/space" }
54452
+ },
54453
+ required: ["space", "ok"],
54454
+ type: "object"
54455
+ }
54456
+ }
54457
+ },
54458
+ description: "OK"
54459
+ },
54460
+ 400: { description: "Bad Request" },
54461
+ 401: { description: "Unauthorized" }
54462
+ },
54463
+ security: [{ client_session_with_customer: [] }],
54464
+ summary: "/seam/customer/v1/spaces/create",
54465
+ tags: [],
54466
+ "x-draft": "Early access.",
54467
+ "x-fern-sdk-group-name": ["seam", "customer", "v1", "spaces"],
54468
+ "x-fern-sdk-method-name": "create",
54469
+ "x-fern-sdk-return-value": "space",
54470
+ "x-response-key": "space",
54471
+ "x-title": "Create a Space"
54472
+ }
54473
+ },
54296
54474
  "/seam/instant_key/v1/client_sessions/exchange_short_code": {
54297
54475
  post: {
54298
54476
  description: "Exchanges a short code for a client session token. Mobile apps use this endpoint to retrieve a client session token securely using a short code obtained from an Instant Key URL.",