@seamapi/types 1.472.0 → 1.474.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.
@@ -17178,53 +17178,6 @@ export default {
17178
17178
  type: 'object',
17179
17179
  'x-route-path': '/instant_keys',
17180
17180
  },
17181
- location: {
17182
- properties: {
17183
- created_at: {
17184
- description: 'Date and time at which the location object was created.',
17185
- format: 'date-time',
17186
- type: 'string',
17187
- },
17188
- display_name: {
17189
- description: 'Display name of the location.',
17190
- type: 'string',
17191
- },
17192
- geolocation: {
17193
- description: 'Geographical location of the location.',
17194
- properties: {
17195
- latitude: { format: 'float', type: 'number' },
17196
- longitude: { format: 'float', type: 'number' },
17197
- },
17198
- required: ['latitude', 'longitude'],
17199
- type: 'object',
17200
- },
17201
- location_id: {
17202
- description: 'Unique identifier for the location.',
17203
- format: 'uuid',
17204
- type: 'string',
17205
- },
17206
- name: { description: 'Name of the location.', type: 'string' },
17207
- time_zone: {
17208
- description: 'Time zone of the location.',
17209
- type: 'string',
17210
- },
17211
- workspace_id: {
17212
- description: 'Unique identifier for the Seam workspace associated with the location.',
17213
- format: 'uuid',
17214
- type: 'string',
17215
- },
17216
- },
17217
- required: [
17218
- 'location_id',
17219
- 'workspace_id',
17220
- 'name',
17221
- 'display_name',
17222
- 'created_at',
17223
- ],
17224
- type: 'object',
17225
- 'x-route-path': '/unstable_locations',
17226
- 'x-undocumented': 'Will be removed.',
17227
- },
17228
17181
  magic_link: {
17229
17182
  description: "Represents a Customer Portal. Customer Portal is a hosted, customizable interface for managing device access. It enables you to embed secure, pre-authenticated access flows into your product—either by sharing a link with users or embedding a view in an iframe.\n\nWith Customer Portal, you no longer need to build out frontend experiences for physical access, thermostats, and sensors. Instead, you can ship enterprise-grade access control experiences in a fraction of the time, while maintaining your product's branding and user experience.\n\nSeam hosts these flows, handling everything from account connection and device mapping to full-featured device control.",
17230
17183
  properties: {
@@ -26312,6 +26265,10 @@ export default {
26312
26265
  batch: {
26313
26266
  description: 'A batch of workspace resources.',
26314
26267
  properties: {
26268
+ access_methods: {
26269
+ items: { $ref: '#/components/schemas/access_method' },
26270
+ type: 'array',
26271
+ },
26315
26272
  acs_access_groups: {
26316
26273
  items: {
26317
26274
  $ref: '#/components/schemas/acs_access_group',
@@ -26469,6 +26426,10 @@ export default {
26469
26426
  batch: {
26470
26427
  description: 'A batch of workspace resources.',
26471
26428
  properties: {
26429
+ access_methods: {
26430
+ items: { $ref: '#/components/schemas/access_method' },
26431
+ type: 'array',
26432
+ },
26472
26433
  acs_access_groups: {
26473
26434
  items: {
26474
26435
  $ref: '#/components/schemas/acs_access_group',
@@ -49163,28 +49124,21 @@ export default {
49163
49124
  'x-title': 'Update the Thermostat Weekly Program',
49164
49125
  },
49165
49126
  },
49166
- '/unstable_locations/add_acs_entrances': {
49127
+ '/unstable_partner/building_blocks/connect_accounts': {
49167
49128
  post: {
49168
- description: 'Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific location.',
49169
- operationId: 'unstableLocationsAddAcsEntrancesPost',
49129
+ description: 'Creates a new building block magic link to connect accounts.',
49130
+ operationId: 'unstablePartnerBuildingBlocksConnectAccountsPost',
49170
49131
  requestBody: {
49171
49132
  content: {
49172
49133
  'application/json': {
49173
49134
  schema: {
49174
49135
  properties: {
49175
- acs_entrance_ids: {
49176
- description: 'IDs of the entrances that you want to add to the location.',
49177
- items: { format: 'uuid', type: 'string' },
49178
- minItems: 1,
49179
- type: 'array',
49180
- },
49181
- location_id: {
49182
- description: 'ID of the location to which you want to add entrances.',
49183
- format: 'uuid',
49136
+ customer_key: {
49137
+ description: 'Customer key for which you want to connect accounts.',
49184
49138
  type: 'string',
49185
49139
  },
49186
49140
  },
49187
- required: ['location_id', 'acs_entrance_ids'],
49141
+ required: ['customer_key'],
49188
49142
  type: 'object',
49189
49143
  },
49190
49144
  },
@@ -49195,8 +49149,11 @@ export default {
49195
49149
  content: {
49196
49150
  'application/json': {
49197
49151
  schema: {
49198
- properties: { ok: { type: 'boolean' } },
49199
- required: ['ok'],
49152
+ properties: {
49153
+ magic_link: { $ref: '#/components/schemas/magic_link' },
49154
+ ok: { type: 'boolean' },
49155
+ },
49156
+ required: ['magic_link', 'ok'],
49200
49157
  type: 'object',
49201
49158
  },
49202
49159
  },
@@ -49211,47 +49168,79 @@ export default {
49211
49168
  { console_session_with_workspace: [] },
49212
49169
  { api_key: [] },
49213
49170
  ],
49214
- summary: '/unstable_locations/add_acs_entrances',
49171
+ summary: '/unstable_partner/building_blocks/connect_accounts',
49215
49172
  tags: [],
49216
- 'x-fern-sdk-group-name': ['unstable_locations'],
49217
- 'x-fern-sdk-method-name': 'add_acs_entrances',
49218
- 'x-response-key': null,
49219
- 'x-title': 'Add Entrances to a Location',
49220
- 'x-undocumented': 'Experimental locations.',
49173
+ 'x-fern-sdk-group-name': ['unstable_partner', 'building_blocks'],
49174
+ 'x-fern-sdk-method-name': 'connect_accounts',
49175
+ 'x-fern-sdk-return-value': 'magic_link',
49176
+ 'x-response-key': 'magic_link',
49177
+ 'x-title': 'Generate a Connect Accounts Building Block Magic Link',
49178
+ 'x-undocumented': 'Experimental partner building blocks.',
49221
49179
  },
49222
- put: {
49223
- description: 'Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific location.',
49224
- operationId: 'unstableLocationsAddAcsEntrancesPut',
49225
- requestBody: {
49226
- content: {
49227
- 'application/json': {
49228
- schema: {
49180
+ },
49181
+ '/unstable_partner/building_blocks/generate_magic_link': {
49182
+ get: {
49183
+ description: 'Creates a new building block magic link.',
49184
+ operationId: 'unstablePartnerBuildingBlocksGenerateMagicLinkGet',
49185
+ parameters: [
49186
+ {
49187
+ in: 'query',
49188
+ name: 'building_block_type',
49189
+ required: true,
49190
+ schema: {
49191
+ description: 'Type of building block for which you want to create a magic link.',
49192
+ enum: [
49193
+ 'connect_accounts',
49194
+ 'organize_spaces',
49195
+ 'console',
49196
+ 'manage_devices',
49197
+ ],
49198
+ type: 'string',
49199
+ },
49200
+ },
49201
+ {
49202
+ in: 'query',
49203
+ name: 'customer_key',
49204
+ required: true,
49205
+ schema: {
49206
+ description: 'Customer key for which you want to create a new building block magic link.',
49207
+ type: 'string',
49208
+ },
49209
+ },
49210
+ {
49211
+ in: 'query',
49212
+ name: 'spaces',
49213
+ required: false,
49214
+ schema: {
49215
+ description: 'Optional list of spaces that you want to include in the new building block magic link.',
49216
+ items: {
49229
49217
  properties: {
49230
- acs_entrance_ids: {
49231
- description: 'IDs of the entrances that you want to add to the location.',
49232
- items: { format: 'uuid', type: 'string' },
49233
- minItems: 1,
49234
- type: 'array',
49218
+ name: {
49219
+ description: 'Your display name for this location resource.',
49220
+ type: 'string',
49235
49221
  },
49236
- location_id: {
49237
- description: 'ID of the location to which you want to add entrances.',
49238
- format: 'uuid',
49222
+ space_key: {
49223
+ description: 'Your unique identifier for the space.',
49239
49224
  type: 'string',
49240
49225
  },
49241
49226
  },
49242
- required: ['location_id', 'acs_entrance_ids'],
49227
+ required: ['name', 'space_key'],
49243
49228
  type: 'object',
49244
49229
  },
49230
+ type: 'array',
49245
49231
  },
49246
49232
  },
49247
- },
49233
+ ],
49248
49234
  responses: {
49249
49235
  200: {
49250
49236
  content: {
49251
49237
  'application/json': {
49252
49238
  schema: {
49253
- properties: { ok: { type: 'boolean' } },
49254
- required: ['ok'],
49239
+ properties: {
49240
+ magic_link: { $ref: '#/components/schemas/magic_link' },
49241
+ ok: { type: 'boolean' },
49242
+ },
49243
+ required: ['magic_link', 'ok'],
49255
49244
  type: 'object',
49256
49245
  },
49257
49246
  },
@@ -49266,37 +49255,57 @@ export default {
49266
49255
  { console_session_with_workspace: [] },
49267
49256
  { api_key: [] },
49268
49257
  ],
49269
- summary: '/unstable_locations/add_acs_entrances',
49258
+ summary: '/unstable_partner/building_blocks/generate_magic_link',
49270
49259
  tags: [],
49271
- 'x-fern-sdk-group-name': ['unstable_locations'],
49272
- 'x-fern-sdk-method-name': 'add_acs_entrances',
49273
- 'x-response-key': null,
49274
- 'x-title': 'Add Entrances to a Location',
49275
- 'x-undocumented': 'Experimental locations.',
49260
+ 'x-fern-sdk-group-name': ['unstable_partner', 'building_blocks'],
49261
+ 'x-fern-sdk-method-name': 'generate_magic_link',
49262
+ 'x-fern-sdk-return-value': 'magic_link',
49263
+ 'x-response-key': 'magic_link',
49264
+ 'x-title': 'Generate a Building Block Magic Link',
49265
+ 'x-undocumented': 'Experimental partner building blocks.',
49276
49266
  },
49277
- },
49278
- '/unstable_locations/add_devices': {
49279
49267
  post: {
49280
- description: 'Adds devices to a specific location.',
49281
- operationId: 'unstableLocationsAddDevicesPost',
49268
+ description: 'Creates a new building block magic link.',
49269
+ operationId: 'unstablePartnerBuildingBlocksGenerateMagicLinkPost',
49282
49270
  requestBody: {
49283
49271
  content: {
49284
49272
  'application/json': {
49285
49273
  schema: {
49286
49274
  properties: {
49287
- device_ids: {
49288
- description: 'IDs of the devices that you want to add to the location.',
49289
- items: { format: 'uuid', type: 'string' },
49290
- minItems: 1,
49291
- type: 'array',
49275
+ building_block_type: {
49276
+ description: 'Type of building block for which you want to create a magic link.',
49277
+ enum: [
49278
+ 'connect_accounts',
49279
+ 'organize_spaces',
49280
+ 'console',
49281
+ 'manage_devices',
49282
+ ],
49283
+ type: 'string',
49292
49284
  },
49293
- location_id: {
49294
- description: 'ID of the location to which you want to add devices.',
49295
- format: 'uuid',
49285
+ customer_key: {
49286
+ description: 'Customer key for which you want to create a new building block magic link.',
49296
49287
  type: 'string',
49297
49288
  },
49289
+ spaces: {
49290
+ description: 'Optional list of spaces that you want to include in the new building block magic link.',
49291
+ items: {
49292
+ properties: {
49293
+ name: {
49294
+ description: 'Your display name for this location resource.',
49295
+ type: 'string',
49296
+ },
49297
+ space_key: {
49298
+ description: 'Your unique identifier for the space.',
49299
+ type: 'string',
49300
+ },
49301
+ },
49302
+ required: ['name', 'space_key'],
49303
+ type: 'object',
49304
+ },
49305
+ type: 'array',
49306
+ },
49298
49307
  },
49299
- required: ['location_id', 'device_ids'],
49308
+ required: ['building_block_type', 'customer_key'],
49300
49309
  type: 'object',
49301
49310
  },
49302
49311
  },
@@ -49307,8 +49316,11 @@ export default {
49307
49316
  content: {
49308
49317
  'application/json': {
49309
49318
  schema: {
49310
- properties: { ok: { type: 'boolean' } },
49311
- required: ['ok'],
49319
+ properties: {
49320
+ magic_link: { $ref: '#/components/schemas/magic_link' },
49321
+ ok: { type: 'boolean' },
49322
+ },
49323
+ required: ['magic_link', 'ok'],
49312
49324
  type: 'object',
49313
49325
  },
49314
49326
  },
@@ -49323,35 +49335,31 @@ export default {
49323
49335
  { console_session_with_workspace: [] },
49324
49336
  { api_key: [] },
49325
49337
  ],
49326
- summary: '/unstable_locations/add_devices',
49338
+ summary: '/unstable_partner/building_blocks/generate_magic_link',
49327
49339
  tags: [],
49328
- 'x-fern-sdk-group-name': ['unstable_locations'],
49329
- 'x-fern-sdk-method-name': 'add_devices',
49330
- 'x-response-key': null,
49331
- 'x-title': 'Add Devices to a Location',
49332
- 'x-undocumented': 'Experimental locations.',
49340
+ 'x-fern-sdk-group-name': ['unstable_partner', 'building_blocks'],
49341
+ 'x-fern-sdk-method-name': 'generate_magic_link',
49342
+ 'x-fern-sdk-return-value': 'magic_link',
49343
+ 'x-response-key': 'magic_link',
49344
+ 'x-title': 'Generate a Building Block Magic Link',
49345
+ 'x-undocumented': 'Experimental partner building blocks.',
49333
49346
  },
49334
- put: {
49335
- description: 'Adds devices to a specific location.',
49336
- operationId: 'unstableLocationsAddDevicesPut',
49347
+ },
49348
+ '/unstable_partner/building_blocks/manage_devices': {
49349
+ post: {
49350
+ description: 'Creates a new building block magic link to manage devices.',
49351
+ operationId: 'unstablePartnerBuildingBlocksManageDevicesPost',
49337
49352
  requestBody: {
49338
49353
  content: {
49339
49354
  'application/json': {
49340
49355
  schema: {
49341
49356
  properties: {
49342
- device_ids: {
49343
- description: 'IDs of the devices that you want to add to the location.',
49344
- items: { format: 'uuid', type: 'string' },
49345
- minItems: 1,
49346
- type: 'array',
49347
- },
49348
- location_id: {
49349
- description: 'ID of the location to which you want to add devices.',
49350
- format: 'uuid',
49357
+ customer_key: {
49358
+ description: 'Customer key for which you want to manage devices.',
49351
49359
  type: 'string',
49352
49360
  },
49353
49361
  },
49354
- required: ['location_id', 'device_ids'],
49362
+ required: ['customer_key'],
49355
49363
  type: 'object',
49356
49364
  },
49357
49365
  },
@@ -49362,8 +49370,11 @@ export default {
49362
49370
  content: {
49363
49371
  'application/json': {
49364
49372
  schema: {
49365
- properties: { ok: { type: 'boolean' } },
49366
- required: ['ok'],
49373
+ properties: {
49374
+ magic_link: { $ref: '#/components/schemas/magic_link' },
49375
+ ok: { type: 'boolean' },
49376
+ },
49377
+ required: ['magic_link', 'ok'],
49367
49378
  type: 'object',
49368
49379
  },
49369
49380
  },
@@ -49378,53 +49389,49 @@ export default {
49378
49389
  { console_session_with_workspace: [] },
49379
49390
  { api_key: [] },
49380
49391
  ],
49381
- summary: '/unstable_locations/add_devices',
49392
+ summary: '/unstable_partner/building_blocks/manage_devices',
49382
49393
  tags: [],
49383
- 'x-fern-sdk-group-name': ['unstable_locations'],
49384
- 'x-fern-sdk-method-name': 'add_devices',
49385
- 'x-response-key': null,
49386
- 'x-title': 'Add Devices to a Location',
49387
- 'x-undocumented': 'Experimental locations.',
49394
+ 'x-fern-sdk-group-name': ['unstable_partner', 'building_blocks'],
49395
+ 'x-fern-sdk-method-name': 'manage_devices',
49396
+ 'x-fern-sdk-return-value': 'magic_link',
49397
+ 'x-response-key': 'magic_link',
49398
+ 'x-title': 'Generate a Manage Devices Building Block Magic Link',
49399
+ 'x-undocumented': 'Experimental partner building blocks.',
49388
49400
  },
49389
49401
  },
49390
- '/unstable_locations/create': {
49402
+ '/unstable_partner/building_blocks/organize_spaces': {
49391
49403
  post: {
49392
- description: 'Creates a new location.',
49393
- operationId: 'unstableLocationsCreatePost',
49404
+ description: 'Creates a new building block magic link to organize spaces.',
49405
+ operationId: 'unstablePartnerBuildingBlocksOrganizeSpacesPost',
49394
49406
  requestBody: {
49395
49407
  content: {
49396
49408
  'application/json': {
49397
49409
  schema: {
49398
49410
  properties: {
49399
- acs_entrance_ids: {
49400
- description: 'IDs of the entrances that you want to add to the new location.',
49401
- items: { format: 'uuid', type: 'string' },
49402
- type: 'array',
49403
- },
49404
- device_ids: {
49405
- description: 'IDs of the devices that you want to add to the new location.',
49406
- items: { format: 'uuid', type: 'string' },
49407
- type: 'array',
49408
- },
49409
- geolocation: {
49410
- description: 'Geolocation of the new location.',
49411
- properties: {
49412
- latitude: { format: 'float', type: 'number' },
49413
- longitude: { format: 'float', type: 'number' },
49414
- },
49415
- required: ['latitude', 'longitude'],
49416
- type: 'object',
49417
- },
49418
- name: {
49419
- description: 'Name of the new location.',
49411
+ customer_key: {
49412
+ description: 'Customer key for which you want to organize spaces.',
49420
49413
  type: 'string',
49421
49414
  },
49422
- time_zone: {
49423
- description: 'Time zone of the new location.',
49424
- type: 'string',
49415
+ spaces: {
49416
+ description: 'Optional list of spaces that you want to include in the new building block magic link.',
49417
+ items: {
49418
+ properties: {
49419
+ name: {
49420
+ description: 'Your display name for this location resource.',
49421
+ type: 'string',
49422
+ },
49423
+ space_key: {
49424
+ description: 'Your unique identifier for the space.',
49425
+ type: 'string',
49426
+ },
49427
+ },
49428
+ required: ['name', 'space_key'],
49429
+ type: 'object',
49430
+ },
49431
+ type: 'array',
49425
49432
  },
49426
49433
  },
49427
- required: ['name'],
49434
+ required: ['customer_key'],
49428
49435
  type: 'object',
49429
49436
  },
49430
49437
  },
@@ -49436,10 +49443,10 @@ export default {
49436
49443
  'application/json': {
49437
49444
  schema: {
49438
49445
  properties: {
49439
- location: { $ref: '#/components/schemas/location' },
49446
+ magic_link: { $ref: '#/components/schemas/magic_link' },
49440
49447
  ok: { type: 'boolean' },
49441
49448
  },
49442
- required: ['location', 'ok'],
49449
+ required: ['magic_link', 'ok'],
49443
49450
  type: 'object',
49444
49451
  },
49445
49452
  },
@@ -49454,1029 +49461,37 @@ export default {
49454
49461
  { console_session_with_workspace: [] },
49455
49462
  { api_key: [] },
49456
49463
  ],
49457
- summary: '/unstable_locations/create',
49464
+ summary: '/unstable_partner/building_blocks/organize_spaces',
49458
49465
  tags: [],
49459
- 'x-fern-sdk-group-name': ['unstable_locations'],
49460
- 'x-fern-sdk-method-name': 'create',
49461
- 'x-fern-sdk-return-value': 'location',
49462
- 'x-response-key': 'location',
49463
- 'x-title': 'Create a Location',
49464
- 'x-undocumented': 'Experimental locations.',
49466
+ 'x-fern-sdk-group-name': ['unstable_partner', 'building_blocks'],
49467
+ 'x-fern-sdk-method-name': 'organize_spaces',
49468
+ 'x-fern-sdk-return-value': 'magic_link',
49469
+ 'x-response-key': 'magic_link',
49470
+ 'x-title': 'Generate an Organize Spaces Building Block Magic Link',
49471
+ 'x-undocumented': 'Experimental partner building blocks.',
49465
49472
  },
49466
49473
  },
49467
- '/unstable_locations/delete': {
49468
- delete: {
49469
- description: 'Deletes a location.',
49470
- operationId: 'unstableLocationsDeleteDelete',
49474
+ '/user_identities/add_acs_user': {
49475
+ post: {
49476
+ 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/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
49477
+ operationId: 'userIdentitiesAddAcsUserPost',
49471
49478
  requestBody: {
49472
49479
  content: {
49473
49480
  'application/json': {
49474
49481
  schema: {
49475
49482
  properties: {
49476
- location_id: {
49477
- description: 'ID of the location that you want to delete.',
49483
+ acs_user_id: {
49484
+ description: 'ID of the access system user that you want to add to the user identity.',
49485
+ format: 'uuid',
49486
+ type: 'string',
49487
+ },
49488
+ user_identity_id: {
49489
+ description: 'ID of the user identity to which you want to add an access system user.',
49478
49490
  format: 'uuid',
49479
49491
  type: 'string',
49480
49492
  },
49481
49493
  },
49482
- required: ['location_id'],
49483
- type: 'object',
49484
- },
49485
- },
49486
- },
49487
- },
49488
- responses: {
49489
- 200: {
49490
- content: {
49491
- 'application/json': {
49492
- schema: {
49493
- properties: { ok: { type: 'boolean' } },
49494
- required: ['ok'],
49495
- type: 'object',
49496
- },
49497
- },
49498
- },
49499
- description: 'OK',
49500
- },
49501
- 400: { description: 'Bad Request' },
49502
- 401: { description: 'Unauthorized' },
49503
- },
49504
- security: [
49505
- { pat_with_workspace: [] },
49506
- { console_session_with_workspace: [] },
49507
- { api_key: [] },
49508
- ],
49509
- summary: '/unstable_locations/delete',
49510
- tags: [],
49511
- 'x-fern-sdk-group-name': ['unstable_locations'],
49512
- 'x-fern-sdk-method-name': 'delete',
49513
- 'x-response-key': null,
49514
- 'x-title': 'Delete a Location',
49515
- 'x-undocumented': 'Experimental locations.',
49516
- },
49517
- post: {
49518
- description: 'Deletes a location.',
49519
- operationId: 'unstableLocationsDeletePost',
49520
- requestBody: {
49521
- content: {
49522
- 'application/json': {
49523
- schema: {
49524
- properties: {
49525
- location_id: {
49526
- description: 'ID of the location that you want to delete.',
49527
- format: 'uuid',
49528
- type: 'string',
49529
- },
49530
- },
49531
- required: ['location_id'],
49532
- type: 'object',
49533
- },
49534
- },
49535
- },
49536
- },
49537
- responses: {
49538
- 200: {
49539
- content: {
49540
- 'application/json': {
49541
- schema: {
49542
- properties: { ok: { type: 'boolean' } },
49543
- required: ['ok'],
49544
- type: 'object',
49545
- },
49546
- },
49547
- },
49548
- description: 'OK',
49549
- },
49550
- 400: { description: 'Bad Request' },
49551
- 401: { description: 'Unauthorized' },
49552
- },
49553
- security: [
49554
- { pat_with_workspace: [] },
49555
- { console_session_with_workspace: [] },
49556
- { api_key: [] },
49557
- ],
49558
- summary: '/unstable_locations/delete',
49559
- tags: [],
49560
- 'x-fern-sdk-group-name': ['unstable_locations'],
49561
- 'x-fern-sdk-method-name': 'delete',
49562
- 'x-response-key': null,
49563
- 'x-title': 'Delete a Location',
49564
- 'x-undocumented': 'Experimental locations.',
49565
- },
49566
- },
49567
- '/unstable_locations/get': {
49568
- get: {
49569
- description: 'Gets a location.',
49570
- operationId: 'unstableLocationsGetGet',
49571
- parameters: [
49572
- {
49573
- in: 'query',
49574
- name: 'location_id',
49575
- required: true,
49576
- schema: {
49577
- description: 'ID of the location that you want to get.',
49578
- format: 'uuid',
49579
- type: 'string',
49580
- },
49581
- },
49582
- ],
49583
- responses: {
49584
- 200: {
49585
- content: {
49586
- 'application/json': {
49587
- schema: {
49588
- properties: {
49589
- location: { $ref: '#/components/schemas/location' },
49590
- ok: { type: 'boolean' },
49591
- },
49592
- required: ['location', 'ok'],
49593
- type: 'object',
49594
- },
49595
- },
49596
- },
49597
- description: 'OK',
49598
- },
49599
- 400: { description: 'Bad Request' },
49600
- 401: { description: 'Unauthorized' },
49601
- },
49602
- security: [
49603
- { pat_with_workspace: [] },
49604
- { console_session_with_workspace: [] },
49605
- { api_key: [] },
49606
- ],
49607
- summary: '/unstable_locations/get',
49608
- tags: [],
49609
- 'x-fern-sdk-group-name': ['unstable_locations'],
49610
- 'x-fern-sdk-method-name': 'get',
49611
- 'x-fern-sdk-return-value': 'location',
49612
- 'x-response-key': 'location',
49613
- 'x-title': 'Get a Location',
49614
- 'x-undocumented': 'Experimental locations.',
49615
- },
49616
- post: {
49617
- description: 'Gets a location.',
49618
- operationId: 'unstableLocationsGetPost',
49619
- requestBody: {
49620
- content: {
49621
- 'application/json': {
49622
- schema: {
49623
- properties: {
49624
- location_id: {
49625
- description: 'ID of the location that you want to get.',
49626
- format: 'uuid',
49627
- type: 'string',
49628
- },
49629
- },
49630
- required: ['location_id'],
49631
- type: 'object',
49632
- },
49633
- },
49634
- },
49635
- },
49636
- responses: {
49637
- 200: {
49638
- content: {
49639
- 'application/json': {
49640
- schema: {
49641
- properties: {
49642
- location: { $ref: '#/components/schemas/location' },
49643
- ok: { type: 'boolean' },
49644
- },
49645
- required: ['location', 'ok'],
49646
- type: 'object',
49647
- },
49648
- },
49649
- },
49650
- description: 'OK',
49651
- },
49652
- 400: { description: 'Bad Request' },
49653
- 401: { description: 'Unauthorized' },
49654
- },
49655
- security: [
49656
- { pat_with_workspace: [] },
49657
- { console_session_with_workspace: [] },
49658
- { api_key: [] },
49659
- ],
49660
- summary: '/unstable_locations/get',
49661
- tags: [],
49662
- 'x-fern-sdk-group-name': ['unstable_locations'],
49663
- 'x-fern-sdk-method-name': 'get',
49664
- 'x-fern-sdk-return-value': 'location',
49665
- 'x-response-key': 'location',
49666
- 'x-title': 'Get a Location',
49667
- 'x-undocumented': 'Experimental locations.',
49668
- },
49669
- },
49670
- '/unstable_locations/list': {
49671
- get: {
49672
- description: 'Returns a list of all locations.',
49673
- operationId: 'unstableLocationsListGet',
49674
- responses: {
49675
- 200: {
49676
- content: {
49677
- 'application/json': {
49678
- schema: {
49679
- properties: {
49680
- locations: {
49681
- items: { $ref: '#/components/schemas/location' },
49682
- type: 'array',
49683
- },
49684
- ok: { type: 'boolean' },
49685
- },
49686
- required: ['locations', 'ok'],
49687
- type: 'object',
49688
- },
49689
- },
49690
- },
49691
- description: 'OK',
49692
- },
49693
- 400: { description: 'Bad Request' },
49694
- 401: { description: 'Unauthorized' },
49695
- },
49696
- security: [
49697
- { pat_with_workspace: [] },
49698
- { console_session_with_workspace: [] },
49699
- { api_key: [] },
49700
- ],
49701
- summary: '/unstable_locations/list',
49702
- tags: [],
49703
- 'x-fern-sdk-group-name': ['unstable_locations'],
49704
- 'x-fern-sdk-method-name': 'list',
49705
- 'x-fern-sdk-return-value': 'locations',
49706
- 'x-response-key': 'locations',
49707
- 'x-title': 'List Locations',
49708
- 'x-undocumented': 'Experimental locations.',
49709
- },
49710
- post: {
49711
- description: 'Returns a list of all locations.',
49712
- operationId: 'unstableLocationsListPost',
49713
- responses: {
49714
- 200: {
49715
- content: {
49716
- 'application/json': {
49717
- schema: {
49718
- properties: {
49719
- locations: {
49720
- items: { $ref: '#/components/schemas/location' },
49721
- type: 'array',
49722
- },
49723
- ok: { type: 'boolean' },
49724
- },
49725
- required: ['locations', 'ok'],
49726
- type: 'object',
49727
- },
49728
- },
49729
- },
49730
- description: 'OK',
49731
- },
49732
- 400: { description: 'Bad Request' },
49733
- 401: { description: 'Unauthorized' },
49734
- },
49735
- security: [
49736
- { pat_with_workspace: [] },
49737
- { console_session_with_workspace: [] },
49738
- { api_key: [] },
49739
- ],
49740
- summary: '/unstable_locations/list',
49741
- tags: [],
49742
- 'x-fern-sdk-group-name': ['unstable_locations'],
49743
- 'x-fern-sdk-method-name': 'list',
49744
- 'x-fern-sdk-return-value': 'locations',
49745
- 'x-response-key': 'locations',
49746
- 'x-title': 'List Locations',
49747
- 'x-undocumented': 'Experimental locations.',
49748
- },
49749
- },
49750
- '/unstable_locations/remove_acs_entrances': {
49751
- delete: {
49752
- description: 'Removes entrances from a specific location.',
49753
- operationId: 'unstableLocationsRemoveAcsEntrancesDelete',
49754
- parameters: [
49755
- {
49756
- in: 'query',
49757
- name: 'location_id',
49758
- required: true,
49759
- schema: {
49760
- description: 'ID of the location from which you want to remove entrances.',
49761
- format: 'uuid',
49762
- type: 'string',
49763
- },
49764
- },
49765
- {
49766
- in: 'query',
49767
- name: 'acs_entrance_ids',
49768
- required: true,
49769
- schema: {
49770
- description: 'IDs of the entrances that you want to remove from the location.',
49771
- items: { format: 'uuid', type: 'string' },
49772
- type: 'array',
49773
- },
49774
- },
49775
- ],
49776
- responses: {
49777
- 200: {
49778
- content: {
49779
- 'application/json': {
49780
- schema: {
49781
- properties: { ok: { type: 'boolean' } },
49782
- required: ['ok'],
49783
- type: 'object',
49784
- },
49785
- },
49786
- },
49787
- description: 'OK',
49788
- },
49789
- 400: { description: 'Bad Request' },
49790
- 401: { description: 'Unauthorized' },
49791
- },
49792
- security: [
49793
- { pat_with_workspace: [] },
49794
- { console_session_with_workspace: [] },
49795
- { api_key: [] },
49796
- ],
49797
- summary: '/unstable_locations/remove_acs_entrances',
49798
- tags: [],
49799
- 'x-fern-sdk-group-name': ['unstable_locations'],
49800
- 'x-fern-sdk-method-name': 'remove_acs_entrances',
49801
- 'x-response-key': null,
49802
- 'x-title': 'Remove Entrances from a Location',
49803
- 'x-undocumented': 'Experimental locations.',
49804
- },
49805
- post: {
49806
- description: 'Removes entrances from a specific location.',
49807
- operationId: 'unstableLocationsRemoveAcsEntrancesPost',
49808
- requestBody: {
49809
- content: {
49810
- 'application/json': {
49811
- schema: {
49812
- properties: {
49813
- acs_entrance_ids: {
49814
- description: 'IDs of the entrances that you want to remove from the location.',
49815
- items: { format: 'uuid', type: 'string' },
49816
- type: 'array',
49817
- },
49818
- location_id: {
49819
- description: 'ID of the location from which you want to remove entrances.',
49820
- format: 'uuid',
49821
- type: 'string',
49822
- },
49823
- },
49824
- required: ['location_id', 'acs_entrance_ids'],
49825
- type: 'object',
49826
- },
49827
- },
49828
- },
49829
- },
49830
- responses: {
49831
- 200: {
49832
- content: {
49833
- 'application/json': {
49834
- schema: {
49835
- properties: { ok: { type: 'boolean' } },
49836
- required: ['ok'],
49837
- type: 'object',
49838
- },
49839
- },
49840
- },
49841
- description: 'OK',
49842
- },
49843
- 400: { description: 'Bad Request' },
49844
- 401: { description: 'Unauthorized' },
49845
- },
49846
- security: [
49847
- { pat_with_workspace: [] },
49848
- { console_session_with_workspace: [] },
49849
- { api_key: [] },
49850
- ],
49851
- summary: '/unstable_locations/remove_acs_entrances',
49852
- tags: [],
49853
- 'x-fern-sdk-group-name': ['unstable_locations'],
49854
- 'x-fern-sdk-method-name': 'remove_acs_entrances',
49855
- 'x-response-key': null,
49856
- 'x-title': 'Remove Entrances from a Location',
49857
- 'x-undocumented': 'Experimental locations.',
49858
- },
49859
- },
49860
- '/unstable_locations/remove_devices': {
49861
- delete: {
49862
- description: 'Removes devices from a specific location.',
49863
- operationId: 'unstableLocationsRemoveDevicesDelete',
49864
- parameters: [
49865
- {
49866
- in: 'query',
49867
- name: 'location_id',
49868
- required: true,
49869
- schema: {
49870
- description: 'ID of the location from which you want to remove devices.',
49871
- format: 'uuid',
49872
- type: 'string',
49873
- },
49874
- },
49875
- {
49876
- in: 'query',
49877
- name: 'device_ids',
49878
- required: true,
49879
- schema: {
49880
- description: 'IDs of the devices that you want to remove from the location.',
49881
- items: { format: 'uuid', type: 'string' },
49882
- type: 'array',
49883
- },
49884
- },
49885
- ],
49886
- responses: {
49887
- 200: {
49888
- content: {
49889
- 'application/json': {
49890
- schema: {
49891
- properties: { ok: { type: 'boolean' } },
49892
- required: ['ok'],
49893
- type: 'object',
49894
- },
49895
- },
49896
- },
49897
- description: 'OK',
49898
- },
49899
- 400: { description: 'Bad Request' },
49900
- 401: { description: 'Unauthorized' },
49901
- },
49902
- security: [
49903
- { pat_with_workspace: [] },
49904
- { console_session_with_workspace: [] },
49905
- { api_key: [] },
49906
- ],
49907
- summary: '/unstable_locations/remove_devices',
49908
- tags: [],
49909
- 'x-fern-sdk-group-name': ['unstable_locations'],
49910
- 'x-fern-sdk-method-name': 'remove_devices',
49911
- 'x-response-key': null,
49912
- 'x-title': 'Remove Devices from a Location',
49913
- 'x-undocumented': 'Experimental locations.',
49914
- },
49915
- post: {
49916
- description: 'Removes devices from a specific location.',
49917
- operationId: 'unstableLocationsRemoveDevicesPost',
49918
- requestBody: {
49919
- content: {
49920
- 'application/json': {
49921
- schema: {
49922
- properties: {
49923
- device_ids: {
49924
- description: 'IDs of the devices that you want to remove from the location.',
49925
- items: { format: 'uuid', type: 'string' },
49926
- type: 'array',
49927
- },
49928
- location_id: {
49929
- description: 'ID of the location from which you want to remove devices.',
49930
- format: 'uuid',
49931
- type: 'string',
49932
- },
49933
- },
49934
- required: ['location_id', 'device_ids'],
49935
- type: 'object',
49936
- },
49937
- },
49938
- },
49939
- },
49940
- responses: {
49941
- 200: {
49942
- content: {
49943
- 'application/json': {
49944
- schema: {
49945
- properties: { ok: { type: 'boolean' } },
49946
- required: ['ok'],
49947
- type: 'object',
49948
- },
49949
- },
49950
- },
49951
- description: 'OK',
49952
- },
49953
- 400: { description: 'Bad Request' },
49954
- 401: { description: 'Unauthorized' },
49955
- },
49956
- security: [
49957
- { pat_with_workspace: [] },
49958
- { console_session_with_workspace: [] },
49959
- { api_key: [] },
49960
- ],
49961
- summary: '/unstable_locations/remove_devices',
49962
- tags: [],
49963
- 'x-fern-sdk-group-name': ['unstable_locations'],
49964
- 'x-fern-sdk-method-name': 'remove_devices',
49965
- 'x-response-key': null,
49966
- 'x-title': 'Remove Devices from a Location',
49967
- 'x-undocumented': 'Experimental locations.',
49968
- },
49969
- },
49970
- '/unstable_locations/update': {
49971
- patch: {
49972
- description: 'Updates a location.',
49973
- operationId: 'unstableLocationsUpdatePatch',
49974
- requestBody: {
49975
- content: {
49976
- 'application/json': {
49977
- schema: {
49978
- properties: {
49979
- geolocation: {
49980
- description: 'Geolocation of the location.',
49981
- properties: {
49982
- latitude: { format: 'float', type: 'number' },
49983
- longitude: { format: 'float', type: 'number' },
49984
- },
49985
- required: ['latitude', 'longitude'],
49986
- type: 'object',
49987
- },
49988
- location_id: {
49989
- description: 'ID of the location that you want to update.',
49990
- format: 'uuid',
49991
- type: 'string',
49992
- },
49993
- name: {
49994
- description: 'Name of the location.',
49995
- type: 'string',
49996
- },
49997
- time_zone: {
49998
- description: 'Time zone of the the location.',
49999
- type: 'string',
50000
- },
50001
- },
50002
- required: ['location_id'],
50003
- type: 'object',
50004
- },
50005
- },
50006
- },
50007
- },
50008
- responses: {
50009
- 200: {
50010
- content: {
50011
- 'application/json': {
50012
- schema: {
50013
- properties: {
50014
- location: { $ref: '#/components/schemas/location' },
50015
- ok: { type: 'boolean' },
50016
- },
50017
- required: ['location', 'ok'],
50018
- type: 'object',
50019
- },
50020
- },
50021
- },
50022
- description: 'OK',
50023
- },
50024
- 400: { description: 'Bad Request' },
50025
- 401: { description: 'Unauthorized' },
50026
- },
50027
- security: [
50028
- { pat_with_workspace: [] },
50029
- { console_session_with_workspace: [] },
50030
- { api_key: [] },
50031
- ],
50032
- summary: '/unstable_locations/update',
50033
- tags: [],
50034
- 'x-fern-sdk-group-name': ['unstable_locations'],
50035
- 'x-fern-sdk-method-name': 'update',
50036
- 'x-fern-sdk-return-value': 'location',
50037
- 'x-response-key': 'location',
50038
- 'x-title': 'Update a Location',
50039
- 'x-undocumented': 'Experimental locations.',
50040
- },
50041
- post: {
50042
- description: 'Updates a location.',
50043
- operationId: 'unstableLocationsUpdatePost',
50044
- requestBody: {
50045
- content: {
50046
- 'application/json': {
50047
- schema: {
50048
- properties: {
50049
- geolocation: {
50050
- description: 'Geolocation of the location.',
50051
- properties: {
50052
- latitude: { format: 'float', type: 'number' },
50053
- longitude: { format: 'float', type: 'number' },
50054
- },
50055
- required: ['latitude', 'longitude'],
50056
- type: 'object',
50057
- },
50058
- location_id: {
50059
- description: 'ID of the location that you want to update.',
50060
- format: 'uuid',
50061
- type: 'string',
50062
- },
50063
- name: {
50064
- description: 'Name of the location.',
50065
- type: 'string',
50066
- },
50067
- time_zone: {
50068
- description: 'Time zone of the the location.',
50069
- type: 'string',
50070
- },
50071
- },
50072
- required: ['location_id'],
50073
- type: 'object',
50074
- },
50075
- },
50076
- },
50077
- },
50078
- responses: {
50079
- 200: {
50080
- content: {
50081
- 'application/json': {
50082
- schema: {
50083
- properties: {
50084
- location: { $ref: '#/components/schemas/location' },
50085
- ok: { type: 'boolean' },
50086
- },
50087
- required: ['location', 'ok'],
50088
- type: 'object',
50089
- },
50090
- },
50091
- },
50092
- description: 'OK',
50093
- },
50094
- 400: { description: 'Bad Request' },
50095
- 401: { description: 'Unauthorized' },
50096
- },
50097
- security: [
50098
- { pat_with_workspace: [] },
50099
- { console_session_with_workspace: [] },
50100
- { api_key: [] },
50101
- ],
50102
- summary: '/unstable_locations/update',
50103
- tags: [],
50104
- 'x-fern-sdk-group-name': ['unstable_locations'],
50105
- 'x-fern-sdk-method-name': 'update',
50106
- 'x-fern-sdk-return-value': 'location',
50107
- 'x-response-key': 'location',
50108
- 'x-title': 'Update a Location',
50109
- 'x-undocumented': 'Experimental locations.',
50110
- },
50111
- },
50112
- '/unstable_partner/building_blocks/connect_accounts': {
50113
- post: {
50114
- description: 'Creates a new building block magic link to connect accounts.',
50115
- operationId: 'unstablePartnerBuildingBlocksConnectAccountsPost',
50116
- requestBody: {
50117
- content: {
50118
- 'application/json': {
50119
- schema: {
50120
- properties: {
50121
- customer_key: {
50122
- description: 'Customer key for which you want to connect accounts.',
50123
- type: 'string',
50124
- },
50125
- },
50126
- required: ['customer_key'],
50127
- type: 'object',
50128
- },
50129
- },
50130
- },
50131
- },
50132
- responses: {
50133
- 200: {
50134
- content: {
50135
- 'application/json': {
50136
- schema: {
50137
- properties: {
50138
- magic_link: { $ref: '#/components/schemas/magic_link' },
50139
- ok: { type: 'boolean' },
50140
- },
50141
- required: ['magic_link', 'ok'],
50142
- type: 'object',
50143
- },
50144
- },
50145
- },
50146
- description: 'OK',
50147
- },
50148
- 400: { description: 'Bad Request' },
50149
- 401: { description: 'Unauthorized' },
50150
- },
50151
- security: [
50152
- { pat_with_workspace: [] },
50153
- { console_session_with_workspace: [] },
50154
- { api_key: [] },
50155
- ],
50156
- summary: '/unstable_partner/building_blocks/connect_accounts',
50157
- tags: [],
50158
- 'x-fern-sdk-group-name': ['unstable_partner', 'building_blocks'],
50159
- 'x-fern-sdk-method-name': 'connect_accounts',
50160
- 'x-fern-sdk-return-value': 'magic_link',
50161
- 'x-response-key': 'magic_link',
50162
- 'x-title': 'Generate a Connect Accounts Building Block Magic Link',
50163
- 'x-undocumented': 'Experimental partner building blocks.',
50164
- },
50165
- },
50166
- '/unstable_partner/building_blocks/generate_magic_link': {
50167
- get: {
50168
- description: 'Creates a new building block magic link.',
50169
- operationId: 'unstablePartnerBuildingBlocksGenerateMagicLinkGet',
50170
- parameters: [
50171
- {
50172
- in: 'query',
50173
- name: 'building_block_type',
50174
- required: true,
50175
- schema: {
50176
- description: 'Type of building block for which you want to create a magic link.',
50177
- enum: [
50178
- 'connect_accounts',
50179
- 'organize_spaces',
50180
- 'console',
50181
- 'manage_devices',
50182
- ],
50183
- type: 'string',
50184
- },
50185
- },
50186
- {
50187
- in: 'query',
50188
- name: 'customer_key',
50189
- required: true,
50190
- schema: {
50191
- description: 'Customer key for which you want to create a new building block magic link.',
50192
- type: 'string',
50193
- },
50194
- },
50195
- {
50196
- in: 'query',
50197
- name: 'spaces',
50198
- required: false,
50199
- schema: {
50200
- description: 'Optional list of spaces that you want to include in the new building block magic link.',
50201
- items: {
50202
- properties: {
50203
- name: {
50204
- description: 'Your display name for this location resource.',
50205
- type: 'string',
50206
- },
50207
- space_key: {
50208
- description: 'Your unique identifier for the space.',
50209
- type: 'string',
50210
- },
50211
- },
50212
- required: ['name', 'space_key'],
50213
- type: 'object',
50214
- },
50215
- type: 'array',
50216
- },
50217
- },
50218
- ],
50219
- responses: {
50220
- 200: {
50221
- content: {
50222
- 'application/json': {
50223
- schema: {
50224
- properties: {
50225
- magic_link: { $ref: '#/components/schemas/magic_link' },
50226
- ok: { type: 'boolean' },
50227
- },
50228
- required: ['magic_link', 'ok'],
50229
- type: 'object',
50230
- },
50231
- },
50232
- },
50233
- description: 'OK',
50234
- },
50235
- 400: { description: 'Bad Request' },
50236
- 401: { description: 'Unauthorized' },
50237
- },
50238
- security: [
50239
- { pat_with_workspace: [] },
50240
- { console_session_with_workspace: [] },
50241
- { api_key: [] },
50242
- ],
50243
- summary: '/unstable_partner/building_blocks/generate_magic_link',
50244
- tags: [],
50245
- 'x-fern-sdk-group-name': ['unstable_partner', 'building_blocks'],
50246
- 'x-fern-sdk-method-name': 'generate_magic_link',
50247
- 'x-fern-sdk-return-value': 'magic_link',
50248
- 'x-response-key': 'magic_link',
50249
- 'x-title': 'Generate a Building Block Magic Link',
50250
- 'x-undocumented': 'Experimental partner building blocks.',
50251
- },
50252
- post: {
50253
- description: 'Creates a new building block magic link.',
50254
- operationId: 'unstablePartnerBuildingBlocksGenerateMagicLinkPost',
50255
- requestBody: {
50256
- content: {
50257
- 'application/json': {
50258
- schema: {
50259
- properties: {
50260
- building_block_type: {
50261
- description: 'Type of building block for which you want to create a magic link.',
50262
- enum: [
50263
- 'connect_accounts',
50264
- 'organize_spaces',
50265
- 'console',
50266
- 'manage_devices',
50267
- ],
50268
- type: 'string',
50269
- },
50270
- customer_key: {
50271
- description: 'Customer key for which you want to create a new building block magic link.',
50272
- type: 'string',
50273
- },
50274
- spaces: {
50275
- description: 'Optional list of spaces that you want to include in the new building block magic link.',
50276
- items: {
50277
- properties: {
50278
- name: {
50279
- description: 'Your display name for this location resource.',
50280
- type: 'string',
50281
- },
50282
- space_key: {
50283
- description: 'Your unique identifier for the space.',
50284
- type: 'string',
50285
- },
50286
- },
50287
- required: ['name', 'space_key'],
50288
- type: 'object',
50289
- },
50290
- type: 'array',
50291
- },
50292
- },
50293
- required: ['building_block_type', 'customer_key'],
50294
- type: 'object',
50295
- },
50296
- },
50297
- },
50298
- },
50299
- responses: {
50300
- 200: {
50301
- content: {
50302
- 'application/json': {
50303
- schema: {
50304
- properties: {
50305
- magic_link: { $ref: '#/components/schemas/magic_link' },
50306
- ok: { type: 'boolean' },
50307
- },
50308
- required: ['magic_link', 'ok'],
50309
- type: 'object',
50310
- },
50311
- },
50312
- },
50313
- description: 'OK',
50314
- },
50315
- 400: { description: 'Bad Request' },
50316
- 401: { description: 'Unauthorized' },
50317
- },
50318
- security: [
50319
- { pat_with_workspace: [] },
50320
- { console_session_with_workspace: [] },
50321
- { api_key: [] },
50322
- ],
50323
- summary: '/unstable_partner/building_blocks/generate_magic_link',
50324
- tags: [],
50325
- 'x-fern-sdk-group-name': ['unstable_partner', 'building_blocks'],
50326
- 'x-fern-sdk-method-name': 'generate_magic_link',
50327
- 'x-fern-sdk-return-value': 'magic_link',
50328
- 'x-response-key': 'magic_link',
50329
- 'x-title': 'Generate a Building Block Magic Link',
50330
- 'x-undocumented': 'Experimental partner building blocks.',
50331
- },
50332
- },
50333
- '/unstable_partner/building_blocks/manage_devices': {
50334
- post: {
50335
- description: 'Creates a new building block magic link to manage devices.',
50336
- operationId: 'unstablePartnerBuildingBlocksManageDevicesPost',
50337
- requestBody: {
50338
- content: {
50339
- 'application/json': {
50340
- schema: {
50341
- properties: {
50342
- customer_key: {
50343
- description: 'Customer key for which you want to manage devices.',
50344
- type: 'string',
50345
- },
50346
- },
50347
- required: ['customer_key'],
50348
- type: 'object',
50349
- },
50350
- },
50351
- },
50352
- },
50353
- responses: {
50354
- 200: {
50355
- content: {
50356
- 'application/json': {
50357
- schema: {
50358
- properties: {
50359
- magic_link: { $ref: '#/components/schemas/magic_link' },
50360
- ok: { type: 'boolean' },
50361
- },
50362
- required: ['magic_link', 'ok'],
50363
- type: 'object',
50364
- },
50365
- },
50366
- },
50367
- description: 'OK',
50368
- },
50369
- 400: { description: 'Bad Request' },
50370
- 401: { description: 'Unauthorized' },
50371
- },
50372
- security: [
50373
- { pat_with_workspace: [] },
50374
- { console_session_with_workspace: [] },
50375
- { api_key: [] },
50376
- ],
50377
- summary: '/unstable_partner/building_blocks/manage_devices',
50378
- tags: [],
50379
- 'x-fern-sdk-group-name': ['unstable_partner', 'building_blocks'],
50380
- 'x-fern-sdk-method-name': 'manage_devices',
50381
- 'x-fern-sdk-return-value': 'magic_link',
50382
- 'x-response-key': 'magic_link',
50383
- 'x-title': 'Generate a Manage Devices Building Block Magic Link',
50384
- 'x-undocumented': 'Experimental partner building blocks.',
50385
- },
50386
- },
50387
- '/unstable_partner/building_blocks/organize_spaces': {
50388
- post: {
50389
- description: 'Creates a new building block magic link to organize spaces.',
50390
- operationId: 'unstablePartnerBuildingBlocksOrganizeSpacesPost',
50391
- requestBody: {
50392
- content: {
50393
- 'application/json': {
50394
- schema: {
50395
- properties: {
50396
- customer_key: {
50397
- description: 'Customer key for which you want to organize spaces.',
50398
- type: 'string',
50399
- },
50400
- spaces: {
50401
- description: 'Optional list of spaces that you want to include in the new building block magic link.',
50402
- items: {
50403
- properties: {
50404
- name: {
50405
- description: 'Your display name for this location resource.',
50406
- type: 'string',
50407
- },
50408
- space_key: {
50409
- description: 'Your unique identifier for the space.',
50410
- type: 'string',
50411
- },
50412
- },
50413
- required: ['name', 'space_key'],
50414
- type: 'object',
50415
- },
50416
- type: 'array',
50417
- },
50418
- },
50419
- required: ['customer_key'],
50420
- type: 'object',
50421
- },
50422
- },
50423
- },
50424
- },
50425
- responses: {
50426
- 200: {
50427
- content: {
50428
- 'application/json': {
50429
- schema: {
50430
- properties: {
50431
- magic_link: { $ref: '#/components/schemas/magic_link' },
50432
- ok: { type: 'boolean' },
50433
- },
50434
- required: ['magic_link', 'ok'],
50435
- type: 'object',
50436
- },
50437
- },
50438
- },
50439
- description: 'OK',
50440
- },
50441
- 400: { description: 'Bad Request' },
50442
- 401: { description: 'Unauthorized' },
50443
- },
50444
- security: [
50445
- { pat_with_workspace: [] },
50446
- { console_session_with_workspace: [] },
50447
- { api_key: [] },
50448
- ],
50449
- summary: '/unstable_partner/building_blocks/organize_spaces',
50450
- tags: [],
50451
- 'x-fern-sdk-group-name': ['unstable_partner', 'building_blocks'],
50452
- 'x-fern-sdk-method-name': 'organize_spaces',
50453
- 'x-fern-sdk-return-value': 'magic_link',
50454
- 'x-response-key': 'magic_link',
50455
- 'x-title': 'Generate an Organize Spaces Building Block Magic Link',
50456
- 'x-undocumented': 'Experimental partner building blocks.',
50457
- },
50458
- },
50459
- '/user_identities/add_acs_user': {
50460
- post: {
50461
- 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/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
50462
- operationId: 'userIdentitiesAddAcsUserPost',
50463
- requestBody: {
50464
- content: {
50465
- 'application/json': {
50466
- schema: {
50467
- properties: {
50468
- acs_user_id: {
50469
- description: 'ID of the access system user that you want to add to the user identity.',
50470
- format: 'uuid',
50471
- type: 'string',
50472
- },
50473
- user_identity_id: {
50474
- description: 'ID of the user identity to which you want to add an access system user.',
50475
- format: 'uuid',
50476
- type: 'string',
50477
- },
50478
- },
50479
- required: ['user_identity_id', 'acs_user_id'],
49494
+ required: ['user_identity_id', 'acs_user_id'],
50480
49495
  type: 'object',
50481
49496
  },
50482
49497
  },
@@ -52789,6 +51804,10 @@ export default {
52789
51804
  batch: {
52790
51805
  description: 'A batch of workspace resources.',
52791
51806
  properties: {
51807
+ access_methods: {
51808
+ items: { $ref: '#/components/schemas/access_method' },
51809
+ type: 'array',
51810
+ },
52792
51811
  acs_access_groups: {
52793
51812
  items: {
52794
51813
  $ref: '#/components/schemas/acs_access_group',
@@ -52923,6 +51942,10 @@ export default {
52923
51942
  batch: {
52924
51943
  description: 'A batch of workspace resources.',
52925
51944
  properties: {
51945
+ access_methods: {
51946
+ items: { $ref: '#/components/schemas/access_method' },
51947
+ type: 'array',
51948
+ },
52926
51949
  acs_access_groups: {
52927
51950
  items: {
52928
51951
  $ref: '#/components/schemas/acs_access_group',