@seamapi/types 1.410.1 → 1.411.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -14585,7 +14585,12 @@ export default {
14585
14585
  magic_link: {
14586
14586
  properties: {
14587
14587
  building_block_type: {
14588
- enum: ['connect_accounts', 'manage_devices', 'organize_spaces'],
14588
+ enum: [
14589
+ 'connect_accounts',
14590
+ 'manage_devices',
14591
+ 'organize_spaces',
14592
+ 'console',
14593
+ ],
14589
14594
  type: 'string',
14590
14595
  },
14591
14596
  created_at: { format: 'date-time', type: 'string' },
@@ -20277,6 +20282,7 @@ export default {
20277
20282
  },
20278
20283
  security: [
20279
20284
  { client_session: [] },
20285
+ { client_session_with_customer: [] },
20280
20286
  { pat_with_workspace: [] },
20281
20287
  { console_session_with_workspace: [] },
20282
20288
  { api_key: [] },
@@ -20409,6 +20415,7 @@ export default {
20409
20415
  },
20410
20416
  security: [
20411
20417
  { client_session: [] },
20418
+ { client_session_with_customer: [] },
20412
20419
  { pat_with_workspace: [] },
20413
20420
  { console_session_with_workspace: [] },
20414
20421
  { api_key: [] },
@@ -20542,6 +20549,7 @@ export default {
20542
20549
  },
20543
20550
  security: [
20544
20551
  { client_session: [] },
20552
+ { client_session_with_customer: [] },
20545
20553
  { pat_with_workspace: [] },
20546
20554
  { console_session_with_workspace: [] },
20547
20555
  { api_key: [] },
@@ -26751,6 +26759,7 @@ export default {
26751
26759
  },
26752
26760
  security: [
26753
26761
  { client_session: [] },
26762
+ { client_session_with_customer: [] },
26754
26763
  { api_key: [] },
26755
26764
  { pat_with_workspace: [] },
26756
26765
  { console_session_with_workspace: [] },
@@ -27504,6 +27513,7 @@ export default {
27504
27513
  { api_key: [] },
27505
27514
  { pat_with_workspace: [] },
27506
27515
  { console_session_with_workspace: [] },
27516
+ { client_session_with_customer: [] },
27507
27517
  ],
27508
27518
  summary: '/devices/simulate/connect',
27509
27519
  tags: ['/devices'],
@@ -27554,6 +27564,7 @@ export default {
27554
27564
  { api_key: [] },
27555
27565
  { pat_with_workspace: [] },
27556
27566
  { console_session_with_workspace: [] },
27567
+ { client_session_with_customer: [] },
27557
27568
  ],
27558
27569
  summary: '/devices/simulate/disconnect',
27559
27570
  tags: ['/devices'],
@@ -27604,6 +27615,7 @@ export default {
27604
27615
  { api_key: [] },
27605
27616
  { pat_with_workspace: [] },
27606
27617
  { console_session_with_workspace: [] },
27618
+ { client_session_with_customer: [] },
27607
27619
  ],
27608
27620
  summary: '/devices/simulate/remove',
27609
27621
  tags: ['/devices'],
@@ -28173,6 +28185,7 @@ export default {
28173
28185
  { pat_with_workspace: [] },
28174
28186
  { console_session_with_workspace: [] },
28175
28187
  { client_session: [] },
28188
+ { client_session_with_customer: [] },
28176
28189
  ],
28177
28190
  summary: '/devices/update',
28178
28191
  tags: ['/devices'],
@@ -28252,6 +28265,7 @@ export default {
28252
28265
  { pat_with_workspace: [] },
28253
28266
  { console_session_with_workspace: [] },
28254
28267
  { client_session: [] },
28268
+ { client_session_with_customer: [] },
28255
28269
  ],
28256
28270
  summary: '/devices/update',
28257
28271
  tags: ['/devices'],
@@ -28315,6 +28329,7 @@ export default {
28315
28329
  { api_key: [] },
28316
28330
  { pat_with_workspace: [] },
28317
28331
  { console_session_with_workspace: [] },
28332
+ { client_session_with_customer: [] },
28318
28333
  ],
28319
28334
  summary: '/events/get',
28320
28335
  tags: ['/events'],
@@ -30108,7 +30123,7 @@ export default {
30108
30123
  schema: {
30109
30124
  properties: {
30110
30125
  device_id: {
30111
- description: 'Device ID of the desired phone.',
30126
+ description: 'Device ID of the phone that you want to deactivate.',
30112
30127
  type: 'string',
30113
30128
  },
30114
30129
  },
@@ -30150,7 +30165,7 @@ export default {
30150
30165
  },
30151
30166
  '/phones/get': {
30152
30167
  post: {
30153
- description: 'Returns a single phone entry matching the provided `device_id`.',
30168
+ description: 'Returns a specified [phone](https://docs.seam.co/latest/capability-guides/mobile-access/managing-phones-for-a-user-identity).',
30154
30169
  operationId: 'phonesGetPost',
30155
30170
  requestBody: {
30156
30171
  content: {
@@ -30158,7 +30173,7 @@ export default {
30158
30173
  schema: {
30159
30174
  properties: {
30160
30175
  device_id: {
30161
- description: 'Device ID of the desired phone.',
30176
+ description: 'Device ID of the phone that you want to get.',
30162
30177
  format: 'uuid',
30163
30178
  type: 'string',
30164
30179
  },
@@ -30199,12 +30214,12 @@ export default {
30199
30214
  'x-fern-sdk-method-name': 'get',
30200
30215
  'x-fern-sdk-return-value': 'phone',
30201
30216
  'x-response-key': 'phone',
30202
- 'x-title': 'Get Phone',
30217
+ 'x-title': 'Get a Phone',
30203
30218
  },
30204
30219
  },
30205
30220
  '/phones/list': {
30206
30221
  post: {
30207
- 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.',
30222
+ 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.',
30208
30223
  operationId: 'phonesListPost',
30209
30224
  requestBody: {
30210
30225
  content: {
@@ -30212,12 +30227,12 @@ export default {
30212
30227
  schema: {
30213
30228
  properties: {
30214
30229
  acs_credential_id: {
30215
- 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.',
30230
+ 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.',
30216
30231
  format: 'uuid',
30217
30232
  type: 'string',
30218
30233
  },
30219
30234
  owner_user_identity_id: {
30220
- description: 'ID of the user identity that represents the owner by which to filter the list of returned phones.',
30235
+ description: 'ID of the user identity that represents the owner by which you want to filter the list of returned phones.',
30221
30236
  format: 'uuid',
30222
30237
  type: 'string',
30223
30238
  },
@@ -30265,7 +30280,7 @@ export default {
30265
30280
  },
30266
30281
  '/phones/simulate/create_sandbox_phone': {
30267
30282
  post: {
30268
- 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).',
30283
+ 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).',
30269
30284
  operationId: 'phonesSimulateCreateSandboxPhonePost',
30270
30285
  requestBody: {
30271
30286
  content: {
@@ -30274,7 +30289,7 @@ export default {
30274
30289
  properties: {
30275
30290
  assa_abloy_metadata: {
30276
30291
  default: {},
30277
- description: 'ASSA ABLOY metadata to associate with the simulated phone.',
30292
+ description: 'ASSA ABLOY metadata that you want to associate with the simulated phone.',
30278
30293
  properties: {
30279
30294
  application_version: {
30280
30295
  default: '1.0.0',
@@ -30311,12 +30326,12 @@ export default {
30311
30326
  type: 'object',
30312
30327
  },
30313
30328
  custom_sdk_installation_id: {
30314
- description: 'ID of the custom SDK installation to use for the simulated phone.',
30329
+ description: 'ID of the custom SDK installation that you want to use for the simulated phone.',
30315
30330
  type: 'string',
30316
30331
  },
30317
30332
  phone_metadata: {
30318
30333
  default: {},
30319
- description: 'Metadata to associate with the simulated phone.',
30334
+ description: 'Metadata that you want to associate with the simulated phone.',
30320
30335
  properties: {
30321
30336
  device_manufacturer: {
30322
30337
  default: 'Samsung',
@@ -30343,7 +30358,7 @@ export default {
30343
30358
  type: 'object',
30344
30359
  },
30345
30360
  user_identity_id: {
30346
- description: 'ID of the user identity to associate with the simulated phone.',
30361
+ description: 'ID of the user identity that you want to associate with the simulated phone.',
30347
30362
  format: 'uuid',
30348
30363
  type: 'string',
30349
30364
  },
@@ -30389,16 +30404,25 @@ export default {
30389
30404
  },
30390
30405
  '/seam/bridge/v1/bridge_client_sessions/create': {
30391
30406
  post: {
30392
- description: 'Creates a new bridge client session.',
30407
+ description: 'Creates a new [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client session.',
30393
30408
  operationId: 'seamBridgeV1BridgeClientSessionsCreatePost',
30394
30409
  requestBody: {
30395
30410
  content: {
30396
30411
  'application/json': {
30397
30412
  schema: {
30398
30413
  properties: {
30399
- bridge_client_machine_identifier_key: { type: 'string' },
30400
- bridge_client_name: { type: 'string' },
30401
- bridge_client_time_zone: { type: 'string' },
30414
+ bridge_client_machine_identifier_key: {
30415
+ description: 'Identifier key of the client machine for the Seam Bridge client that you want to create.',
30416
+ type: 'string',
30417
+ },
30418
+ bridge_client_name: {
30419
+ description: 'Name of the Seam Bridge client that you want to create.',
30420
+ type: 'string',
30421
+ },
30422
+ bridge_client_time_zone: {
30423
+ description: 'Time zone for the Seam Bridge that you want to create.',
30424
+ type: 'string',
30425
+ },
30402
30426
  },
30403
30427
  required: [
30404
30428
  'bridge_client_name',
@@ -30574,12 +30598,12 @@ export default {
30574
30598
  'x-fern-sdk-return-value': 'bridge_client_session',
30575
30599
  'x-response-key': 'bridge_client_session',
30576
30600
  'x-title': 'Create a Bridge Client Session',
30577
- 'x-undocumented': 'Seam Bridge Client only.',
30601
+ 'x-undocumented': 'Seam Bridge client only.',
30578
30602
  },
30579
30603
  },
30580
30604
  '/seam/bridge/v1/bridge_client_sessions/get': {
30581
30605
  get: {
30582
- description: 'Returns the bridge client session associated with the session token used.',
30606
+ 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.',
30583
30607
  operationId: 'seamBridgeV1BridgeClientSessionsGetGet',
30584
30608
  responses: {
30585
30609
  200: {
@@ -30737,11 +30761,11 @@ export default {
30737
30761
  tags: [],
30738
30762
  'x-fern-ignore': true,
30739
30763
  'x-response-key': 'bridge_client_session',
30740
- 'x-title': 'Get a Bridge Client Session',
30764
+ 'x-title': 'Get a Seam Bridge Client Session',
30741
30765
  'x-undocumented': 'Seam Bridge Client only.',
30742
30766
  },
30743
30767
  post: {
30744
- description: 'Returns the bridge client session associated with the session token used.',
30768
+ 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.',
30745
30769
  operationId: 'seamBridgeV1BridgeClientSessionsGetPost',
30746
30770
  responses: {
30747
30771
  200: {
@@ -30906,13 +30930,13 @@ export default {
30906
30930
  'x-fern-sdk-method-name': 'get',
30907
30931
  'x-fern-sdk-return-value': 'bridge_client_session',
30908
30932
  'x-response-key': 'bridge_client_session',
30909
- 'x-title': 'Get a Bridge Client Session',
30933
+ 'x-title': 'Get a Seam Bridge Client Session',
30910
30934
  'x-undocumented': 'Seam Bridge Client only.',
30911
30935
  },
30912
30936
  },
30913
30937
  '/seam/bridge/v1/bridge_client_sessions/refresh_telemetry_token': {
30914
30938
  post: {
30915
- description: 'Returns the bridge client session associated with the session token and refreshed telemetry token.',
30939
+ 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.',
30916
30940
  operationId: 'seamBridgeV1BridgeClientSessionsRefreshTelemetryTokenPost',
30917
30941
  responses: {
30918
30942
  200: {
@@ -31077,13 +31101,13 @@ export default {
31077
31101
  'x-fern-sdk-method-name': 'refresh_telemetry_token',
31078
31102
  'x-fern-sdk-return-value': 'bridge_client_session',
31079
31103
  'x-response-key': 'bridge_client_session',
31080
- 'x-title': 'Refresh telemetry token for bridge client session',
31104
+ 'x-title': 'Refresh the Telemetry Token for a Seam Bridge Client Session',
31081
31105
  'x-undocumented': 'Seam Bridge Client only.',
31082
31106
  },
31083
31107
  },
31084
31108
  '/seam/bridge/v1/bridge_client_sessions/regenerate_pairing_code': {
31085
31109
  post: {
31086
- description: 'Generate a new pairing code and return the updated bridge client session.',
31110
+ description: 'Generate a new pairing code and return the updated [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client session.',
31087
31111
  operationId: 'seamBridgeV1BridgeClientSessionsRegeneratePairingCodePost',
31088
31112
  responses: {
31089
31113
  200: {
@@ -31248,21 +31272,29 @@ export default {
31248
31272
  'x-fern-sdk-method-name': 'regenerate_pairing_code',
31249
31273
  'x-fern-sdk-return-value': 'bridge_client_session',
31250
31274
  'x-response-key': 'bridge_client_session',
31251
- 'x-title': 'Regenerate a Bridge Client Session Pairing Code',
31275
+ 'x-title': 'Regenerate a Seam Bridge Client Session Pairing Code',
31252
31276
  'x-undocumented': 'Seam Bridge Client only.',
31253
31277
  },
31254
31278
  },
31255
31279
  '/seam/bridge/v1/bridge_client_sessions/report_status': {
31256
31280
  post: {
31257
- description: "Report a Seam Bridge Bridge client's status.",
31281
+ description: 'Report the status of a [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client.',
31258
31282
  operationId: 'seamBridgeV1BridgeClientSessionsReportStatusPost',
31259
31283
  requestBody: {
31260
31284
  content: {
31261
31285
  'application/json': {
31262
31286
  schema: {
31263
31287
  properties: {
31264
- is_tailscale_connected: { nullable: true, type: 'boolean' },
31265
- tailscale_ip_v4: { nullable: true, type: 'string' },
31288
+ is_tailscale_connected: {
31289
+ description: 'Indicates whether Tailscale is connected.',
31290
+ nullable: true,
31291
+ type: 'boolean',
31292
+ },
31293
+ tailscale_ip_v4: {
31294
+ description: 'Tailscale IPv4 address.',
31295
+ nullable: true,
31296
+ type: 'string',
31297
+ },
31266
31298
  },
31267
31299
  required: ['is_tailscale_connected', 'tailscale_ip_v4'],
31268
31300
  type: 'object',
@@ -31297,13 +31329,13 @@ export default {
31297
31329
  ],
31298
31330
  'x-fern-sdk-method-name': 'report_status',
31299
31331
  'x-response-key': null,
31300
- 'x-title': "Report a Bridge Client's Status",
31332
+ 'x-title': 'Report the Status of a Seam Bridge Client',
31301
31333
  'x-undocumented': 'Seam Bridge Client only.',
31302
31334
  },
31303
31335
  },
31304
31336
  '/seam/bridge/v1/bridge_connected_systems/list': {
31305
31337
  get: {
31306
- description: 'Returns the bridge connected systems associated with the session token used.',
31338
+ 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.',
31307
31339
  operationId: 'seamBridgeV1BridgeConnectedSystemsListGet',
31308
31340
  responses: {
31309
31341
  200: {
@@ -31365,11 +31397,11 @@ export default {
31365
31397
  tags: [],
31366
31398
  'x-fern-ignore': true,
31367
31399
  'x-response-key': 'bridge_connected_systems',
31368
- 'x-title': 'List Bridge Connected Systems',
31400
+ 'x-title': 'List Bridge-Connected Systems',
31369
31401
  'x-undocumented': 'Seam Bridge Client only.',
31370
31402
  },
31371
31403
  post: {
31372
- description: 'Returns the bridge connected systems associated with the session token used.',
31404
+ 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.',
31373
31405
  operationId: 'seamBridgeV1BridgeConnectedSystemsListPost',
31374
31406
  responses: {
31375
31407
  200: {
@@ -31438,13 +31470,13 @@ export default {
31438
31470
  'x-fern-sdk-method-name': 'list',
31439
31471
  'x-fern-sdk-return-value': 'bridge_connected_systems',
31440
31472
  'x-response-key': 'bridge_connected_systems',
31441
- 'x-title': 'List Bridge Connected Systems',
31473
+ 'x-title': 'List Bridge-Connected Systems',
31442
31474
  'x-undocumented': 'Seam Bridge Client only.',
31443
31475
  },
31444
31476
  },
31445
31477
  '/seam/instant_key/v1/client_sessions/exchange_short_code': {
31446
31478
  post: {
31447
- 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.',
31479
+ 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.',
31448
31480
  operationId: 'seamInstantKeyV1ClientSessionsExchangeShortCodePost',
31449
31481
  requestBody: {
31450
31482
  content: {
@@ -31452,7 +31484,7 @@ export default {
31452
31484
  schema: {
31453
31485
  properties: {
31454
31486
  short_code: {
31455
- description: 'The short code to exchange for a client session token',
31487
+ description: 'Short code that you want to exchange for a client session token.',
31456
31488
  type: 'string',
31457
31489
  },
31458
31490
  },
@@ -31501,7 +31533,7 @@ export default {
31501
31533
  },
31502
31534
  '/seam/mobile_sdk/v1/acs/credentials/list': {
31503
31535
  post: {
31504
- description: 'Returns a list of all ACS credentials.',
31536
+ description: 'Returns a list of all [credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
31505
31537
  operationId: 'seamMobileSdkV1AcsCredentialsListPost',
31506
31538
  requestBody: {
31507
31539
  content: {
@@ -31549,15 +31581,19 @@ export default {
31549
31581
  },
31550
31582
  '/seam/mobile_sdk/v1/phone_sessions/get_or_create': {
31551
31583
  post: {
31552
- description: 'Get or create a session for a mobile SDK phone.',
31584
+ description: 'Gets or creates a session for a mobile SDK phone.',
31553
31585
  operationId: 'seamMobileSdkV1PhoneSessionsGetOrCreatePost',
31554
31586
  requestBody: {
31555
31587
  content: {
31556
31588
  'application/json': {
31557
31589
  schema: {
31558
31590
  properties: {
31559
- custom_sdk_installation_id: { type: 'string' },
31591
+ custom_sdk_installation_id: {
31592
+ description: 'ID of the custom SDK installation that you want to use for the new session.',
31593
+ type: 'string',
31594
+ },
31560
31595
  phone_device_metadata: {
31596
+ description: 'Phone device metadata that you want to use for the new session.',
31561
31597
  properties: {
31562
31598
  manufacturer: { type: 'string' },
31563
31599
  model: { type: 'string' },
@@ -31565,7 +31601,11 @@ export default {
31565
31601
  },
31566
31602
  type: 'object',
31567
31603
  },
31568
- phone_os: { enum: ['ios', 'android'], type: 'string' },
31604
+ phone_os: {
31605
+ description: 'Phone operating system that you want to use for the new session.',
31606
+ enum: ['ios', 'android'],
31607
+ type: 'string',
31608
+ },
31569
31609
  },
31570
31610
  required: ['custom_sdk_installation_id', 'phone_os'],
31571
31611
  type: 'object',
@@ -31607,13 +31647,18 @@ export default {
31607
31647
  },
31608
31648
  '/seam/partner/v1/building_blocks/spaces/auto_map': {
31609
31649
  post: {
31610
- description: 'Auto map partner resources that have been pushed to Seam.',
31650
+ description: 'Auto-maps partner resources that have been pushed to Seam.',
31611
31651
  operationId: 'seamPartnerV1BuildingBlocksSpacesAutoMapPost',
31612
31652
  requestBody: {
31613
31653
  content: {
31614
31654
  'application/json': {
31615
31655
  schema: {
31616
- properties: { collection_key: { type: 'string' } },
31656
+ properties: {
31657
+ collection_key: {
31658
+ description: 'Collection key.',
31659
+ type: 'string',
31660
+ },
31661
+ },
31617
31662
  required: ['collection_key'],
31618
31663
  type: 'object',
31619
31664
  },
@@ -31694,13 +31739,13 @@ export default {
31694
31739
  'x-fern-sdk-method-name': 'auto_map',
31695
31740
  'x-fern-sdk-return-value': 'spaces',
31696
31741
  'x-response-key': 'spaces',
31697
- 'x-title': 'Do auto mapping for partner resources that map to spaces',
31742
+ 'x-title': 'Do Auto-Mapping for Partner Resources that Map to Spaces',
31698
31743
  'x-undocumented': 'Partner building blocks/UI only.',
31699
31744
  },
31700
31745
  },
31701
31746
  '/seam/partner/v1/resources/list': {
31702
31747
  post: {
31703
- description: 'List partner resources that have been pushed to Seam.',
31748
+ description: 'Lists partner resources that have been pushed to Seam.',
31704
31749
  operationId: 'seamPartnerV1ResourcesListPost',
31705
31750
  requestBody: {
31706
31751
  content: {
@@ -31708,7 +31753,7 @@ export default {
31708
31753
  schema: {
31709
31754
  properties: {
31710
31755
  resource_type_alias: {
31711
- description: 'Filter by resource type alias.',
31756
+ description: 'Resource type alias by which you want to filter partner resources.',
31712
31757
  type: 'string',
31713
31758
  },
31714
31759
  },
@@ -31775,13 +31820,13 @@ export default {
31775
31820
  'x-fern-sdk-method-name': 'list',
31776
31821
  'x-fern-sdk-return-value': 'partner_resources',
31777
31822
  'x-response-key': 'partner_resources',
31778
- 'x-title': 'List partner resources at Seam',
31823
+ 'x-title': 'List Partner Resources at Seam',
31779
31824
  'x-undocumented': 'Partner building blocks/UI only.',
31780
31825
  },
31781
31826
  },
31782
31827
  '/spaces/add_acs_entrances': {
31783
31828
  post: {
31784
- description: 'Add entrances to a specific space.',
31829
+ description: 'Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific space.',
31785
31830
  operationId: 'spacesAddAcsEntrancesPost',
31786
31831
  requestBody: {
31787
31832
  content: {
@@ -31789,11 +31834,16 @@ export default {
31789
31834
  schema: {
31790
31835
  properties: {
31791
31836
  acs_entrance_ids: {
31837
+ description: 'IDs of the entrances that you want to add to the space.',
31792
31838
  items: { format: 'uuid', type: 'string' },
31793
31839
  minItems: 1,
31794
31840
  type: 'array',
31795
31841
  },
31796
- space_id: { format: 'uuid', type: 'string' },
31842
+ space_id: {
31843
+ description: 'ID of the space to which you want to add entrances.',
31844
+ format: 'uuid',
31845
+ type: 'string',
31846
+ },
31797
31847
  },
31798
31848
  required: ['space_id', 'acs_entrance_ids'],
31799
31849
  type: 'object',
@@ -31828,10 +31878,10 @@ export default {
31828
31878
  'x-fern-sdk-group-name': ['spaces'],
31829
31879
  'x-fern-sdk-method-name': 'add_acs_entrances',
31830
31880
  'x-response-key': null,
31831
- 'x-title': 'Add ACS Entrances',
31881
+ 'x-title': 'Add Entrances to a Space',
31832
31882
  },
31833
31883
  put: {
31834
- description: 'Add entrances to a specific space.',
31884
+ description: 'Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific space.',
31835
31885
  operationId: 'spacesAddAcsEntrancesPut',
31836
31886
  requestBody: {
31837
31887
  content: {
@@ -31839,11 +31889,16 @@ export default {
31839
31889
  schema: {
31840
31890
  properties: {
31841
31891
  acs_entrance_ids: {
31892
+ description: 'IDs of the entrances that you want to add to the space.',
31842
31893
  items: { format: 'uuid', type: 'string' },
31843
31894
  minItems: 1,
31844
31895
  type: 'array',
31845
31896
  },
31846
- space_id: { format: 'uuid', type: 'string' },
31897
+ space_id: {
31898
+ description: 'ID of the space to which you want to add entrances.',
31899
+ format: 'uuid',
31900
+ type: 'string',
31901
+ },
31847
31902
  },
31848
31903
  required: ['space_id', 'acs_entrance_ids'],
31849
31904
  type: 'object',
@@ -31877,12 +31932,12 @@ export default {
31877
31932
  'x-draft': 'Early access.',
31878
31933
  'x-fern-ignore': true,
31879
31934
  'x-response-key': null,
31880
- 'x-title': 'Add ACS Entrances',
31935
+ 'x-title': 'Add Entrances to a Space',
31881
31936
  },
31882
31937
  },
31883
31938
  '/spaces/add_devices': {
31884
31939
  post: {
31885
- description: 'Add devices to a specific space.',
31940
+ description: 'Adds devices to a specific space.',
31886
31941
  operationId: 'spacesAddDevicesPost',
31887
31942
  requestBody: {
31888
31943
  content: {
@@ -31890,11 +31945,16 @@ export default {
31890
31945
  schema: {
31891
31946
  properties: {
31892
31947
  device_ids: {
31948
+ description: 'IDs of the devices that you want to add to the space.',
31893
31949
  items: { format: 'uuid', type: 'string' },
31894
31950
  minItems: 1,
31895
31951
  type: 'array',
31896
31952
  },
31897
- space_id: { format: 'uuid', type: 'string' },
31953
+ space_id: {
31954
+ description: 'ID of the space to which you want to add devices.',
31955
+ format: 'uuid',
31956
+ type: 'string',
31957
+ },
31898
31958
  },
31899
31959
  required: ['space_id', 'device_ids'],
31900
31960
  type: 'object',
@@ -31929,10 +31989,10 @@ export default {
31929
31989
  'x-fern-sdk-group-name': ['spaces'],
31930
31990
  'x-fern-sdk-method-name': 'add_devices',
31931
31991
  'x-response-key': null,
31932
- 'x-title': 'Add Space Devices',
31992
+ 'x-title': 'Add Devices to a Space',
31933
31993
  },
31934
31994
  put: {
31935
- description: 'Add devices to a specific space.',
31995
+ description: 'Adds devices to a specific space.',
31936
31996
  operationId: 'spacesAddDevicesPut',
31937
31997
  requestBody: {
31938
31998
  content: {
@@ -31940,11 +32000,16 @@ export default {
31940
32000
  schema: {
31941
32001
  properties: {
31942
32002
  device_ids: {
32003
+ description: 'IDs of the devices that you want to add to the space.',
31943
32004
  items: { format: 'uuid', type: 'string' },
31944
32005
  minItems: 1,
31945
32006
  type: 'array',
31946
32007
  },
31947
- space_id: { format: 'uuid', type: 'string' },
32008
+ space_id: {
32009
+ description: 'ID of the space to which you want to add devices.',
32010
+ format: 'uuid',
32011
+ type: 'string',
32012
+ },
31948
32013
  },
31949
32014
  required: ['space_id', 'device_ids'],
31950
32015
  type: 'object',
@@ -31978,12 +32043,12 @@ export default {
31978
32043
  'x-draft': 'Early access.',
31979
32044
  'x-fern-ignore': true,
31980
32045
  'x-response-key': null,
31981
- 'x-title': 'Add Space Devices',
32046
+ 'x-title': 'Add Devices to a Space',
31982
32047
  },
31983
32048
  },
31984
32049
  '/spaces/create': {
31985
32050
  post: {
31986
- description: 'Create a new space.',
32051
+ description: 'Creates a new space.',
31987
32052
  operationId: 'spacesCreatePost',
31988
32053
  requestBody: {
31989
32054
  content: {
@@ -31991,14 +32056,19 @@ export default {
31991
32056
  schema: {
31992
32057
  properties: {
31993
32058
  acs_entrance_ids: {
32059
+ description: 'IDs of the entrances that you want to add to the new space.',
31994
32060
  items: { format: 'uuid', type: 'string' },
31995
32061
  type: 'array',
31996
32062
  },
31997
32063
  device_ids: {
32064
+ description: 'IDs of the devices that you want to add to the new space.',
31998
32065
  items: { format: 'uuid', type: 'string' },
31999
32066
  type: 'array',
32000
32067
  },
32001
- name: { type: 'string' },
32068
+ name: {
32069
+ description: 'Name of the space that you want to create.',
32070
+ type: 'string',
32071
+ },
32002
32072
  },
32003
32073
  required: ['name'],
32004
32074
  type: 'object',
@@ -32037,18 +32107,24 @@ export default {
32037
32107
  'x-fern-sdk-method-name': 'create',
32038
32108
  'x-fern-sdk-return-value': 'space',
32039
32109
  'x-response-key': 'space',
32040
- 'x-title': 'Create Space',
32110
+ 'x-title': 'Create a Space',
32041
32111
  },
32042
32112
  },
32043
32113
  '/spaces/delete': {
32044
32114
  post: {
32045
- description: 'Delete a space.',
32115
+ description: 'Deletes a space.',
32046
32116
  operationId: 'spacesDeletePost',
32047
32117
  requestBody: {
32048
32118
  content: {
32049
32119
  'application/json': {
32050
32120
  schema: {
32051
- properties: { space_id: { format: 'uuid', type: 'string' } },
32121
+ properties: {
32122
+ space_id: {
32123
+ description: 'ID of the space that you want to delete.',
32124
+ format: 'uuid',
32125
+ type: 'string',
32126
+ },
32127
+ },
32052
32128
  required: ['space_id'],
32053
32129
  type: 'object',
32054
32130
  },
@@ -32078,21 +32154,28 @@ export default {
32078
32154
  ],
32079
32155
  summary: '/spaces/delete',
32080
32156
  tags: [],
32157
+ 'x-draft': 'Early access.',
32081
32158
  'x-fern-sdk-group-name': ['spaces'],
32082
32159
  'x-fern-sdk-method-name': 'delete',
32083
32160
  'x-response-key': null,
32084
- 'x-title': 'Delete Space',
32161
+ 'x-title': 'Delete a Space',
32085
32162
  },
32086
32163
  },
32087
32164
  '/spaces/get': {
32088
32165
  post: {
32089
- description: 'Get a space.',
32166
+ description: 'Gets a space.',
32090
32167
  operationId: 'spacesGetPost',
32091
32168
  requestBody: {
32092
32169
  content: {
32093
32170
  'application/json': {
32094
32171
  schema: {
32095
- properties: { space_id: { format: 'uuid', type: 'string' } },
32172
+ properties: {
32173
+ space_id: {
32174
+ description: 'ID of the space that you want to get.',
32175
+ format: 'uuid',
32176
+ type: 'string',
32177
+ },
32178
+ },
32096
32179
  required: ['space_id'],
32097
32180
  type: 'object',
32098
32181
  },
@@ -32125,11 +32208,12 @@ export default {
32125
32208
  ],
32126
32209
  summary: '/spaces/get',
32127
32210
  tags: [],
32211
+ 'x-draft': 'Early access.',
32128
32212
  'x-fern-sdk-group-name': ['spaces'],
32129
32213
  'x-fern-sdk-method-name': 'get',
32130
32214
  'x-fern-sdk-return-value': 'space',
32131
32215
  'x-response-key': 'space',
32132
- 'x-title': 'Get Space',
32216
+ 'x-title': 'Get a Space',
32133
32217
  },
32134
32218
  },
32135
32219
  '/spaces/list': {
@@ -32212,7 +32296,7 @@ export default {
32212
32296
  },
32213
32297
  '/spaces/remove_acs_entrances': {
32214
32298
  post: {
32215
- description: 'Remove entrances from a specific space.',
32299
+ description: 'Removes [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) from a specific space.',
32216
32300
  operationId: 'spacesRemoveAcsEntrancesPost',
32217
32301
  requestBody: {
32218
32302
  content: {
@@ -32220,10 +32304,15 @@ export default {
32220
32304
  schema: {
32221
32305
  properties: {
32222
32306
  acs_entrance_ids: {
32307
+ description: 'IDs of the entrances that you want to remove from the space.',
32223
32308
  items: { format: 'uuid', type: 'string' },
32224
32309
  type: 'array',
32225
32310
  },
32226
- space_id: { format: 'uuid', type: 'string' },
32311
+ space_id: {
32312
+ description: 'ID of the space from which you want to remove entrances.',
32313
+ format: 'uuid',
32314
+ type: 'string',
32315
+ },
32227
32316
  },
32228
32317
  required: ['space_id', 'acs_entrance_ids'],
32229
32318
  type: 'object',
@@ -32258,12 +32347,12 @@ export default {
32258
32347
  'x-fern-sdk-group-name': ['spaces'],
32259
32348
  'x-fern-sdk-method-name': 'remove_acs_entrances',
32260
32349
  'x-response-key': null,
32261
- 'x-title': 'Remove ACS Entrances',
32350
+ 'x-title': 'Remove Entrances from a Space',
32262
32351
  },
32263
32352
  },
32264
32353
  '/spaces/remove_devices': {
32265
32354
  post: {
32266
- description: 'Remove devices from a specific space.',
32355
+ description: 'Removes devices from a specific space.',
32267
32356
  operationId: 'spacesRemoveDevicesPost',
32268
32357
  requestBody: {
32269
32358
  content: {
@@ -32271,10 +32360,15 @@ export default {
32271
32360
  schema: {
32272
32361
  properties: {
32273
32362
  device_ids: {
32363
+ description: 'IDs of the devices that you want to remove from the space.',
32274
32364
  items: { format: 'uuid', type: 'string' },
32275
32365
  type: 'array',
32276
32366
  },
32277
- space_id: { format: 'uuid', type: 'string' },
32367
+ space_id: {
32368
+ description: 'ID of the space from which you want to remove devices.',
32369
+ format: 'uuid',
32370
+ type: 'string',
32371
+ },
32278
32372
  },
32279
32373
  required: ['space_id', 'device_ids'],
32280
32374
  type: 'object',
@@ -32309,20 +32403,24 @@ export default {
32309
32403
  'x-fern-sdk-group-name': ['spaces'],
32310
32404
  'x-fern-sdk-method-name': 'remove_devices',
32311
32405
  'x-response-key': null,
32312
- 'x-title': 'Remove Space Devices',
32406
+ 'x-title': 'Remove Devices from a Space',
32313
32407
  },
32314
32408
  },
32315
32409
  '/spaces/update': {
32316
32410
  patch: {
32317
- description: 'Update an existing space.',
32411
+ description: 'Updates an existing space.',
32318
32412
  operationId: 'spacesUpdatePatch',
32319
32413
  requestBody: {
32320
32414
  content: {
32321
32415
  'application/json': {
32322
32416
  schema: {
32323
32417
  properties: {
32324
- name: { type: 'string' },
32325
- space_id: { format: 'uuid', type: 'string' },
32418
+ name: { description: 'Name of the space.', type: 'string' },
32419
+ space_id: {
32420
+ description: 'ID of the space that you want to update.',
32421
+ format: 'uuid',
32422
+ type: 'string',
32423
+ },
32326
32424
  },
32327
32425
  required: ['space_id'],
32328
32426
  type: 'object',
@@ -32359,18 +32457,22 @@ export default {
32359
32457
  'x-draft': 'Early access.',
32360
32458
  'x-fern-ignore': true,
32361
32459
  'x-response-key': 'space',
32362
- 'x-title': 'Update Space',
32460
+ 'x-title': 'Update a Space',
32363
32461
  },
32364
32462
  post: {
32365
- description: 'Update an existing space.',
32463
+ description: 'Updates an existing space.',
32366
32464
  operationId: 'spacesUpdatePost',
32367
32465
  requestBody: {
32368
32466
  content: {
32369
32467
  'application/json': {
32370
32468
  schema: {
32371
32469
  properties: {
32372
- name: { type: 'string' },
32373
- space_id: { format: 'uuid', type: 'string' },
32470
+ name: { description: 'Name of the space.', type: 'string' },
32471
+ space_id: {
32472
+ description: 'ID of the space that you want to update.',
32473
+ format: 'uuid',
32474
+ type: 'string',
32475
+ },
32374
32476
  },
32375
32477
  required: ['space_id'],
32376
32478
  type: 'object',
@@ -32409,7 +32511,7 @@ export default {
32409
32511
  'x-fern-sdk-method-name': 'update',
32410
32512
  'x-fern-sdk-return-value': 'space',
32411
32513
  'x-response-key': 'space',
32412
- 'x-title': 'Update Space',
32514
+ 'x-title': 'Update a Space',
32413
32515
  },
32414
32516
  },
32415
32517
  '/thermostats/activate_climate_preset': {
@@ -32483,12 +32585,12 @@ export default {
32483
32585
  schema: {
32484
32586
  properties: {
32485
32587
  cooling_set_point_celsius: {
32486
- description: 'Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `cooling_set_point` parameters.',
32588
+ description: '[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.',
32487
32589
  format: 'float',
32488
32590
  type: 'number',
32489
32591
  },
32490
32592
  cooling_set_point_fahrenheit: {
32491
- description: 'Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `cooling_set_point` parameters.',
32593
+ description: '[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.',
32492
32594
  format: 'float',
32493
32595
  type: 'number',
32494
32596
  },
@@ -32646,7 +32748,7 @@ export default {
32646
32748
  },
32647
32749
  '/thermostats/daily_programs/create': {
32648
32750
  post: {
32649
- 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.',
32751
+ 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.',
32650
32752
  operationId: 'thermostatsDailyProgramsCreatePost',
32651
32753
  requestBody: {
32652
32754
  content: {
@@ -32659,7 +32761,7 @@ export default {
32659
32761
  type: 'string',
32660
32762
  },
32661
32763
  name: {
32662
- description: 'User-friendly name to identify the thermostat daily program.',
32764
+ description: 'Name of the thermostat daily program.',
32663
32765
  type: 'string',
32664
32766
  },
32665
32767
  periods: {
@@ -32843,7 +32945,7 @@ export default {
32843
32945
  schema: {
32844
32946
  properties: {
32845
32947
  name: {
32846
- description: 'User-friendly name to identify the thermostat daily program that you want to update.',
32948
+ description: 'Name of the thermostat daily program that you want to update.',
32847
32949
  type: 'string',
32848
32950
  },
32849
32951
  periods: {
@@ -32921,7 +33023,7 @@ export default {
32921
33023
  schema: {
32922
33024
  properties: {
32923
33025
  name: {
32924
- description: 'User-friendly name to identify the thermostat daily program that you want to update.',
33026
+ description: 'Name of the thermostat daily program that you want to update.',
32925
33027
  type: 'string',
32926
33028
  },
32927
33029
  periods: {
@@ -33050,7 +33152,7 @@ export default {
33050
33152
  },
33051
33153
  '/thermostats/get': {
33052
33154
  post: {
33053
- description: 'Returns a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
33155
+ description: 'Returns a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). **Deprecated:** Will be removed. Use `/devices/get` instead.',
33054
33156
  operationId: 'thermostatsGetPost',
33055
33157
  requestBody: {
33056
33158
  content: {
@@ -33058,12 +33160,12 @@ export default {
33058
33160
  schema: {
33059
33161
  properties: {
33060
33162
  device_id: {
33061
- description: 'ID of the thermostat device that you want to retrieve.',
33163
+ description: 'ID of the thermostat device that you want to get.',
33062
33164
  format: 'uuid',
33063
33165
  type: 'string',
33064
33166
  },
33065
33167
  name: {
33066
- description: 'User-friendly name of the thermostat device that you want to retrieve.',
33168
+ description: 'Name of the thermostat device that you want to retrieve.',
33067
33169
  type: 'string',
33068
33170
  },
33069
33171
  },
@@ -33123,12 +33225,12 @@ export default {
33123
33225
  type: 'string',
33124
33226
  },
33125
33227
  heating_set_point_celsius: {
33126
- description: 'Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `heating_set_point` parameters.',
33228
+ description: '[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.',
33127
33229
  format: 'float',
33128
33230
  type: 'number',
33129
33231
  },
33130
33232
  heating_set_point_fahrenheit: {
33131
- description: 'Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `heating_set_point` parameters.',
33233
+ description: '[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.',
33132
33234
  format: 'float',
33133
33235
  type: 'number',
33134
33236
  },
@@ -33191,12 +33293,12 @@ export default {
33191
33293
  schema: {
33192
33294
  properties: {
33193
33295
  cooling_set_point_celsius: {
33194
- description: 'Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `cooling_set_point` parameters.',
33296
+ description: '[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.',
33195
33297
  format: 'float',
33196
33298
  type: 'number',
33197
33299
  },
33198
33300
  cooling_set_point_fahrenheit: {
33199
- description: 'Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `cooling_set_point` parameters.',
33301
+ description: '[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.',
33200
33302
  format: 'float',
33201
33303
  type: 'number',
33202
33304
  },
@@ -33206,12 +33308,12 @@ export default {
33206
33308
  type: 'string',
33207
33309
  },
33208
33310
  heating_set_point_celsius: {
33209
- description: 'Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `heating_set_point` parameters.',
33311
+ description: '[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.',
33210
33312
  format: 'float',
33211
33313
  type: 'number',
33212
33314
  },
33213
33315
  heating_set_point_fahrenheit: {
33214
- description: 'Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `heating_set_point` parameters.',
33316
+ description: '[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.',
33215
33317
  format: 'float',
33216
33318
  type: 'number',
33217
33319
  },
@@ -33310,7 +33412,7 @@ export default {
33310
33412
  type: 'array',
33311
33413
  },
33312
33414
  device_type: {
33313
- description: 'Device type by which to filter thermostat devices.',
33415
+ description: 'Device type by which you want to filter thermostat devices.',
33314
33416
  enum: [
33315
33417
  'ecobee_thermostat',
33316
33418
  'nest_thermostat',
@@ -33322,7 +33424,7 @@ export default {
33322
33424
  type: 'string',
33323
33425
  },
33324
33426
  device_types: {
33325
- description: 'Array of device types by which to filter thermostat devices.',
33427
+ description: 'Array of device types by which you want to filter thermostat devices.',
33326
33428
  items: {
33327
33429
  description: 'Device type for thermostats.\n ',
33328
33430
  enum: [
@@ -33384,7 +33486,7 @@ export default {
33384
33486
  type: 'number',
33385
33487
  },
33386
33488
  manufacturer: {
33387
- description: 'Manufacturer by which to filter thermostat devices.',
33489
+ description: 'Manufacturer by which you want to filter thermostat devices.',
33388
33490
  enum: [
33389
33491
  'ecobee',
33390
33492
  'honeywell_resideo',
@@ -33528,7 +33630,7 @@ export default {
33528
33630
  },
33529
33631
  '/thermostats/schedules/create': {
33530
33632
  post: {
33531
- 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).',
33633
+ 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).',
33532
33634
  operationId: 'thermostatsSchedulesCreatePost',
33533
33635
  requestBody: {
33534
33636
  content: {
@@ -33536,19 +33638,19 @@ export default {
33536
33638
  schema: {
33537
33639
  properties: {
33538
33640
  climate_preset_key: {
33539
- 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.',
33641
+ 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.',
33540
33642
  type: 'string',
33541
33643
  },
33542
33644
  device_id: {
33543
- description: 'ID of the desired thermostat device.',
33645
+ description: 'ID of the thermostat device for which you want to create a schedule.',
33544
33646
  type: 'string',
33545
33647
  },
33546
33648
  ends_at: {
33547
- 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.',
33649
+ 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.',
33548
33650
  type: 'string',
33549
33651
  },
33550
33652
  is_override_allowed: {
33551
- 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).",
33653
+ 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).",
33552
33654
  type: 'boolean',
33553
33655
  },
33554
33656
  max_override_period_minutes: {
@@ -33559,11 +33661,11 @@ export default {
33559
33661
  type: 'integer',
33560
33662
  },
33561
33663
  name: {
33562
- description: 'User-friendly name to identify the thermostat schedule.',
33664
+ description: 'Name of the thermostat schedule.',
33563
33665
  type: 'string',
33564
33666
  },
33565
33667
  starts_at: {
33566
- 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.',
33668
+ 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.',
33567
33669
  type: 'string',
33568
33670
  },
33569
33671
  },
@@ -33624,7 +33726,7 @@ export default {
33624
33726
  schema: {
33625
33727
  properties: {
33626
33728
  thermostat_schedule_id: {
33627
- description: 'ID of the desired thermostat schedule.',
33729
+ description: 'ID of the thermostat schedule that you want to delete.',
33628
33730
  format: 'uuid',
33629
33731
  type: 'string',
33630
33732
  },
@@ -33675,7 +33777,7 @@ export default {
33675
33777
  schema: {
33676
33778
  properties: {
33677
33779
  thermostat_schedule_id: {
33678
- description: 'ID of the desired thermostat schedule.',
33780
+ description: 'ID of the thermostat schedule that you want to get.',
33679
33781
  format: 'uuid',
33680
33782
  type: 'string',
33681
33783
  },
@@ -33732,7 +33834,7 @@ export default {
33732
33834
  schema: {
33733
33835
  properties: {
33734
33836
  device_id: {
33735
- description: 'ID of the desired thermostat device.',
33837
+ description: 'ID of the thermostat device for which you want to list schedules.',
33736
33838
  format: 'uuid',
33737
33839
  type: 'string',
33738
33840
  },
@@ -33815,7 +33917,7 @@ export default {
33815
33917
  type: 'integer',
33816
33918
  },
33817
33919
  name: {
33818
- description: 'User-friendly name to identify the thermostat schedule.',
33920
+ description: 'Name of the thermostat schedule.',
33819
33921
  type: 'string',
33820
33922
  },
33821
33923
  starts_at: {
@@ -33823,7 +33925,7 @@ export default {
33823
33925
  type: 'string',
33824
33926
  },
33825
33927
  thermostat_schedule_id: {
33826
- description: 'ID of the desired thermostat schedule.',
33928
+ description: 'ID of the thermostat schedule that you want to update.',
33827
33929
  format: 'uuid',
33828
33930
  type: 'string',
33829
33931
  },
@@ -33890,7 +33992,7 @@ export default {
33890
33992
  type: 'integer',
33891
33993
  },
33892
33994
  name: {
33893
- description: 'User-friendly name to identify the thermostat schedule.',
33995
+ description: 'Name of the thermostat schedule.',
33894
33996
  type: 'string',
33895
33997
  },
33896
33998
  starts_at: {
@@ -33898,7 +34000,7 @@ export default {
33898
34000
  type: 'string',
33899
34001
  },
33900
34002
  thermostat_schedule_id: {
33901
- description: 'ID of the desired thermostat schedule.',
34003
+ description: 'ID of the thermostat schedule that you want to update.',
33902
34004
  format: 'uuid',
33903
34005
  type: 'string',
33904
34006
  },
@@ -34014,7 +34116,7 @@ export default {
34014
34116
  'x-deprecated': 'Use `fan_mode_setting` instead.',
34015
34117
  },
34016
34118
  fan_mode_setting: {
34017
- description: 'Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for the thermostat.',
34119
+ 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.',
34018
34120
  enum: ['auto', 'on', 'circulate'],
34019
34121
  type: 'string',
34020
34122
  },
@@ -34092,12 +34194,12 @@ export default {
34092
34194
  {
34093
34195
  properties: {
34094
34196
  cooling_set_point_celsius: {
34095
- description: 'Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `cooling_set_point` parameters.',
34197
+ description: '[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.',
34096
34198
  format: 'float',
34097
34199
  type: 'number',
34098
34200
  },
34099
34201
  cooling_set_point_fahrenheit: {
34100
- description: 'Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `cooling_set_point` parameters.',
34202
+ description: '[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.',
34101
34203
  format: 'float',
34102
34204
  type: 'number',
34103
34205
  },
@@ -34119,12 +34221,12 @@ export default {
34119
34221
  type: 'string',
34120
34222
  },
34121
34223
  heating_set_point_celsius: {
34122
- description: 'Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `heating_set_point` parameters.',
34224
+ description: '[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.',
34123
34225
  format: 'float',
34124
34226
  type: 'number',
34125
34227
  },
34126
34228
  heating_set_point_fahrenheit: {
34127
- description: 'Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `heating_set_point` parameters.',
34229
+ description: '[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.',
34128
34230
  format: 'float',
34129
34231
  type: 'number',
34130
34232
  },
@@ -34136,12 +34238,12 @@ export default {
34136
34238
  {
34137
34239
  properties: {
34138
34240
  cooling_set_point_celsius: {
34139
- description: 'Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `cooling_set_point` parameters.',
34241
+ description: '[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.',
34140
34242
  format: 'float',
34141
34243
  type: 'number',
34142
34244
  },
34143
34245
  cooling_set_point_fahrenheit: {
34144
- description: 'Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `cooling_set_point` parameters.',
34246
+ description: '[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.',
34145
34247
  format: 'float',
34146
34248
  type: 'number',
34147
34249
  },
@@ -34151,12 +34253,12 @@ export default {
34151
34253
  type: 'string',
34152
34254
  },
34153
34255
  heating_set_point_celsius: {
34154
- description: 'Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `heating_set_point` parameters.',
34256
+ description: '[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.',
34155
34257
  format: 'float',
34156
34258
  type: 'number',
34157
34259
  },
34158
34260
  heating_set_point_fahrenheit: {
34159
- description: 'Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `heating_set_point` parameters.',
34261
+ description: '[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.',
34160
34262
  format: 'float',
34161
34263
  type: 'number',
34162
34264
  },
@@ -34376,12 +34478,12 @@ export default {
34376
34478
  {
34377
34479
  properties: {
34378
34480
  device_id: {
34379
- description: 'ID of the desired thermostat device.',
34481
+ description: 'ID of the thermostat device for which you want to simulate having adjusted the HVAC mode.',
34380
34482
  format: 'uuid',
34381
34483
  type: 'string',
34382
34484
  },
34383
34485
  hvac_mode: {
34384
- description: 'Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate.',
34486
+ description: 'HVAC mode that you want to simulate.',
34385
34487
  enum: ['off'],
34386
34488
  type: 'string',
34387
34489
  },
@@ -34392,22 +34494,22 @@ export default {
34392
34494
  {
34393
34495
  properties: {
34394
34496
  cooling_set_point_celsius: {
34395
- description: 'Desired simulated cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`.',
34497
+ description: 'Cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`.',
34396
34498
  format: 'float',
34397
34499
  type: 'number',
34398
34500
  },
34399
34501
  cooling_set_point_fahrenheit: {
34400
- description: 'Desired simulated cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`.',
34502
+ description: 'Cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`.',
34401
34503
  format: 'float',
34402
34504
  type: 'number',
34403
34505
  },
34404
34506
  device_id: {
34405
- description: 'ID of the desired thermostat device.',
34507
+ description: 'ID of the thermostat device for which you want to simulate having adjusted the HVAC mode.',
34406
34508
  format: 'uuid',
34407
34509
  type: 'string',
34408
34510
  },
34409
34511
  hvac_mode: {
34410
- description: 'Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate.',
34512
+ description: 'HVAC mode that you want to simulate.',
34411
34513
  enum: ['cool'],
34412
34514
  type: 'string',
34413
34515
  },
@@ -34418,22 +34520,22 @@ export default {
34418
34520
  {
34419
34521
  properties: {
34420
34522
  device_id: {
34421
- description: 'ID of the desired thermostat device.',
34523
+ description: 'ID of the thermostat device for which you want to simulate having adjusted the HVAC mode.',
34422
34524
  format: 'uuid',
34423
34525
  type: 'string',
34424
34526
  },
34425
34527
  heating_set_point_celsius: {
34426
- description: 'Desired simulated heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`.',
34528
+ description: 'Heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`.',
34427
34529
  format: 'float',
34428
34530
  type: 'number',
34429
34531
  },
34430
34532
  heating_set_point_fahrenheit: {
34431
- description: 'Desired simulated heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`.',
34533
+ description: 'Heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`.',
34432
34534
  format: 'float',
34433
34535
  type: 'number',
34434
34536
  },
34435
34537
  hvac_mode: {
34436
- description: 'Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate.',
34538
+ description: 'HVAC mode that you want to simulate.',
34437
34539
  enum: ['heat'],
34438
34540
  type: 'string',
34439
34541
  },
@@ -34444,32 +34546,32 @@ export default {
34444
34546
  {
34445
34547
  properties: {
34446
34548
  cooling_set_point_celsius: {
34447
- description: 'Desired simulated cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`.',
34549
+ description: 'Cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`.',
34448
34550
  format: 'float',
34449
34551
  type: 'number',
34450
34552
  },
34451
34553
  cooling_set_point_fahrenheit: {
34452
- description: 'Desired simulated cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`.',
34554
+ description: 'Cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`.',
34453
34555
  format: 'float',
34454
34556
  type: 'number',
34455
34557
  },
34456
34558
  device_id: {
34457
- description: 'ID of the desired thermostat device.',
34559
+ description: 'ID of the thermostat device for which you want to simulate having adjusted the HVAC mode.',
34458
34560
  format: 'uuid',
34459
34561
  type: 'string',
34460
34562
  },
34461
34563
  heating_set_point_celsius: {
34462
- description: 'Desired simulated heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`.',
34564
+ description: 'Heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`.',
34463
34565
  format: 'float',
34464
34566
  type: 'number',
34465
34567
  },
34466
34568
  heating_set_point_fahrenheit: {
34467
- description: 'Desired simulated heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`.',
34569
+ description: 'Heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`.',
34468
34570
  format: 'float',
34469
34571
  type: 'number',
34470
34572
  },
34471
34573
  hvac_mode: {
34472
- description: 'Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate.',
34574
+ description: 'HVAC mode that you want to simulate.',
34473
34575
  enum: ['heat_cool'],
34474
34576
  type: 'string',
34475
34577
  },
@@ -34521,17 +34623,17 @@ export default {
34521
34623
  schema: {
34522
34624
  properties: {
34523
34625
  device_id: {
34524
- description: 'ID of the desired thermostat device.',
34626
+ description: 'ID of the thermostat device that you want to simulate reaching a specified temperature.',
34525
34627
  format: 'uuid',
34526
34628
  type: 'string',
34527
34629
  },
34528
34630
  temperature_celsius: {
34529
- description: 'Desired simulated temperature in °C. You must set `temperature_celsius` or `temperature_fahrenheit`.',
34631
+ description: 'Temperature in °C that you want simulate the thermostat reaching. You must set `temperature_celsius` or `temperature_fahrenheit`.',
34530
34632
  format: 'float',
34531
34633
  type: 'number',
34532
34634
  },
34533
34635
  temperature_fahrenheit: {
34534
- description: 'Desired simulated temperature in °F. You must set `temperature_fahrenheit` or `temperature_celsius`.',
34636
+ description: 'Temperature in °F that you want simulate the thermostat reaching. You must set `temperature_fahrenheit` or `temperature_celsius`.',
34535
34637
  format: 'float',
34536
34638
  type: 'number',
34537
34639
  },
@@ -34876,7 +34978,7 @@ export default {
34876
34978
  {
34877
34979
  properties: {
34878
34980
  user_identity_id: {
34879
- description: 'ID of user identity for whom access is being granted.',
34981
+ description: 'ID of user identity for whom you want to grant access.',
34880
34982
  format: 'uuid',
34881
34983
  type: 'string',
34882
34984
  },
@@ -34887,7 +34989,7 @@ export default {
34887
34989
  {
34888
34990
  properties: {
34889
34991
  user_identity: {
34890
- description: 'When used, creates a new user identity with the given details, and grants them access.',
34992
+ description: 'User identity. When used, creates a new user identity with the specified details and grants them access.',
34891
34993
  properties: {
34892
34994
  email_address: {
34893
34995
  description: 'Unique email address for the user identity.',
@@ -34918,13 +35020,13 @@ export default {
34918
35020
  properties: {
34919
35021
  acs_entrance_ids: {
34920
35022
  default: [],
34921
- description: 'Set of IDs of the [entrances](https://docs.seam.co/latest/api/acs/systems/list) to which access is being granted.',
35023
+ description: 'IDs of the [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to which you want to grant access.',
34922
35024
  items: { format: 'uuid', type: 'string' },
34923
35025
  type: 'array',
34924
35026
  },
34925
35027
  device_ids: {
34926
35028
  default: [],
34927
- description: 'Set of IDs of the [devices](https://docs.seam.co/latest/api/devices/list) to which access is being granted.',
35029
+ description: 'IDs of the devices to which you want to grant access.',
34928
35030
  items: { format: 'uuid', type: 'string' },
34929
35031
  type: 'array',
34930
35032
  },
@@ -34934,7 +35036,7 @@ export default {
34934
35036
  type: 'string',
34935
35037
  },
34936
35038
  location: {
34937
- description: 'When used, creates a new location with the given entrances and devices, and gives the user access to this location.',
35039
+ description: 'Location. When used, creates a new location with the specified entrances and devices, and gives the user access to this location.',
34938
35040
  properties: {
34939
35041
  acs_entrance_ids: {
34940
35042
  default: [],
@@ -34967,7 +35069,7 @@ export default {
34967
35069
  items: {
34968
35070
  properties: {
34969
35071
  mode: {
34970
- description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
35072
+ description: 'Access method mode.',
34971
35073
  enum: ['code', 'card', 'mobile_key'],
34972
35074
  type: 'string',
34973
35075
  },
@@ -34978,7 +35080,7 @@ export default {
34978
35080
  type: 'array',
34979
35081
  },
34980
35082
  space_ids: {
34981
- description: 'Set of IDs of existing spaces to which access is being granted.',
35083
+ description: 'IDs of the existing spaces to which you want to grant access.',
34982
35084
  items: { format: 'uuid', type: 'string' },
34983
35085
  type: 'array',
34984
35086
  },
@@ -35124,7 +35226,7 @@ export default {
35124
35226
  },
35125
35227
  '/unstable_access_grants/delete': {
35126
35228
  post: {
35127
- description: 'Delete an access grant.',
35229
+ description: 'Deletes an access grant.',
35128
35230
  operationId: 'unstableAccessGrantsDeletePost',
35129
35231
  requestBody: {
35130
35232
  content: {
@@ -35132,7 +35234,7 @@ export default {
35132
35234
  schema: {
35133
35235
  properties: {
35134
35236
  access_grant_id: {
35135
- description: 'ID of access grant to delete.',
35237
+ description: 'ID of access grant that you want to delete.',
35136
35238
  format: 'uuid',
35137
35239
  type: 'string',
35138
35240
  },
@@ -35176,7 +35278,7 @@ export default {
35176
35278
  },
35177
35279
  '/unstable_access_grants/get': {
35178
35280
  post: {
35179
- description: 'Get an access grant.',
35281
+ description: 'Gets an access grant.',
35180
35282
  operationId: 'unstableAccessGrantsGetPost',
35181
35283
  requestBody: {
35182
35284
  content: {
@@ -35184,7 +35286,7 @@ export default {
35184
35286
  schema: {
35185
35287
  properties: {
35186
35288
  access_grant_id: {
35187
- description: 'ID of access grant to get.',
35289
+ description: 'ID of access grant that you want to get.',
35188
35290
  format: 'uuid',
35189
35291
  type: 'string',
35190
35292
  },
@@ -35323,7 +35425,7 @@ export default {
35323
35425
  },
35324
35426
  '/unstable_access_grants/list': {
35325
35427
  post: {
35326
- description: 'Get an access grant.',
35428
+ description: 'Returns a list of all access grants.',
35327
35429
  operationId: 'unstableAccessGrantsListPost',
35328
35430
  requestBody: {
35329
35431
  content: {
@@ -35331,12 +35433,12 @@ export default {
35331
35433
  schema: {
35332
35434
  properties: {
35333
35435
  acs_entrance_id: {
35334
- description: 'ID of entrance to filter list of access grants by.',
35436
+ description: 'ID of the entrance by which you want to filter the list of access grants.',
35335
35437
  format: 'uuid',
35336
35438
  type: 'string',
35337
35439
  },
35338
35440
  acs_system_id: {
35339
- description: 'ID of system to filter list of access grants by.',
35441
+ description: 'ID of the access system by which you want to filter the list of access grants.',
35340
35442
  format: 'uuid',
35341
35443
  type: 'string',
35342
35444
  },
@@ -35347,12 +35449,12 @@ export default {
35347
35449
  'x-deprecated': 'Use `space_id`.',
35348
35450
  },
35349
35451
  space_id: {
35350
- description: 'ID of space to filter list of access grants by.',
35452
+ description: 'ID of the space by which you want to filter the list of access grants.',
35351
35453
  format: 'uuid',
35352
35454
  type: 'string',
35353
35455
  },
35354
35456
  user_identity_id: {
35355
- description: 'ID of user identity to filter list of access grants by.',
35457
+ description: 'ID of the user identity by which you want to filter the list of access grants.',
35356
35458
  format: 'uuid',
35357
35459
  type: 'string',
35358
35460
  },
@@ -35493,7 +35595,7 @@ export default {
35493
35595
  },
35494
35596
  '/unstable_access_methods/delete': {
35495
35597
  post: {
35496
- description: 'Delete an access method.',
35598
+ description: 'Deletes an access method.',
35497
35599
  operationId: 'unstableAccessMethodsDeletePost',
35498
35600
  requestBody: {
35499
35601
  content: {
@@ -35501,7 +35603,7 @@ export default {
35501
35603
  schema: {
35502
35604
  properties: {
35503
35605
  access_method_id: {
35504
- description: 'ID of access method to get.',
35606
+ description: 'ID of the access method that you want to delete.',
35505
35607
  format: 'uuid',
35506
35608
  type: 'string',
35507
35609
  },
@@ -35544,7 +35646,7 @@ export default {
35544
35646
  },
35545
35647
  '/unstable_access_methods/get': {
35546
35648
  post: {
35547
- description: 'Get an access method.',
35649
+ description: 'Gets an access method.',
35548
35650
  operationId: 'unstableAccessMethodsGetPost',
35549
35651
  requestBody: {
35550
35652
  content: {
@@ -35552,7 +35654,7 @@ export default {
35552
35654
  schema: {
35553
35655
  properties: {
35554
35656
  access_method_id: {
35555
- description: 'ID of access method to get.',
35657
+ description: 'ID of the access method that you want to get.',
35556
35658
  format: 'uuid',
35557
35659
  type: 'string',
35558
35660
  },
@@ -35649,7 +35751,7 @@ export default {
35649
35751
  },
35650
35752
  '/unstable_access_methods/list': {
35651
35753
  post: {
35652
- description: 'List all access methods, usually filtered by access grant.',
35754
+ description: 'Lists all access methods, usually filtered by access grant.',
35653
35755
  operationId: 'unstableAccessMethodsListPost',
35654
35756
  requestBody: {
35655
35757
  content: {
@@ -35657,7 +35759,7 @@ export default {
35657
35759
  schema: {
35658
35760
  properties: {
35659
35761
  access_grant_id: {
35660
- description: 'ID of access grant to list access methods for.',
35762
+ description: 'ID of the access grant by which to filter the list of access methods.',
35661
35763
  format: 'uuid',
35662
35764
  type: 'string',
35663
35765
  },
@@ -35757,7 +35859,7 @@ export default {
35757
35859
  },
35758
35860
  '/unstable_locations/add_acs_entrances': {
35759
35861
  post: {
35760
- description: 'Add entrances to a specific location.',
35862
+ description: 'Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific location.',
35761
35863
  operationId: 'unstableLocationsAddAcsEntrancesPost',
35762
35864
  requestBody: {
35763
35865
  content: {
@@ -35765,11 +35867,16 @@ export default {
35765
35867
  schema: {
35766
35868
  properties: {
35767
35869
  acs_entrance_ids: {
35870
+ description: 'IDs of the entrances that you want to add to the location.',
35768
35871
  items: { format: 'uuid', type: 'string' },
35769
35872
  minItems: 1,
35770
35873
  type: 'array',
35771
35874
  },
35772
- location_id: { format: 'uuid', type: 'string' },
35875
+ location_id: {
35876
+ description: 'ID of the location to which you want to add entrances.',
35877
+ format: 'uuid',
35878
+ type: 'string',
35879
+ },
35773
35880
  },
35774
35881
  required: ['location_id', 'acs_entrance_ids'],
35775
35882
  type: 'object',
@@ -35803,11 +35910,11 @@ export default {
35803
35910
  'x-fern-sdk-group-name': ['unstable_locations'],
35804
35911
  'x-fern-sdk-method-name': 'add_acs_entrances',
35805
35912
  'x-response-key': null,
35806
- 'x-title': 'Add ACS Entrances',
35913
+ 'x-title': 'Add Entrances to a Location',
35807
35914
  'x-undocumented': 'Experimental locations.',
35808
35915
  },
35809
35916
  put: {
35810
- description: 'Add entrances to a specific location.',
35917
+ description: 'Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific location.',
35811
35918
  operationId: 'unstableLocationsAddAcsEntrancesPut',
35812
35919
  requestBody: {
35813
35920
  content: {
@@ -35815,11 +35922,16 @@ export default {
35815
35922
  schema: {
35816
35923
  properties: {
35817
35924
  acs_entrance_ids: {
35925
+ description: 'IDs of the entrances that you want to add to the location.',
35818
35926
  items: { format: 'uuid', type: 'string' },
35819
35927
  minItems: 1,
35820
35928
  type: 'array',
35821
35929
  },
35822
- location_id: { format: 'uuid', type: 'string' },
35930
+ location_id: {
35931
+ description: 'ID of the location to which you want to add entrances.',
35932
+ format: 'uuid',
35933
+ type: 'string',
35934
+ },
35823
35935
  },
35824
35936
  required: ['location_id', 'acs_entrance_ids'],
35825
35937
  type: 'object',
@@ -35852,13 +35964,13 @@ export default {
35852
35964
  tags: [],
35853
35965
  'x-fern-ignore': true,
35854
35966
  'x-response-key': null,
35855
- 'x-title': 'Add ACS Entrances',
35967
+ 'x-title': 'Add Entrances to a Location',
35856
35968
  'x-undocumented': 'Experimental locations.',
35857
35969
  },
35858
35970
  },
35859
35971
  '/unstable_locations/add_devices': {
35860
35972
  post: {
35861
- description: 'Add devices to a specific location.',
35973
+ description: 'Adds devices to a specific location.',
35862
35974
  operationId: 'unstableLocationsAddDevicesPost',
35863
35975
  requestBody: {
35864
35976
  content: {
@@ -35866,11 +35978,16 @@ export default {
35866
35978
  schema: {
35867
35979
  properties: {
35868
35980
  device_ids: {
35981
+ description: 'IDs of the devices that you want to add to the location.',
35869
35982
  items: { format: 'uuid', type: 'string' },
35870
35983
  minItems: 1,
35871
35984
  type: 'array',
35872
35985
  },
35873
- location_id: { format: 'uuid', type: 'string' },
35986
+ location_id: {
35987
+ description: 'ID of the location to which you want to add devices.',
35988
+ format: 'uuid',
35989
+ type: 'string',
35990
+ },
35874
35991
  },
35875
35992
  required: ['location_id', 'device_ids'],
35876
35993
  type: 'object',
@@ -35904,11 +36021,11 @@ export default {
35904
36021
  'x-fern-sdk-group-name': ['unstable_locations'],
35905
36022
  'x-fern-sdk-method-name': 'add_devices',
35906
36023
  'x-response-key': null,
35907
- 'x-title': 'Add Location Devices',
36024
+ 'x-title': 'Add Devices to a Location',
35908
36025
  'x-undocumented': 'Experimental locations.',
35909
36026
  },
35910
36027
  put: {
35911
- description: 'Add devices to a specific location.',
36028
+ description: 'Adds devices to a specific location.',
35912
36029
  operationId: 'unstableLocationsAddDevicesPut',
35913
36030
  requestBody: {
35914
36031
  content: {
@@ -35916,11 +36033,16 @@ export default {
35916
36033
  schema: {
35917
36034
  properties: {
35918
36035
  device_ids: {
36036
+ description: 'IDs of the devices that you want to add to the location.',
35919
36037
  items: { format: 'uuid', type: 'string' },
35920
36038
  minItems: 1,
35921
36039
  type: 'array',
35922
36040
  },
35923
- location_id: { format: 'uuid', type: 'string' },
36041
+ location_id: {
36042
+ description: 'ID of the location to which you want to add devices.',
36043
+ format: 'uuid',
36044
+ type: 'string',
36045
+ },
35924
36046
  },
35925
36047
  required: ['location_id', 'device_ids'],
35926
36048
  type: 'object',
@@ -35953,13 +36075,13 @@ export default {
35953
36075
  tags: [],
35954
36076
  'x-fern-ignore': true,
35955
36077
  'x-response-key': null,
35956
- 'x-title': 'Add Location Devices',
36078
+ 'x-title': 'Add Devices to a Location',
35957
36079
  'x-undocumented': 'Experimental locations.',
35958
36080
  },
35959
36081
  },
35960
36082
  '/unstable_locations/create': {
35961
36083
  post: {
35962
- description: 'Create a new location.',
36084
+ description: 'Creates a new location.',
35963
36085
  operationId: 'unstableLocationsCreatePost',
35964
36086
  requestBody: {
35965
36087
  content: {
@@ -35967,14 +36089,17 @@ export default {
35967
36089
  schema: {
35968
36090
  properties: {
35969
36091
  acs_entrance_ids: {
36092
+ description: 'IDs of the entrances that you want to add to the new location.',
35970
36093
  items: { format: 'uuid', type: 'string' },
35971
36094
  type: 'array',
35972
36095
  },
35973
36096
  device_ids: {
36097
+ description: 'IDs of the devices that you want to add to the new location.',
35974
36098
  items: { format: 'uuid', type: 'string' },
35975
36099
  type: 'array',
35976
36100
  },
35977
36101
  geolocation: {
36102
+ description: 'Geolocation of the new location.',
35978
36103
  properties: {
35979
36104
  latitude: { format: 'float', type: 'number' },
35980
36105
  longitude: { format: 'float', type: 'number' },
@@ -35982,8 +36107,14 @@ export default {
35982
36107
  required: ['latitude', 'longitude'],
35983
36108
  type: 'object',
35984
36109
  },
35985
- name: { type: 'string' },
35986
- time_zone: { type: 'string' },
36110
+ name: {
36111
+ description: 'Name of the new location.',
36112
+ type: 'string',
36113
+ },
36114
+ time_zone: {
36115
+ description: 'Time zone of the new location.',
36116
+ type: 'string',
36117
+ },
35987
36118
  },
35988
36119
  required: ['name'],
35989
36120
  type: 'object',
@@ -36068,19 +36199,25 @@ export default {
36068
36199
  'x-fern-sdk-method-name': 'create',
36069
36200
  'x-fern-sdk-return-value': 'location',
36070
36201
  'x-response-key': 'location',
36071
- 'x-title': 'Create Location',
36202
+ 'x-title': 'Create a Location',
36072
36203
  'x-undocumented': 'Experimental locations.',
36073
36204
  },
36074
36205
  },
36075
36206
  '/unstable_locations/delete': {
36076
36207
  post: {
36077
- description: 'Delete a location.',
36208
+ description: 'Deletes a location.',
36078
36209
  operationId: 'unstableLocationsDeletePost',
36079
36210
  requestBody: {
36080
36211
  content: {
36081
36212
  'application/json': {
36082
36213
  schema: {
36083
- properties: { location_id: { format: 'uuid', type: 'string' } },
36214
+ properties: {
36215
+ location_id: {
36216
+ description: 'ID of the location that you want to delete.',
36217
+ format: 'uuid',
36218
+ type: 'string',
36219
+ },
36220
+ },
36084
36221
  required: ['location_id'],
36085
36222
  type: 'object',
36086
36223
  },
@@ -36113,19 +36250,25 @@ export default {
36113
36250
  'x-fern-sdk-group-name': ['unstable_locations'],
36114
36251
  'x-fern-sdk-method-name': 'delete',
36115
36252
  'x-response-key': null,
36116
- 'x-title': 'Delete Location',
36253
+ 'x-title': 'Delete a Location',
36117
36254
  'x-undocumented': 'Experimental locations.',
36118
36255
  },
36119
36256
  },
36120
36257
  '/unstable_locations/get': {
36121
36258
  post: {
36122
- description: 'Get a location.',
36259
+ description: 'Gets a location.',
36123
36260
  operationId: 'unstableLocationsGetPost',
36124
36261
  requestBody: {
36125
36262
  content: {
36126
36263
  'application/json': {
36127
36264
  schema: {
36128
- properties: { location_id: { format: 'uuid', type: 'string' } },
36265
+ properties: {
36266
+ location_id: {
36267
+ description: 'ID of the location that you want to get.',
36268
+ format: 'uuid',
36269
+ type: 'string',
36270
+ },
36271
+ },
36129
36272
  required: ['location_id'],
36130
36273
  type: 'object',
36131
36274
  },
@@ -36209,7 +36352,7 @@ export default {
36209
36352
  'x-fern-sdk-method-name': 'get',
36210
36353
  'x-fern-sdk-return-value': 'location',
36211
36354
  'x-response-key': 'location',
36212
- 'x-title': 'Get Location',
36355
+ 'x-title': 'Get a Location',
36213
36356
  'x-undocumented': 'Experimental locations.',
36214
36357
  },
36215
36358
  },
@@ -36387,7 +36530,7 @@ export default {
36387
36530
  },
36388
36531
  '/unstable_locations/remove_acs_entrances': {
36389
36532
  post: {
36390
- description: 'Remove entrances from a specific location.',
36533
+ description: 'Removes entrances from a specific location.',
36391
36534
  operationId: 'unstableLocationsRemoveAcsEntrancesPost',
36392
36535
  requestBody: {
36393
36536
  content: {
@@ -36395,10 +36538,15 @@ export default {
36395
36538
  schema: {
36396
36539
  properties: {
36397
36540
  acs_entrance_ids: {
36541
+ description: 'IDs of the entrances that you want to remove from the location.',
36398
36542
  items: { format: 'uuid', type: 'string' },
36399
36543
  type: 'array',
36400
36544
  },
36401
- location_id: { format: 'uuid', type: 'string' },
36545
+ location_id: {
36546
+ description: 'ID of the location from which you want to remove entrances.',
36547
+ format: 'uuid',
36548
+ type: 'string',
36549
+ },
36402
36550
  },
36403
36551
  required: ['location_id', 'acs_entrance_ids'],
36404
36552
  type: 'object',
@@ -36432,13 +36580,13 @@ export default {
36432
36580
  'x-fern-sdk-group-name': ['unstable_locations'],
36433
36581
  'x-fern-sdk-method-name': 'remove_acs_entrances',
36434
36582
  'x-response-key': null,
36435
- 'x-title': 'Remove ACS Entrances',
36583
+ 'x-title': 'Remove Entrances from a Location',
36436
36584
  'x-undocumented': 'Experimental locations.',
36437
36585
  },
36438
36586
  },
36439
36587
  '/unstable_locations/remove_devices': {
36440
36588
  post: {
36441
- description: 'Remove devices from a specific location.',
36589
+ description: 'Removes devices from a specific location.',
36442
36590
  operationId: 'unstableLocationsRemoveDevicesPost',
36443
36591
  requestBody: {
36444
36592
  content: {
@@ -36446,10 +36594,15 @@ export default {
36446
36594
  schema: {
36447
36595
  properties: {
36448
36596
  device_ids: {
36597
+ description: 'IDs of the devices that you want to remove from the location.',
36449
36598
  items: { format: 'uuid', type: 'string' },
36450
36599
  type: 'array',
36451
36600
  },
36452
- location_id: { format: 'uuid', type: 'string' },
36601
+ location_id: {
36602
+ description: 'ID of the location from which you want to remove devices.',
36603
+ format: 'uuid',
36604
+ type: 'string',
36605
+ },
36453
36606
  },
36454
36607
  required: ['location_id', 'device_ids'],
36455
36608
  type: 'object',
@@ -36483,13 +36636,13 @@ export default {
36483
36636
  'x-fern-sdk-group-name': ['unstable_locations'],
36484
36637
  'x-fern-sdk-method-name': 'remove_devices',
36485
36638
  'x-response-key': null,
36486
- 'x-title': 'Remove Location Devices',
36639
+ 'x-title': 'Remove Devices from a Location',
36487
36640
  'x-undocumented': 'Experimental locations.',
36488
36641
  },
36489
36642
  },
36490
36643
  '/unstable_locations/update': {
36491
36644
  patch: {
36492
- description: 'Update an existing location.',
36645
+ description: 'Updates a location.',
36493
36646
  operationId: 'unstableLocationsUpdatePatch',
36494
36647
  requestBody: {
36495
36648
  content: {
@@ -36497,6 +36650,7 @@ export default {
36497
36650
  schema: {
36498
36651
  properties: {
36499
36652
  geolocation: {
36653
+ description: 'Geolocation of the location.',
36500
36654
  properties: {
36501
36655
  latitude: { format: 'float', type: 'number' },
36502
36656
  longitude: { format: 'float', type: 'number' },
@@ -36504,9 +36658,19 @@ export default {
36504
36658
  required: ['latitude', 'longitude'],
36505
36659
  type: 'object',
36506
36660
  },
36507
- location_id: { format: 'uuid', type: 'string' },
36508
- name: { type: 'string' },
36509
- time_zone: { type: 'string' },
36661
+ location_id: {
36662
+ description: 'ID of the location that you want to update.',
36663
+ format: 'uuid',
36664
+ type: 'string',
36665
+ },
36666
+ name: {
36667
+ description: 'Name of the location.',
36668
+ type: 'string',
36669
+ },
36670
+ time_zone: {
36671
+ description: 'Time zone of the the location.',
36672
+ type: 'string',
36673
+ },
36510
36674
  },
36511
36675
  required: ['location_id'],
36512
36676
  type: 'object',
@@ -36589,11 +36753,11 @@ export default {
36589
36753
  tags: [],
36590
36754
  'x-fern-ignore': true,
36591
36755
  'x-response-key': 'location',
36592
- 'x-title': 'Update Location',
36756
+ 'x-title': 'Update a Location',
36593
36757
  'x-undocumented': 'Experimental locations.',
36594
36758
  },
36595
36759
  post: {
36596
- description: 'Update an existing location.',
36760
+ description: 'Updates a location.',
36597
36761
  operationId: 'unstableLocationsUpdatePost',
36598
36762
  requestBody: {
36599
36763
  content: {
@@ -36601,6 +36765,7 @@ export default {
36601
36765
  schema: {
36602
36766
  properties: {
36603
36767
  geolocation: {
36768
+ description: 'Geolocation of the location.',
36604
36769
  properties: {
36605
36770
  latitude: { format: 'float', type: 'number' },
36606
36771
  longitude: { format: 'float', type: 'number' },
@@ -36608,9 +36773,19 @@ export default {
36608
36773
  required: ['latitude', 'longitude'],
36609
36774
  type: 'object',
36610
36775
  },
36611
- location_id: { format: 'uuid', type: 'string' },
36612
- name: { type: 'string' },
36613
- time_zone: { type: 'string' },
36776
+ location_id: {
36777
+ description: 'ID of the location that you want to update.',
36778
+ format: 'uuid',
36779
+ type: 'string',
36780
+ },
36781
+ name: {
36782
+ description: 'Name of the location.',
36783
+ type: 'string',
36784
+ },
36785
+ time_zone: {
36786
+ description: 'Time zone of the the location.',
36787
+ type: 'string',
36788
+ },
36614
36789
  },
36615
36790
  required: ['location_id'],
36616
36791
  type: 'object',
@@ -36695,7 +36870,7 @@ export default {
36695
36870
  'x-fern-sdk-method-name': 'update',
36696
36871
  'x-fern-sdk-return-value': 'location',
36697
36872
  'x-response-key': 'location',
36698
- 'x-title': 'Update Location',
36873
+ 'x-title': 'Update a Location',
36699
36874
  'x-undocumented': 'Experimental locations.',
36700
36875
  },
36701
36876
  },
@@ -36707,7 +36882,12 @@ export default {
36707
36882
  content: {
36708
36883
  'application/json': {
36709
36884
  schema: {
36710
- properties: { customer_key: { type: 'string' } },
36885
+ properties: {
36886
+ customer_key: {
36887
+ description: 'Customer key for which you want to connect accounts.',
36888
+ type: 'string',
36889
+ },
36890
+ },
36711
36891
  required: ['customer_key'],
36712
36892
  type: 'object',
36713
36893
  },
@@ -36744,7 +36924,7 @@ export default {
36744
36924
  'x-fern-sdk-method-name': 'connect_accounts',
36745
36925
  'x-fern-sdk-return-value': 'magic_link',
36746
36926
  'x-response-key': 'magic_link',
36747
- 'x-title': 'Connect Accounts',
36927
+ 'x-title': 'Generate a Connect Accounts Building Block Magic Link',
36748
36928
  'x-undocumented': 'Experimental partner building blocks.',
36749
36929
  },
36750
36930
  },
@@ -36756,60 +36936,43 @@ export default {
36756
36936
  content: {
36757
36937
  'application/json': {
36758
36938
  schema: {
36759
- oneOf: [
36760
- {
36761
- properties: {
36762
- building_block_type: {
36763
- enum: ['connect_accounts'],
36764
- type: 'string',
36765
- },
36766
- customer_key: { type: 'string' },
36767
- },
36768
- required: ['building_block_type', 'customer_key'],
36769
- type: 'object',
36939
+ properties: {
36940
+ building_block_type: {
36941
+ description: 'Type of building block to create a magic link for.',
36942
+ enum: [
36943
+ 'connect_accounts',
36944
+ 'organize_spaces',
36945
+ 'console',
36946
+ 'manage_devices',
36947
+ ],
36948
+ type: 'string',
36770
36949
  },
36771
- {
36772
- properties: {
36773
- building_block_type: {
36774
- enum: ['manage_devices'],
36775
- type: 'string',
36776
- },
36777
- customer_key: { type: 'string' },
36778
- },
36779
- required: ['building_block_type', 'customer_key'],
36780
- type: 'object',
36950
+ customer_key: {
36951
+ description: 'Customer key for which you want to create a new building block magic link.',
36952
+ type: 'string',
36781
36953
  },
36782
- {
36783
- properties: {
36784
- building_block_type: {
36785
- enum: ['organize_spaces'],
36786
- type: 'string',
36787
- },
36788
- customer_key: { type: 'string' },
36789
- partner_resources: {
36790
- description: 'Optional list of partner resources to include in the magic link.',
36791
- items: {
36792
- properties: {
36793
- custom_metadata: {
36794
- additionalProperties: { type: 'string' },
36795
- type: 'object',
36796
- },
36797
- description: { type: 'string' },
36798
- name: { type: 'string' },
36799
- partner_resource_key: { type: 'string' },
36800
- },
36801
- required: ['partner_resource_key', 'name'],
36954
+ spaces: {
36955
+ description: 'Optional list of spaces that you want to include in the new building block magic link.',
36956
+ items: {
36957
+ properties: {
36958
+ custom_metadata: {
36959
+ additionalProperties: { type: 'string' },
36802
36960
  type: 'object',
36803
- 'x-route-path': '/unstable_partner/resources',
36804
- 'x-undocumented': 'Unreleased.',
36805
36961
  },
36806
- type: 'array',
36962
+ description: { type: 'string' },
36963
+ name: { type: 'string' },
36964
+ space_key: { type: 'string' },
36807
36965
  },
36966
+ required: ['space_key', 'name'],
36967
+ type: 'object',
36968
+ 'x-route-path': '/unstable_partner/resources',
36969
+ 'x-undocumented': 'Unreleased.',
36808
36970
  },
36809
- required: ['building_block_type', 'customer_key'],
36810
- type: 'object',
36971
+ type: 'array',
36811
36972
  },
36812
- ],
36973
+ },
36974
+ required: ['building_block_type', 'customer_key'],
36975
+ type: 'object',
36813
36976
  },
36814
36977
  },
36815
36978
  },
@@ -36844,7 +37007,7 @@ export default {
36844
37007
  'x-fern-sdk-method-name': 'generate_magic_link',
36845
37008
  'x-fern-sdk-return-value': 'magic_link',
36846
37009
  'x-response-key': 'magic_link',
36847
- 'x-title': 'Generate a building block magic link',
37010
+ 'x-title': 'Generate a Building Block Magic Link',
36848
37011
  'x-undocumented': 'Experimental partner building blocks.',
36849
37012
  },
36850
37013
  },
@@ -36856,7 +37019,12 @@ export default {
36856
37019
  content: {
36857
37020
  'application/json': {
36858
37021
  schema: {
36859
- properties: { customer_key: { type: 'string' } },
37022
+ properties: {
37023
+ customer_key: {
37024
+ description: 'Customer key for which you want to manage devices.',
37025
+ type: 'string',
37026
+ },
37027
+ },
36860
37028
  required: ['customer_key'],
36861
37029
  type: 'object',
36862
37030
  },
@@ -36893,7 +37061,7 @@ export default {
36893
37061
  'x-fern-sdk-method-name': 'manage_devices',
36894
37062
  'x-fern-sdk-return-value': 'magic_link',
36895
37063
  'x-response-key': 'magic_link',
36896
- 'x-title': 'Manage Devices',
37064
+ 'x-title': 'Generate a Manage Devices Building Block Magic Link',
36897
37065
  'x-undocumented': 'Experimental partner building blocks.',
36898
37066
  },
36899
37067
  },
@@ -36906,8 +37074,12 @@ export default {
36906
37074
  'application/json': {
36907
37075
  schema: {
36908
37076
  properties: {
36909
- customer_key: { type: 'string' },
36910
- partner_resources: {
37077
+ customer_key: {
37078
+ description: 'Customer key for which you want to organize spaces.',
37079
+ type: 'string',
37080
+ },
37081
+ spaces: {
37082
+ description: 'Optional list of spaces that you want to include in the new building block magic link.',
36911
37083
  items: {
36912
37084
  properties: {
36913
37085
  custom_metadata: {
@@ -36916,9 +37088,9 @@ export default {
36916
37088
  },
36917
37089
  description: { type: 'string' },
36918
37090
  name: { type: 'string' },
36919
- partner_resource_key: { type: 'string' },
37091
+ space_key: { type: 'string' },
36920
37092
  },
36921
- required: ['partner_resource_key', 'name'],
37093
+ required: ['space_key', 'name'],
36922
37094
  type: 'object',
36923
37095
  'x-route-path': '/unstable_partner/resources',
36924
37096
  'x-undocumented': 'Unreleased.',
@@ -36962,13 +37134,13 @@ export default {
36962
37134
  'x-fern-sdk-method-name': 'organize_spaces',
36963
37135
  'x-fern-sdk-return-value': 'magic_link',
36964
37136
  'x-response-key': 'magic_link',
36965
- 'x-title': 'Organize Spaces',
37137
+ 'x-title': 'Generate an Organize Spaces Building Block Magic Link',
36966
37138
  'x-undocumented': 'Experimental partner building blocks.',
36967
37139
  },
36968
37140
  },
36969
37141
  '/unstable_partner/resources/push': {
36970
37142
  post: {
36971
- description: 'Send Seam some of your resources.',
37143
+ description: 'Sends Seam some of your resources.',
36972
37144
  operationId: 'unstablePartnerResourcesPushPost',
36973
37145
  requestBody: {
36974
37146
  content: {
@@ -36982,7 +37154,10 @@ export default {
36982
37154
  additionalProperties: { type: 'string' },
36983
37155
  type: 'object',
36984
37156
  },
36985
- customer_key: { type: 'string' },
37157
+ customer_key: {
37158
+ description: 'Customer key associated with the resource that you want to push to Seam.',
37159
+ type: 'string',
37160
+ },
36986
37161
  description: { type: 'string' },
36987
37162
  email_address: { type: 'string' },
36988
37163
  ends_at: { type: 'string' },
@@ -36991,8 +37166,14 @@ export default {
36991
37166
  type: 'array',
36992
37167
  },
36993
37168
  name: { type: 'string' },
36994
- partner_resource_key: { type: 'string' },
36995
- partner_resource_type: { type: 'string' },
37169
+ partner_resource_key: {
37170
+ description: 'Key of the resource that you want to push to Seam.',
37171
+ type: 'string',
37172
+ },
37173
+ partner_resource_type: {
37174
+ description: 'Type of the resource that you want to push to Seam.',
37175
+ type: 'string',
37176
+ },
36996
37177
  phone_number: { type: 'string' },
36997
37178
  starts_at: { type: 'string' },
36998
37179
  user_identity_key: { type: 'string' },
@@ -37009,7 +37190,10 @@ export default {
37009
37190
  additionalProperties: { type: 'string' },
37010
37191
  type: 'object',
37011
37192
  },
37012
- customer_key: { type: 'string' },
37193
+ customer_key: {
37194
+ description: 'Customer key associated with the resource that you want to push to Seam.',
37195
+ type: 'string',
37196
+ },
37013
37197
  description: { type: 'string' },
37014
37198
  email_address: { type: 'string' },
37015
37199
  ends_at: { type: 'string' },
@@ -37018,8 +37202,14 @@ export default {
37018
37202
  type: 'array',
37019
37203
  },
37020
37204
  name: { type: 'string' },
37021
- partner_resource_key: { type: 'string' },
37022
- partner_resource_type: { type: 'string' },
37205
+ partner_resource_key: {
37206
+ description: 'Key of the resource that you want to push to Seam.',
37207
+ type: 'string',
37208
+ },
37209
+ partner_resource_type: {
37210
+ description: 'Type of the resource that you want to push to Seam.',
37211
+ type: 'string',
37212
+ },
37023
37213
  phone_number: { type: 'string' },
37024
37214
  starts_at: { type: 'string' },
37025
37215
  user_identity_key: { type: 'string' },
@@ -37059,13 +37249,13 @@ export default {
37059
37249
  'x-fern-sdk-group-name': ['unstable_partner', 'resources'],
37060
37250
  'x-fern-sdk-method-name': 'push',
37061
37251
  'x-response-key': null,
37062
- 'x-title': 'Push partner resources at Seam',
37252
+ 'x-title': 'Push Partner Resources at Seam',
37063
37253
  'x-undocumented': 'Experimental partner resources.',
37064
37254
  },
37065
37255
  },
37066
37256
  '/user_identities/add_acs_user': {
37067
37257
  post: {
37068
- 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).',
37258
+ 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).',
37069
37259
  operationId: 'userIdentitiesAddAcsUserPost',
37070
37260
  requestBody: {
37071
37261
  content: {
@@ -37073,12 +37263,12 @@ export default {
37073
37263
  schema: {
37074
37264
  properties: {
37075
37265
  acs_user_id: {
37076
- description: 'ID of the desired ACS user.',
37266
+ description: 'ID of the access system user that you want to add to the user identity.',
37077
37267
  format: 'uuid',
37078
37268
  type: 'string',
37079
37269
  },
37080
37270
  user_identity_id: {
37081
- description: 'ID of the desired user identity.',
37271
+ description: 'ID of the user identity to which you want to add an access system user.',
37082
37272
  format: 'uuid',
37083
37273
  type: 'string',
37084
37274
  },
@@ -37118,7 +37308,7 @@ export default {
37118
37308
  'x-title': 'Add an ACS User to a User Identity',
37119
37309
  },
37120
37310
  put: {
37121
- 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).',
37311
+ 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).',
37122
37312
  operationId: 'userIdentitiesAddAcsUserPut',
37123
37313
  requestBody: {
37124
37314
  content: {
@@ -37126,12 +37316,12 @@ export default {
37126
37316
  schema: {
37127
37317
  properties: {
37128
37318
  acs_user_id: {
37129
- description: 'ID of the desired ACS user.',
37319
+ description: 'ID of the access system user that you want to add to the user identity.',
37130
37320
  format: 'uuid',
37131
37321
  type: 'string',
37132
37322
  },
37133
37323
  user_identity_id: {
37134
- description: 'ID of the desired user identity.',
37324
+ description: 'ID of the user identity to which you want to add an access system user.',
37135
37325
  format: 'uuid',
37136
37326
  type: 'string',
37137
37327
  },
@@ -37180,29 +37370,29 @@ export default {
37180
37370
  schema: {
37181
37371
  properties: {
37182
37372
  acs_system_ids: {
37183
- 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.",
37373
+ 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.",
37184
37374
  items: { format: 'uuid', type: 'string' },
37185
37375
  type: 'array',
37186
37376
  },
37187
37377
  email_address: {
37188
- description: 'Unique email address for the user identity.',
37378
+ description: 'Unique email address for the new user identity.',
37189
37379
  format: 'email',
37190
37380
  nullable: true,
37191
37381
  type: 'string',
37192
37382
  },
37193
37383
  full_name: {
37194
- description: 'Full name of the user associated with the user identity.',
37384
+ description: 'Full name of the user associated with the new user identity.',
37195
37385
  minLength: 1,
37196
37386
  nullable: true,
37197
37387
  type: 'string',
37198
37388
  },
37199
37389
  phone_number: {
37200
- description: 'Unique phone number for the user identity in E.164 format (for example, +15555550100).',
37390
+ description: 'Unique phone number for the new user identity in E.164 format (for example, +15555550100).',
37201
37391
  nullable: true,
37202
37392
  type: 'string',
37203
37393
  },
37204
37394
  user_identity_key: {
37205
- description: 'Unique key for the user identity.',
37395
+ description: 'Unique key for the new user identity.',
37206
37396
  minLength: 1,
37207
37397
  nullable: true,
37208
37398
  type: 'string',
@@ -37258,7 +37448,7 @@ export default {
37258
37448
  schema: {
37259
37449
  properties: {
37260
37450
  user_identity_id: {
37261
- description: 'ID of the desired user identity.',
37451
+ description: 'ID of the user identity that you want to delete.',
37262
37452
  format: 'uuid',
37263
37453
  type: 'string',
37264
37454
  },
@@ -37308,7 +37498,7 @@ export default {
37308
37498
  schema: {
37309
37499
  properties: {
37310
37500
  enrollment_automation_id: {
37311
- description: 'ID of the desired enrollment automation.',
37501
+ description: 'ID of the enrollment automation that you want to delete.',
37312
37502
  format: 'uuid',
37313
37503
  type: 'string',
37314
37504
  },
@@ -37358,7 +37548,7 @@ export default {
37358
37548
  schema: {
37359
37549
  properties: {
37360
37550
  enrollment_automation_id: {
37361
- description: 'ID of the desired enrollment automation.',
37551
+ description: 'ID of the enrollment automation that you want to get.',
37362
37552
  format: 'uuid',
37363
37553
  type: 'string',
37364
37554
  },
@@ -37415,7 +37605,7 @@ export default {
37415
37605
  schema: {
37416
37606
  properties: {
37417
37607
  acs_credential_pool_id: {
37418
- description: 'ID of the ACS credential pool from which to obtain credentials for the user identity.',
37608
+ description: 'ID of the credential pool from which to obtain credentials for the user identity.',
37419
37609
  format: 'uuid',
37420
37610
  type: 'string',
37421
37611
  },
@@ -37424,17 +37614,17 @@ export default {
37424
37614
  type: 'boolean',
37425
37615
  },
37426
37616
  credential_manager_acs_system_id: {
37427
- description: 'ID of the desired ACS system that serves as the credential manager.',
37617
+ description: 'ID of the desired access system that serves as the credential manager for the enrollment automation.',
37428
37618
  format: 'uuid',
37429
37619
  type: 'string',
37430
37620
  },
37431
37621
  credential_manager_acs_user_id: {
37432
- 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`.',
37622
+ 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`.',
37433
37623
  format: 'uuid',
37434
37624
  type: 'string',
37435
37625
  },
37436
37626
  user_identity_id: {
37437
- description: 'ID of the desired user identity.',
37627
+ description: 'ID of the user identity for which you want to launch an enrollment automation.',
37438
37628
  format: 'uuid',
37439
37629
  type: 'string',
37440
37630
  },
@@ -37518,7 +37708,7 @@ export default {
37518
37708
  schema: {
37519
37709
  properties: {
37520
37710
  user_identity_id: {
37521
- description: 'ID of the user identity for which you want to retrieve all enrollment automations.',
37711
+ description: 'ID of the user identity for which you want to retrieve enrollment automations.',
37522
37712
  format: 'uuid',
37523
37713
  type: 'string',
37524
37714
  },
@@ -37579,7 +37769,7 @@ export default {
37579
37769
  properties: {
37580
37770
  max_use_count: {
37581
37771
  default: 1,
37582
- description: 'The maximum number of times the instant key can be used. Defaults to 1.',
37772
+ description: 'Maximum number of times the instant key can be used. Default: 1.',
37583
37773
  format: 'float',
37584
37774
  type: 'number',
37585
37775
  },
@@ -37640,7 +37830,7 @@ export default {
37640
37830
  {
37641
37831
  properties: {
37642
37832
  user_identity_id: {
37643
- description: 'ID of the desired user identity.',
37833
+ description: 'ID of the user identity that you want to get.',
37644
37834
  format: 'uuid',
37645
37835
  type: 'string',
37646
37836
  },
@@ -37703,12 +37893,12 @@ export default {
37703
37893
  schema: {
37704
37894
  properties: {
37705
37895
  device_id: {
37706
- description: 'ID of the desired managed device.',
37896
+ description: 'ID of the managed device to which you want to grant access to the user identity.',
37707
37897
  format: 'uuid',
37708
37898
  type: 'string',
37709
37899
  },
37710
37900
  user_identity_id: {
37711
- description: 'ID of the desired user identity.',
37901
+ description: 'ID of the user identity that you want to grant access to a device.',
37712
37902
  format: 'uuid',
37713
37903
  type: 'string',
37714
37904
  },
@@ -37756,12 +37946,12 @@ export default {
37756
37946
  schema: {
37757
37947
  properties: {
37758
37948
  device_id: {
37759
- description: 'ID of the desired managed device.',
37949
+ description: 'ID of the managed device to which you want to grant access to the user identity.',
37760
37950
  format: 'uuid',
37761
37951
  type: 'string',
37762
37952
  },
37763
37953
  user_identity_id: {
37764
- description: 'ID of the desired user identity.',
37954
+ description: 'ID of the user identity that you want to grant access to a device.',
37765
37955
  format: 'uuid',
37766
37956
  type: 'string',
37767
37957
  },
@@ -37810,6 +38000,7 @@ export default {
37810
38000
  schema: {
37811
38001
  properties: {
37812
38002
  credential_manager_acs_system_id: {
38003
+ description: '`acs_system_id` of the credential manager by which you want to filter the list of user identities.',
37813
38004
  format: 'uuid',
37814
38005
  type: 'string',
37815
38006
  },
@@ -37887,7 +38078,7 @@ export default {
37887
38078
  deprecated: true,
37888
38079
  items: { $ref: '#/components/schemas/device' },
37889
38080
  type: 'array',
37890
- 'x-deprecated': 'use devices.',
38081
+ 'x-deprecated': 'Use devices.',
37891
38082
  },
37892
38083
  devices: {
37893
38084
  items: { $ref: '#/components/schemas/device' },
@@ -37921,7 +38112,7 @@ export default {
37921
38112
  },
37922
38113
  '/user_identities/list_acs_systems': {
37923
38114
  post: {
37924
- 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).',
38115
+ 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).',
37925
38116
  operationId: 'userIdentitiesListAcsSystemsPost',
37926
38117
  requestBody: {
37927
38118
  content: {
@@ -37929,7 +38120,7 @@ export default {
37929
38120
  schema: {
37930
38121
  properties: {
37931
38122
  user_identity_id: {
37932
- description: 'ID of the user identity for which you want to retrieve all access control systems.',
38123
+ description: 'ID of the user identity for which you want to retrieve all access systems.',
37933
38124
  format: 'uuid',
37934
38125
  type: 'string',
37935
38126
  },
@@ -37979,7 +38170,7 @@ export default {
37979
38170
  },
37980
38171
  '/user_identities/list_acs_users': {
37981
38172
  post: {
37982
- 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).',
38173
+ 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).',
37983
38174
  operationId: 'userIdentitiesListAcsUsersPost',
37984
38175
  requestBody: {
37985
38176
  content: {
@@ -37987,7 +38178,7 @@ export default {
37987
38178
  schema: {
37988
38179
  properties: {
37989
38180
  user_identity_id: {
37990
- description: 'ID of the user identity for which you want to retrieve all ACS users.',
38181
+ description: 'ID of the user identity for which you want to retrieve all access system users.',
37991
38182
  format: 'uuid',
37992
38183
  type: 'string',
37993
38184
  },
@@ -38036,7 +38227,7 @@ export default {
38036
38227
  },
38037
38228
  '/user_identities/remove_acs_user': {
38038
38229
  post: {
38039
- 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).',
38230
+ 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).',
38040
38231
  operationId: 'userIdentitiesRemoveAcsUserPost',
38041
38232
  requestBody: {
38042
38233
  content: {
@@ -38044,12 +38235,12 @@ export default {
38044
38235
  schema: {
38045
38236
  properties: {
38046
38237
  acs_user_id: {
38047
- description: 'ID of the ACS user.',
38238
+ description: 'ID of the access system user that you want to remove from the user identity..',
38048
38239
  format: 'uuid',
38049
38240
  type: 'string',
38050
38241
  },
38051
38242
  user_identity_id: {
38052
- description: 'ID of the desired user identity.',
38243
+ description: 'ID of the user identity from which you want to remove an access system user.',
38053
38244
  format: 'uuid',
38054
38245
  type: 'string',
38055
38246
  },
@@ -38099,12 +38290,12 @@ export default {
38099
38290
  schema: {
38100
38291
  properties: {
38101
38292
  device_id: {
38102
- description: 'ID of the desired managed device.',
38293
+ description: 'ID of the managed device to which you want to revoke access from the user identity.',
38103
38294
  format: 'uuid',
38104
38295
  type: 'string',
38105
38296
  },
38106
38297
  user_identity_id: {
38107
- description: 'ID of the desired user identity.',
38298
+ description: 'ID of the user identity from which you want to revoke access to a device.',
38108
38299
  format: 'uuid',
38109
38300
  type: 'string',
38110
38301
  },
@@ -38146,6 +38337,7 @@ export default {
38146
38337
  },
38147
38338
  '/user_identities/update': {
38148
38339
  patch: {
38340
+ 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).',
38149
38341
  operationId: 'userIdentitiesUpdatePatch',
38150
38342
  requestBody: {
38151
38343
  content: {
@@ -38158,14 +38350,19 @@ export default {
38158
38350
  nullable: true,
38159
38351
  type: 'string',
38160
38352
  },
38161
- full_name: { minLength: 1, nullable: true, type: 'string' },
38353
+ full_name: {
38354
+ description: 'Full name of the user associated with the user identity.',
38355
+ minLength: 1,
38356
+ nullable: true,
38357
+ type: 'string',
38358
+ },
38162
38359
  phone_number: {
38163
- 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).',
38360
+ description: 'Unique phone number for the user identity.',
38164
38361
  nullable: true,
38165
38362
  type: 'string',
38166
38363
  },
38167
38364
  user_identity_id: {
38168
- description: 'ID of the user identity.',
38365
+ description: 'ID of the user identity that you want to update.',
38169
38366
  format: 'uuid',
38170
38367
  type: 'string',
38171
38368
  },
@@ -38210,6 +38407,7 @@ export default {
38210
38407
  'x-title': 'Update a User Identity',
38211
38408
  },
38212
38409
  post: {
38410
+ 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).',
38213
38411
  operationId: 'userIdentitiesUpdatePost',
38214
38412
  requestBody: {
38215
38413
  content: {
@@ -38222,14 +38420,19 @@ export default {
38222
38420
  nullable: true,
38223
38421
  type: 'string',
38224
38422
  },
38225
- full_name: { minLength: 1, nullable: true, type: 'string' },
38423
+ full_name: {
38424
+ description: 'Full name of the user associated with the user identity.',
38425
+ minLength: 1,
38426
+ nullable: true,
38427
+ type: 'string',
38428
+ },
38226
38429
  phone_number: {
38227
- 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).',
38430
+ description: 'Unique phone number for the user identity.',
38228
38431
  nullable: true,
38229
38432
  type: 'string',
38230
38433
  },
38231
38434
  user_identity_id: {
38232
- description: 'ID of the user identity.',
38435
+ description: 'ID of the user identity that you want to update.',
38233
38436
  format: 'uuid',
38234
38437
  type: 'string',
38235
38438
  },
@@ -38277,6 +38480,7 @@ export default {
38277
38480
  },
38278
38481
  '/webhooks/create': {
38279
38482
  post: {
38483
+ description: 'Creates a new [webhook](https://docs.seam.co/latest/developer-tools/webhooks).',
38280
38484
  operationId: 'webhooksCreatePost',
38281
38485
  requestBody: {
38282
38486
  content: {
@@ -38285,10 +38489,15 @@ export default {
38285
38489
  properties: {
38286
38490
  event_types: {
38287
38491
  default: ['*'],
38492
+ description: 'Types of events that you want the new webhook to receive.',
38288
38493
  items: { type: 'string' },
38289
38494
  type: 'array',
38290
38495
  },
38291
- url: { format: 'uri', type: 'string' },
38496
+ url: {
38497
+ description: 'URL for the new webhook.',
38498
+ format: 'uri',
38499
+ type: 'string',
38500
+ },
38292
38501
  },
38293
38502
  required: ['url'],
38294
38503
  type: 'object',
@@ -38326,16 +38535,23 @@ export default {
38326
38535
  'x-fern-sdk-method-name': 'create',
38327
38536
  'x-fern-sdk-return-value': 'webhook',
38328
38537
  'x-response-key': 'webhook',
38538
+ 'x-title': 'Create a Webhook',
38329
38539
  },
38330
38540
  },
38331
38541
  '/webhooks/delete': {
38332
38542
  post: {
38543
+ description: 'Deletes a specified [webhook](https://docs.seam.co/latest/developer-tools/webhooks).',
38333
38544
  operationId: 'webhooksDeletePost',
38334
38545
  requestBody: {
38335
38546
  content: {
38336
38547
  'application/json': {
38337
38548
  schema: {
38338
- properties: { webhook_id: { type: 'string' } },
38549
+ properties: {
38550
+ webhook_id: {
38551
+ description: 'ID of the webhook that you want to delete.',
38552
+ type: 'string',
38553
+ },
38554
+ },
38339
38555
  required: ['webhook_id'],
38340
38556
  type: 'object',
38341
38557
  },
@@ -38368,16 +38584,23 @@ export default {
38368
38584
  'x-fern-sdk-group-name': ['webhooks'],
38369
38585
  'x-fern-sdk-method-name': 'delete',
38370
38586
  'x-response-key': null,
38587
+ 'x-title': 'Delete a Webhook',
38371
38588
  },
38372
38589
  },
38373
38590
  '/webhooks/get': {
38374
38591
  post: {
38592
+ description: 'Gets a specified [webhook](https://docs.seam.co/latest/developer-tools/webhooks).',
38375
38593
  operationId: 'webhooksGetPost',
38376
38594
  requestBody: {
38377
38595
  content: {
38378
38596
  'application/json': {
38379
38597
  schema: {
38380
- properties: { webhook_id: { type: 'string' } },
38598
+ properties: {
38599
+ webhook_id: {
38600
+ description: 'ID of the webhook that you want to get.',
38601
+ type: 'string',
38602
+ },
38603
+ },
38381
38604
  required: ['webhook_id'],
38382
38605
  type: 'object',
38383
38606
  },
@@ -38414,10 +38637,12 @@ export default {
38414
38637
  'x-fern-sdk-method-name': 'get',
38415
38638
  'x-fern-sdk-return-value': 'webhook',
38416
38639
  'x-response-key': 'webhook',
38640
+ 'x-title': 'Get a Webhook',
38417
38641
  },
38418
38642
  },
38419
38643
  '/webhooks/list': {
38420
38644
  get: {
38645
+ description: 'Returns a list of all [webhooks](https://docs.seam.co/latest/developer-tools/webhooks).',
38421
38646
  operationId: 'webhooksListGet',
38422
38647
  responses: {
38423
38648
  200: {
@@ -38450,8 +38675,10 @@ export default {
38450
38675
  tags: ['/webhooks'],
38451
38676
  'x-fern-ignore': true,
38452
38677
  'x-response-key': 'webhooks',
38678
+ 'x-title': 'List Webhooks',
38453
38679
  },
38454
38680
  post: {
38681
+ description: 'Returns a list of all [webhooks](https://docs.seam.co/latest/developer-tools/webhooks).',
38455
38682
  operationId: 'webhooksListPost',
38456
38683
  responses: {
38457
38684
  200: {
@@ -38486,18 +38713,27 @@ export default {
38486
38713
  'x-fern-sdk-method-name': 'list',
38487
38714
  'x-fern-sdk-return-value': 'webhooks',
38488
38715
  'x-response-key': 'webhooks',
38716
+ 'x-title': 'List Webhooks',
38489
38717
  },
38490
38718
  },
38491
38719
  '/webhooks/update': {
38492
38720
  post: {
38721
+ description: 'Updates a specified [webhook](https://docs.seam.co/latest/developer-tools/webhooks).',
38493
38722
  operationId: 'webhooksUpdatePost',
38494
38723
  requestBody: {
38495
38724
  content: {
38496
38725
  'application/json': {
38497
38726
  schema: {
38498
38727
  properties: {
38499
- event_types: { items: { type: 'string' }, type: 'array' },
38500
- webhook_id: { type: 'string' },
38728
+ event_types: {
38729
+ description: 'Types of events that you want the webhook to receive.',
38730
+ items: { type: 'string' },
38731
+ type: 'array',
38732
+ },
38733
+ webhook_id: {
38734
+ description: 'ID of the webhook that you want to update.',
38735
+ type: 'string',
38736
+ },
38501
38737
  },
38502
38738
  required: ['webhook_id', 'event_types'],
38503
38739
  type: 'object',
@@ -38531,16 +38767,25 @@ export default {
38531
38767
  'x-fern-sdk-group-name': ['webhooks'],
38532
38768
  'x-fern-sdk-method-name': 'update',
38533
38769
  'x-response-key': null,
38770
+ 'x-title': 'Update a Webhook',
38534
38771
  },
38535
38772
  put: {
38773
+ description: 'Updates a specified [webhook](https://docs.seam.co/latest/developer-tools/webhooks).',
38536
38774
  operationId: 'webhooksUpdatePut',
38537
38775
  requestBody: {
38538
38776
  content: {
38539
38777
  'application/json': {
38540
38778
  schema: {
38541
38779
  properties: {
38542
- event_types: { items: { type: 'string' }, type: 'array' },
38543
- webhook_id: { type: 'string' },
38780
+ event_types: {
38781
+ description: 'Types of events that you want the webhook to receive.',
38782
+ items: { type: 'string' },
38783
+ type: 'array',
38784
+ },
38785
+ webhook_id: {
38786
+ description: 'ID of the webhook that you want to update.',
38787
+ type: 'string',
38788
+ },
38544
38789
  },
38545
38790
  required: ['webhook_id', 'event_types'],
38546
38791
  type: 'object',
@@ -38573,41 +38818,65 @@ export default {
38573
38818
  tags: ['/webhooks'],
38574
38819
  'x-fern-ignore': true,
38575
38820
  'x-response-key': null,
38821
+ 'x-title': 'Update a Webhook',
38576
38822
  },
38577
38823
  },
38578
38824
  '/workspaces/create': {
38579
38825
  post: {
38826
+ description: 'Creates a new [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
38580
38827
  operationId: 'workspacesCreatePost',
38581
38828
  requestBody: {
38582
38829
  content: {
38583
38830
  'application/json': {
38584
38831
  schema: {
38585
38832
  properties: {
38586
- company_name: { type: 'string' },
38833
+ company_name: {
38834
+ description: 'Company name for the new workspace.',
38835
+ type: 'string',
38836
+ },
38587
38837
  connect_partner_name: {
38588
38838
  deprecated: true,
38839
+ description: 'Connect partner name for the new workspace.',
38589
38840
  nullable: true,
38590
38841
  type: 'string',
38591
38842
  'x-deprecated': 'use company_name',
38592
38843
  },
38593
38844
  connect_webview_customization: {
38845
+ 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).',
38594
38846
  properties: {
38595
38847
  logo_shape: {
38848
+ 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).',
38596
38849
  enum: ['circle', 'square'],
38597
38850
  nullable: true,
38598
38851
  type: 'string',
38599
38852
  },
38600
- primary_button_color: { nullable: true, type: 'string' },
38853
+ primary_button_color: {
38854
+ 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).',
38855
+ nullable: true,
38856
+ type: 'string',
38857
+ },
38601
38858
  primary_button_text_color: {
38859
+ 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).',
38860
+ nullable: true,
38861
+ type: 'string',
38862
+ },
38863
+ success_message: {
38864
+ 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).',
38602
38865
  nullable: true,
38603
38866
  type: 'string',
38604
38867
  },
38605
- success_message: { nullable: true, type: 'string' },
38606
38868
  },
38607
38869
  type: 'object',
38608
38870
  },
38609
- is_sandbox: { default: false, type: 'boolean' },
38610
- name: { type: 'string' },
38871
+ is_sandbox: {
38872
+ default: false,
38873
+ description: 'Indicates whether the new workspace is a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).',
38874
+ type: 'boolean',
38875
+ },
38876
+ name: {
38877
+ description: 'Name of the new workspace.',
38878
+ type: 'string',
38879
+ },
38611
38880
  webview_logo_shape: {
38612
38881
  deprecated: true,
38613
38882
  enum: ['circle', 'square'],
@@ -38666,10 +38935,12 @@ export default {
38666
38935
  'x-fern-sdk-method-name': 'create',
38667
38936
  'x-fern-sdk-return-value': 'workspace',
38668
38937
  'x-response-key': 'workspace',
38938
+ 'x-title': 'Create a Workspace',
38669
38939
  },
38670
38940
  },
38671
38941
  '/workspaces/get': {
38672
38942
  get: {
38943
+ description: 'Returns the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.',
38673
38944
  operationId: 'workspacesGetGet',
38674
38945
  responses: {
38675
38946
  200: {
@@ -38694,14 +38965,17 @@ export default {
38694
38965
  { api_key: [] },
38695
38966
  { console_session_with_workspace: [] },
38696
38967
  { client_session: [] },
38968
+ { client_session_with_customer: [] },
38697
38969
  { pat_with_workspace: [] },
38698
38970
  ],
38699
38971
  summary: '/workspaces/get',
38700
38972
  tags: ['/workspaces'],
38701
38973
  'x-fern-ignore': true,
38702
38974
  'x-response-key': 'workspace',
38975
+ 'x-title': 'Get a Workspace',
38703
38976
  },
38704
38977
  post: {
38978
+ description: 'Returns the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.',
38705
38979
  operationId: 'workspacesGetPost',
38706
38980
  responses: {
38707
38981
  200: {
@@ -38726,6 +39000,7 @@ export default {
38726
39000
  { api_key: [] },
38727
39001
  { console_session_with_workspace: [] },
38728
39002
  { client_session: [] },
39003
+ { client_session_with_customer: [] },
38729
39004
  { pat_with_workspace: [] },
38730
39005
  ],
38731
39006
  summary: '/workspaces/get',
@@ -38734,10 +39009,12 @@ export default {
38734
39009
  'x-fern-sdk-method-name': 'get',
38735
39010
  'x-fern-sdk-return-value': 'workspace',
38736
39011
  'x-response-key': 'workspace',
39012
+ 'x-title': 'Get a Workspace',
38737
39013
  },
38738
39014
  },
38739
39015
  '/workspaces/list': {
38740
39016
  get: {
39017
+ description: 'Returns a list of [workspaces](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.',
38741
39018
  operationId: 'workspacesListGet',
38742
39019
  responses: {
38743
39020
  200: {
@@ -38773,8 +39050,10 @@ export default {
38773
39050
  tags: ['/workspaces'],
38774
39051
  'x-fern-ignore': true,
38775
39052
  'x-response-key': 'workspaces',
39053
+ 'x-title': 'List Workspaces',
38776
39054
  },
38777
39055
  post: {
39056
+ description: 'Returns a list of [workspaces](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.',
38778
39057
  operationId: 'workspacesListPost',
38779
39058
  responses: {
38780
39059
  200: {
@@ -38812,11 +39091,12 @@ export default {
38812
39091
  'x-fern-sdk-method-name': 'list',
38813
39092
  'x-fern-sdk-return-value': 'workspaces',
38814
39093
  'x-response-key': 'workspaces',
39094
+ 'x-title': 'List Workspaces',
38815
39095
  },
38816
39096
  },
38817
39097
  '/workspaces/reset_sandbox': {
38818
39098
  post: {
38819
- 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.',
39099
+ 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.',
38820
39100
  operationId: 'workspacesResetSandboxPost',
38821
39101
  responses: {
38822
39102
  200: {
@@ -38851,35 +39131,57 @@ export default {
38851
39131
  'x-fern-sdk-method-name': 'reset_sandbox',
38852
39132
  'x-fern-sdk-return-value': 'action_attempt',
38853
39133
  'x-response-key': 'action_attempt',
39134
+ 'x-title': 'Reset a Sandbox Workspace',
38854
39135
  },
38855
39136
  },
38856
39137
  '/workspaces/update': {
38857
39138
  patch: {
39139
+ description: 'Updates the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.',
38858
39140
  operationId: 'workspacesUpdatePatch',
38859
39141
  requestBody: {
38860
39142
  content: {
38861
39143
  'application/json': {
38862
39144
  schema: {
38863
39145
  properties: {
38864
- connect_partner_name: { type: 'string' },
39146
+ connect_partner_name: {
39147
+ description: 'Connect partner name for the workspace.',
39148
+ type: 'string',
39149
+ },
38865
39150
  connect_webview_customization: {
39151
+ 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).',
38866
39152
  properties: {
38867
39153
  logo_shape: {
39154
+ 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).',
38868
39155
  enum: ['circle', 'square'],
38869
39156
  nullable: true,
38870
39157
  type: 'string',
38871
39158
  },
38872
- primary_button_color: { nullable: true, type: 'string' },
39159
+ primary_button_color: {
39160
+ 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).',
39161
+ nullable: true,
39162
+ type: 'string',
39163
+ },
38873
39164
  primary_button_text_color: {
39165
+ 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).',
39166
+ nullable: true,
39167
+ type: 'string',
39168
+ },
39169
+ success_message: {
39170
+ 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).',
38874
39171
  nullable: true,
38875
39172
  type: 'string',
38876
39173
  },
38877
- success_message: { nullable: true, type: 'string' },
38878
39174
  },
38879
39175
  type: 'object',
38880
39176
  },
38881
- is_suspended: { type: 'boolean' },
38882
- name: { type: 'string' },
39177
+ is_suspended: {
39178
+ description: 'Indicates whether the workspace is suspended.',
39179
+ type: 'boolean',
39180
+ },
39181
+ name: {
39182
+ description: 'Name of the workspace.',
39183
+ type: 'string',
39184
+ },
38883
39185
  },
38884
39186
  type: 'object',
38885
39187
  },
@@ -38900,33 +39202,55 @@ export default {
38900
39202
  tags: ['/workspaces'],
38901
39203
  'x-fern-ignore': true,
38902
39204
  'x-response-key': null,
39205
+ 'x-title': 'Udpate a Workspace',
38903
39206
  },
38904
39207
  post: {
39208
+ description: 'Updates the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.',
38905
39209
  operationId: 'workspacesUpdatePost',
38906
39210
  requestBody: {
38907
39211
  content: {
38908
39212
  'application/json': {
38909
39213
  schema: {
38910
39214
  properties: {
38911
- connect_partner_name: { type: 'string' },
39215
+ connect_partner_name: {
39216
+ description: 'Connect partner name for the workspace.',
39217
+ type: 'string',
39218
+ },
38912
39219
  connect_webview_customization: {
39220
+ 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).',
38913
39221
  properties: {
38914
39222
  logo_shape: {
39223
+ 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).',
38915
39224
  enum: ['circle', 'square'],
38916
39225
  nullable: true,
38917
39226
  type: 'string',
38918
39227
  },
38919
- primary_button_color: { nullable: true, type: 'string' },
39228
+ primary_button_color: {
39229
+ 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).',
39230
+ nullable: true,
39231
+ type: 'string',
39232
+ },
38920
39233
  primary_button_text_color: {
39234
+ 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).',
39235
+ nullable: true,
39236
+ type: 'string',
39237
+ },
39238
+ success_message: {
39239
+ 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).',
38921
39240
  nullable: true,
38922
39241
  type: 'string',
38923
39242
  },
38924
- success_message: { nullable: true, type: 'string' },
38925
39243
  },
38926
39244
  type: 'object',
38927
39245
  },
38928
- is_suspended: { type: 'boolean' },
38929
- name: { type: 'string' },
39246
+ is_suspended: {
39247
+ description: 'Indicates whether the workspace is suspended.',
39248
+ type: 'boolean',
39249
+ },
39250
+ name: {
39251
+ description: 'Name of the workspace.',
39252
+ type: 'string',
39253
+ },
38930
39254
  },
38931
39255
  type: 'object',
38932
39256
  },
@@ -38948,6 +39272,7 @@ export default {
38948
39272
  'x-fern-sdk-group-name': ['workspaces'],
38949
39273
  'x-fern-sdk-method-name': 'update',
38950
39274
  'x-response-key': null,
39275
+ 'x-title': 'Udpate a Workspace',
38951
39276
  },
38952
39277
  },
38953
39278
  },