@seamapi/types 1.410.0 → 1.410.2

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
@@ -25446,6 +25446,7 @@ var openapi_default = {
25446
25446
  },
25447
25447
  security: [
25448
25448
  { client_session: [] },
25449
+ { client_session_with_customer: [] },
25449
25450
  { pat_with_workspace: [] },
25450
25451
  { console_session_with_workspace: [] },
25451
25452
  { api_key: [] }
@@ -25578,6 +25579,7 @@ var openapi_default = {
25578
25579
  },
25579
25580
  security: [
25580
25581
  { client_session: [] },
25582
+ { client_session_with_customer: [] },
25581
25583
  { pat_with_workspace: [] },
25582
25584
  { console_session_with_workspace: [] },
25583
25585
  { api_key: [] }
@@ -25711,6 +25713,7 @@ var openapi_default = {
25711
25713
  },
25712
25714
  security: [
25713
25715
  { client_session: [] },
25716
+ { client_session_with_customer: [] },
25714
25717
  { pat_with_workspace: [] },
25715
25718
  { console_session_with_workspace: [] },
25716
25719
  { api_key: [] }
@@ -31920,6 +31923,7 @@ var openapi_default = {
31920
31923
  },
31921
31924
  security: [
31922
31925
  { client_session: [] },
31926
+ { client_session_with_customer: [] },
31923
31927
  { api_key: [] },
31924
31928
  { pat_with_workspace: [] },
31925
31929
  { console_session_with_workspace: [] }
@@ -32672,7 +32676,8 @@ var openapi_default = {
32672
32676
  security: [
32673
32677
  { api_key: [] },
32674
32678
  { pat_with_workspace: [] },
32675
- { console_session_with_workspace: [] }
32679
+ { console_session_with_workspace: [] },
32680
+ { client_session_with_customer: [] }
32676
32681
  ],
32677
32682
  summary: "/devices/simulate/connect",
32678
32683
  tags: ["/devices"],
@@ -32722,7 +32727,8 @@ var openapi_default = {
32722
32727
  security: [
32723
32728
  { api_key: [] },
32724
32729
  { pat_with_workspace: [] },
32725
- { console_session_with_workspace: [] }
32730
+ { console_session_with_workspace: [] },
32731
+ { client_session_with_customer: [] }
32726
32732
  ],
32727
32733
  summary: "/devices/simulate/disconnect",
32728
32734
  tags: ["/devices"],
@@ -32772,7 +32778,8 @@ var openapi_default = {
32772
32778
  security: [
32773
32779
  { api_key: [] },
32774
32780
  { pat_with_workspace: [] },
32775
- { console_session_with_workspace: [] }
32781
+ { console_session_with_workspace: [] },
32782
+ { client_session_with_customer: [] }
32776
32783
  ],
32777
32784
  summary: "/devices/simulate/remove",
32778
32785
  tags: ["/devices"],
@@ -33341,7 +33348,8 @@ var openapi_default = {
33341
33348
  { api_key: [] },
33342
33349
  { pat_with_workspace: [] },
33343
33350
  { console_session_with_workspace: [] },
33344
- { client_session: [] }
33351
+ { client_session: [] },
33352
+ { client_session_with_customer: [] }
33345
33353
  ],
33346
33354
  summary: "/devices/update",
33347
33355
  tags: ["/devices"],
@@ -33420,7 +33428,8 @@ var openapi_default = {
33420
33428
  { api_key: [] },
33421
33429
  { pat_with_workspace: [] },
33422
33430
  { console_session_with_workspace: [] },
33423
- { client_session: [] }
33431
+ { client_session: [] },
33432
+ { client_session_with_customer: [] }
33424
33433
  ],
33425
33434
  summary: "/devices/update",
33426
33435
  tags: ["/devices"],
@@ -33483,7 +33492,8 @@ var openapi_default = {
33483
33492
  { client_session: [] },
33484
33493
  { api_key: [] },
33485
33494
  { pat_with_workspace: [] },
33486
- { console_session_with_workspace: [] }
33495
+ { console_session_with_workspace: [] },
33496
+ { client_session_with_customer: [] }
33487
33497
  ],
33488
33498
  summary: "/events/get",
33489
33499
  tags: ["/events"],
@@ -35277,7 +35287,7 @@ var openapi_default = {
35277
35287
  schema: {
35278
35288
  properties: {
35279
35289
  device_id: {
35280
- description: "Device ID of the desired phone.",
35290
+ description: "Device ID of the phone that you want to deactivate.",
35281
35291
  type: "string"
35282
35292
  }
35283
35293
  },
@@ -35319,7 +35329,7 @@ var openapi_default = {
35319
35329
  },
35320
35330
  "/phones/get": {
35321
35331
  post: {
35322
- description: "Returns a single phone entry matching the provided `device_id`.",
35332
+ description: "Returns a specified [phone](https://docs.seam.co/latest/capability-guides/mobile-access/managing-phones-for-a-user-identity).",
35323
35333
  operationId: "phonesGetPost",
35324
35334
  requestBody: {
35325
35335
  content: {
@@ -35327,7 +35337,7 @@ var openapi_default = {
35327
35337
  schema: {
35328
35338
  properties: {
35329
35339
  device_id: {
35330
- description: "Device ID of the desired phone.",
35340
+ description: "Device ID of the phone that you want to get.",
35331
35341
  format: "uuid",
35332
35342
  type: "string"
35333
35343
  }
@@ -35368,12 +35378,12 @@ var openapi_default = {
35368
35378
  "x-fern-sdk-method-name": "get",
35369
35379
  "x-fern-sdk-return-value": "phone",
35370
35380
  "x-response-key": "phone",
35371
- "x-title": "Get Phone"
35381
+ "x-title": "Get a Phone"
35372
35382
  }
35373
35383
  },
35374
35384
  "/phones/list": {
35375
35385
  post: {
35376
- description: "Returns a list of all phones. To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body.",
35386
+ description: "Returns a list of all [phones](https://docs.seam.co/latest/capability-guides/mobile-access/managing-phones-for-a-user-identity). To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body.",
35377
35387
  operationId: "phonesListPost",
35378
35388
  requestBody: {
35379
35389
  content: {
@@ -35381,12 +35391,12 @@ var openapi_default = {
35381
35391
  schema: {
35382
35392
  properties: {
35383
35393
  acs_credential_id: {
35384
- description: "ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) by which to filter the list of returned phones.",
35394
+ description: "ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) by which you want to filter the list of returned phones.",
35385
35395
  format: "uuid",
35386
35396
  type: "string"
35387
35397
  },
35388
35398
  owner_user_identity_id: {
35389
- description: "ID of the user identity that represents the owner by which to filter the list of returned phones.",
35399
+ description: "ID of the user identity that represents the owner by which you want to filter the list of returned phones.",
35390
35400
  format: "uuid",
35391
35401
  type: "string"
35392
35402
  }
@@ -35434,7 +35444,7 @@ var openapi_default = {
35434
35444
  },
35435
35445
  "/phones/simulate/create_sandbox_phone": {
35436
35446
  post: {
35437
- description: "Creates a new simulated phone in a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). For more information, see [Creating a Simulated Phone for a User Identity](https://docs.seam.co/latest/capability-guides/mobile-access/developing-in-a-sandbox-workspace#creating-a-simulated-phone-for-a-user-identity).",
35447
+ description: "Creates a new simulated phone in a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). See also [Creating a Simulated Phone for a User Identity](https://docs.seam.co/latest/capability-guides/mobile-access/developing-in-a-sandbox-workspace#creating-a-simulated-phone-for-a-user-identity).",
35438
35448
  operationId: "phonesSimulateCreateSandboxPhonePost",
35439
35449
  requestBody: {
35440
35450
  content: {
@@ -35443,7 +35453,7 @@ var openapi_default = {
35443
35453
  properties: {
35444
35454
  assa_abloy_metadata: {
35445
35455
  default: {},
35446
- description: "ASSA ABLOY metadata to associate with the simulated phone.",
35456
+ description: "ASSA ABLOY metadata that you want to associate with the simulated phone.",
35447
35457
  properties: {
35448
35458
  application_version: {
35449
35459
  default: "1.0.0",
@@ -35480,12 +35490,12 @@ var openapi_default = {
35480
35490
  type: "object"
35481
35491
  },
35482
35492
  custom_sdk_installation_id: {
35483
- description: "ID of the custom SDK installation to use for the simulated phone.",
35493
+ description: "ID of the custom SDK installation that you want to use for the simulated phone.",
35484
35494
  type: "string"
35485
35495
  },
35486
35496
  phone_metadata: {
35487
35497
  default: {},
35488
- description: "Metadata to associate with the simulated phone.",
35498
+ description: "Metadata that you want to associate with the simulated phone.",
35489
35499
  properties: {
35490
35500
  device_manufacturer: {
35491
35501
  default: "Samsung",
@@ -35512,7 +35522,7 @@ var openapi_default = {
35512
35522
  type: "object"
35513
35523
  },
35514
35524
  user_identity_id: {
35515
- description: "ID of the user identity to associate with the simulated phone.",
35525
+ description: "ID of the user identity that you want to associate with the simulated phone.",
35516
35526
  format: "uuid",
35517
35527
  type: "string"
35518
35528
  }
@@ -35558,16 +35568,25 @@ var openapi_default = {
35558
35568
  },
35559
35569
  "/seam/bridge/v1/bridge_client_sessions/create": {
35560
35570
  post: {
35561
- description: "Creates a new bridge client session.",
35571
+ description: "Creates a new [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client session.",
35562
35572
  operationId: "seamBridgeV1BridgeClientSessionsCreatePost",
35563
35573
  requestBody: {
35564
35574
  content: {
35565
35575
  "application/json": {
35566
35576
  schema: {
35567
35577
  properties: {
35568
- bridge_client_machine_identifier_key: { type: "string" },
35569
- bridge_client_name: { type: "string" },
35570
- bridge_client_time_zone: { type: "string" }
35578
+ bridge_client_machine_identifier_key: {
35579
+ description: "Identifier key of the client machine for the Seam Bridge client that you want to create.",
35580
+ type: "string"
35581
+ },
35582
+ bridge_client_name: {
35583
+ description: "Name of the Seam Bridge client that you want to create.",
35584
+ type: "string"
35585
+ },
35586
+ bridge_client_time_zone: {
35587
+ description: "Time zone for the Seam Bridge that you want to create.",
35588
+ type: "string"
35589
+ }
35571
35590
  },
35572
35591
  required: [
35573
35592
  "bridge_client_name",
@@ -35743,12 +35762,12 @@ var openapi_default = {
35743
35762
  "x-fern-sdk-return-value": "bridge_client_session",
35744
35763
  "x-response-key": "bridge_client_session",
35745
35764
  "x-title": "Create a Bridge Client Session",
35746
- "x-undocumented": "Seam Bridge Client only."
35765
+ "x-undocumented": "Seam Bridge client only."
35747
35766
  }
35748
35767
  },
35749
35768
  "/seam/bridge/v1/bridge_client_sessions/get": {
35750
35769
  get: {
35751
- description: "Returns the bridge client session associated with the session token used.",
35770
+ description: "Returns the [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client session associated with the client session token used for authentication.",
35752
35771
  operationId: "seamBridgeV1BridgeClientSessionsGetGet",
35753
35772
  responses: {
35754
35773
  200: {
@@ -35906,11 +35925,11 @@ var openapi_default = {
35906
35925
  tags: [],
35907
35926
  "x-fern-ignore": true,
35908
35927
  "x-response-key": "bridge_client_session",
35909
- "x-title": "Get a Bridge Client Session",
35928
+ "x-title": "Get a Seam Bridge Client Session",
35910
35929
  "x-undocumented": "Seam Bridge Client only."
35911
35930
  },
35912
35931
  post: {
35913
- description: "Returns the bridge client session associated with the session token used.",
35932
+ description: "Returns the [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client session associated with the client session token used for authentication.",
35914
35933
  operationId: "seamBridgeV1BridgeClientSessionsGetPost",
35915
35934
  responses: {
35916
35935
  200: {
@@ -36075,13 +36094,13 @@ var openapi_default = {
36075
36094
  "x-fern-sdk-method-name": "get",
36076
36095
  "x-fern-sdk-return-value": "bridge_client_session",
36077
36096
  "x-response-key": "bridge_client_session",
36078
- "x-title": "Get a Bridge Client Session",
36097
+ "x-title": "Get a Seam Bridge Client Session",
36079
36098
  "x-undocumented": "Seam Bridge Client only."
36080
36099
  }
36081
36100
  },
36082
36101
  "/seam/bridge/v1/bridge_client_sessions/refresh_telemetry_token": {
36083
36102
  post: {
36084
- description: "Returns the bridge client session associated with the session token and refreshed telemetry token.",
36103
+ description: "Returns the [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client session associated with the client session token used for authentication and refreshed telemetry token.",
36085
36104
  operationId: "seamBridgeV1BridgeClientSessionsRefreshTelemetryTokenPost",
36086
36105
  responses: {
36087
36106
  200: {
@@ -36246,13 +36265,13 @@ var openapi_default = {
36246
36265
  "x-fern-sdk-method-name": "refresh_telemetry_token",
36247
36266
  "x-fern-sdk-return-value": "bridge_client_session",
36248
36267
  "x-response-key": "bridge_client_session",
36249
- "x-title": "Refresh telemetry token for bridge client session",
36268
+ "x-title": "Refresh the Telemetry Token for a Seam Bridge Client Session",
36250
36269
  "x-undocumented": "Seam Bridge Client only."
36251
36270
  }
36252
36271
  },
36253
36272
  "/seam/bridge/v1/bridge_client_sessions/regenerate_pairing_code": {
36254
36273
  post: {
36255
- description: "Generate a new pairing code and return the updated bridge client session.",
36274
+ description: "Generate a new pairing code and return the updated [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client session.",
36256
36275
  operationId: "seamBridgeV1BridgeClientSessionsRegeneratePairingCodePost",
36257
36276
  responses: {
36258
36277
  200: {
@@ -36417,21 +36436,29 @@ var openapi_default = {
36417
36436
  "x-fern-sdk-method-name": "regenerate_pairing_code",
36418
36437
  "x-fern-sdk-return-value": "bridge_client_session",
36419
36438
  "x-response-key": "bridge_client_session",
36420
- "x-title": "Regenerate a Bridge Client Session Pairing Code",
36439
+ "x-title": "Regenerate a Seam Bridge Client Session Pairing Code",
36421
36440
  "x-undocumented": "Seam Bridge Client only."
36422
36441
  }
36423
36442
  },
36424
36443
  "/seam/bridge/v1/bridge_client_sessions/report_status": {
36425
36444
  post: {
36426
- description: "Report a Seam Bridge Bridge client's status.",
36445
+ description: "Report the status of a [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client.",
36427
36446
  operationId: "seamBridgeV1BridgeClientSessionsReportStatusPost",
36428
36447
  requestBody: {
36429
36448
  content: {
36430
36449
  "application/json": {
36431
36450
  schema: {
36432
36451
  properties: {
36433
- is_tailscale_connected: { nullable: true, type: "boolean" },
36434
- tailscale_ip_v4: { nullable: true, type: "string" }
36452
+ is_tailscale_connected: {
36453
+ description: "Indicates whether Tailscale is connected.",
36454
+ nullable: true,
36455
+ type: "boolean"
36456
+ },
36457
+ tailscale_ip_v4: {
36458
+ description: "Tailscale IPv4 address.",
36459
+ nullable: true,
36460
+ type: "string"
36461
+ }
36435
36462
  },
36436
36463
  required: ["is_tailscale_connected", "tailscale_ip_v4"],
36437
36464
  type: "object"
@@ -36466,13 +36493,13 @@ var openapi_default = {
36466
36493
  ],
36467
36494
  "x-fern-sdk-method-name": "report_status",
36468
36495
  "x-response-key": null,
36469
- "x-title": "Report a Bridge Client's Status",
36496
+ "x-title": "Report the Status of a Seam Bridge Client",
36470
36497
  "x-undocumented": "Seam Bridge Client only."
36471
36498
  }
36472
36499
  },
36473
36500
  "/seam/bridge/v1/bridge_connected_systems/list": {
36474
36501
  get: {
36475
- description: "Returns the bridge connected systems associated with the session token used.",
36502
+ description: "Returns the [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge)-connected systems associated with the client session token used for authentication.",
36476
36503
  operationId: "seamBridgeV1BridgeConnectedSystemsListGet",
36477
36504
  responses: {
36478
36505
  200: {
@@ -36534,11 +36561,11 @@ var openapi_default = {
36534
36561
  tags: [],
36535
36562
  "x-fern-ignore": true,
36536
36563
  "x-response-key": "bridge_connected_systems",
36537
- "x-title": "List Bridge Connected Systems",
36564
+ "x-title": "List Bridge-Connected Systems",
36538
36565
  "x-undocumented": "Seam Bridge Client only."
36539
36566
  },
36540
36567
  post: {
36541
- description: "Returns the bridge connected systems associated with the session token used.",
36568
+ description: "Returns the [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge)-connected systems associated with the client session token used for authentication.",
36542
36569
  operationId: "seamBridgeV1BridgeConnectedSystemsListPost",
36543
36570
  responses: {
36544
36571
  200: {
@@ -36607,13 +36634,13 @@ var openapi_default = {
36607
36634
  "x-fern-sdk-method-name": "list",
36608
36635
  "x-fern-sdk-return-value": "bridge_connected_systems",
36609
36636
  "x-response-key": "bridge_connected_systems",
36610
- "x-title": "List Bridge Connected Systems",
36637
+ "x-title": "List Bridge-Connected Systems",
36611
36638
  "x-undocumented": "Seam Bridge Client only."
36612
36639
  }
36613
36640
  },
36614
36641
  "/seam/instant_key/v1/client_sessions/exchange_short_code": {
36615
36642
  post: {
36616
- description: "Exchanges a short code for a Client Session Token (CST).\nThis endpoint is used by mobile apps to securely retrieve a client session token\nusing a short code obtained from an instant key URL.",
36643
+ 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.",
36617
36644
  operationId: "seamInstantKeyV1ClientSessionsExchangeShortCodePost",
36618
36645
  requestBody: {
36619
36646
  content: {
@@ -36621,7 +36648,7 @@ var openapi_default = {
36621
36648
  schema: {
36622
36649
  properties: {
36623
36650
  short_code: {
36624
- description: "The short code to exchange for a client session token",
36651
+ description: "Short code that you want to exchange for a client session token.",
36625
36652
  type: "string"
36626
36653
  }
36627
36654
  },
@@ -36670,7 +36697,7 @@ var openapi_default = {
36670
36697
  },
36671
36698
  "/seam/mobile_sdk/v1/acs/credentials/list": {
36672
36699
  post: {
36673
- description: "Returns a list of all ACS credentials.",
36700
+ description: "Returns a list of all [credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
36674
36701
  operationId: "seamMobileSdkV1AcsCredentialsListPost",
36675
36702
  requestBody: {
36676
36703
  content: {
@@ -36718,15 +36745,19 @@ var openapi_default = {
36718
36745
  },
36719
36746
  "/seam/mobile_sdk/v1/phone_sessions/get_or_create": {
36720
36747
  post: {
36721
- description: "Get or create a session for a mobile SDK phone.",
36748
+ description: "Gets or creates a session for a mobile SDK phone.",
36722
36749
  operationId: "seamMobileSdkV1PhoneSessionsGetOrCreatePost",
36723
36750
  requestBody: {
36724
36751
  content: {
36725
36752
  "application/json": {
36726
36753
  schema: {
36727
36754
  properties: {
36728
- custom_sdk_installation_id: { type: "string" },
36755
+ custom_sdk_installation_id: {
36756
+ description: "ID of the custom SDK installation that you want to use for the new session.",
36757
+ type: "string"
36758
+ },
36729
36759
  phone_device_metadata: {
36760
+ description: "Phone device metadata that you want to use for the new session.",
36730
36761
  properties: {
36731
36762
  manufacturer: { type: "string" },
36732
36763
  model: { type: "string" },
@@ -36734,7 +36765,11 @@ var openapi_default = {
36734
36765
  },
36735
36766
  type: "object"
36736
36767
  },
36737
- phone_os: { enum: ["ios", "android"], type: "string" }
36768
+ phone_os: {
36769
+ description: "Phone operating system that you want to use for the new session.",
36770
+ enum: ["ios", "android"],
36771
+ type: "string"
36772
+ }
36738
36773
  },
36739
36774
  required: ["custom_sdk_installation_id", "phone_os"],
36740
36775
  type: "object"
@@ -36776,13 +36811,18 @@ var openapi_default = {
36776
36811
  },
36777
36812
  "/seam/partner/v1/building_blocks/spaces/auto_map": {
36778
36813
  post: {
36779
- description: "Auto map partner resources that have been pushed to Seam.",
36814
+ description: "Auto-maps partner resources that have been pushed to Seam.",
36780
36815
  operationId: "seamPartnerV1BuildingBlocksSpacesAutoMapPost",
36781
36816
  requestBody: {
36782
36817
  content: {
36783
36818
  "application/json": {
36784
36819
  schema: {
36785
- properties: { collection_key: { type: "string" } },
36820
+ properties: {
36821
+ collection_key: {
36822
+ description: "Collection key.",
36823
+ type: "string"
36824
+ }
36825
+ },
36786
36826
  required: ["collection_key"],
36787
36827
  type: "object"
36788
36828
  }
@@ -36863,13 +36903,13 @@ var openapi_default = {
36863
36903
  "x-fern-sdk-method-name": "auto_map",
36864
36904
  "x-fern-sdk-return-value": "spaces",
36865
36905
  "x-response-key": "spaces",
36866
- "x-title": "Do auto mapping for partner resources that map to spaces",
36906
+ "x-title": "Do Auto-Mapping for Partner Resources that Map to Spaces",
36867
36907
  "x-undocumented": "Partner building blocks/UI only."
36868
36908
  }
36869
36909
  },
36870
36910
  "/seam/partner/v1/resources/list": {
36871
36911
  post: {
36872
- description: "List partner resources that have been pushed to Seam.",
36912
+ description: "Lists partner resources that have been pushed to Seam.",
36873
36913
  operationId: "seamPartnerV1ResourcesListPost",
36874
36914
  requestBody: {
36875
36915
  content: {
@@ -36877,7 +36917,7 @@ var openapi_default = {
36877
36917
  schema: {
36878
36918
  properties: {
36879
36919
  resource_type_alias: {
36880
- description: "Filter by resource type alias.",
36920
+ description: "Resource type alias by which you want to filter partner resources.",
36881
36921
  type: "string"
36882
36922
  }
36883
36923
  },
@@ -36944,13 +36984,13 @@ var openapi_default = {
36944
36984
  "x-fern-sdk-method-name": "list",
36945
36985
  "x-fern-sdk-return-value": "partner_resources",
36946
36986
  "x-response-key": "partner_resources",
36947
- "x-title": "List partner resources at Seam",
36987
+ "x-title": "List Partner Resources at Seam",
36948
36988
  "x-undocumented": "Partner building blocks/UI only."
36949
36989
  }
36950
36990
  },
36951
36991
  "/spaces/add_acs_entrances": {
36952
36992
  post: {
36953
- description: "Add entrances to a specific space.",
36993
+ description: "Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific space.",
36954
36994
  operationId: "spacesAddAcsEntrancesPost",
36955
36995
  requestBody: {
36956
36996
  content: {
@@ -36958,11 +36998,16 @@ var openapi_default = {
36958
36998
  schema: {
36959
36999
  properties: {
36960
37000
  acs_entrance_ids: {
37001
+ description: "IDs of the entrances that you want to add to the space.",
36961
37002
  items: { format: "uuid", type: "string" },
36962
37003
  minItems: 1,
36963
37004
  type: "array"
36964
37005
  },
36965
- space_id: { format: "uuid", type: "string" }
37006
+ space_id: {
37007
+ description: "ID of the space to which you want to add entrances.",
37008
+ format: "uuid",
37009
+ type: "string"
37010
+ }
36966
37011
  },
36967
37012
  required: ["space_id", "acs_entrance_ids"],
36968
37013
  type: "object"
@@ -36997,10 +37042,10 @@ var openapi_default = {
36997
37042
  "x-fern-sdk-group-name": ["spaces"],
36998
37043
  "x-fern-sdk-method-name": "add_acs_entrances",
36999
37044
  "x-response-key": null,
37000
- "x-title": "Add ACS Entrances"
37045
+ "x-title": "Add Entrances to a Space"
37001
37046
  },
37002
37047
  put: {
37003
- description: "Add entrances to a specific space.",
37048
+ description: "Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific space.",
37004
37049
  operationId: "spacesAddAcsEntrancesPut",
37005
37050
  requestBody: {
37006
37051
  content: {
@@ -37008,11 +37053,16 @@ var openapi_default = {
37008
37053
  schema: {
37009
37054
  properties: {
37010
37055
  acs_entrance_ids: {
37056
+ description: "IDs of the entrances that you want to add to the space.",
37011
37057
  items: { format: "uuid", type: "string" },
37012
37058
  minItems: 1,
37013
37059
  type: "array"
37014
37060
  },
37015
- space_id: { format: "uuid", type: "string" }
37061
+ space_id: {
37062
+ description: "ID of the space to which you want to add entrances.",
37063
+ format: "uuid",
37064
+ type: "string"
37065
+ }
37016
37066
  },
37017
37067
  required: ["space_id", "acs_entrance_ids"],
37018
37068
  type: "object"
@@ -37046,12 +37096,12 @@ var openapi_default = {
37046
37096
  "x-draft": "Early access.",
37047
37097
  "x-fern-ignore": true,
37048
37098
  "x-response-key": null,
37049
- "x-title": "Add ACS Entrances"
37099
+ "x-title": "Add Entrances to a Space"
37050
37100
  }
37051
37101
  },
37052
37102
  "/spaces/add_devices": {
37053
37103
  post: {
37054
- description: "Add devices to a specific space.",
37104
+ description: "Adds devices to a specific space.",
37055
37105
  operationId: "spacesAddDevicesPost",
37056
37106
  requestBody: {
37057
37107
  content: {
@@ -37059,11 +37109,16 @@ var openapi_default = {
37059
37109
  schema: {
37060
37110
  properties: {
37061
37111
  device_ids: {
37112
+ description: "IDs of the devices that you want to add to the space.",
37062
37113
  items: { format: "uuid", type: "string" },
37063
37114
  minItems: 1,
37064
37115
  type: "array"
37065
37116
  },
37066
- space_id: { format: "uuid", type: "string" }
37117
+ space_id: {
37118
+ description: "ID of the space to which you want to add devices.",
37119
+ format: "uuid",
37120
+ type: "string"
37121
+ }
37067
37122
  },
37068
37123
  required: ["space_id", "device_ids"],
37069
37124
  type: "object"
@@ -37098,10 +37153,10 @@ var openapi_default = {
37098
37153
  "x-fern-sdk-group-name": ["spaces"],
37099
37154
  "x-fern-sdk-method-name": "add_devices",
37100
37155
  "x-response-key": null,
37101
- "x-title": "Add Space Devices"
37156
+ "x-title": "Add Devices to a Space"
37102
37157
  },
37103
37158
  put: {
37104
- description: "Add devices to a specific space.",
37159
+ description: "Adds devices to a specific space.",
37105
37160
  operationId: "spacesAddDevicesPut",
37106
37161
  requestBody: {
37107
37162
  content: {
@@ -37109,11 +37164,16 @@ var openapi_default = {
37109
37164
  schema: {
37110
37165
  properties: {
37111
37166
  device_ids: {
37167
+ description: "IDs of the devices that you want to add to the space.",
37112
37168
  items: { format: "uuid", type: "string" },
37113
37169
  minItems: 1,
37114
37170
  type: "array"
37115
37171
  },
37116
- space_id: { format: "uuid", type: "string" }
37172
+ space_id: {
37173
+ description: "ID of the space to which you want to add devices.",
37174
+ format: "uuid",
37175
+ type: "string"
37176
+ }
37117
37177
  },
37118
37178
  required: ["space_id", "device_ids"],
37119
37179
  type: "object"
@@ -37147,12 +37207,12 @@ var openapi_default = {
37147
37207
  "x-draft": "Early access.",
37148
37208
  "x-fern-ignore": true,
37149
37209
  "x-response-key": null,
37150
- "x-title": "Add Space Devices"
37210
+ "x-title": "Add Devices to a Space"
37151
37211
  }
37152
37212
  },
37153
37213
  "/spaces/create": {
37154
37214
  post: {
37155
- description: "Create a new space.",
37215
+ description: "Creates a new space.",
37156
37216
  operationId: "spacesCreatePost",
37157
37217
  requestBody: {
37158
37218
  content: {
@@ -37160,14 +37220,19 @@ var openapi_default = {
37160
37220
  schema: {
37161
37221
  properties: {
37162
37222
  acs_entrance_ids: {
37223
+ description: "IDs of the entrances that you want to add to the new space.",
37163
37224
  items: { format: "uuid", type: "string" },
37164
37225
  type: "array"
37165
37226
  },
37166
37227
  device_ids: {
37228
+ description: "IDs of the devices that you want to add to the new space.",
37167
37229
  items: { format: "uuid", type: "string" },
37168
37230
  type: "array"
37169
37231
  },
37170
- name: { type: "string" }
37232
+ name: {
37233
+ description: "Name of the space that you want to create.",
37234
+ type: "string"
37235
+ }
37171
37236
  },
37172
37237
  required: ["name"],
37173
37238
  type: "object"
@@ -37206,18 +37271,24 @@ var openapi_default = {
37206
37271
  "x-fern-sdk-method-name": "create",
37207
37272
  "x-fern-sdk-return-value": "space",
37208
37273
  "x-response-key": "space",
37209
- "x-title": "Create Space"
37274
+ "x-title": "Create a Space"
37210
37275
  }
37211
37276
  },
37212
37277
  "/spaces/delete": {
37213
37278
  post: {
37214
- description: "Delete a space.",
37279
+ description: "Deletes a space.",
37215
37280
  operationId: "spacesDeletePost",
37216
37281
  requestBody: {
37217
37282
  content: {
37218
37283
  "application/json": {
37219
37284
  schema: {
37220
- properties: { space_id: { format: "uuid", type: "string" } },
37285
+ properties: {
37286
+ space_id: {
37287
+ description: "ID of the space that you want to delete.",
37288
+ format: "uuid",
37289
+ type: "string"
37290
+ }
37291
+ },
37221
37292
  required: ["space_id"],
37222
37293
  type: "object"
37223
37294
  }
@@ -37247,21 +37318,28 @@ var openapi_default = {
37247
37318
  ],
37248
37319
  summary: "/spaces/delete",
37249
37320
  tags: [],
37321
+ "x-draft": "Early access.",
37250
37322
  "x-fern-sdk-group-name": ["spaces"],
37251
37323
  "x-fern-sdk-method-name": "delete",
37252
37324
  "x-response-key": null,
37253
- "x-title": "Delete Space"
37325
+ "x-title": "Delete a Space"
37254
37326
  }
37255
37327
  },
37256
37328
  "/spaces/get": {
37257
37329
  post: {
37258
- description: "Get a space.",
37330
+ description: "Gets a space.",
37259
37331
  operationId: "spacesGetPost",
37260
37332
  requestBody: {
37261
37333
  content: {
37262
37334
  "application/json": {
37263
37335
  schema: {
37264
- properties: { space_id: { format: "uuid", type: "string" } },
37336
+ properties: {
37337
+ space_id: {
37338
+ description: "ID of the space that you want to get.",
37339
+ format: "uuid",
37340
+ type: "string"
37341
+ }
37342
+ },
37265
37343
  required: ["space_id"],
37266
37344
  type: "object"
37267
37345
  }
@@ -37294,11 +37372,12 @@ var openapi_default = {
37294
37372
  ],
37295
37373
  summary: "/spaces/get",
37296
37374
  tags: [],
37375
+ "x-draft": "Early access.",
37297
37376
  "x-fern-sdk-group-name": ["spaces"],
37298
37377
  "x-fern-sdk-method-name": "get",
37299
37378
  "x-fern-sdk-return-value": "space",
37300
37379
  "x-response-key": "space",
37301
- "x-title": "Get Space"
37380
+ "x-title": "Get a Space"
37302
37381
  }
37303
37382
  },
37304
37383
  "/spaces/list": {
@@ -37381,7 +37460,7 @@ var openapi_default = {
37381
37460
  },
37382
37461
  "/spaces/remove_acs_entrances": {
37383
37462
  post: {
37384
- description: "Remove entrances from a specific space.",
37463
+ description: "Removes [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) from a specific space.",
37385
37464
  operationId: "spacesRemoveAcsEntrancesPost",
37386
37465
  requestBody: {
37387
37466
  content: {
@@ -37389,10 +37468,15 @@ var openapi_default = {
37389
37468
  schema: {
37390
37469
  properties: {
37391
37470
  acs_entrance_ids: {
37471
+ description: "IDs of the entrances that you want to remove from the space.",
37392
37472
  items: { format: "uuid", type: "string" },
37393
37473
  type: "array"
37394
37474
  },
37395
- space_id: { format: "uuid", type: "string" }
37475
+ space_id: {
37476
+ description: "ID of the space from which you want to remove entrances.",
37477
+ format: "uuid",
37478
+ type: "string"
37479
+ }
37396
37480
  },
37397
37481
  required: ["space_id", "acs_entrance_ids"],
37398
37482
  type: "object"
@@ -37427,12 +37511,12 @@ var openapi_default = {
37427
37511
  "x-fern-sdk-group-name": ["spaces"],
37428
37512
  "x-fern-sdk-method-name": "remove_acs_entrances",
37429
37513
  "x-response-key": null,
37430
- "x-title": "Remove ACS Entrances"
37514
+ "x-title": "Remove Entrances from a Space"
37431
37515
  }
37432
37516
  },
37433
37517
  "/spaces/remove_devices": {
37434
37518
  post: {
37435
- description: "Remove devices from a specific space.",
37519
+ description: "Removes devices from a specific space.",
37436
37520
  operationId: "spacesRemoveDevicesPost",
37437
37521
  requestBody: {
37438
37522
  content: {
@@ -37440,10 +37524,15 @@ var openapi_default = {
37440
37524
  schema: {
37441
37525
  properties: {
37442
37526
  device_ids: {
37527
+ description: "IDs of the devices that you want to remove from the space.",
37443
37528
  items: { format: "uuid", type: "string" },
37444
37529
  type: "array"
37445
37530
  },
37446
- space_id: { format: "uuid", type: "string" }
37531
+ space_id: {
37532
+ description: "ID of the space from which you want to remove devices.",
37533
+ format: "uuid",
37534
+ type: "string"
37535
+ }
37447
37536
  },
37448
37537
  required: ["space_id", "device_ids"],
37449
37538
  type: "object"
@@ -37478,20 +37567,24 @@ var openapi_default = {
37478
37567
  "x-fern-sdk-group-name": ["spaces"],
37479
37568
  "x-fern-sdk-method-name": "remove_devices",
37480
37569
  "x-response-key": null,
37481
- "x-title": "Remove Space Devices"
37570
+ "x-title": "Remove Devices from a Space"
37482
37571
  }
37483
37572
  },
37484
37573
  "/spaces/update": {
37485
37574
  patch: {
37486
- description: "Update an existing space.",
37575
+ description: "Updates an existing space.",
37487
37576
  operationId: "spacesUpdatePatch",
37488
37577
  requestBody: {
37489
37578
  content: {
37490
37579
  "application/json": {
37491
37580
  schema: {
37492
37581
  properties: {
37493
- name: { type: "string" },
37494
- space_id: { format: "uuid", type: "string" }
37582
+ name: { description: "Name of the space.", type: "string" },
37583
+ space_id: {
37584
+ description: "ID of the space that you want to update.",
37585
+ format: "uuid",
37586
+ type: "string"
37587
+ }
37495
37588
  },
37496
37589
  required: ["space_id"],
37497
37590
  type: "object"
@@ -37528,18 +37621,22 @@ var openapi_default = {
37528
37621
  "x-draft": "Early access.",
37529
37622
  "x-fern-ignore": true,
37530
37623
  "x-response-key": "space",
37531
- "x-title": "Update Space"
37624
+ "x-title": "Update a Space"
37532
37625
  },
37533
37626
  post: {
37534
- description: "Update an existing space.",
37627
+ description: "Updates an existing space.",
37535
37628
  operationId: "spacesUpdatePost",
37536
37629
  requestBody: {
37537
37630
  content: {
37538
37631
  "application/json": {
37539
37632
  schema: {
37540
37633
  properties: {
37541
- name: { type: "string" },
37542
- space_id: { format: "uuid", type: "string" }
37634
+ name: { description: "Name of the space.", type: "string" },
37635
+ space_id: {
37636
+ description: "ID of the space that you want to update.",
37637
+ format: "uuid",
37638
+ type: "string"
37639
+ }
37543
37640
  },
37544
37641
  required: ["space_id"],
37545
37642
  type: "object"
@@ -37578,7 +37675,7 @@ var openapi_default = {
37578
37675
  "x-fern-sdk-method-name": "update",
37579
37676
  "x-fern-sdk-return-value": "space",
37580
37677
  "x-response-key": "space",
37581
- "x-title": "Update Space"
37678
+ "x-title": "Update a Space"
37582
37679
  }
37583
37680
  },
37584
37681
  "/thermostats/activate_climate_preset": {
@@ -37652,12 +37749,12 @@ var openapi_default = {
37652
37749
  schema: {
37653
37750
  properties: {
37654
37751
  cooling_set_point_celsius: {
37655
- description: "Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C. You must set one of the `cooling_set_point` parameters.",
37752
+ description: "[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.",
37656
37753
  format: "float",
37657
37754
  type: "number"
37658
37755
  },
37659
37756
  cooling_set_point_fahrenheit: {
37660
- description: "Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F. You must set one of the `cooling_set_point` parameters.",
37757
+ description: "[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.",
37661
37758
  format: "float",
37662
37759
  type: "number"
37663
37760
  },
@@ -37815,7 +37912,7 @@ var openapi_default = {
37815
37912
  },
37816
37913
  "/thermostats/daily_programs/create": {
37817
37914
  post: {
37818
- description: "Creates a thermostat daily program. A daily program consists of a set of periods, where each period includes a start time and the key of a configured climate preset. Once you have defined a daily program, you can assign it to one or more days within a weekly program.",
37915
+ description: "Creates a new thermostat daily program. A daily program consists of a set of periods, where each period includes a start time and the key of a configured climate preset. Once you have defined a daily program, you can assign it to one or more days within a weekly program.",
37819
37916
  operationId: "thermostatsDailyProgramsCreatePost",
37820
37917
  requestBody: {
37821
37918
  content: {
@@ -37828,7 +37925,7 @@ var openapi_default = {
37828
37925
  type: "string"
37829
37926
  },
37830
37927
  name: {
37831
- description: "User-friendly name to identify the thermostat daily program.",
37928
+ description: "Name of the thermostat daily program.",
37832
37929
  type: "string"
37833
37930
  },
37834
37931
  periods: {
@@ -38012,7 +38109,7 @@ var openapi_default = {
38012
38109
  schema: {
38013
38110
  properties: {
38014
38111
  name: {
38015
- description: "User-friendly name to identify the thermostat daily program that you want to update.",
38112
+ description: "Name of the thermostat daily program that you want to update.",
38016
38113
  type: "string"
38017
38114
  },
38018
38115
  periods: {
@@ -38090,7 +38187,7 @@ var openapi_default = {
38090
38187
  schema: {
38091
38188
  properties: {
38092
38189
  name: {
38093
- description: "User-friendly name to identify the thermostat daily program that you want to update.",
38190
+ description: "Name of the thermostat daily program that you want to update.",
38094
38191
  type: "string"
38095
38192
  },
38096
38193
  periods: {
@@ -38219,7 +38316,7 @@ var openapi_default = {
38219
38316
  },
38220
38317
  "/thermostats/get": {
38221
38318
  post: {
38222
- description: "Returns a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
38319
+ description: "Returns a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). **Deprecated:** Will be removed. Use `/devices/get` instead.",
38223
38320
  operationId: "thermostatsGetPost",
38224
38321
  requestBody: {
38225
38322
  content: {
@@ -38227,12 +38324,12 @@ var openapi_default = {
38227
38324
  schema: {
38228
38325
  properties: {
38229
38326
  device_id: {
38230
- description: "ID of the thermostat device that you want to retrieve.",
38327
+ description: "ID of the thermostat device that you want to get.",
38231
38328
  format: "uuid",
38232
38329
  type: "string"
38233
38330
  },
38234
38331
  name: {
38235
- description: "User-friendly name of the thermostat device that you want to retrieve.",
38332
+ description: "Name of the thermostat device that you want to retrieve.",
38236
38333
  type: "string"
38237
38334
  }
38238
38335
  },
@@ -38292,12 +38389,12 @@ var openapi_default = {
38292
38389
  type: "string"
38293
38390
  },
38294
38391
  heating_set_point_celsius: {
38295
- description: "Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C. You must set one of the `heating_set_point` parameters.",
38392
+ description: "[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.",
38296
38393
  format: "float",
38297
38394
  type: "number"
38298
38395
  },
38299
38396
  heating_set_point_fahrenheit: {
38300
- description: "Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F. You must set one of the `heating_set_point` parameters.",
38397
+ description: "[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.",
38301
38398
  format: "float",
38302
38399
  type: "number"
38303
38400
  },
@@ -38360,12 +38457,12 @@ var openapi_default = {
38360
38457
  schema: {
38361
38458
  properties: {
38362
38459
  cooling_set_point_celsius: {
38363
- description: "Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C. You must set one of the `cooling_set_point` parameters.",
38460
+ description: "[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.",
38364
38461
  format: "float",
38365
38462
  type: "number"
38366
38463
  },
38367
38464
  cooling_set_point_fahrenheit: {
38368
- description: "Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F. You must set one of the `cooling_set_point` parameters.",
38465
+ description: "[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.",
38369
38466
  format: "float",
38370
38467
  type: "number"
38371
38468
  },
@@ -38375,12 +38472,12 @@ var openapi_default = {
38375
38472
  type: "string"
38376
38473
  },
38377
38474
  heating_set_point_celsius: {
38378
- description: "Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C. You must set one of the `heating_set_point` parameters.",
38475
+ description: "[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.",
38379
38476
  format: "float",
38380
38477
  type: "number"
38381
38478
  },
38382
38479
  heating_set_point_fahrenheit: {
38383
- description: "Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F. You must set one of the `heating_set_point` parameters.",
38480
+ description: "[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.",
38384
38481
  format: "float",
38385
38482
  type: "number"
38386
38483
  },
@@ -38479,7 +38576,7 @@ var openapi_default = {
38479
38576
  type: "array"
38480
38577
  },
38481
38578
  device_type: {
38482
- description: "Device type by which to filter thermostat devices.",
38579
+ description: "Device type by which you want to filter thermostat devices.",
38483
38580
  enum: [
38484
38581
  "ecobee_thermostat",
38485
38582
  "nest_thermostat",
@@ -38491,7 +38588,7 @@ var openapi_default = {
38491
38588
  type: "string"
38492
38589
  },
38493
38590
  device_types: {
38494
- description: "Array of device types by which to filter thermostat devices.",
38591
+ description: "Array of device types by which you want to filter thermostat devices.",
38495
38592
  items: {
38496
38593
  description: "Device type for thermostats.\n ",
38497
38594
  enum: [
@@ -38553,7 +38650,7 @@ var openapi_default = {
38553
38650
  type: "number"
38554
38651
  },
38555
38652
  manufacturer: {
38556
- description: "Manufacturer by which to filter thermostat devices.",
38653
+ description: "Manufacturer by which you want to filter thermostat devices.",
38557
38654
  enum: [
38558
38655
  "ecobee",
38559
38656
  "honeywell_resideo",
@@ -38697,7 +38794,7 @@ var openapi_default = {
38697
38794
  },
38698
38795
  "/thermostats/schedules/create": {
38699
38796
  post: {
38700
- description: "Creates a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
38797
+ description: "Creates a new [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
38701
38798
  operationId: "thermostatsSchedulesCreatePost",
38702
38799
  requestBody: {
38703
38800
  content: {
@@ -38705,19 +38802,19 @@ var openapi_default = {
38705
38802
  schema: {
38706
38803
  properties: {
38707
38804
  climate_preset_key: {
38708
- description: "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.",
38805
+ description: "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the new thermostat schedule.",
38709
38806
  type: "string"
38710
38807
  },
38711
38808
  device_id: {
38712
- description: "ID of the desired thermostat device.",
38809
+ description: "ID of the thermostat device for which you want to create a schedule.",
38713
38810
  type: "string"
38714
38811
  },
38715
38812
  ends_at: {
38716
- description: "Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
38813
+ description: "Date and time at which the new thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
38717
38814
  type: "string"
38718
38815
  },
38719
38816
  is_override_allowed: {
38720
- description: "Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
38817
+ description: "Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the new schedule is active. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
38721
38818
  type: "boolean"
38722
38819
  },
38723
38820
  max_override_period_minutes: {
@@ -38728,11 +38825,11 @@ var openapi_default = {
38728
38825
  type: "integer"
38729
38826
  },
38730
38827
  name: {
38731
- description: "User-friendly name to identify the thermostat schedule.",
38828
+ description: "Name of the thermostat schedule.",
38732
38829
  type: "string"
38733
38830
  },
38734
38831
  starts_at: {
38735
- description: "Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
38832
+ description: "Date and time at which the new thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
38736
38833
  type: "string"
38737
38834
  }
38738
38835
  },
@@ -38793,7 +38890,7 @@ var openapi_default = {
38793
38890
  schema: {
38794
38891
  properties: {
38795
38892
  thermostat_schedule_id: {
38796
- description: "ID of the desired thermostat schedule.",
38893
+ description: "ID of the thermostat schedule that you want to delete.",
38797
38894
  format: "uuid",
38798
38895
  type: "string"
38799
38896
  }
@@ -38844,7 +38941,7 @@ var openapi_default = {
38844
38941
  schema: {
38845
38942
  properties: {
38846
38943
  thermostat_schedule_id: {
38847
- description: "ID of the desired thermostat schedule.",
38944
+ description: "ID of the thermostat schedule that you want to get.",
38848
38945
  format: "uuid",
38849
38946
  type: "string"
38850
38947
  }
@@ -38901,7 +38998,7 @@ var openapi_default = {
38901
38998
  schema: {
38902
38999
  properties: {
38903
39000
  device_id: {
38904
- description: "ID of the desired thermostat device.",
39001
+ description: "ID of the thermostat device for which you want to list schedules.",
38905
39002
  format: "uuid",
38906
39003
  type: "string"
38907
39004
  },
@@ -38984,7 +39081,7 @@ var openapi_default = {
38984
39081
  type: "integer"
38985
39082
  },
38986
39083
  name: {
38987
- description: "User-friendly name to identify the thermostat schedule.",
39084
+ description: "Name of the thermostat schedule.",
38988
39085
  type: "string"
38989
39086
  },
38990
39087
  starts_at: {
@@ -38992,7 +39089,7 @@ var openapi_default = {
38992
39089
  type: "string"
38993
39090
  },
38994
39091
  thermostat_schedule_id: {
38995
- description: "ID of the desired thermostat schedule.",
39092
+ description: "ID of the thermostat schedule that you want to update.",
38996
39093
  format: "uuid",
38997
39094
  type: "string"
38998
39095
  }
@@ -39059,7 +39156,7 @@ var openapi_default = {
39059
39156
  type: "integer"
39060
39157
  },
39061
39158
  name: {
39062
- description: "User-friendly name to identify the thermostat schedule.",
39159
+ description: "Name of the thermostat schedule.",
39063
39160
  type: "string"
39064
39161
  },
39065
39162
  starts_at: {
@@ -39067,7 +39164,7 @@ var openapi_default = {
39067
39164
  type: "string"
39068
39165
  },
39069
39166
  thermostat_schedule_id: {
39070
- description: "ID of the desired thermostat schedule.",
39167
+ description: "ID of the thermostat schedule that you want to update.",
39071
39168
  format: "uuid",
39072
39169
  type: "string"
39073
39170
  }
@@ -39183,7 +39280,7 @@ var openapi_default = {
39183
39280
  "x-deprecated": "Use `fan_mode_setting` instead."
39184
39281
  },
39185
39282
  fan_mode_setting: {
39186
- description: "Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for the thermostat.",
39283
+ description: "[Fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) that you want to set for the thermostat.",
39187
39284
  enum: ["auto", "on", "circulate"],
39188
39285
  type: "string"
39189
39286
  },
@@ -39261,12 +39358,12 @@ var openapi_default = {
39261
39358
  {
39262
39359
  properties: {
39263
39360
  cooling_set_point_celsius: {
39264
- description: "Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C. You must set one of the `cooling_set_point` parameters.",
39361
+ description: "[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.",
39265
39362
  format: "float",
39266
39363
  type: "number"
39267
39364
  },
39268
39365
  cooling_set_point_fahrenheit: {
39269
- description: "Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F. You must set one of the `cooling_set_point` parameters.",
39366
+ description: "[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.",
39270
39367
  format: "float",
39271
39368
  type: "number"
39272
39369
  },
@@ -39288,12 +39385,12 @@ var openapi_default = {
39288
39385
  type: "string"
39289
39386
  },
39290
39387
  heating_set_point_celsius: {
39291
- description: "Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C. You must set one of the `heating_set_point` parameters.",
39388
+ description: "[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.",
39292
39389
  format: "float",
39293
39390
  type: "number"
39294
39391
  },
39295
39392
  heating_set_point_fahrenheit: {
39296
- description: "Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F. You must set one of the `heating_set_point` parameters.",
39393
+ description: "[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.",
39297
39394
  format: "float",
39298
39395
  type: "number"
39299
39396
  },
@@ -39305,12 +39402,12 @@ var openapi_default = {
39305
39402
  {
39306
39403
  properties: {
39307
39404
  cooling_set_point_celsius: {
39308
- description: "Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C. You must set one of the `cooling_set_point` parameters.",
39405
+ description: "[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.",
39309
39406
  format: "float",
39310
39407
  type: "number"
39311
39408
  },
39312
39409
  cooling_set_point_fahrenheit: {
39313
- description: "Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F. You must set one of the `cooling_set_point` parameters.",
39410
+ description: "[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.",
39314
39411
  format: "float",
39315
39412
  type: "number"
39316
39413
  },
@@ -39320,12 +39417,12 @@ var openapi_default = {
39320
39417
  type: "string"
39321
39418
  },
39322
39419
  heating_set_point_celsius: {
39323
- description: "Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C. You must set one of the `heating_set_point` parameters.",
39420
+ description: "[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.",
39324
39421
  format: "float",
39325
39422
  type: "number"
39326
39423
  },
39327
39424
  heating_set_point_fahrenheit: {
39328
- description: "Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F. You must set one of the `heating_set_point` parameters.",
39425
+ description: "[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.",
39329
39426
  format: "float",
39330
39427
  type: "number"
39331
39428
  },
@@ -39545,12 +39642,12 @@ var openapi_default = {
39545
39642
  {
39546
39643
  properties: {
39547
39644
  device_id: {
39548
- description: "ID of the desired thermostat device.",
39645
+ description: "ID of the thermostat device for which you want to simulate having adjusted the HVAC mode.",
39549
39646
  format: "uuid",
39550
39647
  type: "string"
39551
39648
  },
39552
39649
  hvac_mode: {
39553
- description: "Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate.",
39650
+ description: "HVAC mode that you want to simulate.",
39554
39651
  enum: ["off"],
39555
39652
  type: "string"
39556
39653
  }
@@ -39561,22 +39658,22 @@ var openapi_default = {
39561
39658
  {
39562
39659
  properties: {
39563
39660
  cooling_set_point_celsius: {
39564
- description: "Desired simulated cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`.",
39661
+ description: "Cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C that you want to simulate. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`.",
39565
39662
  format: "float",
39566
39663
  type: "number"
39567
39664
  },
39568
39665
  cooling_set_point_fahrenheit: {
39569
- description: "Desired simulated cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`.",
39666
+ description: "Cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F that you want to simulate. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`.",
39570
39667
  format: "float",
39571
39668
  type: "number"
39572
39669
  },
39573
39670
  device_id: {
39574
- description: "ID of the desired thermostat device.",
39671
+ description: "ID of the thermostat device for which you want to simulate having adjusted the HVAC mode.",
39575
39672
  format: "uuid",
39576
39673
  type: "string"
39577
39674
  },
39578
39675
  hvac_mode: {
39579
- description: "Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate.",
39676
+ description: "HVAC mode that you want to simulate.",
39580
39677
  enum: ["cool"],
39581
39678
  type: "string"
39582
39679
  }
@@ -39587,22 +39684,22 @@ var openapi_default = {
39587
39684
  {
39588
39685
  properties: {
39589
39686
  device_id: {
39590
- description: "ID of the desired thermostat device.",
39687
+ description: "ID of the thermostat device for which you want to simulate having adjusted the HVAC mode.",
39591
39688
  format: "uuid",
39592
39689
  type: "string"
39593
39690
  },
39594
39691
  heating_set_point_celsius: {
39595
- description: "Desired simulated heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`.",
39692
+ description: "Heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C that you want to simulate. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`.",
39596
39693
  format: "float",
39597
39694
  type: "number"
39598
39695
  },
39599
39696
  heating_set_point_fahrenheit: {
39600
- description: "Desired simulated heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`.",
39697
+ description: "Heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F that you want to simulate. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`.",
39601
39698
  format: "float",
39602
39699
  type: "number"
39603
39700
  },
39604
39701
  hvac_mode: {
39605
- description: "Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate.",
39702
+ description: "HVAC mode that you want to simulate.",
39606
39703
  enum: ["heat"],
39607
39704
  type: "string"
39608
39705
  }
@@ -39613,32 +39710,32 @@ var openapi_default = {
39613
39710
  {
39614
39711
  properties: {
39615
39712
  cooling_set_point_celsius: {
39616
- description: "Desired simulated cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`.",
39713
+ description: "Cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C that you want to simulate. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`.",
39617
39714
  format: "float",
39618
39715
  type: "number"
39619
39716
  },
39620
39717
  cooling_set_point_fahrenheit: {
39621
- description: "Desired simulated cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`.",
39718
+ description: "Cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F that you want to simulate. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`.",
39622
39719
  format: "float",
39623
39720
  type: "number"
39624
39721
  },
39625
39722
  device_id: {
39626
- description: "ID of the desired thermostat device.",
39723
+ description: "ID of the thermostat device for which you want to simulate having adjusted the HVAC mode.",
39627
39724
  format: "uuid",
39628
39725
  type: "string"
39629
39726
  },
39630
39727
  heating_set_point_celsius: {
39631
- description: "Desired simulated heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`.",
39728
+ description: "Heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C that you want to simulate. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`.",
39632
39729
  format: "float",
39633
39730
  type: "number"
39634
39731
  },
39635
39732
  heating_set_point_fahrenheit: {
39636
- description: "Desired simulated heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`.",
39733
+ description: "Heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F that you want to simulate. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`.",
39637
39734
  format: "float",
39638
39735
  type: "number"
39639
39736
  },
39640
39737
  hvac_mode: {
39641
- description: "Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate.",
39738
+ description: "HVAC mode that you want to simulate.",
39642
39739
  enum: ["heat_cool"],
39643
39740
  type: "string"
39644
39741
  }
@@ -39690,17 +39787,17 @@ var openapi_default = {
39690
39787
  schema: {
39691
39788
  properties: {
39692
39789
  device_id: {
39693
- description: "ID of the desired thermostat device.",
39790
+ description: "ID of the thermostat device that you want to simulate reaching a specified temperature.",
39694
39791
  format: "uuid",
39695
39792
  type: "string"
39696
39793
  },
39697
39794
  temperature_celsius: {
39698
- description: "Desired simulated temperature in \xB0C. You must set `temperature_celsius` or `temperature_fahrenheit`.",
39795
+ description: "Temperature in \xB0C that you want simulate the thermostat reaching. You must set `temperature_celsius` or `temperature_fahrenheit`.",
39699
39796
  format: "float",
39700
39797
  type: "number"
39701
39798
  },
39702
39799
  temperature_fahrenheit: {
39703
- description: "Desired simulated temperature in \xB0F. You must set `temperature_fahrenheit` or `temperature_celsius`.",
39800
+ description: "Temperature in \xB0F that you want simulate the thermostat reaching. You must set `temperature_fahrenheit` or `temperature_celsius`.",
39704
39801
  format: "float",
39705
39802
  type: "number"
39706
39803
  }
@@ -39801,11 +39898,7 @@ var openapi_default = {
39801
39898
  type: "string"
39802
39899
  }
39803
39900
  },
39804
- required: [
39805
- "device_id",
39806
- "climate_preset_key",
39807
- "manual_override_allowed"
39808
- ],
39901
+ required: ["device_id", "climate_preset_key"],
39809
39902
  type: "object"
39810
39903
  }
39811
39904
  }
@@ -39899,11 +39992,7 @@ var openapi_default = {
39899
39992
  type: "string"
39900
39993
  }
39901
39994
  },
39902
- required: [
39903
- "device_id",
39904
- "climate_preset_key",
39905
- "manual_override_allowed"
39906
- ],
39995
+ required: ["device_id", "climate_preset_key"],
39907
39996
  type: "object"
39908
39997
  }
39909
39998
  }
@@ -40053,7 +40142,7 @@ var openapi_default = {
40053
40142
  {
40054
40143
  properties: {
40055
40144
  user_identity_id: {
40056
- description: "ID of user identity for whom access is being granted.",
40145
+ description: "ID of user identity for whom you want to grant access.",
40057
40146
  format: "uuid",
40058
40147
  type: "string"
40059
40148
  }
@@ -40064,7 +40153,7 @@ var openapi_default = {
40064
40153
  {
40065
40154
  properties: {
40066
40155
  user_identity: {
40067
- description: "When used, creates a new user identity with the given details, and grants them access.",
40156
+ description: "User identity. When used, creates a new user identity with the specified details and grants them access.",
40068
40157
  properties: {
40069
40158
  email_address: {
40070
40159
  description: "Unique email address for the user identity.",
@@ -40095,13 +40184,13 @@ var openapi_default = {
40095
40184
  properties: {
40096
40185
  acs_entrance_ids: {
40097
40186
  default: [],
40098
- description: "Set of IDs of the [entrances](https://docs.seam.co/latest/api/acs/systems/list) to which access is being granted.",
40187
+ description: "IDs of the [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to which you want to grant access.",
40099
40188
  items: { format: "uuid", type: "string" },
40100
40189
  type: "array"
40101
40190
  },
40102
40191
  device_ids: {
40103
40192
  default: [],
40104
- description: "Set of IDs of the [devices](https://docs.seam.co/latest/api/devices/list) to which access is being granted.",
40193
+ description: "IDs of the devices to which you want to grant access.",
40105
40194
  items: { format: "uuid", type: "string" },
40106
40195
  type: "array"
40107
40196
  },
@@ -40111,7 +40200,7 @@ var openapi_default = {
40111
40200
  type: "string"
40112
40201
  },
40113
40202
  location: {
40114
- description: "When used, creates a new location with the given entrances and devices, and gives the user access to this location.",
40203
+ description: "Location. When used, creates a new location with the specified entrances and devices, and gives the user access to this location.",
40115
40204
  properties: {
40116
40205
  acs_entrance_ids: {
40117
40206
  default: [],
@@ -40144,7 +40233,7 @@ var openapi_default = {
40144
40233
  items: {
40145
40234
  properties: {
40146
40235
  mode: {
40147
- description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
40236
+ description: "Access method mode.",
40148
40237
  enum: ["code", "card", "mobile_key"],
40149
40238
  type: "string"
40150
40239
  }
@@ -40155,7 +40244,7 @@ var openapi_default = {
40155
40244
  type: "array"
40156
40245
  },
40157
40246
  space_ids: {
40158
- description: "Set of IDs of existing spaces to which access is being granted.",
40247
+ description: "IDs of the existing spaces to which you want to grant access.",
40159
40248
  items: { format: "uuid", type: "string" },
40160
40249
  type: "array"
40161
40250
  },
@@ -40301,7 +40390,7 @@ var openapi_default = {
40301
40390
  },
40302
40391
  "/unstable_access_grants/delete": {
40303
40392
  post: {
40304
- description: "Delete an access grant.",
40393
+ description: "Deletes an access grant.",
40305
40394
  operationId: "unstableAccessGrantsDeletePost",
40306
40395
  requestBody: {
40307
40396
  content: {
@@ -40309,7 +40398,7 @@ var openapi_default = {
40309
40398
  schema: {
40310
40399
  properties: {
40311
40400
  access_grant_id: {
40312
- description: "ID of access grant to delete.",
40401
+ description: "ID of access grant that you want to delete.",
40313
40402
  format: "uuid",
40314
40403
  type: "string"
40315
40404
  }
@@ -40353,7 +40442,7 @@ var openapi_default = {
40353
40442
  },
40354
40443
  "/unstable_access_grants/get": {
40355
40444
  post: {
40356
- description: "Get an access grant.",
40445
+ description: "Gets an access grant.",
40357
40446
  operationId: "unstableAccessGrantsGetPost",
40358
40447
  requestBody: {
40359
40448
  content: {
@@ -40361,7 +40450,7 @@ var openapi_default = {
40361
40450
  schema: {
40362
40451
  properties: {
40363
40452
  access_grant_id: {
40364
- description: "ID of access grant to get.",
40453
+ description: "ID of access grant that you want to get.",
40365
40454
  format: "uuid",
40366
40455
  type: "string"
40367
40456
  }
@@ -40500,7 +40589,7 @@ var openapi_default = {
40500
40589
  },
40501
40590
  "/unstable_access_grants/list": {
40502
40591
  post: {
40503
- description: "Get an access grant.",
40592
+ description: "Returns a list of all access grants.",
40504
40593
  operationId: "unstableAccessGrantsListPost",
40505
40594
  requestBody: {
40506
40595
  content: {
@@ -40508,12 +40597,12 @@ var openapi_default = {
40508
40597
  schema: {
40509
40598
  properties: {
40510
40599
  acs_entrance_id: {
40511
- description: "ID of entrance to filter list of access grants by.",
40600
+ description: "ID of the entrance by which you want to filter the list of access grants.",
40512
40601
  format: "uuid",
40513
40602
  type: "string"
40514
40603
  },
40515
40604
  acs_system_id: {
40516
- description: "ID of system to filter list of access grants by.",
40605
+ description: "ID of the access system by which you want to filter the list of access grants.",
40517
40606
  format: "uuid",
40518
40607
  type: "string"
40519
40608
  },
@@ -40524,12 +40613,12 @@ var openapi_default = {
40524
40613
  "x-deprecated": "Use `space_id`."
40525
40614
  },
40526
40615
  space_id: {
40527
- description: "ID of space to filter list of access grants by.",
40616
+ description: "ID of the space by which you want to filter the list of access grants.",
40528
40617
  format: "uuid",
40529
40618
  type: "string"
40530
40619
  },
40531
40620
  user_identity_id: {
40532
- description: "ID of user identity to filter list of access grants by.",
40621
+ description: "ID of the user identity by which you want to filter the list of access grants.",
40533
40622
  format: "uuid",
40534
40623
  type: "string"
40535
40624
  }
@@ -40670,7 +40759,7 @@ var openapi_default = {
40670
40759
  },
40671
40760
  "/unstable_access_methods/delete": {
40672
40761
  post: {
40673
- description: "Delete an access method.",
40762
+ description: "Deletes an access method.",
40674
40763
  operationId: "unstableAccessMethodsDeletePost",
40675
40764
  requestBody: {
40676
40765
  content: {
@@ -40678,7 +40767,7 @@ var openapi_default = {
40678
40767
  schema: {
40679
40768
  properties: {
40680
40769
  access_method_id: {
40681
- description: "ID of access method to get.",
40770
+ description: "ID of the access method that you want to delete.",
40682
40771
  format: "uuid",
40683
40772
  type: "string"
40684
40773
  }
@@ -40721,7 +40810,7 @@ var openapi_default = {
40721
40810
  },
40722
40811
  "/unstable_access_methods/get": {
40723
40812
  post: {
40724
- description: "Get an access method.",
40813
+ description: "Gets an access method.",
40725
40814
  operationId: "unstableAccessMethodsGetPost",
40726
40815
  requestBody: {
40727
40816
  content: {
@@ -40729,7 +40818,7 @@ var openapi_default = {
40729
40818
  schema: {
40730
40819
  properties: {
40731
40820
  access_method_id: {
40732
- description: "ID of access method to get.",
40821
+ description: "ID of the access method that you want to get.",
40733
40822
  format: "uuid",
40734
40823
  type: "string"
40735
40824
  }
@@ -40826,7 +40915,7 @@ var openapi_default = {
40826
40915
  },
40827
40916
  "/unstable_access_methods/list": {
40828
40917
  post: {
40829
- description: "List all access methods, usually filtered by access grant.",
40918
+ description: "Lists all access methods, usually filtered by access grant.",
40830
40919
  operationId: "unstableAccessMethodsListPost",
40831
40920
  requestBody: {
40832
40921
  content: {
@@ -40834,7 +40923,7 @@ var openapi_default = {
40834
40923
  schema: {
40835
40924
  properties: {
40836
40925
  access_grant_id: {
40837
- description: "ID of access grant to list access methods for.",
40926
+ description: "ID of the access grant by which to filter the list of access methods.",
40838
40927
  format: "uuid",
40839
40928
  type: "string"
40840
40929
  }
@@ -40934,7 +41023,7 @@ var openapi_default = {
40934
41023
  },
40935
41024
  "/unstable_locations/add_acs_entrances": {
40936
41025
  post: {
40937
- description: "Add entrances to a specific location.",
41026
+ description: "Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific location.",
40938
41027
  operationId: "unstableLocationsAddAcsEntrancesPost",
40939
41028
  requestBody: {
40940
41029
  content: {
@@ -40942,11 +41031,16 @@ var openapi_default = {
40942
41031
  schema: {
40943
41032
  properties: {
40944
41033
  acs_entrance_ids: {
41034
+ description: "IDs of the entrances that you want to add to the location.",
40945
41035
  items: { format: "uuid", type: "string" },
40946
41036
  minItems: 1,
40947
41037
  type: "array"
40948
41038
  },
40949
- location_id: { format: "uuid", type: "string" }
41039
+ location_id: {
41040
+ description: "ID of the location to which you want to add entrances.",
41041
+ format: "uuid",
41042
+ type: "string"
41043
+ }
40950
41044
  },
40951
41045
  required: ["location_id", "acs_entrance_ids"],
40952
41046
  type: "object"
@@ -40980,11 +41074,11 @@ var openapi_default = {
40980
41074
  "x-fern-sdk-group-name": ["unstable_locations"],
40981
41075
  "x-fern-sdk-method-name": "add_acs_entrances",
40982
41076
  "x-response-key": null,
40983
- "x-title": "Add ACS Entrances",
41077
+ "x-title": "Add Entrances to a Location",
40984
41078
  "x-undocumented": "Experimental locations."
40985
41079
  },
40986
41080
  put: {
40987
- description: "Add entrances to a specific location.",
41081
+ description: "Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific location.",
40988
41082
  operationId: "unstableLocationsAddAcsEntrancesPut",
40989
41083
  requestBody: {
40990
41084
  content: {
@@ -40992,11 +41086,16 @@ var openapi_default = {
40992
41086
  schema: {
40993
41087
  properties: {
40994
41088
  acs_entrance_ids: {
41089
+ description: "IDs of the entrances that you want to add to the location.",
40995
41090
  items: { format: "uuid", type: "string" },
40996
41091
  minItems: 1,
40997
41092
  type: "array"
40998
41093
  },
40999
- location_id: { format: "uuid", type: "string" }
41094
+ location_id: {
41095
+ description: "ID of the location to which you want to add entrances.",
41096
+ format: "uuid",
41097
+ type: "string"
41098
+ }
41000
41099
  },
41001
41100
  required: ["location_id", "acs_entrance_ids"],
41002
41101
  type: "object"
@@ -41029,13 +41128,13 @@ var openapi_default = {
41029
41128
  tags: [],
41030
41129
  "x-fern-ignore": true,
41031
41130
  "x-response-key": null,
41032
- "x-title": "Add ACS Entrances",
41131
+ "x-title": "Add Entrances to a Location",
41033
41132
  "x-undocumented": "Experimental locations."
41034
41133
  }
41035
41134
  },
41036
41135
  "/unstable_locations/add_devices": {
41037
41136
  post: {
41038
- description: "Add devices to a specific location.",
41137
+ description: "Adds devices to a specific location.",
41039
41138
  operationId: "unstableLocationsAddDevicesPost",
41040
41139
  requestBody: {
41041
41140
  content: {
@@ -41043,11 +41142,16 @@ var openapi_default = {
41043
41142
  schema: {
41044
41143
  properties: {
41045
41144
  device_ids: {
41145
+ description: "IDs of the devices that you want to add to the location.",
41046
41146
  items: { format: "uuid", type: "string" },
41047
41147
  minItems: 1,
41048
41148
  type: "array"
41049
41149
  },
41050
- location_id: { format: "uuid", type: "string" }
41150
+ location_id: {
41151
+ description: "ID of the location to which you want to add devices.",
41152
+ format: "uuid",
41153
+ type: "string"
41154
+ }
41051
41155
  },
41052
41156
  required: ["location_id", "device_ids"],
41053
41157
  type: "object"
@@ -41081,11 +41185,11 @@ var openapi_default = {
41081
41185
  "x-fern-sdk-group-name": ["unstable_locations"],
41082
41186
  "x-fern-sdk-method-name": "add_devices",
41083
41187
  "x-response-key": null,
41084
- "x-title": "Add Location Devices",
41188
+ "x-title": "Add Devices to a Location",
41085
41189
  "x-undocumented": "Experimental locations."
41086
41190
  },
41087
41191
  put: {
41088
- description: "Add devices to a specific location.",
41192
+ description: "Adds devices to a specific location.",
41089
41193
  operationId: "unstableLocationsAddDevicesPut",
41090
41194
  requestBody: {
41091
41195
  content: {
@@ -41093,11 +41197,16 @@ var openapi_default = {
41093
41197
  schema: {
41094
41198
  properties: {
41095
41199
  device_ids: {
41200
+ description: "IDs of the devices that you want to add to the location.",
41096
41201
  items: { format: "uuid", type: "string" },
41097
41202
  minItems: 1,
41098
41203
  type: "array"
41099
41204
  },
41100
- location_id: { format: "uuid", type: "string" }
41205
+ location_id: {
41206
+ description: "ID of the location to which you want to add devices.",
41207
+ format: "uuid",
41208
+ type: "string"
41209
+ }
41101
41210
  },
41102
41211
  required: ["location_id", "device_ids"],
41103
41212
  type: "object"
@@ -41130,13 +41239,13 @@ var openapi_default = {
41130
41239
  tags: [],
41131
41240
  "x-fern-ignore": true,
41132
41241
  "x-response-key": null,
41133
- "x-title": "Add Location Devices",
41242
+ "x-title": "Add Devices to a Location",
41134
41243
  "x-undocumented": "Experimental locations."
41135
41244
  }
41136
41245
  },
41137
41246
  "/unstable_locations/create": {
41138
41247
  post: {
41139
- description: "Create a new location.",
41248
+ description: "Creates a new location.",
41140
41249
  operationId: "unstableLocationsCreatePost",
41141
41250
  requestBody: {
41142
41251
  content: {
@@ -41144,14 +41253,17 @@ var openapi_default = {
41144
41253
  schema: {
41145
41254
  properties: {
41146
41255
  acs_entrance_ids: {
41256
+ description: "IDs of the entrances that you want to add to the new location.",
41147
41257
  items: { format: "uuid", type: "string" },
41148
41258
  type: "array"
41149
41259
  },
41150
41260
  device_ids: {
41261
+ description: "IDs of the devices that you want to add to the new location.",
41151
41262
  items: { format: "uuid", type: "string" },
41152
41263
  type: "array"
41153
41264
  },
41154
41265
  geolocation: {
41266
+ description: "Geolocation of the new location.",
41155
41267
  properties: {
41156
41268
  latitude: { format: "float", type: "number" },
41157
41269
  longitude: { format: "float", type: "number" }
@@ -41159,8 +41271,14 @@ var openapi_default = {
41159
41271
  required: ["latitude", "longitude"],
41160
41272
  type: "object"
41161
41273
  },
41162
- name: { type: "string" },
41163
- time_zone: { type: "string" }
41274
+ name: {
41275
+ description: "Name of the new location.",
41276
+ type: "string"
41277
+ },
41278
+ time_zone: {
41279
+ description: "Time zone of the new location.",
41280
+ type: "string"
41281
+ }
41164
41282
  },
41165
41283
  required: ["name"],
41166
41284
  type: "object"
@@ -41245,19 +41363,25 @@ var openapi_default = {
41245
41363
  "x-fern-sdk-method-name": "create",
41246
41364
  "x-fern-sdk-return-value": "location",
41247
41365
  "x-response-key": "location",
41248
- "x-title": "Create Location",
41366
+ "x-title": "Create a Location",
41249
41367
  "x-undocumented": "Experimental locations."
41250
41368
  }
41251
41369
  },
41252
41370
  "/unstable_locations/delete": {
41253
41371
  post: {
41254
- description: "Delete a location.",
41372
+ description: "Deletes a location.",
41255
41373
  operationId: "unstableLocationsDeletePost",
41256
41374
  requestBody: {
41257
41375
  content: {
41258
41376
  "application/json": {
41259
41377
  schema: {
41260
- properties: { location_id: { format: "uuid", type: "string" } },
41378
+ properties: {
41379
+ location_id: {
41380
+ description: "ID of the location that you want to delete.",
41381
+ format: "uuid",
41382
+ type: "string"
41383
+ }
41384
+ },
41261
41385
  required: ["location_id"],
41262
41386
  type: "object"
41263
41387
  }
@@ -41290,19 +41414,25 @@ var openapi_default = {
41290
41414
  "x-fern-sdk-group-name": ["unstable_locations"],
41291
41415
  "x-fern-sdk-method-name": "delete",
41292
41416
  "x-response-key": null,
41293
- "x-title": "Delete Location",
41417
+ "x-title": "Delete a Location",
41294
41418
  "x-undocumented": "Experimental locations."
41295
41419
  }
41296
41420
  },
41297
41421
  "/unstable_locations/get": {
41298
41422
  post: {
41299
- description: "Get a location.",
41423
+ description: "Gets a location.",
41300
41424
  operationId: "unstableLocationsGetPost",
41301
41425
  requestBody: {
41302
41426
  content: {
41303
41427
  "application/json": {
41304
41428
  schema: {
41305
- properties: { location_id: { format: "uuid", type: "string" } },
41429
+ properties: {
41430
+ location_id: {
41431
+ description: "ID of the location that you want to get.",
41432
+ format: "uuid",
41433
+ type: "string"
41434
+ }
41435
+ },
41306
41436
  required: ["location_id"],
41307
41437
  type: "object"
41308
41438
  }
@@ -41386,7 +41516,7 @@ var openapi_default = {
41386
41516
  "x-fern-sdk-method-name": "get",
41387
41517
  "x-fern-sdk-return-value": "location",
41388
41518
  "x-response-key": "location",
41389
- "x-title": "Get Location",
41519
+ "x-title": "Get a Location",
41390
41520
  "x-undocumented": "Experimental locations."
41391
41521
  }
41392
41522
  },
@@ -41564,7 +41694,7 @@ var openapi_default = {
41564
41694
  },
41565
41695
  "/unstable_locations/remove_acs_entrances": {
41566
41696
  post: {
41567
- description: "Remove entrances from a specific location.",
41697
+ description: "Removes entrances from a specific location.",
41568
41698
  operationId: "unstableLocationsRemoveAcsEntrancesPost",
41569
41699
  requestBody: {
41570
41700
  content: {
@@ -41572,10 +41702,15 @@ var openapi_default = {
41572
41702
  schema: {
41573
41703
  properties: {
41574
41704
  acs_entrance_ids: {
41705
+ description: "IDs of the entrances that you want to remove from the location.",
41575
41706
  items: { format: "uuid", type: "string" },
41576
41707
  type: "array"
41577
41708
  },
41578
- location_id: { format: "uuid", type: "string" }
41709
+ location_id: {
41710
+ description: "ID of the location from which you want to remove entrances.",
41711
+ format: "uuid",
41712
+ type: "string"
41713
+ }
41579
41714
  },
41580
41715
  required: ["location_id", "acs_entrance_ids"],
41581
41716
  type: "object"
@@ -41609,13 +41744,13 @@ var openapi_default = {
41609
41744
  "x-fern-sdk-group-name": ["unstable_locations"],
41610
41745
  "x-fern-sdk-method-name": "remove_acs_entrances",
41611
41746
  "x-response-key": null,
41612
- "x-title": "Remove ACS Entrances",
41747
+ "x-title": "Remove Entrances from a Location",
41613
41748
  "x-undocumented": "Experimental locations."
41614
41749
  }
41615
41750
  },
41616
41751
  "/unstable_locations/remove_devices": {
41617
41752
  post: {
41618
- description: "Remove devices from a specific location.",
41753
+ description: "Removes devices from a specific location.",
41619
41754
  operationId: "unstableLocationsRemoveDevicesPost",
41620
41755
  requestBody: {
41621
41756
  content: {
@@ -41623,10 +41758,15 @@ var openapi_default = {
41623
41758
  schema: {
41624
41759
  properties: {
41625
41760
  device_ids: {
41761
+ description: "IDs of the devices that you want to remove from the location.",
41626
41762
  items: { format: "uuid", type: "string" },
41627
41763
  type: "array"
41628
41764
  },
41629
- location_id: { format: "uuid", type: "string" }
41765
+ location_id: {
41766
+ description: "ID of the location from which you want to remove devices.",
41767
+ format: "uuid",
41768
+ type: "string"
41769
+ }
41630
41770
  },
41631
41771
  required: ["location_id", "device_ids"],
41632
41772
  type: "object"
@@ -41660,13 +41800,13 @@ var openapi_default = {
41660
41800
  "x-fern-sdk-group-name": ["unstable_locations"],
41661
41801
  "x-fern-sdk-method-name": "remove_devices",
41662
41802
  "x-response-key": null,
41663
- "x-title": "Remove Location Devices",
41803
+ "x-title": "Remove Devices from a Location",
41664
41804
  "x-undocumented": "Experimental locations."
41665
41805
  }
41666
41806
  },
41667
41807
  "/unstable_locations/update": {
41668
41808
  patch: {
41669
- description: "Update an existing location.",
41809
+ description: "Updates a location.",
41670
41810
  operationId: "unstableLocationsUpdatePatch",
41671
41811
  requestBody: {
41672
41812
  content: {
@@ -41674,6 +41814,7 @@ var openapi_default = {
41674
41814
  schema: {
41675
41815
  properties: {
41676
41816
  geolocation: {
41817
+ description: "Geolocation of the location.",
41677
41818
  properties: {
41678
41819
  latitude: { format: "float", type: "number" },
41679
41820
  longitude: { format: "float", type: "number" }
@@ -41681,9 +41822,19 @@ var openapi_default = {
41681
41822
  required: ["latitude", "longitude"],
41682
41823
  type: "object"
41683
41824
  },
41684
- location_id: { format: "uuid", type: "string" },
41685
- name: { type: "string" },
41686
- time_zone: { type: "string" }
41825
+ location_id: {
41826
+ description: "ID of the location that you want to update.",
41827
+ format: "uuid",
41828
+ type: "string"
41829
+ },
41830
+ name: {
41831
+ description: "Name of the location.",
41832
+ type: "string"
41833
+ },
41834
+ time_zone: {
41835
+ description: "Time zone of the the location.",
41836
+ type: "string"
41837
+ }
41687
41838
  },
41688
41839
  required: ["location_id"],
41689
41840
  type: "object"
@@ -41766,11 +41917,11 @@ var openapi_default = {
41766
41917
  tags: [],
41767
41918
  "x-fern-ignore": true,
41768
41919
  "x-response-key": "location",
41769
- "x-title": "Update Location",
41920
+ "x-title": "Update a Location",
41770
41921
  "x-undocumented": "Experimental locations."
41771
41922
  },
41772
41923
  post: {
41773
- description: "Update an existing location.",
41924
+ description: "Updates a location.",
41774
41925
  operationId: "unstableLocationsUpdatePost",
41775
41926
  requestBody: {
41776
41927
  content: {
@@ -41778,6 +41929,7 @@ var openapi_default = {
41778
41929
  schema: {
41779
41930
  properties: {
41780
41931
  geolocation: {
41932
+ description: "Geolocation of the location.",
41781
41933
  properties: {
41782
41934
  latitude: { format: "float", type: "number" },
41783
41935
  longitude: { format: "float", type: "number" }
@@ -41785,9 +41937,19 @@ var openapi_default = {
41785
41937
  required: ["latitude", "longitude"],
41786
41938
  type: "object"
41787
41939
  },
41788
- location_id: { format: "uuid", type: "string" },
41789
- name: { type: "string" },
41790
- time_zone: { type: "string" }
41940
+ location_id: {
41941
+ description: "ID of the location that you want to update.",
41942
+ format: "uuid",
41943
+ type: "string"
41944
+ },
41945
+ name: {
41946
+ description: "Name of the location.",
41947
+ type: "string"
41948
+ },
41949
+ time_zone: {
41950
+ description: "Time zone of the the location.",
41951
+ type: "string"
41952
+ }
41791
41953
  },
41792
41954
  required: ["location_id"],
41793
41955
  type: "object"
@@ -41872,7 +42034,7 @@ var openapi_default = {
41872
42034
  "x-fern-sdk-method-name": "update",
41873
42035
  "x-fern-sdk-return-value": "location",
41874
42036
  "x-response-key": "location",
41875
- "x-title": "Update Location",
42037
+ "x-title": "Update a Location",
41876
42038
  "x-undocumented": "Experimental locations."
41877
42039
  }
41878
42040
  },
@@ -41884,7 +42046,12 @@ var openapi_default = {
41884
42046
  content: {
41885
42047
  "application/json": {
41886
42048
  schema: {
41887
- properties: { customer_key: { type: "string" } },
42049
+ properties: {
42050
+ customer_key: {
42051
+ description: "Customer key for which you want to connect accounts.",
42052
+ type: "string"
42053
+ }
42054
+ },
41888
42055
  required: ["customer_key"],
41889
42056
  type: "object"
41890
42057
  }
@@ -41921,7 +42088,7 @@ var openapi_default = {
41921
42088
  "x-fern-sdk-method-name": "connect_accounts",
41922
42089
  "x-fern-sdk-return-value": "magic_link",
41923
42090
  "x-response-key": "magic_link",
41924
- "x-title": "Connect Accounts",
42091
+ "x-title": "Generate a Connect Accounts Building Block Magic Link",
41925
42092
  "x-undocumented": "Experimental partner building blocks."
41926
42093
  }
41927
42094
  },
@@ -41937,10 +42104,14 @@ var openapi_default = {
41937
42104
  {
41938
42105
  properties: {
41939
42106
  building_block_type: {
42107
+ description: "`connect_accounts` building block type.",
41940
42108
  enum: ["connect_accounts"],
41941
42109
  type: "string"
41942
42110
  },
41943
- customer_key: { type: "string" }
42111
+ customer_key: {
42112
+ description: "Customer key for which you want to create a new building block magic link.",
42113
+ type: "string"
42114
+ }
41944
42115
  },
41945
42116
  required: ["building_block_type", "customer_key"],
41946
42117
  type: "object"
@@ -41948,10 +42119,14 @@ var openapi_default = {
41948
42119
  {
41949
42120
  properties: {
41950
42121
  building_block_type: {
42122
+ description: "`manage_devices` building block type.",
41951
42123
  enum: ["manage_devices"],
41952
42124
  type: "string"
41953
42125
  },
41954
- customer_key: { type: "string" }
42126
+ customer_key: {
42127
+ description: "Customer key for which you want to create a new building block magic link.",
42128
+ type: "string"
42129
+ }
41955
42130
  },
41956
42131
  required: ["building_block_type", "customer_key"],
41957
42132
  type: "object"
@@ -41959,12 +42134,16 @@ var openapi_default = {
41959
42134
  {
41960
42135
  properties: {
41961
42136
  building_block_type: {
42137
+ description: "`organize_spaces` building block type.",
41962
42138
  enum: ["organize_spaces"],
41963
42139
  type: "string"
41964
42140
  },
41965
- customer_key: { type: "string" },
42141
+ customer_key: {
42142
+ description: "Customer key for which you want to create a new building block magic link.",
42143
+ type: "string"
42144
+ },
41966
42145
  partner_resources: {
41967
- description: "Optional list of partner resources to include in the magic link.",
42146
+ description: "Optional list of partner resources that you want to include in the new building block magic link.",
41968
42147
  items: {
41969
42148
  properties: {
41970
42149
  custom_metadata: {
@@ -42021,7 +42200,7 @@ var openapi_default = {
42021
42200
  "x-fern-sdk-method-name": "generate_magic_link",
42022
42201
  "x-fern-sdk-return-value": "magic_link",
42023
42202
  "x-response-key": "magic_link",
42024
- "x-title": "Generate a building block magic link",
42203
+ "x-title": "Generate a Building Block Magic Link",
42025
42204
  "x-undocumented": "Experimental partner building blocks."
42026
42205
  }
42027
42206
  },
@@ -42033,7 +42212,12 @@ var openapi_default = {
42033
42212
  content: {
42034
42213
  "application/json": {
42035
42214
  schema: {
42036
- properties: { customer_key: { type: "string" } },
42215
+ properties: {
42216
+ customer_key: {
42217
+ description: "Customer key for which you want to manage devices.",
42218
+ type: "string"
42219
+ }
42220
+ },
42037
42221
  required: ["customer_key"],
42038
42222
  type: "object"
42039
42223
  }
@@ -42070,7 +42254,7 @@ var openapi_default = {
42070
42254
  "x-fern-sdk-method-name": "manage_devices",
42071
42255
  "x-fern-sdk-return-value": "magic_link",
42072
42256
  "x-response-key": "magic_link",
42073
- "x-title": "Manage Devices",
42257
+ "x-title": "Generate a Manage Devices Building Block Magic Link",
42074
42258
  "x-undocumented": "Experimental partner building blocks."
42075
42259
  }
42076
42260
  },
@@ -42083,8 +42267,12 @@ var openapi_default = {
42083
42267
  "application/json": {
42084
42268
  schema: {
42085
42269
  properties: {
42086
- customer_key: { type: "string" },
42270
+ customer_key: {
42271
+ description: "Customer key for which you want to organize spaces.",
42272
+ type: "string"
42273
+ },
42087
42274
  partner_resources: {
42275
+ description: "Optional list of partner resources that you want to include in the new building block magic link.",
42088
42276
  items: {
42089
42277
  properties: {
42090
42278
  custom_metadata: {
@@ -42139,13 +42327,13 @@ var openapi_default = {
42139
42327
  "x-fern-sdk-method-name": "organize_spaces",
42140
42328
  "x-fern-sdk-return-value": "magic_link",
42141
42329
  "x-response-key": "magic_link",
42142
- "x-title": "Organize Spaces",
42330
+ "x-title": "Generate an Organize Spaces Building Block Magic Link",
42143
42331
  "x-undocumented": "Experimental partner building blocks."
42144
42332
  }
42145
42333
  },
42146
42334
  "/unstable_partner/resources/push": {
42147
42335
  post: {
42148
- description: "Send Seam some of your resources.",
42336
+ description: "Sends Seam some of your resources.",
42149
42337
  operationId: "unstablePartnerResourcesPushPost",
42150
42338
  requestBody: {
42151
42339
  content: {
@@ -42159,7 +42347,10 @@ var openapi_default = {
42159
42347
  additionalProperties: { type: "string" },
42160
42348
  type: "object"
42161
42349
  },
42162
- customer_key: { type: "string" },
42350
+ customer_key: {
42351
+ description: "Customer key associated with the resource that you want to push to Seam.",
42352
+ type: "string"
42353
+ },
42163
42354
  description: { type: "string" },
42164
42355
  email_address: { type: "string" },
42165
42356
  ends_at: { type: "string" },
@@ -42168,8 +42359,14 @@ var openapi_default = {
42168
42359
  type: "array"
42169
42360
  },
42170
42361
  name: { type: "string" },
42171
- partner_resource_key: { type: "string" },
42172
- partner_resource_type: { type: "string" },
42362
+ partner_resource_key: {
42363
+ description: "Key of the resource that you want to push to Seam.",
42364
+ type: "string"
42365
+ },
42366
+ partner_resource_type: {
42367
+ description: "Type of the resource that you want to push to Seam.",
42368
+ type: "string"
42369
+ },
42173
42370
  phone_number: { type: "string" },
42174
42371
  starts_at: { type: "string" },
42175
42372
  user_identity_key: { type: "string" }
@@ -42186,7 +42383,10 @@ var openapi_default = {
42186
42383
  additionalProperties: { type: "string" },
42187
42384
  type: "object"
42188
42385
  },
42189
- customer_key: { type: "string" },
42386
+ customer_key: {
42387
+ description: "Customer key associated with the resource that you want to push to Seam.",
42388
+ type: "string"
42389
+ },
42190
42390
  description: { type: "string" },
42191
42391
  email_address: { type: "string" },
42192
42392
  ends_at: { type: "string" },
@@ -42195,8 +42395,14 @@ var openapi_default = {
42195
42395
  type: "array"
42196
42396
  },
42197
42397
  name: { type: "string" },
42198
- partner_resource_key: { type: "string" },
42199
- partner_resource_type: { type: "string" },
42398
+ partner_resource_key: {
42399
+ description: "Key of the resource that you want to push to Seam.",
42400
+ type: "string"
42401
+ },
42402
+ partner_resource_type: {
42403
+ description: "Type of the resource that you want to push to Seam.",
42404
+ type: "string"
42405
+ },
42200
42406
  phone_number: { type: "string" },
42201
42407
  starts_at: { type: "string" },
42202
42408
  user_identity_key: { type: "string" }
@@ -42236,13 +42442,13 @@ var openapi_default = {
42236
42442
  "x-fern-sdk-group-name": ["unstable_partner", "resources"],
42237
42443
  "x-fern-sdk-method-name": "push",
42238
42444
  "x-response-key": null,
42239
- "x-title": "Push partner resources at Seam",
42445
+ "x-title": "Push Partner Resources at Seam",
42240
42446
  "x-undocumented": "Experimental partner resources."
42241
42447
  }
42242
42448
  },
42243
42449
  "/user_identities/add_acs_user": {
42244
42450
  post: {
42245
- description: "Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).",
42451
+ description: "Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).",
42246
42452
  operationId: "userIdentitiesAddAcsUserPost",
42247
42453
  requestBody: {
42248
42454
  content: {
@@ -42250,12 +42456,12 @@ var openapi_default = {
42250
42456
  schema: {
42251
42457
  properties: {
42252
42458
  acs_user_id: {
42253
- description: "ID of the desired ACS user.",
42459
+ description: "ID of the access system user that you want to add to the user identity.",
42254
42460
  format: "uuid",
42255
42461
  type: "string"
42256
42462
  },
42257
42463
  user_identity_id: {
42258
- description: "ID of the desired user identity.",
42464
+ description: "ID of the user identity to which you want to add an access system user.",
42259
42465
  format: "uuid",
42260
42466
  type: "string"
42261
42467
  }
@@ -42295,7 +42501,7 @@ var openapi_default = {
42295
42501
  "x-title": "Add an ACS User to a User Identity"
42296
42502
  },
42297
42503
  put: {
42298
- description: "Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).",
42504
+ description: "Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).",
42299
42505
  operationId: "userIdentitiesAddAcsUserPut",
42300
42506
  requestBody: {
42301
42507
  content: {
@@ -42303,12 +42509,12 @@ var openapi_default = {
42303
42509
  schema: {
42304
42510
  properties: {
42305
42511
  acs_user_id: {
42306
- description: "ID of the desired ACS user.",
42512
+ description: "ID of the access system user that you want to add to the user identity.",
42307
42513
  format: "uuid",
42308
42514
  type: "string"
42309
42515
  },
42310
42516
  user_identity_id: {
42311
- description: "ID of the desired user identity.",
42517
+ description: "ID of the user identity to which you want to add an access system user.",
42312
42518
  format: "uuid",
42313
42519
  type: "string"
42314
42520
  }
@@ -42357,29 +42563,29 @@ var openapi_default = {
42357
42563
  schema: {
42358
42564
  properties: {
42359
42565
  acs_system_ids: {
42360
- description: "List of ACS system IDs to associate with the user identity through ACS users. If there's no user with the same email address or phone number in the specified ACS systems, a new ACS user is created. If there is an existing user with the same email or phone number in the specified ACS systems, the user is linked to the user identity.",
42566
+ description: "List of access system IDs to associate with the new user identity through access system users. If there's no user with the same email address or phone number in the specified access systems, a new access system user is created. If there is an existing user with the same email or phone number in the specified access systems, the user is linked to the user identity.",
42361
42567
  items: { format: "uuid", type: "string" },
42362
42568
  type: "array"
42363
42569
  },
42364
42570
  email_address: {
42365
- description: "Unique email address for the user identity.",
42571
+ description: "Unique email address for the new user identity.",
42366
42572
  format: "email",
42367
42573
  nullable: true,
42368
42574
  type: "string"
42369
42575
  },
42370
42576
  full_name: {
42371
- description: "Full name of the user associated with the user identity.",
42577
+ description: "Full name of the user associated with the new user identity.",
42372
42578
  minLength: 1,
42373
42579
  nullable: true,
42374
42580
  type: "string"
42375
42581
  },
42376
42582
  phone_number: {
42377
- description: "Unique phone number for the user identity in E.164 format (for example, +15555550100).",
42583
+ description: "Unique phone number for the new user identity in E.164 format (for example, +15555550100).",
42378
42584
  nullable: true,
42379
42585
  type: "string"
42380
42586
  },
42381
42587
  user_identity_key: {
42382
- description: "Unique key for the user identity.",
42588
+ description: "Unique key for the new user identity.",
42383
42589
  minLength: 1,
42384
42590
  nullable: true,
42385
42591
  type: "string"
@@ -42435,7 +42641,7 @@ var openapi_default = {
42435
42641
  schema: {
42436
42642
  properties: {
42437
42643
  user_identity_id: {
42438
- description: "ID of the desired user identity.",
42644
+ description: "ID of the user identity that you want to delete.",
42439
42645
  format: "uuid",
42440
42646
  type: "string"
42441
42647
  }
@@ -42485,7 +42691,7 @@ var openapi_default = {
42485
42691
  schema: {
42486
42692
  properties: {
42487
42693
  enrollment_automation_id: {
42488
- description: "ID of the desired enrollment automation.",
42694
+ description: "ID of the enrollment automation that you want to delete.",
42489
42695
  format: "uuid",
42490
42696
  type: "string"
42491
42697
  }
@@ -42535,7 +42741,7 @@ var openapi_default = {
42535
42741
  schema: {
42536
42742
  properties: {
42537
42743
  enrollment_automation_id: {
42538
- description: "ID of the desired enrollment automation.",
42744
+ description: "ID of the enrollment automation that you want to get.",
42539
42745
  format: "uuid",
42540
42746
  type: "string"
42541
42747
  }
@@ -42592,7 +42798,7 @@ var openapi_default = {
42592
42798
  schema: {
42593
42799
  properties: {
42594
42800
  acs_credential_pool_id: {
42595
- description: "ID of the ACS credential pool from which to obtain credentials for the user identity.",
42801
+ description: "ID of the credential pool from which to obtain credentials for the user identity.",
42596
42802
  format: "uuid",
42597
42803
  type: "string"
42598
42804
  },
@@ -42601,17 +42807,17 @@ var openapi_default = {
42601
42807
  type: "boolean"
42602
42808
  },
42603
42809
  credential_manager_acs_system_id: {
42604
- description: "ID of the desired ACS system that serves as the credential manager.",
42810
+ description: "ID of the desired access system that serves as the credential manager for the enrollment automation.",
42605
42811
  format: "uuid",
42606
42812
  type: "string"
42607
42813
  },
42608
42814
  credential_manager_acs_user_id: {
42609
- description: "ID of the associated ACS user within the credential manager. If you specify a `credential_manager_acs_user_id`, you cannot set `create_credential_manager_user` to `true`.",
42815
+ description: "ID of the associated access system user within the credential manager. If you specify a `credential_manager_acs_user_id`, you cannot set `create_credential_manager_user` to `true`.",
42610
42816
  format: "uuid",
42611
42817
  type: "string"
42612
42818
  },
42613
42819
  user_identity_id: {
42614
- description: "ID of the desired user identity.",
42820
+ description: "ID of the user identity for which you want to launch an enrollment automation.",
42615
42821
  format: "uuid",
42616
42822
  type: "string"
42617
42823
  }
@@ -42695,7 +42901,7 @@ var openapi_default = {
42695
42901
  schema: {
42696
42902
  properties: {
42697
42903
  user_identity_id: {
42698
- description: "ID of the user identity for which you want to retrieve all enrollment automations.",
42904
+ description: "ID of the user identity for which you want to retrieve enrollment automations.",
42699
42905
  format: "uuid",
42700
42906
  type: "string"
42701
42907
  }
@@ -42756,7 +42962,7 @@ var openapi_default = {
42756
42962
  properties: {
42757
42963
  max_use_count: {
42758
42964
  default: 1,
42759
- description: "The maximum number of times the instant key can be used. Defaults to 1.",
42965
+ description: "Maximum number of times the instant key can be used. Default: 1.",
42760
42966
  format: "float",
42761
42967
  type: "number"
42762
42968
  },
@@ -42817,7 +43023,7 @@ var openapi_default = {
42817
43023
  {
42818
43024
  properties: {
42819
43025
  user_identity_id: {
42820
- description: "ID of the desired user identity.",
43026
+ description: "ID of the user identity that you want to get.",
42821
43027
  format: "uuid",
42822
43028
  type: "string"
42823
43029
  }
@@ -42880,12 +43086,12 @@ var openapi_default = {
42880
43086
  schema: {
42881
43087
  properties: {
42882
43088
  device_id: {
42883
- description: "ID of the desired managed device.",
43089
+ description: "ID of the managed device to which you want to grant access to the user identity.",
42884
43090
  format: "uuid",
42885
43091
  type: "string"
42886
43092
  },
42887
43093
  user_identity_id: {
42888
- description: "ID of the desired user identity.",
43094
+ description: "ID of the user identity that you want to grant access to a device.",
42889
43095
  format: "uuid",
42890
43096
  type: "string"
42891
43097
  }
@@ -42933,12 +43139,12 @@ var openapi_default = {
42933
43139
  schema: {
42934
43140
  properties: {
42935
43141
  device_id: {
42936
- description: "ID of the desired managed device.",
43142
+ description: "ID of the managed device to which you want to grant access to the user identity.",
42937
43143
  format: "uuid",
42938
43144
  type: "string"
42939
43145
  },
42940
43146
  user_identity_id: {
42941
- description: "ID of the desired user identity.",
43147
+ description: "ID of the user identity that you want to grant access to a device.",
42942
43148
  format: "uuid",
42943
43149
  type: "string"
42944
43150
  }
@@ -42987,6 +43193,7 @@ var openapi_default = {
42987
43193
  schema: {
42988
43194
  properties: {
42989
43195
  credential_manager_acs_system_id: {
43196
+ description: "`acs_system_id` of the credential manager by which you want to filter the list of user identities.",
42990
43197
  format: "uuid",
42991
43198
  type: "string"
42992
43199
  }
@@ -43064,7 +43271,7 @@ var openapi_default = {
43064
43271
  deprecated: true,
43065
43272
  items: { $ref: "#/components/schemas/device" },
43066
43273
  type: "array",
43067
- "x-deprecated": "use devices."
43274
+ "x-deprecated": "Use devices."
43068
43275
  },
43069
43276
  devices: {
43070
43277
  items: { $ref: "#/components/schemas/device" },
@@ -43098,7 +43305,7 @@ var openapi_default = {
43098
43305
  },
43099
43306
  "/user_identities/list_acs_systems": {
43100
43307
  post: {
43101
- description: "Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).",
43308
+ description: "Returns a list of all [access systems](https://docs.seam.co/latest/capability-guides/access-systems) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).",
43102
43309
  operationId: "userIdentitiesListAcsSystemsPost",
43103
43310
  requestBody: {
43104
43311
  content: {
@@ -43106,7 +43313,7 @@ var openapi_default = {
43106
43313
  schema: {
43107
43314
  properties: {
43108
43315
  user_identity_id: {
43109
- description: "ID of the user identity for which you want to retrieve all access control systems.",
43316
+ description: "ID of the user identity for which you want to retrieve all access systems.",
43110
43317
  format: "uuid",
43111
43318
  type: "string"
43112
43319
  }
@@ -43156,7 +43363,7 @@ var openapi_default = {
43156
43363
  },
43157
43364
  "/user_identities/list_acs_users": {
43158
43365
  post: {
43159
- description: "Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).",
43366
+ description: "Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).",
43160
43367
  operationId: "userIdentitiesListAcsUsersPost",
43161
43368
  requestBody: {
43162
43369
  content: {
@@ -43164,7 +43371,7 @@ var openapi_default = {
43164
43371
  schema: {
43165
43372
  properties: {
43166
43373
  user_identity_id: {
43167
- description: "ID of the user identity for which you want to retrieve all ACS users.",
43374
+ description: "ID of the user identity for which you want to retrieve all access system users.",
43168
43375
  format: "uuid",
43169
43376
  type: "string"
43170
43377
  }
@@ -43213,7 +43420,7 @@ var openapi_default = {
43213
43420
  },
43214
43421
  "/user_identities/remove_acs_user": {
43215
43422
  post: {
43216
- description: "Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).",
43423
+ description: "Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).",
43217
43424
  operationId: "userIdentitiesRemoveAcsUserPost",
43218
43425
  requestBody: {
43219
43426
  content: {
@@ -43221,12 +43428,12 @@ var openapi_default = {
43221
43428
  schema: {
43222
43429
  properties: {
43223
43430
  acs_user_id: {
43224
- description: "ID of the ACS user.",
43431
+ description: "ID of the access system user that you want to remove from the user identity..",
43225
43432
  format: "uuid",
43226
43433
  type: "string"
43227
43434
  },
43228
43435
  user_identity_id: {
43229
- description: "ID of the desired user identity.",
43436
+ description: "ID of the user identity from which you want to remove an access system user.",
43230
43437
  format: "uuid",
43231
43438
  type: "string"
43232
43439
  }
@@ -43276,12 +43483,12 @@ var openapi_default = {
43276
43483
  schema: {
43277
43484
  properties: {
43278
43485
  device_id: {
43279
- description: "ID of the desired managed device.",
43486
+ description: "ID of the managed device to which you want to revoke access from the user identity.",
43280
43487
  format: "uuid",
43281
43488
  type: "string"
43282
43489
  },
43283
43490
  user_identity_id: {
43284
- description: "ID of the desired user identity.",
43491
+ description: "ID of the user identity from which you want to revoke access to a device.",
43285
43492
  format: "uuid",
43286
43493
  type: "string"
43287
43494
  }
@@ -43323,6 +43530,7 @@ var openapi_default = {
43323
43530
  },
43324
43531
  "/user_identities/update": {
43325
43532
  patch: {
43533
+ description: "Updates a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).",
43326
43534
  operationId: "userIdentitiesUpdatePatch",
43327
43535
  requestBody: {
43328
43536
  content: {
@@ -43335,14 +43543,19 @@ var openapi_default = {
43335
43543
  nullable: true,
43336
43544
  type: "string"
43337
43545
  },
43338
- full_name: { minLength: 1, nullable: true, type: "string" },
43546
+ full_name: {
43547
+ description: "Full name of the user associated with the user identity.",
43548
+ minLength: 1,
43549
+ nullable: true,
43550
+ type: "string"
43551
+ },
43339
43552
  phone_number: {
43340
- description: "Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).",
43553
+ description: "Unique phone number for the user identity.",
43341
43554
  nullable: true,
43342
43555
  type: "string"
43343
43556
  },
43344
43557
  user_identity_id: {
43345
- description: "ID of the user identity.",
43558
+ description: "ID of the user identity that you want to update.",
43346
43559
  format: "uuid",
43347
43560
  type: "string"
43348
43561
  },
@@ -43387,6 +43600,7 @@ var openapi_default = {
43387
43600
  "x-title": "Update a User Identity"
43388
43601
  },
43389
43602
  post: {
43603
+ description: "Updates a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).",
43390
43604
  operationId: "userIdentitiesUpdatePost",
43391
43605
  requestBody: {
43392
43606
  content: {
@@ -43399,14 +43613,19 @@ var openapi_default = {
43399
43613
  nullable: true,
43400
43614
  type: "string"
43401
43615
  },
43402
- full_name: { minLength: 1, nullable: true, type: "string" },
43616
+ full_name: {
43617
+ description: "Full name of the user associated with the user identity.",
43618
+ minLength: 1,
43619
+ nullable: true,
43620
+ type: "string"
43621
+ },
43403
43622
  phone_number: {
43404
- description: "Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).",
43623
+ description: "Unique phone number for the user identity.",
43405
43624
  nullable: true,
43406
43625
  type: "string"
43407
43626
  },
43408
43627
  user_identity_id: {
43409
- description: "ID of the user identity.",
43628
+ description: "ID of the user identity that you want to update.",
43410
43629
  format: "uuid",
43411
43630
  type: "string"
43412
43631
  },
@@ -43454,6 +43673,7 @@ var openapi_default = {
43454
43673
  },
43455
43674
  "/webhooks/create": {
43456
43675
  post: {
43676
+ description: "Creates a new [webhook](https://docs.seam.co/latest/developer-tools/webhooks).",
43457
43677
  operationId: "webhooksCreatePost",
43458
43678
  requestBody: {
43459
43679
  content: {
@@ -43462,10 +43682,15 @@ var openapi_default = {
43462
43682
  properties: {
43463
43683
  event_types: {
43464
43684
  default: ["*"],
43685
+ description: "Types of events that you want the new webhook to receive.",
43465
43686
  items: { type: "string" },
43466
43687
  type: "array"
43467
43688
  },
43468
- url: { format: "uri", type: "string" }
43689
+ url: {
43690
+ description: "URL for the new webhook.",
43691
+ format: "uri",
43692
+ type: "string"
43693
+ }
43469
43694
  },
43470
43695
  required: ["url"],
43471
43696
  type: "object"
@@ -43502,17 +43727,24 @@ var openapi_default = {
43502
43727
  "x-fern-sdk-group-name": ["webhooks"],
43503
43728
  "x-fern-sdk-method-name": "create",
43504
43729
  "x-fern-sdk-return-value": "webhook",
43505
- "x-response-key": "webhook"
43730
+ "x-response-key": "webhook",
43731
+ "x-title": "Create a Webhook"
43506
43732
  }
43507
43733
  },
43508
43734
  "/webhooks/delete": {
43509
43735
  post: {
43736
+ description: "Deletes a specified [webhook](https://docs.seam.co/latest/developer-tools/webhooks).",
43510
43737
  operationId: "webhooksDeletePost",
43511
43738
  requestBody: {
43512
43739
  content: {
43513
43740
  "application/json": {
43514
43741
  schema: {
43515
- properties: { webhook_id: { type: "string" } },
43742
+ properties: {
43743
+ webhook_id: {
43744
+ description: "ID of the webhook that you want to delete.",
43745
+ type: "string"
43746
+ }
43747
+ },
43516
43748
  required: ["webhook_id"],
43517
43749
  type: "object"
43518
43750
  }
@@ -43544,17 +43776,24 @@ var openapi_default = {
43544
43776
  tags: ["/webhooks"],
43545
43777
  "x-fern-sdk-group-name": ["webhooks"],
43546
43778
  "x-fern-sdk-method-name": "delete",
43547
- "x-response-key": null
43779
+ "x-response-key": null,
43780
+ "x-title": "Delete a Webhook"
43548
43781
  }
43549
43782
  },
43550
43783
  "/webhooks/get": {
43551
43784
  post: {
43785
+ description: "Gets a specified [webhook](https://docs.seam.co/latest/developer-tools/webhooks).",
43552
43786
  operationId: "webhooksGetPost",
43553
43787
  requestBody: {
43554
43788
  content: {
43555
43789
  "application/json": {
43556
43790
  schema: {
43557
- properties: { webhook_id: { type: "string" } },
43791
+ properties: {
43792
+ webhook_id: {
43793
+ description: "ID of the webhook that you want to get.",
43794
+ type: "string"
43795
+ }
43796
+ },
43558
43797
  required: ["webhook_id"],
43559
43798
  type: "object"
43560
43799
  }
@@ -43590,11 +43829,13 @@ var openapi_default = {
43590
43829
  "x-fern-sdk-group-name": ["webhooks"],
43591
43830
  "x-fern-sdk-method-name": "get",
43592
43831
  "x-fern-sdk-return-value": "webhook",
43593
- "x-response-key": "webhook"
43832
+ "x-response-key": "webhook",
43833
+ "x-title": "Get a Webhook"
43594
43834
  }
43595
43835
  },
43596
43836
  "/webhooks/list": {
43597
43837
  get: {
43838
+ description: "Returns a list of all [webhooks](https://docs.seam.co/latest/developer-tools/webhooks).",
43598
43839
  operationId: "webhooksListGet",
43599
43840
  responses: {
43600
43841
  200: {
@@ -43626,9 +43867,11 @@ var openapi_default = {
43626
43867
  summary: "/webhooks/list",
43627
43868
  tags: ["/webhooks"],
43628
43869
  "x-fern-ignore": true,
43629
- "x-response-key": "webhooks"
43870
+ "x-response-key": "webhooks",
43871
+ "x-title": "List Webhooks"
43630
43872
  },
43631
43873
  post: {
43874
+ description: "Returns a list of all [webhooks](https://docs.seam.co/latest/developer-tools/webhooks).",
43632
43875
  operationId: "webhooksListPost",
43633
43876
  responses: {
43634
43877
  200: {
@@ -43662,19 +43905,28 @@ var openapi_default = {
43662
43905
  "x-fern-sdk-group-name": ["webhooks"],
43663
43906
  "x-fern-sdk-method-name": "list",
43664
43907
  "x-fern-sdk-return-value": "webhooks",
43665
- "x-response-key": "webhooks"
43908
+ "x-response-key": "webhooks",
43909
+ "x-title": "List Webhooks"
43666
43910
  }
43667
43911
  },
43668
43912
  "/webhooks/update": {
43669
43913
  post: {
43914
+ description: "Updates a specified [webhook](https://docs.seam.co/latest/developer-tools/webhooks).",
43670
43915
  operationId: "webhooksUpdatePost",
43671
43916
  requestBody: {
43672
43917
  content: {
43673
43918
  "application/json": {
43674
43919
  schema: {
43675
43920
  properties: {
43676
- event_types: { items: { type: "string" }, type: "array" },
43677
- webhook_id: { type: "string" }
43921
+ event_types: {
43922
+ description: "Types of events that you want the webhook to receive.",
43923
+ items: { type: "string" },
43924
+ type: "array"
43925
+ },
43926
+ webhook_id: {
43927
+ description: "ID of the webhook that you want to update.",
43928
+ type: "string"
43929
+ }
43678
43930
  },
43679
43931
  required: ["webhook_id", "event_types"],
43680
43932
  type: "object"
@@ -43707,17 +43959,26 @@ var openapi_default = {
43707
43959
  tags: ["/webhooks"],
43708
43960
  "x-fern-sdk-group-name": ["webhooks"],
43709
43961
  "x-fern-sdk-method-name": "update",
43710
- "x-response-key": null
43962
+ "x-response-key": null,
43963
+ "x-title": "Update a Webhook"
43711
43964
  },
43712
43965
  put: {
43966
+ description: "Updates a specified [webhook](https://docs.seam.co/latest/developer-tools/webhooks).",
43713
43967
  operationId: "webhooksUpdatePut",
43714
43968
  requestBody: {
43715
43969
  content: {
43716
43970
  "application/json": {
43717
43971
  schema: {
43718
43972
  properties: {
43719
- event_types: { items: { type: "string" }, type: "array" },
43720
- webhook_id: { type: "string" }
43973
+ event_types: {
43974
+ description: "Types of events that you want the webhook to receive.",
43975
+ items: { type: "string" },
43976
+ type: "array"
43977
+ },
43978
+ webhook_id: {
43979
+ description: "ID of the webhook that you want to update.",
43980
+ type: "string"
43981
+ }
43721
43982
  },
43722
43983
  required: ["webhook_id", "event_types"],
43723
43984
  type: "object"
@@ -43749,42 +44010,66 @@ var openapi_default = {
43749
44010
  summary: "/webhooks/update",
43750
44011
  tags: ["/webhooks"],
43751
44012
  "x-fern-ignore": true,
43752
- "x-response-key": null
44013
+ "x-response-key": null,
44014
+ "x-title": "Update a Webhook"
43753
44015
  }
43754
44016
  },
43755
44017
  "/workspaces/create": {
43756
44018
  post: {
44019
+ description: "Creates a new [workspace](https://docs.seam.co/latest/core-concepts/workspaces).",
43757
44020
  operationId: "workspacesCreatePost",
43758
44021
  requestBody: {
43759
44022
  content: {
43760
44023
  "application/json": {
43761
44024
  schema: {
43762
44025
  properties: {
43763
- company_name: { type: "string" },
44026
+ company_name: {
44027
+ description: "Company name for the new workspace.",
44028
+ type: "string"
44029
+ },
43764
44030
  connect_partner_name: {
43765
44031
  deprecated: true,
44032
+ description: "Connect partner name for the new workspace.",
43766
44033
  nullable: true,
43767
44034
  type: "string",
43768
44035
  "x-deprecated": "use company_name"
43769
44036
  },
43770
44037
  connect_webview_customization: {
44038
+ description: "[Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) customizations for the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).",
43771
44039
  properties: {
43772
44040
  logo_shape: {
44041
+ description: "Logo shape for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).",
43773
44042
  enum: ["circle", "square"],
43774
44043
  nullable: true,
43775
44044
  type: "string"
43776
44045
  },
43777
- primary_button_color: { nullable: true, type: "string" },
44046
+ primary_button_color: {
44047
+ description: "Primary button color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).",
44048
+ nullable: true,
44049
+ type: "string"
44050
+ },
43778
44051
  primary_button_text_color: {
44052
+ description: "Primary button text color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).",
43779
44053
  nullable: true,
43780
44054
  type: "string"
43781
44055
  },
43782
- success_message: { nullable: true, type: "string" }
44056
+ success_message: {
44057
+ description: "Success message for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).",
44058
+ nullable: true,
44059
+ type: "string"
44060
+ }
43783
44061
  },
43784
44062
  type: "object"
43785
44063
  },
43786
- is_sandbox: { default: false, type: "boolean" },
43787
- name: { type: "string" },
44064
+ is_sandbox: {
44065
+ default: false,
44066
+ description: "Indicates whether the new workspace is a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).",
44067
+ type: "boolean"
44068
+ },
44069
+ name: {
44070
+ description: "Name of the new workspace.",
44071
+ type: "string"
44072
+ },
43788
44073
  webview_logo_shape: {
43789
44074
  deprecated: true,
43790
44075
  enum: ["circle", "square"],
@@ -43842,11 +44127,13 @@ var openapi_default = {
43842
44127
  "x-fern-sdk-group-name": ["workspaces"],
43843
44128
  "x-fern-sdk-method-name": "create",
43844
44129
  "x-fern-sdk-return-value": "workspace",
43845
- "x-response-key": "workspace"
44130
+ "x-response-key": "workspace",
44131
+ "x-title": "Create a Workspace"
43846
44132
  }
43847
44133
  },
43848
44134
  "/workspaces/get": {
43849
44135
  get: {
44136
+ description: "Returns the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.",
43850
44137
  operationId: "workspacesGetGet",
43851
44138
  responses: {
43852
44139
  200: {
@@ -43871,14 +44158,17 @@ var openapi_default = {
43871
44158
  { api_key: [] },
43872
44159
  { console_session_with_workspace: [] },
43873
44160
  { client_session: [] },
44161
+ { client_session_with_customer: [] },
43874
44162
  { pat_with_workspace: [] }
43875
44163
  ],
43876
44164
  summary: "/workspaces/get",
43877
44165
  tags: ["/workspaces"],
43878
44166
  "x-fern-ignore": true,
43879
- "x-response-key": "workspace"
44167
+ "x-response-key": "workspace",
44168
+ "x-title": "Get a Workspace"
43880
44169
  },
43881
44170
  post: {
44171
+ description: "Returns the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.",
43882
44172
  operationId: "workspacesGetPost",
43883
44173
  responses: {
43884
44174
  200: {
@@ -43903,6 +44193,7 @@ var openapi_default = {
43903
44193
  { api_key: [] },
43904
44194
  { console_session_with_workspace: [] },
43905
44195
  { client_session: [] },
44196
+ { client_session_with_customer: [] },
43906
44197
  { pat_with_workspace: [] }
43907
44198
  ],
43908
44199
  summary: "/workspaces/get",
@@ -43910,11 +44201,13 @@ var openapi_default = {
43910
44201
  "x-fern-sdk-group-name": ["workspaces"],
43911
44202
  "x-fern-sdk-method-name": "get",
43912
44203
  "x-fern-sdk-return-value": "workspace",
43913
- "x-response-key": "workspace"
44204
+ "x-response-key": "workspace",
44205
+ "x-title": "Get a Workspace"
43914
44206
  }
43915
44207
  },
43916
44208
  "/workspaces/list": {
43917
44209
  get: {
44210
+ description: "Returns a list of [workspaces](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.",
43918
44211
  operationId: "workspacesListGet",
43919
44212
  responses: {
43920
44213
  200: {
@@ -43949,9 +44242,11 @@ var openapi_default = {
43949
44242
  summary: "/workspaces/list",
43950
44243
  tags: ["/workspaces"],
43951
44244
  "x-fern-ignore": true,
43952
- "x-response-key": "workspaces"
44245
+ "x-response-key": "workspaces",
44246
+ "x-title": "List Workspaces"
43953
44247
  },
43954
44248
  post: {
44249
+ description: "Returns a list of [workspaces](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.",
43955
44250
  operationId: "workspacesListPost",
43956
44251
  responses: {
43957
44252
  200: {
@@ -43988,12 +44283,13 @@ var openapi_default = {
43988
44283
  "x-fern-sdk-group-name": ["workspaces"],
43989
44284
  "x-fern-sdk-method-name": "list",
43990
44285
  "x-fern-sdk-return-value": "workspaces",
43991
- "x-response-key": "workspaces"
44286
+ "x-response-key": "workspaces",
44287
+ "x-title": "List Workspaces"
43992
44288
  }
43993
44289
  },
43994
44290
  "/workspaces/reset_sandbox": {
43995
44291
  post: {
43996
- description: "Resets a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). Note that this endpoint is only available for sandbox workspaces.",
44292
+ description: "Resets the [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces) associated with the authentication value. Note that this endpoint is only available for sandbox workspaces.",
43997
44293
  operationId: "workspacesResetSandboxPost",
43998
44294
  responses: {
43999
44295
  200: {
@@ -44027,36 +44323,58 @@ var openapi_default = {
44027
44323
  "x-fern-sdk-group-name": ["workspaces"],
44028
44324
  "x-fern-sdk-method-name": "reset_sandbox",
44029
44325
  "x-fern-sdk-return-value": "action_attempt",
44030
- "x-response-key": "action_attempt"
44326
+ "x-response-key": "action_attempt",
44327
+ "x-title": "Reset a Sandbox Workspace"
44031
44328
  }
44032
44329
  },
44033
44330
  "/workspaces/update": {
44034
44331
  patch: {
44332
+ description: "Updates the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.",
44035
44333
  operationId: "workspacesUpdatePatch",
44036
44334
  requestBody: {
44037
44335
  content: {
44038
44336
  "application/json": {
44039
44337
  schema: {
44040
44338
  properties: {
44041
- connect_partner_name: { type: "string" },
44339
+ connect_partner_name: {
44340
+ description: "Connect partner name for the workspace.",
44341
+ type: "string"
44342
+ },
44042
44343
  connect_webview_customization: {
44344
+ description: "[Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) customizations for the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).",
44043
44345
  properties: {
44044
44346
  logo_shape: {
44347
+ description: "Logo shape for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).",
44045
44348
  enum: ["circle", "square"],
44046
44349
  nullable: true,
44047
44350
  type: "string"
44048
44351
  },
44049
- primary_button_color: { nullable: true, type: "string" },
44352
+ primary_button_color: {
44353
+ description: "Primary button color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).",
44354
+ nullable: true,
44355
+ type: "string"
44356
+ },
44050
44357
  primary_button_text_color: {
44358
+ description: "Primary button text color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).",
44051
44359
  nullable: true,
44052
44360
  type: "string"
44053
44361
  },
44054
- success_message: { nullable: true, type: "string" }
44362
+ success_message: {
44363
+ description: "Success message for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).",
44364
+ nullable: true,
44365
+ type: "string"
44366
+ }
44055
44367
  },
44056
44368
  type: "object"
44057
44369
  },
44058
- is_suspended: { type: "boolean" },
44059
- name: { type: "string" }
44370
+ is_suspended: {
44371
+ description: "Indicates whether the workspace is suspended.",
44372
+ type: "boolean"
44373
+ },
44374
+ name: {
44375
+ description: "Name of the workspace.",
44376
+ type: "string"
44377
+ }
44060
44378
  },
44061
44379
  type: "object"
44062
44380
  }
@@ -44076,34 +44394,56 @@ var openapi_default = {
44076
44394
  summary: "/workspaces/update",
44077
44395
  tags: ["/workspaces"],
44078
44396
  "x-fern-ignore": true,
44079
- "x-response-key": null
44397
+ "x-response-key": null,
44398
+ "x-title": "Udpate a Workspace"
44080
44399
  },
44081
44400
  post: {
44401
+ description: "Updates the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.",
44082
44402
  operationId: "workspacesUpdatePost",
44083
44403
  requestBody: {
44084
44404
  content: {
44085
44405
  "application/json": {
44086
44406
  schema: {
44087
44407
  properties: {
44088
- connect_partner_name: { type: "string" },
44408
+ connect_partner_name: {
44409
+ description: "Connect partner name for the workspace.",
44410
+ type: "string"
44411
+ },
44089
44412
  connect_webview_customization: {
44413
+ description: "[Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) customizations for the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).",
44090
44414
  properties: {
44091
44415
  logo_shape: {
44416
+ description: "Logo shape for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).",
44092
44417
  enum: ["circle", "square"],
44093
44418
  nullable: true,
44094
44419
  type: "string"
44095
44420
  },
44096
- primary_button_color: { nullable: true, type: "string" },
44421
+ primary_button_color: {
44422
+ description: "Primary button color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).",
44423
+ nullable: true,
44424
+ type: "string"
44425
+ },
44097
44426
  primary_button_text_color: {
44427
+ description: "Primary button text color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).",
44098
44428
  nullable: true,
44099
44429
  type: "string"
44100
44430
  },
44101
- success_message: { nullable: true, type: "string" }
44431
+ success_message: {
44432
+ description: "Success message for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).",
44433
+ nullable: true,
44434
+ type: "string"
44435
+ }
44102
44436
  },
44103
44437
  type: "object"
44104
44438
  },
44105
- is_suspended: { type: "boolean" },
44106
- name: { type: "string" }
44439
+ is_suspended: {
44440
+ description: "Indicates whether the workspace is suspended.",
44441
+ type: "boolean"
44442
+ },
44443
+ name: {
44444
+ description: "Name of the workspace.",
44445
+ type: "string"
44446
+ }
44107
44447
  },
44108
44448
  type: "object"
44109
44449
  }
@@ -44124,7 +44464,8 @@ var openapi_default = {
44124
44464
  tags: ["/workspaces"],
44125
44465
  "x-fern-sdk-group-name": ["workspaces"],
44126
44466
  "x-fern-sdk-method-name": "update",
44127
- "x-response-key": null
44467
+ "x-response-key": null,
44468
+ "x-title": "Udpate a Workspace"
44128
44469
  }
44129
44470
  }
44130
44471
  },