@seamapi/types 1.410.0 → 1.410.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -22253,6 +22253,7 @@ export default {
22253
22253
  },
22254
22254
  security: [
22255
22255
  { client_session: [] },
22256
+ { client_session_with_customer: [] },
22256
22257
  { pat_with_workspace: [] },
22257
22258
  { console_session_with_workspace: [] },
22258
22259
  { api_key: [] },
@@ -22401,6 +22402,7 @@ export default {
22401
22402
  },
22402
22403
  security: [
22403
22404
  { client_session: [] },
22405
+ { client_session_with_customer: [] },
22404
22406
  { pat_with_workspace: [] },
22405
22407
  { console_session_with_workspace: [] },
22406
22408
  { api_key: [] },
@@ -22550,6 +22552,7 @@ export default {
22550
22552
  },
22551
22553
  security: [
22552
22554
  { client_session: [] },
22555
+ { client_session_with_customer: [] },
22553
22556
  { pat_with_workspace: [] },
22554
22557
  { console_session_with_workspace: [] },
22555
22558
  { api_key: [] },
@@ -29136,6 +29139,7 @@ export default {
29136
29139
  },
29137
29140
  security: [
29138
29141
  { client_session: [] },
29142
+ { client_session_with_customer: [] },
29139
29143
  { api_key: [] },
29140
29144
  { pat_with_workspace: [] },
29141
29145
  { console_session_with_workspace: [] },
@@ -29926,6 +29930,7 @@ export default {
29926
29930
  { api_key: [] },
29927
29931
  { pat_with_workspace: [] },
29928
29932
  { console_session_with_workspace: [] },
29933
+ { client_session_with_customer: [] },
29929
29934
  ],
29930
29935
  summary: '/devices/simulate/connect',
29931
29936
  tags: ['/devices'],
@@ -29978,6 +29983,7 @@ export default {
29978
29983
  { api_key: [] },
29979
29984
  { pat_with_workspace: [] },
29980
29985
  { console_session_with_workspace: [] },
29986
+ { client_session_with_customer: [] },
29981
29987
  ],
29982
29988
  summary: '/devices/simulate/disconnect',
29983
29989
  tags: ['/devices'],
@@ -30030,6 +30036,7 @@ export default {
30030
30036
  { api_key: [] },
30031
30037
  { pat_with_workspace: [] },
30032
30038
  { console_session_with_workspace: [] },
30039
+ { client_session_with_customer: [] },
30033
30040
  ],
30034
30041
  summary: '/devices/simulate/remove',
30035
30042
  tags: ['/devices'],
@@ -30629,6 +30636,7 @@ export default {
30629
30636
  { pat_with_workspace: [] },
30630
30637
  { console_session_with_workspace: [] },
30631
30638
  { client_session: [] },
30639
+ { client_session_with_customer: [] },
30632
30640
  ],
30633
30641
  summary: '/devices/update',
30634
30642
  tags: ['/devices'],
@@ -30711,6 +30719,7 @@ export default {
30711
30719
  { pat_with_workspace: [] },
30712
30720
  { console_session_with_workspace: [] },
30713
30721
  { client_session: [] },
30722
+ { client_session_with_customer: [] },
30714
30723
  ],
30715
30724
  summary: '/devices/update',
30716
30725
  tags: ['/devices'],
@@ -30777,6 +30786,7 @@ export default {
30777
30786
  { api_key: [] },
30778
30787
  { pat_with_workspace: [] },
30779
30788
  { console_session_with_workspace: [] },
30789
+ { client_session_with_customer: [] },
30780
30790
  ],
30781
30791
  summary: '/events/get',
30782
30792
  tags: ['/events'],
@@ -32661,7 +32671,8 @@ export default {
32661
32671
  schema: {
32662
32672
  properties: {
32663
32673
  device_id: {
32664
- description: 'Device ID of the desired phone.',
32674
+ description:
32675
+ 'Device ID of the phone that you want to deactivate.',
32665
32676
  type: 'string',
32666
32677
  },
32667
32678
  },
@@ -32704,7 +32715,7 @@ export default {
32704
32715
  '/phones/get': {
32705
32716
  post: {
32706
32717
  description:
32707
- 'Returns a single phone entry matching the provided `device_id`.',
32718
+ 'Returns a specified [phone](https://docs.seam.co/latest/capability-guides/mobile-access/managing-phones-for-a-user-identity).',
32708
32719
  operationId: 'phonesGetPost',
32709
32720
  requestBody: {
32710
32721
  content: {
@@ -32712,7 +32723,7 @@ export default {
32712
32723
  schema: {
32713
32724
  properties: {
32714
32725
  device_id: {
32715
- description: 'Device ID of the desired phone.',
32726
+ description: 'Device ID of the phone that you want to get.',
32716
32727
  format: 'uuid',
32717
32728
  type: 'string',
32718
32729
  },
@@ -32753,13 +32764,13 @@ export default {
32753
32764
  'x-fern-sdk-method-name': 'get',
32754
32765
  'x-fern-sdk-return-value': 'phone',
32755
32766
  'x-response-key': 'phone',
32756
- 'x-title': 'Get Phone',
32767
+ 'x-title': 'Get a Phone',
32757
32768
  },
32758
32769
  },
32759
32770
  '/phones/list': {
32760
32771
  post: {
32761
32772
  description:
32762
- '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.',
32773
+ '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.',
32763
32774
  operationId: 'phonesListPost',
32764
32775
  requestBody: {
32765
32776
  content: {
@@ -32768,13 +32779,13 @@ export default {
32768
32779
  properties: {
32769
32780
  acs_credential_id: {
32770
32781
  description:
32771
- 'ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) by which to filter the list of returned phones.',
32782
+ '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.',
32772
32783
  format: 'uuid',
32773
32784
  type: 'string',
32774
32785
  },
32775
32786
  owner_user_identity_id: {
32776
32787
  description:
32777
- 'ID of the user identity that represents the owner by which to filter the list of returned phones.',
32788
+ 'ID of the user identity that represents the owner by which you want to filter the list of returned phones.',
32778
32789
  format: 'uuid',
32779
32790
  type: 'string',
32780
32791
  },
@@ -32823,7 +32834,7 @@ export default {
32823
32834
  '/phones/simulate/create_sandbox_phone': {
32824
32835
  post: {
32825
32836
  description:
32826
- '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).',
32837
+ '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).',
32827
32838
  operationId: 'phonesSimulateCreateSandboxPhonePost',
32828
32839
  requestBody: {
32829
32840
  content: {
@@ -32833,7 +32844,7 @@ export default {
32833
32844
  assa_abloy_metadata: {
32834
32845
  default: {},
32835
32846
  description:
32836
- 'ASSA ABLOY metadata to associate with the simulated phone.',
32847
+ 'ASSA ABLOY metadata that you want to associate with the simulated phone.',
32837
32848
  properties: {
32838
32849
  application_version: {
32839
32850
  default: '1.0.0',
@@ -32877,13 +32888,13 @@ export default {
32877
32888
  },
32878
32889
  custom_sdk_installation_id: {
32879
32890
  description:
32880
- 'ID of the custom SDK installation to use for the simulated phone.',
32891
+ 'ID of the custom SDK installation that you want to use for the simulated phone.',
32881
32892
  type: 'string',
32882
32893
  },
32883
32894
  phone_metadata: {
32884
32895
  default: {},
32885
32896
  description:
32886
- 'Metadata to associate with the simulated phone.',
32897
+ 'Metadata that you want to associate with the simulated phone.',
32887
32898
  properties: {
32888
32899
  device_manufacturer: {
32889
32900
  default: 'Samsung',
@@ -32915,7 +32926,7 @@ export default {
32915
32926
  },
32916
32927
  user_identity_id: {
32917
32928
  description:
32918
- 'ID of the user identity to associate with the simulated phone.',
32929
+ 'ID of the user identity that you want to associate with the simulated phone.',
32919
32930
  format: 'uuid',
32920
32931
  type: 'string',
32921
32932
  },
@@ -32961,16 +32972,29 @@ export default {
32961
32972
  },
32962
32973
  '/seam/bridge/v1/bridge_client_sessions/create': {
32963
32974
  post: {
32964
- description: 'Creates a new bridge client session.',
32975
+ description:
32976
+ 'Creates a new [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client session.',
32965
32977
  operationId: 'seamBridgeV1BridgeClientSessionsCreatePost',
32966
32978
  requestBody: {
32967
32979
  content: {
32968
32980
  'application/json': {
32969
32981
  schema: {
32970
32982
  properties: {
32971
- bridge_client_machine_identifier_key: { type: 'string' },
32972
- bridge_client_name: { type: 'string' },
32973
- bridge_client_time_zone: { type: 'string' },
32983
+ bridge_client_machine_identifier_key: {
32984
+ description:
32985
+ 'Identifier key of the client machine for the Seam Bridge client that you want to create.',
32986
+ type: 'string',
32987
+ },
32988
+ bridge_client_name: {
32989
+ description:
32990
+ 'Name of the Seam Bridge client that you want to create.',
32991
+ type: 'string',
32992
+ },
32993
+ bridge_client_time_zone: {
32994
+ description:
32995
+ 'Time zone for the Seam Bridge that you want to create.',
32996
+ type: 'string',
32997
+ },
32974
32998
  },
32975
32999
  required: [
32976
33000
  'bridge_client_name',
@@ -33156,13 +33180,13 @@ export default {
33156
33180
  'x-fern-sdk-return-value': 'bridge_client_session',
33157
33181
  'x-response-key': 'bridge_client_session',
33158
33182
  'x-title': 'Create a Bridge Client Session',
33159
- 'x-undocumented': 'Seam Bridge Client only.',
33183
+ 'x-undocumented': 'Seam Bridge client only.',
33160
33184
  },
33161
33185
  },
33162
33186
  '/seam/bridge/v1/bridge_client_sessions/get': {
33163
33187
  get: {
33164
33188
  description:
33165
- 'Returns the bridge client session associated with the session token used.',
33189
+ 'Returns the [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client session associated with the client session token used for authentication.',
33166
33190
  operationId: 'seamBridgeV1BridgeClientSessionsGetGet',
33167
33191
  responses: {
33168
33192
  200: {
@@ -33330,12 +33354,12 @@ export default {
33330
33354
  tags: [],
33331
33355
  'x-fern-ignore': true,
33332
33356
  'x-response-key': 'bridge_client_session',
33333
- 'x-title': 'Get a Bridge Client Session',
33357
+ 'x-title': 'Get a Seam Bridge Client Session',
33334
33358
  'x-undocumented': 'Seam Bridge Client only.',
33335
33359
  },
33336
33360
  post: {
33337
33361
  description:
33338
- 'Returns the bridge client session associated with the session token used.',
33362
+ 'Returns the [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client session associated with the client session token used for authentication.',
33339
33363
  operationId: 'seamBridgeV1BridgeClientSessionsGetPost',
33340
33364
  responses: {
33341
33365
  200: {
@@ -33510,14 +33534,14 @@ export default {
33510
33534
  'x-fern-sdk-method-name': 'get',
33511
33535
  'x-fern-sdk-return-value': 'bridge_client_session',
33512
33536
  'x-response-key': 'bridge_client_session',
33513
- 'x-title': 'Get a Bridge Client Session',
33537
+ 'x-title': 'Get a Seam Bridge Client Session',
33514
33538
  'x-undocumented': 'Seam Bridge Client only.',
33515
33539
  },
33516
33540
  },
33517
33541
  '/seam/bridge/v1/bridge_client_sessions/refresh_telemetry_token': {
33518
33542
  post: {
33519
33543
  description:
33520
- 'Returns the bridge client session associated with the session token and refreshed telemetry token.',
33544
+ '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.',
33521
33545
  operationId:
33522
33546
  'seamBridgeV1BridgeClientSessionsRefreshTelemetryTokenPost',
33523
33547
  responses: {
@@ -33694,14 +33718,15 @@ export default {
33694
33718
  'x-fern-sdk-method-name': 'refresh_telemetry_token',
33695
33719
  'x-fern-sdk-return-value': 'bridge_client_session',
33696
33720
  'x-response-key': 'bridge_client_session',
33697
- 'x-title': 'Refresh telemetry token for bridge client session',
33721
+ 'x-title':
33722
+ 'Refresh the Telemetry Token for a Seam Bridge Client Session',
33698
33723
  'x-undocumented': 'Seam Bridge Client only.',
33699
33724
  },
33700
33725
  },
33701
33726
  '/seam/bridge/v1/bridge_client_sessions/regenerate_pairing_code': {
33702
33727
  post: {
33703
33728
  description:
33704
- 'Generate a new pairing code and return the updated bridge client session.',
33729
+ 'Generate a new pairing code and return the updated [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client session.',
33705
33730
  operationId:
33706
33731
  'seamBridgeV1BridgeClientSessionsRegeneratePairingCodePost',
33707
33732
  responses: {
@@ -33878,21 +33903,30 @@ export default {
33878
33903
  'x-fern-sdk-method-name': 'regenerate_pairing_code',
33879
33904
  'x-fern-sdk-return-value': 'bridge_client_session',
33880
33905
  'x-response-key': 'bridge_client_session',
33881
- 'x-title': 'Regenerate a Bridge Client Session Pairing Code',
33906
+ 'x-title': 'Regenerate a Seam Bridge Client Session Pairing Code',
33882
33907
  'x-undocumented': 'Seam Bridge Client only.',
33883
33908
  },
33884
33909
  },
33885
33910
  '/seam/bridge/v1/bridge_client_sessions/report_status': {
33886
33911
  post: {
33887
- description: "Report a Seam Bridge Bridge client's status.",
33912
+ description:
33913
+ 'Report the status of a [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client.',
33888
33914
  operationId: 'seamBridgeV1BridgeClientSessionsReportStatusPost',
33889
33915
  requestBody: {
33890
33916
  content: {
33891
33917
  'application/json': {
33892
33918
  schema: {
33893
33919
  properties: {
33894
- is_tailscale_connected: { nullable: true, type: 'boolean' },
33895
- tailscale_ip_v4: { nullable: true, type: 'string' },
33920
+ is_tailscale_connected: {
33921
+ description: 'Indicates whether Tailscale is connected.',
33922
+ nullable: true,
33923
+ type: 'boolean',
33924
+ },
33925
+ tailscale_ip_v4: {
33926
+ description: 'Tailscale IPv4 address.',
33927
+ nullable: true,
33928
+ type: 'string',
33929
+ },
33896
33930
  },
33897
33931
  required: ['is_tailscale_connected', 'tailscale_ip_v4'],
33898
33932
  type: 'object',
@@ -33927,14 +33961,14 @@ export default {
33927
33961
  ],
33928
33962
  'x-fern-sdk-method-name': 'report_status',
33929
33963
  'x-response-key': null,
33930
- 'x-title': "Report a Bridge Client's Status",
33964
+ 'x-title': 'Report the Status of a Seam Bridge Client',
33931
33965
  'x-undocumented': 'Seam Bridge Client only.',
33932
33966
  },
33933
33967
  },
33934
33968
  '/seam/bridge/v1/bridge_connected_systems/list': {
33935
33969
  get: {
33936
33970
  description:
33937
- 'Returns the bridge connected systems associated with the session token used.',
33971
+ 'Returns the [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge)-connected systems associated with the client session token used for authentication.',
33938
33972
  operationId: 'seamBridgeV1BridgeConnectedSystemsListGet',
33939
33973
  responses: {
33940
33974
  200: {
@@ -33997,12 +34031,12 @@ export default {
33997
34031
  tags: [],
33998
34032
  'x-fern-ignore': true,
33999
34033
  'x-response-key': 'bridge_connected_systems',
34000
- 'x-title': 'List Bridge Connected Systems',
34034
+ 'x-title': 'List Bridge-Connected Systems',
34001
34035
  'x-undocumented': 'Seam Bridge Client only.',
34002
34036
  },
34003
34037
  post: {
34004
34038
  description:
34005
- 'Returns the bridge connected systems associated with the session token used.',
34039
+ 'Returns the [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge)-connected systems associated with the client session token used for authentication.',
34006
34040
  operationId: 'seamBridgeV1BridgeConnectedSystemsListPost',
34007
34041
  responses: {
34008
34042
  200: {
@@ -34072,14 +34106,14 @@ export default {
34072
34106
  'x-fern-sdk-method-name': 'list',
34073
34107
  'x-fern-sdk-return-value': 'bridge_connected_systems',
34074
34108
  'x-response-key': 'bridge_connected_systems',
34075
- 'x-title': 'List Bridge Connected Systems',
34109
+ 'x-title': 'List Bridge-Connected Systems',
34076
34110
  'x-undocumented': 'Seam Bridge Client only.',
34077
34111
  },
34078
34112
  },
34079
34113
  '/seam/instant_key/v1/client_sessions/exchange_short_code': {
34080
34114
  post: {
34081
34115
  description:
34082
- '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.',
34116
+ '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.',
34083
34117
  operationId: 'seamInstantKeyV1ClientSessionsExchangeShortCodePost',
34084
34118
  requestBody: {
34085
34119
  content: {
@@ -34088,7 +34122,7 @@ export default {
34088
34122
  properties: {
34089
34123
  short_code: {
34090
34124
  description:
34091
- 'The short code to exchange for a client session token',
34125
+ 'Short code that you want to exchange for a client session token.',
34092
34126
  type: 'string',
34093
34127
  },
34094
34128
  },
@@ -34137,7 +34171,8 @@ export default {
34137
34171
  },
34138
34172
  '/seam/mobile_sdk/v1/acs/credentials/list': {
34139
34173
  post: {
34140
- description: 'Returns a list of all ACS credentials.',
34174
+ description:
34175
+ 'Returns a list of all [credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
34141
34176
  operationId: 'seamMobileSdkV1AcsCredentialsListPost',
34142
34177
  requestBody: {
34143
34178
  content: {
@@ -34185,15 +34220,21 @@ export default {
34185
34220
  },
34186
34221
  '/seam/mobile_sdk/v1/phone_sessions/get_or_create': {
34187
34222
  post: {
34188
- description: 'Get or create a session for a mobile SDK phone.',
34223
+ description: 'Gets or creates a session for a mobile SDK phone.',
34189
34224
  operationId: 'seamMobileSdkV1PhoneSessionsGetOrCreatePost',
34190
34225
  requestBody: {
34191
34226
  content: {
34192
34227
  'application/json': {
34193
34228
  schema: {
34194
34229
  properties: {
34195
- custom_sdk_installation_id: { type: 'string' },
34230
+ custom_sdk_installation_id: {
34231
+ description:
34232
+ 'ID of the custom SDK installation that you want to use for the new session.',
34233
+ type: 'string',
34234
+ },
34196
34235
  phone_device_metadata: {
34236
+ description:
34237
+ 'Phone device metadata that you want to use for the new session.',
34197
34238
  properties: {
34198
34239
  manufacturer: { type: 'string' },
34199
34240
  model: { type: 'string' },
@@ -34201,7 +34242,12 @@ export default {
34201
34242
  },
34202
34243
  type: 'object',
34203
34244
  },
34204
- phone_os: { enum: ['ios', 'android'], type: 'string' },
34245
+ phone_os: {
34246
+ description:
34247
+ 'Phone operating system that you want to use for the new session.',
34248
+ enum: ['ios', 'android'],
34249
+ type: 'string',
34250
+ },
34205
34251
  },
34206
34252
  required: ['custom_sdk_installation_id', 'phone_os'],
34207
34253
  type: 'object',
@@ -34244,13 +34290,18 @@ export default {
34244
34290
  '/seam/partner/v1/building_blocks/spaces/auto_map': {
34245
34291
  post: {
34246
34292
  description:
34247
- 'Auto map partner resources that have been pushed to Seam.',
34293
+ 'Auto-maps partner resources that have been pushed to Seam.',
34248
34294
  operationId: 'seamPartnerV1BuildingBlocksSpacesAutoMapPost',
34249
34295
  requestBody: {
34250
34296
  content: {
34251
34297
  'application/json': {
34252
34298
  schema: {
34253
- properties: { collection_key: { type: 'string' } },
34299
+ properties: {
34300
+ collection_key: {
34301
+ description: 'Collection key.',
34302
+ type: 'string',
34303
+ },
34304
+ },
34254
34305
  required: ['collection_key'],
34255
34306
  type: 'object',
34256
34307
  },
@@ -34331,13 +34382,13 @@ export default {
34331
34382
  'x-fern-sdk-method-name': 'auto_map',
34332
34383
  'x-fern-sdk-return-value': 'spaces',
34333
34384
  'x-response-key': 'spaces',
34334
- 'x-title': 'Do auto mapping for partner resources that map to spaces',
34385
+ 'x-title': 'Do Auto-Mapping for Partner Resources that Map to Spaces',
34335
34386
  'x-undocumented': 'Partner building blocks/UI only.',
34336
34387
  },
34337
34388
  },
34338
34389
  '/seam/partner/v1/resources/list': {
34339
34390
  post: {
34340
- description: 'List partner resources that have been pushed to Seam.',
34391
+ description: 'Lists partner resources that have been pushed to Seam.',
34341
34392
  operationId: 'seamPartnerV1ResourcesListPost',
34342
34393
  requestBody: {
34343
34394
  content: {
@@ -34345,7 +34396,8 @@ export default {
34345
34396
  schema: {
34346
34397
  properties: {
34347
34398
  resource_type_alias: {
34348
- description: 'Filter by resource type alias.',
34399
+ description:
34400
+ 'Resource type alias by which you want to filter partner resources.',
34349
34401
  type: 'string',
34350
34402
  },
34351
34403
  },
@@ -34412,13 +34464,14 @@ export default {
34412
34464
  'x-fern-sdk-method-name': 'list',
34413
34465
  'x-fern-sdk-return-value': 'partner_resources',
34414
34466
  'x-response-key': 'partner_resources',
34415
- 'x-title': 'List partner resources at Seam',
34467
+ 'x-title': 'List Partner Resources at Seam',
34416
34468
  'x-undocumented': 'Partner building blocks/UI only.',
34417
34469
  },
34418
34470
  },
34419
34471
  '/spaces/add_acs_entrances': {
34420
34472
  post: {
34421
- description: 'Add entrances to a specific space.',
34473
+ description:
34474
+ 'Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific space.',
34422
34475
  operationId: 'spacesAddAcsEntrancesPost',
34423
34476
  requestBody: {
34424
34477
  content: {
@@ -34426,11 +34479,18 @@ export default {
34426
34479
  schema: {
34427
34480
  properties: {
34428
34481
  acs_entrance_ids: {
34482
+ description:
34483
+ 'IDs of the entrances that you want to add to the space.',
34429
34484
  items: { format: 'uuid', type: 'string' },
34430
34485
  minItems: 1,
34431
34486
  type: 'array',
34432
34487
  },
34433
- space_id: { format: 'uuid', type: 'string' },
34488
+ space_id: {
34489
+ description:
34490
+ 'ID of the space to which you want to add entrances.',
34491
+ format: 'uuid',
34492
+ type: 'string',
34493
+ },
34434
34494
  },
34435
34495
  required: ['space_id', 'acs_entrance_ids'],
34436
34496
  type: 'object',
@@ -34465,10 +34525,11 @@ export default {
34465
34525
  'x-fern-sdk-group-name': ['spaces'],
34466
34526
  'x-fern-sdk-method-name': 'add_acs_entrances',
34467
34527
  'x-response-key': null,
34468
- 'x-title': 'Add ACS Entrances',
34528
+ 'x-title': 'Add Entrances to a Space',
34469
34529
  },
34470
34530
  put: {
34471
- description: 'Add entrances to a specific space.',
34531
+ description:
34532
+ 'Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific space.',
34472
34533
  operationId: 'spacesAddAcsEntrancesPut',
34473
34534
  requestBody: {
34474
34535
  content: {
@@ -34476,11 +34537,18 @@ export default {
34476
34537
  schema: {
34477
34538
  properties: {
34478
34539
  acs_entrance_ids: {
34540
+ description:
34541
+ 'IDs of the entrances that you want to add to the space.',
34479
34542
  items: { format: 'uuid', type: 'string' },
34480
34543
  minItems: 1,
34481
34544
  type: 'array',
34482
34545
  },
34483
- space_id: { format: 'uuid', type: 'string' },
34546
+ space_id: {
34547
+ description:
34548
+ 'ID of the space to which you want to add entrances.',
34549
+ format: 'uuid',
34550
+ type: 'string',
34551
+ },
34484
34552
  },
34485
34553
  required: ['space_id', 'acs_entrance_ids'],
34486
34554
  type: 'object',
@@ -34514,12 +34582,12 @@ export default {
34514
34582
  'x-draft': 'Early access.',
34515
34583
  'x-fern-ignore': true,
34516
34584
  'x-response-key': null,
34517
- 'x-title': 'Add ACS Entrances',
34585
+ 'x-title': 'Add Entrances to a Space',
34518
34586
  },
34519
34587
  },
34520
34588
  '/spaces/add_devices': {
34521
34589
  post: {
34522
- description: 'Add devices to a specific space.',
34590
+ description: 'Adds devices to a specific space.',
34523
34591
  operationId: 'spacesAddDevicesPost',
34524
34592
  requestBody: {
34525
34593
  content: {
@@ -34527,11 +34595,18 @@ export default {
34527
34595
  schema: {
34528
34596
  properties: {
34529
34597
  device_ids: {
34598
+ description:
34599
+ 'IDs of the devices that you want to add to the space.',
34530
34600
  items: { format: 'uuid', type: 'string' },
34531
34601
  minItems: 1,
34532
34602
  type: 'array',
34533
34603
  },
34534
- space_id: { format: 'uuid', type: 'string' },
34604
+ space_id: {
34605
+ description:
34606
+ 'ID of the space to which you want to add devices.',
34607
+ format: 'uuid',
34608
+ type: 'string',
34609
+ },
34535
34610
  },
34536
34611
  required: ['space_id', 'device_ids'],
34537
34612
  type: 'object',
@@ -34566,10 +34641,10 @@ export default {
34566
34641
  'x-fern-sdk-group-name': ['spaces'],
34567
34642
  'x-fern-sdk-method-name': 'add_devices',
34568
34643
  'x-response-key': null,
34569
- 'x-title': 'Add Space Devices',
34644
+ 'x-title': 'Add Devices to a Space',
34570
34645
  },
34571
34646
  put: {
34572
- description: 'Add devices to a specific space.',
34647
+ description: 'Adds devices to a specific space.',
34573
34648
  operationId: 'spacesAddDevicesPut',
34574
34649
  requestBody: {
34575
34650
  content: {
@@ -34577,11 +34652,18 @@ export default {
34577
34652
  schema: {
34578
34653
  properties: {
34579
34654
  device_ids: {
34655
+ description:
34656
+ 'IDs of the devices that you want to add to the space.',
34580
34657
  items: { format: 'uuid', type: 'string' },
34581
34658
  minItems: 1,
34582
34659
  type: 'array',
34583
34660
  },
34584
- space_id: { format: 'uuid', type: 'string' },
34661
+ space_id: {
34662
+ description:
34663
+ 'ID of the space to which you want to add devices.',
34664
+ format: 'uuid',
34665
+ type: 'string',
34666
+ },
34585
34667
  },
34586
34668
  required: ['space_id', 'device_ids'],
34587
34669
  type: 'object',
@@ -34615,12 +34697,12 @@ export default {
34615
34697
  'x-draft': 'Early access.',
34616
34698
  'x-fern-ignore': true,
34617
34699
  'x-response-key': null,
34618
- 'x-title': 'Add Space Devices',
34700
+ 'x-title': 'Add Devices to a Space',
34619
34701
  },
34620
34702
  },
34621
34703
  '/spaces/create': {
34622
34704
  post: {
34623
- description: 'Create a new space.',
34705
+ description: 'Creates a new space.',
34624
34706
  operationId: 'spacesCreatePost',
34625
34707
  requestBody: {
34626
34708
  content: {
@@ -34628,14 +34710,21 @@ export default {
34628
34710
  schema: {
34629
34711
  properties: {
34630
34712
  acs_entrance_ids: {
34713
+ description:
34714
+ 'IDs of the entrances that you want to add to the new space.',
34631
34715
  items: { format: 'uuid', type: 'string' },
34632
34716
  type: 'array',
34633
34717
  },
34634
34718
  device_ids: {
34719
+ description:
34720
+ 'IDs of the devices that you want to add to the new space.',
34635
34721
  items: { format: 'uuid', type: 'string' },
34636
34722
  type: 'array',
34637
34723
  },
34638
- name: { type: 'string' },
34724
+ name: {
34725
+ description: 'Name of the space that you want to create.',
34726
+ type: 'string',
34727
+ },
34639
34728
  },
34640
34729
  required: ['name'],
34641
34730
  type: 'object',
@@ -34674,18 +34763,24 @@ export default {
34674
34763
  'x-fern-sdk-method-name': 'create',
34675
34764
  'x-fern-sdk-return-value': 'space',
34676
34765
  'x-response-key': 'space',
34677
- 'x-title': 'Create Space',
34766
+ 'x-title': 'Create a Space',
34678
34767
  },
34679
34768
  },
34680
34769
  '/spaces/delete': {
34681
34770
  post: {
34682
- description: 'Delete a space.',
34771
+ description: 'Deletes a space.',
34683
34772
  operationId: 'spacesDeletePost',
34684
34773
  requestBody: {
34685
34774
  content: {
34686
34775
  'application/json': {
34687
34776
  schema: {
34688
- properties: { space_id: { format: 'uuid', type: 'string' } },
34777
+ properties: {
34778
+ space_id: {
34779
+ description: 'ID of the space that you want to delete.',
34780
+ format: 'uuid',
34781
+ type: 'string',
34782
+ },
34783
+ },
34689
34784
  required: ['space_id'],
34690
34785
  type: 'object',
34691
34786
  },
@@ -34715,21 +34810,28 @@ export default {
34715
34810
  ],
34716
34811
  summary: '/spaces/delete',
34717
34812
  tags: [],
34813
+ 'x-draft': 'Early access.',
34718
34814
  'x-fern-sdk-group-name': ['spaces'],
34719
34815
  'x-fern-sdk-method-name': 'delete',
34720
34816
  'x-response-key': null,
34721
- 'x-title': 'Delete Space',
34817
+ 'x-title': 'Delete a Space',
34722
34818
  },
34723
34819
  },
34724
34820
  '/spaces/get': {
34725
34821
  post: {
34726
- description: 'Get a space.',
34822
+ description: 'Gets a space.',
34727
34823
  operationId: 'spacesGetPost',
34728
34824
  requestBody: {
34729
34825
  content: {
34730
34826
  'application/json': {
34731
34827
  schema: {
34732
- properties: { space_id: { format: 'uuid', type: 'string' } },
34828
+ properties: {
34829
+ space_id: {
34830
+ description: 'ID of the space that you want to get.',
34831
+ format: 'uuid',
34832
+ type: 'string',
34833
+ },
34834
+ },
34733
34835
  required: ['space_id'],
34734
34836
  type: 'object',
34735
34837
  },
@@ -34762,11 +34864,12 @@ export default {
34762
34864
  ],
34763
34865
  summary: '/spaces/get',
34764
34866
  tags: [],
34867
+ 'x-draft': 'Early access.',
34765
34868
  'x-fern-sdk-group-name': ['spaces'],
34766
34869
  'x-fern-sdk-method-name': 'get',
34767
34870
  'x-fern-sdk-return-value': 'space',
34768
34871
  'x-response-key': 'space',
34769
- 'x-title': 'Get Space',
34872
+ 'x-title': 'Get a Space',
34770
34873
  },
34771
34874
  },
34772
34875
  '/spaces/list': {
@@ -34849,7 +34952,8 @@ export default {
34849
34952
  },
34850
34953
  '/spaces/remove_acs_entrances': {
34851
34954
  post: {
34852
- description: 'Remove entrances from a specific space.',
34955
+ description:
34956
+ 'Removes [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) from a specific space.',
34853
34957
  operationId: 'spacesRemoveAcsEntrancesPost',
34854
34958
  requestBody: {
34855
34959
  content: {
@@ -34857,10 +34961,17 @@ export default {
34857
34961
  schema: {
34858
34962
  properties: {
34859
34963
  acs_entrance_ids: {
34964
+ description:
34965
+ 'IDs of the entrances that you want to remove from the space.',
34860
34966
  items: { format: 'uuid', type: 'string' },
34861
34967
  type: 'array',
34862
34968
  },
34863
- space_id: { format: 'uuid', type: 'string' },
34969
+ space_id: {
34970
+ description:
34971
+ 'ID of the space from which you want to remove entrances.',
34972
+ format: 'uuid',
34973
+ type: 'string',
34974
+ },
34864
34975
  },
34865
34976
  required: ['space_id', 'acs_entrance_ids'],
34866
34977
  type: 'object',
@@ -34895,12 +35006,12 @@ export default {
34895
35006
  'x-fern-sdk-group-name': ['spaces'],
34896
35007
  'x-fern-sdk-method-name': 'remove_acs_entrances',
34897
35008
  'x-response-key': null,
34898
- 'x-title': 'Remove ACS Entrances',
35009
+ 'x-title': 'Remove Entrances from a Space',
34899
35010
  },
34900
35011
  },
34901
35012
  '/spaces/remove_devices': {
34902
35013
  post: {
34903
- description: 'Remove devices from a specific space.',
35014
+ description: 'Removes devices from a specific space.',
34904
35015
  operationId: 'spacesRemoveDevicesPost',
34905
35016
  requestBody: {
34906
35017
  content: {
@@ -34908,10 +35019,17 @@ export default {
34908
35019
  schema: {
34909
35020
  properties: {
34910
35021
  device_ids: {
35022
+ description:
35023
+ 'IDs of the devices that you want to remove from the space.',
34911
35024
  items: { format: 'uuid', type: 'string' },
34912
35025
  type: 'array',
34913
35026
  },
34914
- space_id: { format: 'uuid', type: 'string' },
35027
+ space_id: {
35028
+ description:
35029
+ 'ID of the space from which you want to remove devices.',
35030
+ format: 'uuid',
35031
+ type: 'string',
35032
+ },
34915
35033
  },
34916
35034
  required: ['space_id', 'device_ids'],
34917
35035
  type: 'object',
@@ -34946,20 +35064,24 @@ export default {
34946
35064
  'x-fern-sdk-group-name': ['spaces'],
34947
35065
  'x-fern-sdk-method-name': 'remove_devices',
34948
35066
  'x-response-key': null,
34949
- 'x-title': 'Remove Space Devices',
35067
+ 'x-title': 'Remove Devices from a Space',
34950
35068
  },
34951
35069
  },
34952
35070
  '/spaces/update': {
34953
35071
  patch: {
34954
- description: 'Update an existing space.',
35072
+ description: 'Updates an existing space.',
34955
35073
  operationId: 'spacesUpdatePatch',
34956
35074
  requestBody: {
34957
35075
  content: {
34958
35076
  'application/json': {
34959
35077
  schema: {
34960
35078
  properties: {
34961
- name: { type: 'string' },
34962
- space_id: { format: 'uuid', type: 'string' },
35079
+ name: { description: 'Name of the space.', type: 'string' },
35080
+ space_id: {
35081
+ description: 'ID of the space that you want to update.',
35082
+ format: 'uuid',
35083
+ type: 'string',
35084
+ },
34963
35085
  },
34964
35086
  required: ['space_id'],
34965
35087
  type: 'object',
@@ -34996,18 +35118,22 @@ export default {
34996
35118
  'x-draft': 'Early access.',
34997
35119
  'x-fern-ignore': true,
34998
35120
  'x-response-key': 'space',
34999
- 'x-title': 'Update Space',
35121
+ 'x-title': 'Update a Space',
35000
35122
  },
35001
35123
  post: {
35002
- description: 'Update an existing space.',
35124
+ description: 'Updates an existing space.',
35003
35125
  operationId: 'spacesUpdatePost',
35004
35126
  requestBody: {
35005
35127
  content: {
35006
35128
  'application/json': {
35007
35129
  schema: {
35008
35130
  properties: {
35009
- name: { type: 'string' },
35010
- space_id: { format: 'uuid', type: 'string' },
35131
+ name: { description: 'Name of the space.', type: 'string' },
35132
+ space_id: {
35133
+ description: 'ID of the space that you want to update.',
35134
+ format: 'uuid',
35135
+ type: 'string',
35136
+ },
35011
35137
  },
35012
35138
  required: ['space_id'],
35013
35139
  type: 'object',
@@ -35046,7 +35172,7 @@ export default {
35046
35172
  'x-fern-sdk-method-name': 'update',
35047
35173
  'x-fern-sdk-return-value': 'space',
35048
35174
  'x-response-key': 'space',
35049
- 'x-title': 'Update Space',
35175
+ 'x-title': 'Update a Space',
35050
35176
  },
35051
35177
  },
35052
35178
  '/thermostats/activate_climate_preset': {
@@ -35125,13 +35251,13 @@ export default {
35125
35251
  properties: {
35126
35252
  cooling_set_point_celsius: {
35127
35253
  description:
35128
- '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.',
35254
+ '[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.',
35129
35255
  format: 'float',
35130
35256
  type: 'number',
35131
35257
  },
35132
35258
  cooling_set_point_fahrenheit: {
35133
35259
  description:
35134
- '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.',
35260
+ '[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.',
35135
35261
  format: 'float',
35136
35262
  type: 'number',
35137
35263
  },
@@ -35303,7 +35429,7 @@ export default {
35303
35429
  '/thermostats/daily_programs/create': {
35304
35430
  post: {
35305
35431
  description:
35306
- '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.',
35432
+ '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.',
35307
35433
  operationId: 'thermostatsDailyProgramsCreatePost',
35308
35434
  requestBody: {
35309
35435
  content: {
@@ -35317,8 +35443,7 @@ export default {
35317
35443
  type: 'string',
35318
35444
  },
35319
35445
  name: {
35320
- description:
35321
- 'User-friendly name to identify the thermostat daily program.',
35446
+ description: 'Name of the thermostat daily program.',
35322
35447
  type: 'string',
35323
35448
  },
35324
35449
  periods: {
@@ -35518,7 +35643,7 @@ export default {
35518
35643
  properties: {
35519
35644
  name: {
35520
35645
  description:
35521
- 'User-friendly name to identify the thermostat daily program that you want to update.',
35646
+ 'Name of the thermostat daily program that you want to update.',
35522
35647
  type: 'string',
35523
35648
  },
35524
35649
  periods: {
@@ -35603,7 +35728,7 @@ export default {
35603
35728
  properties: {
35604
35729
  name: {
35605
35730
  description:
35606
- 'User-friendly name to identify the thermostat daily program that you want to update.',
35731
+ 'Name of the thermostat daily program that you want to update.',
35607
35732
  type: 'string',
35608
35733
  },
35609
35734
  periods: {
@@ -35741,7 +35866,7 @@ export default {
35741
35866
  '/thermostats/get': {
35742
35867
  post: {
35743
35868
  description:
35744
- 'Returns a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
35869
+ 'Returns a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). **Deprecated:** Will be removed. Use `/devices/get` instead.',
35745
35870
  operationId: 'thermostatsGetPost',
35746
35871
  requestBody: {
35747
35872
  content: {
@@ -35750,13 +35875,13 @@ export default {
35750
35875
  properties: {
35751
35876
  device_id: {
35752
35877
  description:
35753
- 'ID of the thermostat device that you want to retrieve.',
35878
+ 'ID of the thermostat device that you want to get.',
35754
35879
  format: 'uuid',
35755
35880
  type: 'string',
35756
35881
  },
35757
35882
  name: {
35758
35883
  description:
35759
- 'User-friendly name of the thermostat device that you want to retrieve.',
35884
+ 'Name of the thermostat device that you want to retrieve.',
35760
35885
  type: 'string',
35761
35886
  },
35762
35887
  },
@@ -35819,13 +35944,13 @@ export default {
35819
35944
  },
35820
35945
  heating_set_point_celsius: {
35821
35946
  description:
35822
- '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.',
35947
+ '[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.',
35823
35948
  format: 'float',
35824
35949
  type: 'number',
35825
35950
  },
35826
35951
  heating_set_point_fahrenheit: {
35827
35952
  description:
35828
- '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.',
35953
+ '[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.',
35829
35954
  format: 'float',
35830
35955
  type: 'number',
35831
35956
  },
@@ -35890,13 +36015,13 @@ export default {
35890
36015
  properties: {
35891
36016
  cooling_set_point_celsius: {
35892
36017
  description:
35893
- '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.',
36018
+ '[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.',
35894
36019
  format: 'float',
35895
36020
  type: 'number',
35896
36021
  },
35897
36022
  cooling_set_point_fahrenheit: {
35898
36023
  description:
35899
- '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.',
36024
+ '[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.',
35900
36025
  format: 'float',
35901
36026
  type: 'number',
35902
36027
  },
@@ -35908,13 +36033,13 @@ export default {
35908
36033
  },
35909
36034
  heating_set_point_celsius: {
35910
36035
  description:
35911
- '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.',
36036
+ '[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.',
35912
36037
  format: 'float',
35913
36038
  type: 'number',
35914
36039
  },
35915
36040
  heating_set_point_fahrenheit: {
35916
36041
  description:
35917
- '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.',
36042
+ '[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.',
35918
36043
  format: 'float',
35919
36044
  type: 'number',
35920
36045
  },
@@ -36021,7 +36146,7 @@ export default {
36021
36146
  },
36022
36147
  device_type: {
36023
36148
  description:
36024
- 'Device type by which to filter thermostat devices.',
36149
+ 'Device type by which you want to filter thermostat devices.',
36025
36150
  enum: [
36026
36151
  'ecobee_thermostat',
36027
36152
  'nest_thermostat',
@@ -36034,7 +36159,7 @@ export default {
36034
36159
  },
36035
36160
  device_types: {
36036
36161
  description:
36037
- 'Array of device types by which to filter thermostat devices.',
36162
+ 'Array of device types by which you want to filter thermostat devices.',
36038
36163
  items: {
36039
36164
  description: 'Device type for thermostats.\n ',
36040
36165
  enum: [
@@ -36098,7 +36223,7 @@ export default {
36098
36223
  },
36099
36224
  manufacturer: {
36100
36225
  description:
36101
- 'Manufacturer by which to filter thermostat devices.',
36226
+ 'Manufacturer by which you want to filter thermostat devices.',
36102
36227
  enum: [
36103
36228
  'ecobee',
36104
36229
  'honeywell_resideo',
@@ -36248,7 +36373,7 @@ export default {
36248
36373
  '/thermostats/schedules/create': {
36249
36374
  post: {
36250
36375
  description:
36251
- '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).',
36376
+ '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).',
36252
36377
  operationId: 'thermostatsSchedulesCreatePost',
36253
36378
  requestBody: {
36254
36379
  content: {
@@ -36257,21 +36382,22 @@ export default {
36257
36382
  properties: {
36258
36383
  climate_preset_key: {
36259
36384
  description:
36260
- 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.',
36385
+ '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.',
36261
36386
  type: 'string',
36262
36387
  },
36263
36388
  device_id: {
36264
- description: 'ID of the desired thermostat device.',
36389
+ description:
36390
+ 'ID of the thermostat device for which you want to create a schedule.',
36265
36391
  type: 'string',
36266
36392
  },
36267
36393
  ends_at: {
36268
36394
  description:
36269
- 'Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
36395
+ '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.',
36270
36396
  type: 'string',
36271
36397
  },
36272
36398
  is_override_allowed: {
36273
36399
  description:
36274
- "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).",
36400
+ "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).",
36275
36401
  type: 'boolean',
36276
36402
  },
36277
36403
  max_override_period_minutes: {
@@ -36283,13 +36409,12 @@ export default {
36283
36409
  type: 'integer',
36284
36410
  },
36285
36411
  name: {
36286
- description:
36287
- 'User-friendly name to identify the thermostat schedule.',
36412
+ description: 'Name of the thermostat schedule.',
36288
36413
  type: 'string',
36289
36414
  },
36290
36415
  starts_at: {
36291
36416
  description:
36292
- 'Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
36417
+ '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.',
36293
36418
  type: 'string',
36294
36419
  },
36295
36420
  },
@@ -36351,7 +36476,8 @@ export default {
36351
36476
  schema: {
36352
36477
  properties: {
36353
36478
  thermostat_schedule_id: {
36354
- description: 'ID of the desired thermostat schedule.',
36479
+ description:
36480
+ 'ID of the thermostat schedule that you want to delete.',
36355
36481
  format: 'uuid',
36356
36482
  type: 'string',
36357
36483
  },
@@ -36403,7 +36529,8 @@ export default {
36403
36529
  schema: {
36404
36530
  properties: {
36405
36531
  thermostat_schedule_id: {
36406
- description: 'ID of the desired thermostat schedule.',
36532
+ description:
36533
+ 'ID of the thermostat schedule that you want to get.',
36407
36534
  format: 'uuid',
36408
36535
  type: 'string',
36409
36536
  },
@@ -36461,7 +36588,8 @@ export default {
36461
36588
  schema: {
36462
36589
  properties: {
36463
36590
  device_id: {
36464
- description: 'ID of the desired thermostat device.',
36591
+ description:
36592
+ 'ID of the thermostat device for which you want to list schedules.',
36465
36593
  format: 'uuid',
36466
36594
  type: 'string',
36467
36595
  },
@@ -36550,8 +36678,7 @@ export default {
36550
36678
  type: 'integer',
36551
36679
  },
36552
36680
  name: {
36553
- description:
36554
- 'User-friendly name to identify the thermostat schedule.',
36681
+ description: 'Name of the thermostat schedule.',
36555
36682
  type: 'string',
36556
36683
  },
36557
36684
  starts_at: {
@@ -36560,7 +36687,8 @@ export default {
36560
36687
  type: 'string',
36561
36688
  },
36562
36689
  thermostat_schedule_id: {
36563
- description: 'ID of the desired thermostat schedule.',
36690
+ description:
36691
+ 'ID of the thermostat schedule that you want to update.',
36564
36692
  format: 'uuid',
36565
36693
  type: 'string',
36566
36694
  },
@@ -36632,8 +36760,7 @@ export default {
36632
36760
  type: 'integer',
36633
36761
  },
36634
36762
  name: {
36635
- description:
36636
- 'User-friendly name to identify the thermostat schedule.',
36763
+ description: 'Name of the thermostat schedule.',
36637
36764
  type: 'string',
36638
36765
  },
36639
36766
  starts_at: {
@@ -36642,7 +36769,8 @@ export default {
36642
36769
  type: 'string',
36643
36770
  },
36644
36771
  thermostat_schedule_id: {
36645
- description: 'ID of the desired thermostat schedule.',
36772
+ description:
36773
+ 'ID of the thermostat schedule that you want to update.',
36646
36774
  format: 'uuid',
36647
36775
  type: 'string',
36648
36776
  },
@@ -36764,7 +36892,7 @@ export default {
36764
36892
  },
36765
36893
  fan_mode_setting: {
36766
36894
  description:
36767
- 'Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for the thermostat.',
36895
+ '[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.',
36768
36896
  enum: ['auto', 'on', 'circulate'],
36769
36897
  type: 'string',
36770
36898
  },
@@ -36845,13 +36973,13 @@ export default {
36845
36973
  properties: {
36846
36974
  cooling_set_point_celsius: {
36847
36975
  description:
36848
- '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.',
36976
+ '[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.',
36849
36977
  format: 'float',
36850
36978
  type: 'number',
36851
36979
  },
36852
36980
  cooling_set_point_fahrenheit: {
36853
36981
  description:
36854
- '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.',
36982
+ '[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.',
36855
36983
  format: 'float',
36856
36984
  type: 'number',
36857
36985
  },
@@ -36876,13 +37004,13 @@ export default {
36876
37004
  },
36877
37005
  heating_set_point_celsius: {
36878
37006
  description:
36879
- '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.',
37007
+ '[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.',
36880
37008
  format: 'float',
36881
37009
  type: 'number',
36882
37010
  },
36883
37011
  heating_set_point_fahrenheit: {
36884
37012
  description:
36885
- '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.',
37013
+ '[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.',
36886
37014
  format: 'float',
36887
37015
  type: 'number',
36888
37016
  },
@@ -36895,13 +37023,13 @@ export default {
36895
37023
  properties: {
36896
37024
  cooling_set_point_celsius: {
36897
37025
  description:
36898
- '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.',
37026
+ '[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.',
36899
37027
  format: 'float',
36900
37028
  type: 'number',
36901
37029
  },
36902
37030
  cooling_set_point_fahrenheit: {
36903
37031
  description:
36904
- '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.',
37032
+ '[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.',
36905
37033
  format: 'float',
36906
37034
  type: 'number',
36907
37035
  },
@@ -36913,13 +37041,13 @@ export default {
36913
37041
  },
36914
37042
  heating_set_point_celsius: {
36915
37043
  description:
36916
- '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.',
37044
+ '[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.',
36917
37045
  format: 'float',
36918
37046
  type: 'number',
36919
37047
  },
36920
37048
  heating_set_point_fahrenheit: {
36921
37049
  description:
36922
- '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.',
37050
+ '[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.',
36923
37051
  format: 'float',
36924
37052
  type: 'number',
36925
37053
  },
@@ -37152,13 +37280,13 @@ export default {
37152
37280
  {
37153
37281
  properties: {
37154
37282
  device_id: {
37155
- description: 'ID of the desired thermostat device.',
37283
+ description:
37284
+ 'ID of the thermostat device for which you want to simulate having adjusted the HVAC mode.',
37156
37285
  format: 'uuid',
37157
37286
  type: 'string',
37158
37287
  },
37159
37288
  hvac_mode: {
37160
- description:
37161
- 'Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate.',
37289
+ description: 'HVAC mode that you want to simulate.',
37162
37290
  enum: ['off'],
37163
37291
  type: 'string',
37164
37292
  },
@@ -37170,24 +37298,24 @@ export default {
37170
37298
  properties: {
37171
37299
  cooling_set_point_celsius: {
37172
37300
  description:
37173
- '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`.',
37301
+ '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`.',
37174
37302
  format: 'float',
37175
37303
  type: 'number',
37176
37304
  },
37177
37305
  cooling_set_point_fahrenheit: {
37178
37306
  description:
37179
- '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`.',
37307
+ '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`.',
37180
37308
  format: 'float',
37181
37309
  type: 'number',
37182
37310
  },
37183
37311
  device_id: {
37184
- description: 'ID of the desired thermostat device.',
37312
+ description:
37313
+ 'ID of the thermostat device for which you want to simulate having adjusted the HVAC mode.',
37185
37314
  format: 'uuid',
37186
37315
  type: 'string',
37187
37316
  },
37188
37317
  hvac_mode: {
37189
- description:
37190
- 'Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate.',
37318
+ description: 'HVAC mode that you want to simulate.',
37191
37319
  enum: ['cool'],
37192
37320
  type: 'string',
37193
37321
  },
@@ -37198,25 +37326,25 @@ export default {
37198
37326
  {
37199
37327
  properties: {
37200
37328
  device_id: {
37201
- description: 'ID of the desired thermostat device.',
37329
+ description:
37330
+ 'ID of the thermostat device for which you want to simulate having adjusted the HVAC mode.',
37202
37331
  format: 'uuid',
37203
37332
  type: 'string',
37204
37333
  },
37205
37334
  heating_set_point_celsius: {
37206
37335
  description:
37207
- '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`.',
37336
+ '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`.',
37208
37337
  format: 'float',
37209
37338
  type: 'number',
37210
37339
  },
37211
37340
  heating_set_point_fahrenheit: {
37212
37341
  description:
37213
- '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`.',
37342
+ '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`.',
37214
37343
  format: 'float',
37215
37344
  type: 'number',
37216
37345
  },
37217
37346
  hvac_mode: {
37218
- description:
37219
- 'Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate.',
37347
+ description: 'HVAC mode that you want to simulate.',
37220
37348
  enum: ['heat'],
37221
37349
  type: 'string',
37222
37350
  },
@@ -37228,36 +37356,36 @@ export default {
37228
37356
  properties: {
37229
37357
  cooling_set_point_celsius: {
37230
37358
  description:
37231
- '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`.',
37359
+ '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`.',
37232
37360
  format: 'float',
37233
37361
  type: 'number',
37234
37362
  },
37235
37363
  cooling_set_point_fahrenheit: {
37236
37364
  description:
37237
- '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`.',
37365
+ '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`.',
37238
37366
  format: 'float',
37239
37367
  type: 'number',
37240
37368
  },
37241
37369
  device_id: {
37242
- description: 'ID of the desired thermostat device.',
37370
+ description:
37371
+ 'ID of the thermostat device for which you want to simulate having adjusted the HVAC mode.',
37243
37372
  format: 'uuid',
37244
37373
  type: 'string',
37245
37374
  },
37246
37375
  heating_set_point_celsius: {
37247
37376
  description:
37248
- '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`.',
37377
+ '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`.',
37249
37378
  format: 'float',
37250
37379
  type: 'number',
37251
37380
  },
37252
37381
  heating_set_point_fahrenheit: {
37253
37382
  description:
37254
- '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`.',
37383
+ '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`.',
37255
37384
  format: 'float',
37256
37385
  type: 'number',
37257
37386
  },
37258
37387
  hvac_mode: {
37259
- description:
37260
- 'Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate.',
37388
+ description: 'HVAC mode that you want to simulate.',
37261
37389
  enum: ['heat_cool'],
37262
37390
  type: 'string',
37263
37391
  },
@@ -37310,19 +37438,20 @@ export default {
37310
37438
  schema: {
37311
37439
  properties: {
37312
37440
  device_id: {
37313
- description: 'ID of the desired thermostat device.',
37441
+ description:
37442
+ 'ID of the thermostat device that you want to simulate reaching a specified temperature.',
37314
37443
  format: 'uuid',
37315
37444
  type: 'string',
37316
37445
  },
37317
37446
  temperature_celsius: {
37318
37447
  description:
37319
- 'Desired simulated temperature in °C. You must set `temperature_celsius` or `temperature_fahrenheit`.',
37448
+ 'Temperature in °C that you want simulate the thermostat reaching. You must set `temperature_celsius` or `temperature_fahrenheit`.',
37320
37449
  format: 'float',
37321
37450
  type: 'number',
37322
37451
  },
37323
37452
  temperature_fahrenheit: {
37324
37453
  description:
37325
- 'Desired simulated temperature in °F. You must set `temperature_fahrenheit` or `temperature_celsius`.',
37454
+ 'Temperature in °F that you want simulate the thermostat reaching. You must set `temperature_fahrenheit` or `temperature_celsius`.',
37326
37455
  format: 'float',
37327
37456
  type: 'number',
37328
37457
  },
@@ -37435,11 +37564,7 @@ export default {
37435
37564
  type: 'string',
37436
37565
  },
37437
37566
  },
37438
- required: [
37439
- 'device_id',
37440
- 'climate_preset_key',
37441
- 'manual_override_allowed',
37442
- ],
37567
+ required: ['device_id', 'climate_preset_key'],
37443
37568
  type: 'object',
37444
37569
  },
37445
37570
  },
@@ -37545,11 +37670,7 @@ export default {
37545
37670
  type: 'string',
37546
37671
  },
37547
37672
  },
37548
- required: [
37549
- 'device_id',
37550
- 'climate_preset_key',
37551
- 'manual_override_allowed',
37552
- ],
37673
+ required: ['device_id', 'climate_preset_key'],
37553
37674
  type: 'object',
37554
37675
  },
37555
37676
  },
@@ -37709,7 +37830,7 @@ export default {
37709
37830
  properties: {
37710
37831
  user_identity_id: {
37711
37832
  description:
37712
- 'ID of user identity for whom access is being granted.',
37833
+ 'ID of user identity for whom you want to grant access.',
37713
37834
  format: 'uuid',
37714
37835
  type: 'string',
37715
37836
  },
@@ -37721,7 +37842,7 @@ export default {
37721
37842
  properties: {
37722
37843
  user_identity: {
37723
37844
  description:
37724
- 'When used, creates a new user identity with the given details, and grants them access.',
37845
+ 'User identity. When used, creates a new user identity with the specified details and grants them access.',
37725
37846
  properties: {
37726
37847
  email_address: {
37727
37848
  description:
@@ -37755,14 +37876,14 @@ export default {
37755
37876
  acs_entrance_ids: {
37756
37877
  default: [],
37757
37878
  description:
37758
- 'Set of IDs of the [entrances](https://docs.seam.co/latest/api/acs/systems/list) to which access is being granted.',
37879
+ 'IDs of the [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to which you want to grant access.',
37759
37880
  items: { format: 'uuid', type: 'string' },
37760
37881
  type: 'array',
37761
37882
  },
37762
37883
  device_ids: {
37763
37884
  default: [],
37764
37885
  description:
37765
- 'Set of IDs of the [devices](https://docs.seam.co/latest/api/devices/list) to which access is being granted.',
37886
+ 'IDs of the devices to which you want to grant access.',
37766
37887
  items: { format: 'uuid', type: 'string' },
37767
37888
  type: 'array',
37768
37889
  },
@@ -37774,7 +37895,7 @@ export default {
37774
37895
  },
37775
37896
  location: {
37776
37897
  description:
37777
- 'When used, creates a new location with the given entrances and devices, and gives the user access to this location.',
37898
+ 'Location. When used, creates a new location with the specified entrances and devices, and gives the user access to this location.',
37778
37899
  properties: {
37779
37900
  acs_entrance_ids: {
37780
37901
  default: [],
@@ -37809,8 +37930,7 @@ export default {
37809
37930
  items: {
37810
37931
  properties: {
37811
37932
  mode: {
37812
- description:
37813
- 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
37933
+ description: 'Access method mode.',
37814
37934
  enum: ['code', 'card', 'mobile_key'],
37815
37935
  type: 'string',
37816
37936
  },
@@ -37822,7 +37942,7 @@ export default {
37822
37942
  },
37823
37943
  space_ids: {
37824
37944
  description:
37825
- 'Set of IDs of existing spaces to which access is being granted.',
37945
+ 'IDs of the existing spaces to which you want to grant access.',
37826
37946
  items: { format: 'uuid', type: 'string' },
37827
37947
  type: 'array',
37828
37948
  },
@@ -37979,7 +38099,7 @@ export default {
37979
38099
  },
37980
38100
  '/unstable_access_grants/delete': {
37981
38101
  post: {
37982
- description: 'Delete an access grant.',
38102
+ description: 'Deletes an access grant.',
37983
38103
  operationId: 'unstableAccessGrantsDeletePost',
37984
38104
  requestBody: {
37985
38105
  content: {
@@ -37987,7 +38107,7 @@ export default {
37987
38107
  schema: {
37988
38108
  properties: {
37989
38109
  access_grant_id: {
37990
- description: 'ID of access grant to delete.',
38110
+ description: 'ID of access grant that you want to delete.',
37991
38111
  format: 'uuid',
37992
38112
  type: 'string',
37993
38113
  },
@@ -38031,7 +38151,7 @@ export default {
38031
38151
  },
38032
38152
  '/unstable_access_grants/get': {
38033
38153
  post: {
38034
- description: 'Get an access grant.',
38154
+ description: 'Gets an access grant.',
38035
38155
  operationId: 'unstableAccessGrantsGetPost',
38036
38156
  requestBody: {
38037
38157
  content: {
@@ -38039,7 +38159,7 @@ export default {
38039
38159
  schema: {
38040
38160
  properties: {
38041
38161
  access_grant_id: {
38042
- description: 'ID of access grant to get.',
38162
+ description: 'ID of access grant that you want to get.',
38043
38163
  format: 'uuid',
38044
38164
  type: 'string',
38045
38165
  },
@@ -38188,7 +38308,7 @@ export default {
38188
38308
  },
38189
38309
  '/unstable_access_grants/list': {
38190
38310
  post: {
38191
- description: 'Get an access grant.',
38311
+ description: 'Returns a list of all access grants.',
38192
38312
  operationId: 'unstableAccessGrantsListPost',
38193
38313
  requestBody: {
38194
38314
  content: {
@@ -38197,13 +38317,13 @@ export default {
38197
38317
  properties: {
38198
38318
  acs_entrance_id: {
38199
38319
  description:
38200
- 'ID of entrance to filter list of access grants by.',
38320
+ 'ID of the entrance by which you want to filter the list of access grants.',
38201
38321
  format: 'uuid',
38202
38322
  type: 'string',
38203
38323
  },
38204
38324
  acs_system_id: {
38205
38325
  description:
38206
- 'ID of system to filter list of access grants by.',
38326
+ 'ID of the access system by which you want to filter the list of access grants.',
38207
38327
  format: 'uuid',
38208
38328
  type: 'string',
38209
38329
  },
@@ -38215,13 +38335,13 @@ export default {
38215
38335
  },
38216
38336
  space_id: {
38217
38337
  description:
38218
- 'ID of space to filter list of access grants by.',
38338
+ 'ID of the space by which you want to filter the list of access grants.',
38219
38339
  format: 'uuid',
38220
38340
  type: 'string',
38221
38341
  },
38222
38342
  user_identity_id: {
38223
38343
  description:
38224
- 'ID of user identity to filter list of access grants by.',
38344
+ 'ID of the user identity by which you want to filter the list of access grants.',
38225
38345
  format: 'uuid',
38226
38346
  type: 'string',
38227
38347
  },
@@ -38372,7 +38492,7 @@ export default {
38372
38492
  },
38373
38493
  '/unstable_access_methods/delete': {
38374
38494
  post: {
38375
- description: 'Delete an access method.',
38495
+ description: 'Deletes an access method.',
38376
38496
  operationId: 'unstableAccessMethodsDeletePost',
38377
38497
  requestBody: {
38378
38498
  content: {
@@ -38380,7 +38500,8 @@ export default {
38380
38500
  schema: {
38381
38501
  properties: {
38382
38502
  access_method_id: {
38383
- description: 'ID of access method to get.',
38503
+ description:
38504
+ 'ID of the access method that you want to delete.',
38384
38505
  format: 'uuid',
38385
38506
  type: 'string',
38386
38507
  },
@@ -38423,7 +38544,7 @@ export default {
38423
38544
  },
38424
38545
  '/unstable_access_methods/get': {
38425
38546
  post: {
38426
- description: 'Get an access method.',
38547
+ description: 'Gets an access method.',
38427
38548
  operationId: 'unstableAccessMethodsGetPost',
38428
38549
  requestBody: {
38429
38550
  content: {
@@ -38431,7 +38552,8 @@ export default {
38431
38552
  schema: {
38432
38553
  properties: {
38433
38554
  access_method_id: {
38434
- description: 'ID of access method to get.',
38555
+ description:
38556
+ 'ID of the access method that you want to get.',
38435
38557
  format: 'uuid',
38436
38558
  type: 'string',
38437
38559
  },
@@ -38535,7 +38657,7 @@ export default {
38535
38657
  '/unstable_access_methods/list': {
38536
38658
  post: {
38537
38659
  description:
38538
- 'List all access methods, usually filtered by access grant.',
38660
+ 'Lists all access methods, usually filtered by access grant.',
38539
38661
  operationId: 'unstableAccessMethodsListPost',
38540
38662
  requestBody: {
38541
38663
  content: {
@@ -38544,7 +38666,7 @@ export default {
38544
38666
  properties: {
38545
38667
  access_grant_id: {
38546
38668
  description:
38547
- 'ID of access grant to list access methods for.',
38669
+ 'ID of the access grant by which to filter the list of access methods.',
38548
38670
  format: 'uuid',
38549
38671
  type: 'string',
38550
38672
  },
@@ -38650,7 +38772,8 @@ export default {
38650
38772
  },
38651
38773
  '/unstable_locations/add_acs_entrances': {
38652
38774
  post: {
38653
- description: 'Add entrances to a specific location.',
38775
+ description:
38776
+ 'Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific location.',
38654
38777
  operationId: 'unstableLocationsAddAcsEntrancesPost',
38655
38778
  requestBody: {
38656
38779
  content: {
@@ -38658,11 +38781,18 @@ export default {
38658
38781
  schema: {
38659
38782
  properties: {
38660
38783
  acs_entrance_ids: {
38784
+ description:
38785
+ 'IDs of the entrances that you want to add to the location.',
38661
38786
  items: { format: 'uuid', type: 'string' },
38662
38787
  minItems: 1,
38663
38788
  type: 'array',
38664
38789
  },
38665
- location_id: { format: 'uuid', type: 'string' },
38790
+ location_id: {
38791
+ description:
38792
+ 'ID of the location to which you want to add entrances.',
38793
+ format: 'uuid',
38794
+ type: 'string',
38795
+ },
38666
38796
  },
38667
38797
  required: ['location_id', 'acs_entrance_ids'],
38668
38798
  type: 'object',
@@ -38696,11 +38826,12 @@ export default {
38696
38826
  'x-fern-sdk-group-name': ['unstable_locations'],
38697
38827
  'x-fern-sdk-method-name': 'add_acs_entrances',
38698
38828
  'x-response-key': null,
38699
- 'x-title': 'Add ACS Entrances',
38829
+ 'x-title': 'Add Entrances to a Location',
38700
38830
  'x-undocumented': 'Experimental locations.',
38701
38831
  },
38702
38832
  put: {
38703
- description: 'Add entrances to a specific location.',
38833
+ description:
38834
+ 'Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific location.',
38704
38835
  operationId: 'unstableLocationsAddAcsEntrancesPut',
38705
38836
  requestBody: {
38706
38837
  content: {
@@ -38708,11 +38839,18 @@ export default {
38708
38839
  schema: {
38709
38840
  properties: {
38710
38841
  acs_entrance_ids: {
38842
+ description:
38843
+ 'IDs of the entrances that you want to add to the location.',
38711
38844
  items: { format: 'uuid', type: 'string' },
38712
38845
  minItems: 1,
38713
38846
  type: 'array',
38714
38847
  },
38715
- location_id: { format: 'uuid', type: 'string' },
38848
+ location_id: {
38849
+ description:
38850
+ 'ID of the location to which you want to add entrances.',
38851
+ format: 'uuid',
38852
+ type: 'string',
38853
+ },
38716
38854
  },
38717
38855
  required: ['location_id', 'acs_entrance_ids'],
38718
38856
  type: 'object',
@@ -38745,13 +38883,13 @@ export default {
38745
38883
  tags: [],
38746
38884
  'x-fern-ignore': true,
38747
38885
  'x-response-key': null,
38748
- 'x-title': 'Add ACS Entrances',
38886
+ 'x-title': 'Add Entrances to a Location',
38749
38887
  'x-undocumented': 'Experimental locations.',
38750
38888
  },
38751
38889
  },
38752
38890
  '/unstable_locations/add_devices': {
38753
38891
  post: {
38754
- description: 'Add devices to a specific location.',
38892
+ description: 'Adds devices to a specific location.',
38755
38893
  operationId: 'unstableLocationsAddDevicesPost',
38756
38894
  requestBody: {
38757
38895
  content: {
@@ -38759,11 +38897,18 @@ export default {
38759
38897
  schema: {
38760
38898
  properties: {
38761
38899
  device_ids: {
38900
+ description:
38901
+ 'IDs of the devices that you want to add to the location.',
38762
38902
  items: { format: 'uuid', type: 'string' },
38763
38903
  minItems: 1,
38764
38904
  type: 'array',
38765
38905
  },
38766
- location_id: { format: 'uuid', type: 'string' },
38906
+ location_id: {
38907
+ description:
38908
+ 'ID of the location to which you want to add devices.',
38909
+ format: 'uuid',
38910
+ type: 'string',
38911
+ },
38767
38912
  },
38768
38913
  required: ['location_id', 'device_ids'],
38769
38914
  type: 'object',
@@ -38797,11 +38942,11 @@ export default {
38797
38942
  'x-fern-sdk-group-name': ['unstable_locations'],
38798
38943
  'x-fern-sdk-method-name': 'add_devices',
38799
38944
  'x-response-key': null,
38800
- 'x-title': 'Add Location Devices',
38945
+ 'x-title': 'Add Devices to a Location',
38801
38946
  'x-undocumented': 'Experimental locations.',
38802
38947
  },
38803
38948
  put: {
38804
- description: 'Add devices to a specific location.',
38949
+ description: 'Adds devices to a specific location.',
38805
38950
  operationId: 'unstableLocationsAddDevicesPut',
38806
38951
  requestBody: {
38807
38952
  content: {
@@ -38809,11 +38954,18 @@ export default {
38809
38954
  schema: {
38810
38955
  properties: {
38811
38956
  device_ids: {
38957
+ description:
38958
+ 'IDs of the devices that you want to add to the location.',
38812
38959
  items: { format: 'uuid', type: 'string' },
38813
38960
  minItems: 1,
38814
38961
  type: 'array',
38815
38962
  },
38816
- location_id: { format: 'uuid', type: 'string' },
38963
+ location_id: {
38964
+ description:
38965
+ 'ID of the location to which you want to add devices.',
38966
+ format: 'uuid',
38967
+ type: 'string',
38968
+ },
38817
38969
  },
38818
38970
  required: ['location_id', 'device_ids'],
38819
38971
  type: 'object',
@@ -38846,13 +38998,13 @@ export default {
38846
38998
  tags: [],
38847
38999
  'x-fern-ignore': true,
38848
39000
  'x-response-key': null,
38849
- 'x-title': 'Add Location Devices',
39001
+ 'x-title': 'Add Devices to a Location',
38850
39002
  'x-undocumented': 'Experimental locations.',
38851
39003
  },
38852
39004
  },
38853
39005
  '/unstable_locations/create': {
38854
39006
  post: {
38855
- description: 'Create a new location.',
39007
+ description: 'Creates a new location.',
38856
39008
  operationId: 'unstableLocationsCreatePost',
38857
39009
  requestBody: {
38858
39010
  content: {
@@ -38860,14 +39012,19 @@ export default {
38860
39012
  schema: {
38861
39013
  properties: {
38862
39014
  acs_entrance_ids: {
39015
+ description:
39016
+ 'IDs of the entrances that you want to add to the new location.',
38863
39017
  items: { format: 'uuid', type: 'string' },
38864
39018
  type: 'array',
38865
39019
  },
38866
39020
  device_ids: {
39021
+ description:
39022
+ 'IDs of the devices that you want to add to the new location.',
38867
39023
  items: { format: 'uuid', type: 'string' },
38868
39024
  type: 'array',
38869
39025
  },
38870
39026
  geolocation: {
39027
+ description: 'Geolocation of the new location.',
38871
39028
  properties: {
38872
39029
  latitude: { format: 'float', type: 'number' },
38873
39030
  longitude: { format: 'float', type: 'number' },
@@ -38875,8 +39032,14 @@ export default {
38875
39032
  required: ['latitude', 'longitude'],
38876
39033
  type: 'object',
38877
39034
  },
38878
- name: { type: 'string' },
38879
- time_zone: { type: 'string' },
39035
+ name: {
39036
+ description: 'Name of the new location.',
39037
+ type: 'string',
39038
+ },
39039
+ time_zone: {
39040
+ description: 'Time zone of the new location.',
39041
+ type: 'string',
39042
+ },
38880
39043
  },
38881
39044
  required: ['name'],
38882
39045
  type: 'object',
@@ -38963,19 +39126,25 @@ export default {
38963
39126
  'x-fern-sdk-method-name': 'create',
38964
39127
  'x-fern-sdk-return-value': 'location',
38965
39128
  'x-response-key': 'location',
38966
- 'x-title': 'Create Location',
39129
+ 'x-title': 'Create a Location',
38967
39130
  'x-undocumented': 'Experimental locations.',
38968
39131
  },
38969
39132
  },
38970
39133
  '/unstable_locations/delete': {
38971
39134
  post: {
38972
- description: 'Delete a location.',
39135
+ description: 'Deletes a location.',
38973
39136
  operationId: 'unstableLocationsDeletePost',
38974
39137
  requestBody: {
38975
39138
  content: {
38976
39139
  'application/json': {
38977
39140
  schema: {
38978
- properties: { location_id: { format: 'uuid', type: 'string' } },
39141
+ properties: {
39142
+ location_id: {
39143
+ description: 'ID of the location that you want to delete.',
39144
+ format: 'uuid',
39145
+ type: 'string',
39146
+ },
39147
+ },
38979
39148
  required: ['location_id'],
38980
39149
  type: 'object',
38981
39150
  },
@@ -39008,19 +39177,25 @@ export default {
39008
39177
  'x-fern-sdk-group-name': ['unstable_locations'],
39009
39178
  'x-fern-sdk-method-name': 'delete',
39010
39179
  'x-response-key': null,
39011
- 'x-title': 'Delete Location',
39180
+ 'x-title': 'Delete a Location',
39012
39181
  'x-undocumented': 'Experimental locations.',
39013
39182
  },
39014
39183
  },
39015
39184
  '/unstable_locations/get': {
39016
39185
  post: {
39017
- description: 'Get a location.',
39186
+ description: 'Gets a location.',
39018
39187
  operationId: 'unstableLocationsGetPost',
39019
39188
  requestBody: {
39020
39189
  content: {
39021
39190
  'application/json': {
39022
39191
  schema: {
39023
- properties: { location_id: { format: 'uuid', type: 'string' } },
39192
+ properties: {
39193
+ location_id: {
39194
+ description: 'ID of the location that you want to get.',
39195
+ format: 'uuid',
39196
+ type: 'string',
39197
+ },
39198
+ },
39024
39199
  required: ['location_id'],
39025
39200
  type: 'object',
39026
39201
  },
@@ -39106,7 +39281,7 @@ export default {
39106
39281
  'x-fern-sdk-method-name': 'get',
39107
39282
  'x-fern-sdk-return-value': 'location',
39108
39283
  'x-response-key': 'location',
39109
- 'x-title': 'Get Location',
39284
+ 'x-title': 'Get a Location',
39110
39285
  'x-undocumented': 'Experimental locations.',
39111
39286
  },
39112
39287
  },
@@ -39290,7 +39465,7 @@ export default {
39290
39465
  },
39291
39466
  '/unstable_locations/remove_acs_entrances': {
39292
39467
  post: {
39293
- description: 'Remove entrances from a specific location.',
39468
+ description: 'Removes entrances from a specific location.',
39294
39469
  operationId: 'unstableLocationsRemoveAcsEntrancesPost',
39295
39470
  requestBody: {
39296
39471
  content: {
@@ -39298,10 +39473,17 @@ export default {
39298
39473
  schema: {
39299
39474
  properties: {
39300
39475
  acs_entrance_ids: {
39476
+ description:
39477
+ 'IDs of the entrances that you want to remove from the location.',
39301
39478
  items: { format: 'uuid', type: 'string' },
39302
39479
  type: 'array',
39303
39480
  },
39304
- location_id: { format: 'uuid', type: 'string' },
39481
+ location_id: {
39482
+ description:
39483
+ 'ID of the location from which you want to remove entrances.',
39484
+ format: 'uuid',
39485
+ type: 'string',
39486
+ },
39305
39487
  },
39306
39488
  required: ['location_id', 'acs_entrance_ids'],
39307
39489
  type: 'object',
@@ -39335,13 +39517,13 @@ export default {
39335
39517
  'x-fern-sdk-group-name': ['unstable_locations'],
39336
39518
  'x-fern-sdk-method-name': 'remove_acs_entrances',
39337
39519
  'x-response-key': null,
39338
- 'x-title': 'Remove ACS Entrances',
39520
+ 'x-title': 'Remove Entrances from a Location',
39339
39521
  'x-undocumented': 'Experimental locations.',
39340
39522
  },
39341
39523
  },
39342
39524
  '/unstable_locations/remove_devices': {
39343
39525
  post: {
39344
- description: 'Remove devices from a specific location.',
39526
+ description: 'Removes devices from a specific location.',
39345
39527
  operationId: 'unstableLocationsRemoveDevicesPost',
39346
39528
  requestBody: {
39347
39529
  content: {
@@ -39349,10 +39531,17 @@ export default {
39349
39531
  schema: {
39350
39532
  properties: {
39351
39533
  device_ids: {
39534
+ description:
39535
+ 'IDs of the devices that you want to remove from the location.',
39352
39536
  items: { format: 'uuid', type: 'string' },
39353
39537
  type: 'array',
39354
39538
  },
39355
- location_id: { format: 'uuid', type: 'string' },
39539
+ location_id: {
39540
+ description:
39541
+ 'ID of the location from which you want to remove devices.',
39542
+ format: 'uuid',
39543
+ type: 'string',
39544
+ },
39356
39545
  },
39357
39546
  required: ['location_id', 'device_ids'],
39358
39547
  type: 'object',
@@ -39386,13 +39575,13 @@ export default {
39386
39575
  'x-fern-sdk-group-name': ['unstable_locations'],
39387
39576
  'x-fern-sdk-method-name': 'remove_devices',
39388
39577
  'x-response-key': null,
39389
- 'x-title': 'Remove Location Devices',
39578
+ 'x-title': 'Remove Devices from a Location',
39390
39579
  'x-undocumented': 'Experimental locations.',
39391
39580
  },
39392
39581
  },
39393
39582
  '/unstable_locations/update': {
39394
39583
  patch: {
39395
- description: 'Update an existing location.',
39584
+ description: 'Updates a location.',
39396
39585
  operationId: 'unstableLocationsUpdatePatch',
39397
39586
  requestBody: {
39398
39587
  content: {
@@ -39400,6 +39589,7 @@ export default {
39400
39589
  schema: {
39401
39590
  properties: {
39402
39591
  geolocation: {
39592
+ description: 'Geolocation of the location.',
39403
39593
  properties: {
39404
39594
  latitude: { format: 'float', type: 'number' },
39405
39595
  longitude: { format: 'float', type: 'number' },
@@ -39407,9 +39597,19 @@ export default {
39407
39597
  required: ['latitude', 'longitude'],
39408
39598
  type: 'object',
39409
39599
  },
39410
- location_id: { format: 'uuid', type: 'string' },
39411
- name: { type: 'string' },
39412
- time_zone: { type: 'string' },
39600
+ location_id: {
39601
+ description: 'ID of the location that you want to update.',
39602
+ format: 'uuid',
39603
+ type: 'string',
39604
+ },
39605
+ name: {
39606
+ description: 'Name of the location.',
39607
+ type: 'string',
39608
+ },
39609
+ time_zone: {
39610
+ description: 'Time zone of the the location.',
39611
+ type: 'string',
39612
+ },
39413
39613
  },
39414
39614
  required: ['location_id'],
39415
39615
  type: 'object',
@@ -39494,11 +39694,11 @@ export default {
39494
39694
  tags: [],
39495
39695
  'x-fern-ignore': true,
39496
39696
  'x-response-key': 'location',
39497
- 'x-title': 'Update Location',
39697
+ 'x-title': 'Update a Location',
39498
39698
  'x-undocumented': 'Experimental locations.',
39499
39699
  },
39500
39700
  post: {
39501
- description: 'Update an existing location.',
39701
+ description: 'Updates a location.',
39502
39702
  operationId: 'unstableLocationsUpdatePost',
39503
39703
  requestBody: {
39504
39704
  content: {
@@ -39506,6 +39706,7 @@ export default {
39506
39706
  schema: {
39507
39707
  properties: {
39508
39708
  geolocation: {
39709
+ description: 'Geolocation of the location.',
39509
39710
  properties: {
39510
39711
  latitude: { format: 'float', type: 'number' },
39511
39712
  longitude: { format: 'float', type: 'number' },
@@ -39513,9 +39714,19 @@ export default {
39513
39714
  required: ['latitude', 'longitude'],
39514
39715
  type: 'object',
39515
39716
  },
39516
- location_id: { format: 'uuid', type: 'string' },
39517
- name: { type: 'string' },
39518
- time_zone: { type: 'string' },
39717
+ location_id: {
39718
+ description: 'ID of the location that you want to update.',
39719
+ format: 'uuid',
39720
+ type: 'string',
39721
+ },
39722
+ name: {
39723
+ description: 'Name of the location.',
39724
+ type: 'string',
39725
+ },
39726
+ time_zone: {
39727
+ description: 'Time zone of the the location.',
39728
+ type: 'string',
39729
+ },
39519
39730
  },
39520
39731
  required: ['location_id'],
39521
39732
  type: 'object',
@@ -39602,7 +39813,7 @@ export default {
39602
39813
  'x-fern-sdk-method-name': 'update',
39603
39814
  'x-fern-sdk-return-value': 'location',
39604
39815
  'x-response-key': 'location',
39605
- 'x-title': 'Update Location',
39816
+ 'x-title': 'Update a Location',
39606
39817
  'x-undocumented': 'Experimental locations.',
39607
39818
  },
39608
39819
  },
@@ -39615,7 +39826,13 @@ export default {
39615
39826
  content: {
39616
39827
  'application/json': {
39617
39828
  schema: {
39618
- properties: { customer_key: { type: 'string' } },
39829
+ properties: {
39830
+ customer_key: {
39831
+ description:
39832
+ 'Customer key for which you want to connect accounts.',
39833
+ type: 'string',
39834
+ },
39835
+ },
39619
39836
  required: ['customer_key'],
39620
39837
  type: 'object',
39621
39838
  },
@@ -39652,7 +39869,7 @@ export default {
39652
39869
  'x-fern-sdk-method-name': 'connect_accounts',
39653
39870
  'x-fern-sdk-return-value': 'magic_link',
39654
39871
  'x-response-key': 'magic_link',
39655
- 'x-title': 'Connect Accounts',
39872
+ 'x-title': 'Generate a Connect Accounts Building Block Magic Link',
39656
39873
  'x-undocumented': 'Experimental partner building blocks.',
39657
39874
  },
39658
39875
  },
@@ -39668,10 +39885,15 @@ export default {
39668
39885
  {
39669
39886
  properties: {
39670
39887
  building_block_type: {
39888
+ description: '`connect_accounts` building block type.',
39671
39889
  enum: ['connect_accounts'],
39672
39890
  type: 'string',
39673
39891
  },
39674
- customer_key: { type: 'string' },
39892
+ customer_key: {
39893
+ description:
39894
+ 'Customer key for which you want to create a new building block magic link.',
39895
+ type: 'string',
39896
+ },
39675
39897
  },
39676
39898
  required: ['building_block_type', 'customer_key'],
39677
39899
  type: 'object',
@@ -39679,10 +39901,15 @@ export default {
39679
39901
  {
39680
39902
  properties: {
39681
39903
  building_block_type: {
39904
+ description: '`manage_devices` building block type.',
39682
39905
  enum: ['manage_devices'],
39683
39906
  type: 'string',
39684
39907
  },
39685
- customer_key: { type: 'string' },
39908
+ customer_key: {
39909
+ description:
39910
+ 'Customer key for which you want to create a new building block magic link.',
39911
+ type: 'string',
39912
+ },
39686
39913
  },
39687
39914
  required: ['building_block_type', 'customer_key'],
39688
39915
  type: 'object',
@@ -39690,13 +39917,18 @@ export default {
39690
39917
  {
39691
39918
  properties: {
39692
39919
  building_block_type: {
39920
+ description: '`organize_spaces` building block type.',
39693
39921
  enum: ['organize_spaces'],
39694
39922
  type: 'string',
39695
39923
  },
39696
- customer_key: { type: 'string' },
39924
+ customer_key: {
39925
+ description:
39926
+ 'Customer key for which you want to create a new building block magic link.',
39927
+ type: 'string',
39928
+ },
39697
39929
  partner_resources: {
39698
39930
  description:
39699
- 'Optional list of partner resources to include in the magic link.',
39931
+ 'Optional list of partner resources that you want to include in the new building block magic link.',
39700
39932
  items: {
39701
39933
  properties: {
39702
39934
  custom_metadata: {
@@ -39753,7 +39985,7 @@ export default {
39753
39985
  'x-fern-sdk-method-name': 'generate_magic_link',
39754
39986
  'x-fern-sdk-return-value': 'magic_link',
39755
39987
  'x-response-key': 'magic_link',
39756
- 'x-title': 'Generate a building block magic link',
39988
+ 'x-title': 'Generate a Building Block Magic Link',
39757
39989
  'x-undocumented': 'Experimental partner building blocks.',
39758
39990
  },
39759
39991
  },
@@ -39766,7 +39998,13 @@ export default {
39766
39998
  content: {
39767
39999
  'application/json': {
39768
40000
  schema: {
39769
- properties: { customer_key: { type: 'string' } },
40001
+ properties: {
40002
+ customer_key: {
40003
+ description:
40004
+ 'Customer key for which you want to manage devices.',
40005
+ type: 'string',
40006
+ },
40007
+ },
39770
40008
  required: ['customer_key'],
39771
40009
  type: 'object',
39772
40010
  },
@@ -39803,7 +40041,7 @@ export default {
39803
40041
  'x-fern-sdk-method-name': 'manage_devices',
39804
40042
  'x-fern-sdk-return-value': 'magic_link',
39805
40043
  'x-response-key': 'magic_link',
39806
- 'x-title': 'Manage Devices',
40044
+ 'x-title': 'Generate a Manage Devices Building Block Magic Link',
39807
40045
  'x-undocumented': 'Experimental partner building blocks.',
39808
40046
  },
39809
40047
  },
@@ -39817,8 +40055,14 @@ export default {
39817
40055
  'application/json': {
39818
40056
  schema: {
39819
40057
  properties: {
39820
- customer_key: { type: 'string' },
40058
+ customer_key: {
40059
+ description:
40060
+ 'Customer key for which you want to organize spaces.',
40061
+ type: 'string',
40062
+ },
39821
40063
  partner_resources: {
40064
+ description:
40065
+ 'Optional list of partner resources that you want to include in the new building block magic link.',
39822
40066
  items: {
39823
40067
  properties: {
39824
40068
  custom_metadata: {
@@ -39873,13 +40117,13 @@ export default {
39873
40117
  'x-fern-sdk-method-name': 'organize_spaces',
39874
40118
  'x-fern-sdk-return-value': 'magic_link',
39875
40119
  'x-response-key': 'magic_link',
39876
- 'x-title': 'Organize Spaces',
40120
+ 'x-title': 'Generate an Organize Spaces Building Block Magic Link',
39877
40121
  'x-undocumented': 'Experimental partner building blocks.',
39878
40122
  },
39879
40123
  },
39880
40124
  '/unstable_partner/resources/push': {
39881
40125
  post: {
39882
- description: 'Send Seam some of your resources.',
40126
+ description: 'Sends Seam some of your resources.',
39883
40127
  operationId: 'unstablePartnerResourcesPushPost',
39884
40128
  requestBody: {
39885
40129
  content: {
@@ -39893,7 +40137,11 @@ export default {
39893
40137
  additionalProperties: { type: 'string' },
39894
40138
  type: 'object',
39895
40139
  },
39896
- customer_key: { type: 'string' },
40140
+ customer_key: {
40141
+ description:
40142
+ 'Customer key associated with the resource that you want to push to Seam.',
40143
+ type: 'string',
40144
+ },
39897
40145
  description: { type: 'string' },
39898
40146
  email_address: { type: 'string' },
39899
40147
  ends_at: { type: 'string' },
@@ -39902,8 +40150,16 @@ export default {
39902
40150
  type: 'array',
39903
40151
  },
39904
40152
  name: { type: 'string' },
39905
- partner_resource_key: { type: 'string' },
39906
- partner_resource_type: { type: 'string' },
40153
+ partner_resource_key: {
40154
+ description:
40155
+ 'Key of the resource that you want to push to Seam.',
40156
+ type: 'string',
40157
+ },
40158
+ partner_resource_type: {
40159
+ description:
40160
+ 'Type of the resource that you want to push to Seam.',
40161
+ type: 'string',
40162
+ },
39907
40163
  phone_number: { type: 'string' },
39908
40164
  starts_at: { type: 'string' },
39909
40165
  user_identity_key: { type: 'string' },
@@ -39920,7 +40176,11 @@ export default {
39920
40176
  additionalProperties: { type: 'string' },
39921
40177
  type: 'object',
39922
40178
  },
39923
- customer_key: { type: 'string' },
40179
+ customer_key: {
40180
+ description:
40181
+ 'Customer key associated with the resource that you want to push to Seam.',
40182
+ type: 'string',
40183
+ },
39924
40184
  description: { type: 'string' },
39925
40185
  email_address: { type: 'string' },
39926
40186
  ends_at: { type: 'string' },
@@ -39929,8 +40189,16 @@ export default {
39929
40189
  type: 'array',
39930
40190
  },
39931
40191
  name: { type: 'string' },
39932
- partner_resource_key: { type: 'string' },
39933
- partner_resource_type: { type: 'string' },
40192
+ partner_resource_key: {
40193
+ description:
40194
+ 'Key of the resource that you want to push to Seam.',
40195
+ type: 'string',
40196
+ },
40197
+ partner_resource_type: {
40198
+ description:
40199
+ 'Type of the resource that you want to push to Seam.',
40200
+ type: 'string',
40201
+ },
39934
40202
  phone_number: { type: 'string' },
39935
40203
  starts_at: { type: 'string' },
39936
40204
  user_identity_key: { type: 'string' },
@@ -39970,14 +40238,14 @@ export default {
39970
40238
  'x-fern-sdk-group-name': ['unstable_partner', 'resources'],
39971
40239
  'x-fern-sdk-method-name': 'push',
39972
40240
  'x-response-key': null,
39973
- 'x-title': 'Push partner resources at Seam',
40241
+ 'x-title': 'Push Partner Resources at Seam',
39974
40242
  'x-undocumented': 'Experimental partner resources.',
39975
40243
  },
39976
40244
  },
39977
40245
  '/user_identities/add_acs_user': {
39978
40246
  post: {
39979
40247
  description:
39980
- '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).',
40248
+ '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).',
39981
40249
  operationId: 'userIdentitiesAddAcsUserPost',
39982
40250
  requestBody: {
39983
40251
  content: {
@@ -39985,12 +40253,14 @@ export default {
39985
40253
  schema: {
39986
40254
  properties: {
39987
40255
  acs_user_id: {
39988
- description: 'ID of the desired ACS user.',
40256
+ description:
40257
+ 'ID of the access system user that you want to add to the user identity.',
39989
40258
  format: 'uuid',
39990
40259
  type: 'string',
39991
40260
  },
39992
40261
  user_identity_id: {
39993
- description: 'ID of the desired user identity.',
40262
+ description:
40263
+ 'ID of the user identity to which you want to add an access system user.',
39994
40264
  format: 'uuid',
39995
40265
  type: 'string',
39996
40266
  },
@@ -40031,7 +40301,7 @@ export default {
40031
40301
  },
40032
40302
  put: {
40033
40303
  description:
40034
- '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).',
40304
+ '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).',
40035
40305
  operationId: 'userIdentitiesAddAcsUserPut',
40036
40306
  requestBody: {
40037
40307
  content: {
@@ -40039,12 +40309,14 @@ export default {
40039
40309
  schema: {
40040
40310
  properties: {
40041
40311
  acs_user_id: {
40042
- description: 'ID of the desired ACS user.',
40312
+ description:
40313
+ 'ID of the access system user that you want to add to the user identity.',
40043
40314
  format: 'uuid',
40044
40315
  type: 'string',
40045
40316
  },
40046
40317
  user_identity_id: {
40047
- description: 'ID of the desired user identity.',
40318
+ description:
40319
+ 'ID of the user identity to which you want to add an access system user.',
40048
40320
  format: 'uuid',
40049
40321
  type: 'string',
40050
40322
  },
@@ -40095,31 +40367,32 @@ export default {
40095
40367
  properties: {
40096
40368
  acs_system_ids: {
40097
40369
  description:
40098
- "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.",
40370
+ "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.",
40099
40371
  items: { format: 'uuid', type: 'string' },
40100
40372
  type: 'array',
40101
40373
  },
40102
40374
  email_address: {
40103
- description: 'Unique email address for the user identity.',
40375
+ description:
40376
+ 'Unique email address for the new user identity.',
40104
40377
  format: 'email',
40105
40378
  nullable: true,
40106
40379
  type: 'string',
40107
40380
  },
40108
40381
  full_name: {
40109
40382
  description:
40110
- 'Full name of the user associated with the user identity.',
40383
+ 'Full name of the user associated with the new user identity.',
40111
40384
  minLength: 1,
40112
40385
  nullable: true,
40113
40386
  type: 'string',
40114
40387
  },
40115
40388
  phone_number: {
40116
40389
  description:
40117
- 'Unique phone number for the user identity in E.164 format (for example, +15555550100).',
40390
+ 'Unique phone number for the new user identity in E.164 format (for example, +15555550100).',
40118
40391
  nullable: true,
40119
40392
  type: 'string',
40120
40393
  },
40121
40394
  user_identity_key: {
40122
- description: 'Unique key for the user identity.',
40395
+ description: 'Unique key for the new user identity.',
40123
40396
  minLength: 1,
40124
40397
  nullable: true,
40125
40398
  type: 'string',
@@ -40176,7 +40449,8 @@ export default {
40176
40449
  schema: {
40177
40450
  properties: {
40178
40451
  user_identity_id: {
40179
- description: 'ID of the desired user identity.',
40452
+ description:
40453
+ 'ID of the user identity that you want to delete.',
40180
40454
  format: 'uuid',
40181
40455
  type: 'string',
40182
40456
  },
@@ -40227,7 +40501,8 @@ export default {
40227
40501
  schema: {
40228
40502
  properties: {
40229
40503
  enrollment_automation_id: {
40230
- description: 'ID of the desired enrollment automation.',
40504
+ description:
40505
+ 'ID of the enrollment automation that you want to delete.',
40231
40506
  format: 'uuid',
40232
40507
  type: 'string',
40233
40508
  },
@@ -40278,7 +40553,8 @@ export default {
40278
40553
  schema: {
40279
40554
  properties: {
40280
40555
  enrollment_automation_id: {
40281
- description: 'ID of the desired enrollment automation.',
40556
+ description:
40557
+ 'ID of the enrollment automation that you want to get.',
40282
40558
  format: 'uuid',
40283
40559
  type: 'string',
40284
40560
  },
@@ -40337,7 +40613,7 @@ export default {
40337
40613
  properties: {
40338
40614
  acs_credential_pool_id: {
40339
40615
  description:
40340
- 'ID of the ACS credential pool from which to obtain credentials for the user identity.',
40616
+ 'ID of the credential pool from which to obtain credentials for the user identity.',
40341
40617
  format: 'uuid',
40342
40618
  type: 'string',
40343
40619
  },
@@ -40348,18 +40624,19 @@ export default {
40348
40624
  },
40349
40625
  credential_manager_acs_system_id: {
40350
40626
  description:
40351
- 'ID of the desired ACS system that serves as the credential manager.',
40627
+ 'ID of the desired access system that serves as the credential manager for the enrollment automation.',
40352
40628
  format: 'uuid',
40353
40629
  type: 'string',
40354
40630
  },
40355
40631
  credential_manager_acs_user_id: {
40356
40632
  description:
40357
- '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`.',
40633
+ '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`.',
40358
40634
  format: 'uuid',
40359
40635
  type: 'string',
40360
40636
  },
40361
40637
  user_identity_id: {
40362
- description: 'ID of the desired user identity.',
40638
+ description:
40639
+ 'ID of the user identity for which you want to launch an enrollment automation.',
40363
40640
  format: 'uuid',
40364
40641
  type: 'string',
40365
40642
  },
@@ -40445,7 +40722,7 @@ export default {
40445
40722
  properties: {
40446
40723
  user_identity_id: {
40447
40724
  description:
40448
- 'ID of the user identity for which you want to retrieve all enrollment automations.',
40725
+ 'ID of the user identity for which you want to retrieve enrollment automations.',
40449
40726
  format: 'uuid',
40450
40727
  type: 'string',
40451
40728
  },
@@ -40508,7 +40785,7 @@ export default {
40508
40785
  max_use_count: {
40509
40786
  default: 1,
40510
40787
  description:
40511
- 'The maximum number of times the instant key can be used. Defaults to 1.',
40788
+ 'Maximum number of times the instant key can be used. Default: 1.',
40512
40789
  format: 'float',
40513
40790
  type: 'number',
40514
40791
  },
@@ -40571,7 +40848,8 @@ export default {
40571
40848
  {
40572
40849
  properties: {
40573
40850
  user_identity_id: {
40574
- description: 'ID of the desired user identity.',
40851
+ description:
40852
+ 'ID of the user identity that you want to get.',
40575
40853
  format: 'uuid',
40576
40854
  type: 'string',
40577
40855
  },
@@ -40635,12 +40913,14 @@ export default {
40635
40913
  schema: {
40636
40914
  properties: {
40637
40915
  device_id: {
40638
- description: 'ID of the desired managed device.',
40916
+ description:
40917
+ 'ID of the managed device to which you want to grant access to the user identity.',
40639
40918
  format: 'uuid',
40640
40919
  type: 'string',
40641
40920
  },
40642
40921
  user_identity_id: {
40643
- description: 'ID of the desired user identity.',
40922
+ description:
40923
+ 'ID of the user identity that you want to grant access to a device.',
40644
40924
  format: 'uuid',
40645
40925
  type: 'string',
40646
40926
  },
@@ -40689,12 +40969,14 @@ export default {
40689
40969
  schema: {
40690
40970
  properties: {
40691
40971
  device_id: {
40692
- description: 'ID of the desired managed device.',
40972
+ description:
40973
+ 'ID of the managed device to which you want to grant access to the user identity.',
40693
40974
  format: 'uuid',
40694
40975
  type: 'string',
40695
40976
  },
40696
40977
  user_identity_id: {
40697
- description: 'ID of the desired user identity.',
40978
+ description:
40979
+ 'ID of the user identity that you want to grant access to a device.',
40698
40980
  format: 'uuid',
40699
40981
  type: 'string',
40700
40982
  },
@@ -40744,6 +41026,8 @@ export default {
40744
41026
  schema: {
40745
41027
  properties: {
40746
41028
  credential_manager_acs_system_id: {
41029
+ description:
41030
+ '`acs_system_id` of the credential manager by which you want to filter the list of user identities.',
40747
41031
  format: 'uuid',
40748
41032
  type: 'string',
40749
41033
  },
@@ -40823,7 +41107,7 @@ export default {
40823
41107
  deprecated: true,
40824
41108
  items: { $ref: '#/components/schemas/device' },
40825
41109
  type: 'array',
40826
- 'x-deprecated': 'use devices.',
41110
+ 'x-deprecated': 'Use devices.',
40827
41111
  },
40828
41112
  devices: {
40829
41113
  items: { $ref: '#/components/schemas/device' },
@@ -40858,7 +41142,7 @@ export default {
40858
41142
  '/user_identities/list_acs_systems': {
40859
41143
  post: {
40860
41144
  description:
40861
- '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).',
41145
+ '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).',
40862
41146
  operationId: 'userIdentitiesListAcsSystemsPost',
40863
41147
  requestBody: {
40864
41148
  content: {
@@ -40867,7 +41151,7 @@ export default {
40867
41151
  properties: {
40868
41152
  user_identity_id: {
40869
41153
  description:
40870
- 'ID of the user identity for which you want to retrieve all access control systems.',
41154
+ 'ID of the user identity for which you want to retrieve all access systems.',
40871
41155
  format: 'uuid',
40872
41156
  type: 'string',
40873
41157
  },
@@ -40918,7 +41202,7 @@ export default {
40918
41202
  '/user_identities/list_acs_users': {
40919
41203
  post: {
40920
41204
  description:
40921
- '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).',
41205
+ '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).',
40922
41206
  operationId: 'userIdentitiesListAcsUsersPost',
40923
41207
  requestBody: {
40924
41208
  content: {
@@ -40927,7 +41211,7 @@ export default {
40927
41211
  properties: {
40928
41212
  user_identity_id: {
40929
41213
  description:
40930
- 'ID of the user identity for which you want to retrieve all ACS users.',
41214
+ 'ID of the user identity for which you want to retrieve all access system users.',
40931
41215
  format: 'uuid',
40932
41216
  type: 'string',
40933
41217
  },
@@ -40977,7 +41261,7 @@ export default {
40977
41261
  '/user_identities/remove_acs_user': {
40978
41262
  post: {
40979
41263
  description:
40980
- '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).',
41264
+ '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).',
40981
41265
  operationId: 'userIdentitiesRemoveAcsUserPost',
40982
41266
  requestBody: {
40983
41267
  content: {
@@ -40985,12 +41269,14 @@ export default {
40985
41269
  schema: {
40986
41270
  properties: {
40987
41271
  acs_user_id: {
40988
- description: 'ID of the ACS user.',
41272
+ description:
41273
+ 'ID of the access system user that you want to remove from the user identity..',
40989
41274
  format: 'uuid',
40990
41275
  type: 'string',
40991
41276
  },
40992
41277
  user_identity_id: {
40993
- description: 'ID of the desired user identity.',
41278
+ description:
41279
+ 'ID of the user identity from which you want to remove an access system user.',
40994
41280
  format: 'uuid',
40995
41281
  type: 'string',
40996
41282
  },
@@ -41041,12 +41327,14 @@ export default {
41041
41327
  schema: {
41042
41328
  properties: {
41043
41329
  device_id: {
41044
- description: 'ID of the desired managed device.',
41330
+ description:
41331
+ 'ID of the managed device to which you want to revoke access from the user identity.',
41045
41332
  format: 'uuid',
41046
41333
  type: 'string',
41047
41334
  },
41048
41335
  user_identity_id: {
41049
- description: 'ID of the desired user identity.',
41336
+ description:
41337
+ 'ID of the user identity from which you want to revoke access to a device.',
41050
41338
  format: 'uuid',
41051
41339
  type: 'string',
41052
41340
  },
@@ -41088,6 +41376,8 @@ export default {
41088
41376
  },
41089
41377
  '/user_identities/update': {
41090
41378
  patch: {
41379
+ description:
41380
+ '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).',
41091
41381
  operationId: 'userIdentitiesUpdatePatch',
41092
41382
  requestBody: {
41093
41383
  content: {
@@ -41100,15 +41390,21 @@ export default {
41100
41390
  nullable: true,
41101
41391
  type: 'string',
41102
41392
  },
41103
- full_name: { minLength: 1, nullable: true, type: 'string' },
41104
- phone_number: {
41393
+ full_name: {
41105
41394
  description:
41106
- 'Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).',
41395
+ 'Full name of the user associated with the user identity.',
41396
+ minLength: 1,
41397
+ nullable: true,
41398
+ type: 'string',
41399
+ },
41400
+ phone_number: {
41401
+ description: 'Unique phone number for the user identity.',
41107
41402
  nullable: true,
41108
41403
  type: 'string',
41109
41404
  },
41110
41405
  user_identity_id: {
41111
- description: 'ID of the user identity.',
41406
+ description:
41407
+ 'ID of the user identity that you want to update.',
41112
41408
  format: 'uuid',
41113
41409
  type: 'string',
41114
41410
  },
@@ -41153,6 +41449,8 @@ export default {
41153
41449
  'x-title': 'Update a User Identity',
41154
41450
  },
41155
41451
  post: {
41452
+ description:
41453
+ '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).',
41156
41454
  operationId: 'userIdentitiesUpdatePost',
41157
41455
  requestBody: {
41158
41456
  content: {
@@ -41165,15 +41463,21 @@ export default {
41165
41463
  nullable: true,
41166
41464
  type: 'string',
41167
41465
  },
41168
- full_name: { minLength: 1, nullable: true, type: 'string' },
41169
- phone_number: {
41466
+ full_name: {
41170
41467
  description:
41171
- 'Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).',
41468
+ 'Full name of the user associated with the user identity.',
41469
+ minLength: 1,
41470
+ nullable: true,
41471
+ type: 'string',
41472
+ },
41473
+ phone_number: {
41474
+ description: 'Unique phone number for the user identity.',
41172
41475
  nullable: true,
41173
41476
  type: 'string',
41174
41477
  },
41175
41478
  user_identity_id: {
41176
- description: 'ID of the user identity.',
41479
+ description:
41480
+ 'ID of the user identity that you want to update.',
41177
41481
  format: 'uuid',
41178
41482
  type: 'string',
41179
41483
  },
@@ -41221,6 +41525,8 @@ export default {
41221
41525
  },
41222
41526
  '/webhooks/create': {
41223
41527
  post: {
41528
+ description:
41529
+ 'Creates a new [webhook](https://docs.seam.co/latest/developer-tools/webhooks).',
41224
41530
  operationId: 'webhooksCreatePost',
41225
41531
  requestBody: {
41226
41532
  content: {
@@ -41229,10 +41535,16 @@ export default {
41229
41535
  properties: {
41230
41536
  event_types: {
41231
41537
  default: ['*'],
41538
+ description:
41539
+ 'Types of events that you want the new webhook to receive.',
41232
41540
  items: { type: 'string' },
41233
41541
  type: 'array',
41234
41542
  },
41235
- url: { format: 'uri', type: 'string' },
41543
+ url: {
41544
+ description: 'URL for the new webhook.',
41545
+ format: 'uri',
41546
+ type: 'string',
41547
+ },
41236
41548
  },
41237
41549
  required: ['url'],
41238
41550
  type: 'object',
@@ -41270,16 +41582,24 @@ export default {
41270
41582
  'x-fern-sdk-method-name': 'create',
41271
41583
  'x-fern-sdk-return-value': 'webhook',
41272
41584
  'x-response-key': 'webhook',
41585
+ 'x-title': 'Create a Webhook',
41273
41586
  },
41274
41587
  },
41275
41588
  '/webhooks/delete': {
41276
41589
  post: {
41590
+ description:
41591
+ 'Deletes a specified [webhook](https://docs.seam.co/latest/developer-tools/webhooks).',
41277
41592
  operationId: 'webhooksDeletePost',
41278
41593
  requestBody: {
41279
41594
  content: {
41280
41595
  'application/json': {
41281
41596
  schema: {
41282
- properties: { webhook_id: { type: 'string' } },
41597
+ properties: {
41598
+ webhook_id: {
41599
+ description: 'ID of the webhook that you want to delete.',
41600
+ type: 'string',
41601
+ },
41602
+ },
41283
41603
  required: ['webhook_id'],
41284
41604
  type: 'object',
41285
41605
  },
@@ -41312,16 +41632,24 @@ export default {
41312
41632
  'x-fern-sdk-group-name': ['webhooks'],
41313
41633
  'x-fern-sdk-method-name': 'delete',
41314
41634
  'x-response-key': null,
41635
+ 'x-title': 'Delete a Webhook',
41315
41636
  },
41316
41637
  },
41317
41638
  '/webhooks/get': {
41318
41639
  post: {
41640
+ description:
41641
+ 'Gets a specified [webhook](https://docs.seam.co/latest/developer-tools/webhooks).',
41319
41642
  operationId: 'webhooksGetPost',
41320
41643
  requestBody: {
41321
41644
  content: {
41322
41645
  'application/json': {
41323
41646
  schema: {
41324
- properties: { webhook_id: { type: 'string' } },
41647
+ properties: {
41648
+ webhook_id: {
41649
+ description: 'ID of the webhook that you want to get.',
41650
+ type: 'string',
41651
+ },
41652
+ },
41325
41653
  required: ['webhook_id'],
41326
41654
  type: 'object',
41327
41655
  },
@@ -41358,10 +41686,13 @@ export default {
41358
41686
  'x-fern-sdk-method-name': 'get',
41359
41687
  'x-fern-sdk-return-value': 'webhook',
41360
41688
  'x-response-key': 'webhook',
41689
+ 'x-title': 'Get a Webhook',
41361
41690
  },
41362
41691
  },
41363
41692
  '/webhooks/list': {
41364
41693
  get: {
41694
+ description:
41695
+ 'Returns a list of all [webhooks](https://docs.seam.co/latest/developer-tools/webhooks).',
41365
41696
  operationId: 'webhooksListGet',
41366
41697
  responses: {
41367
41698
  200: {
@@ -41394,8 +41725,11 @@ export default {
41394
41725
  tags: ['/webhooks'],
41395
41726
  'x-fern-ignore': true,
41396
41727
  'x-response-key': 'webhooks',
41728
+ 'x-title': 'List Webhooks',
41397
41729
  },
41398
41730
  post: {
41731
+ description:
41732
+ 'Returns a list of all [webhooks](https://docs.seam.co/latest/developer-tools/webhooks).',
41399
41733
  operationId: 'webhooksListPost',
41400
41734
  responses: {
41401
41735
  200: {
@@ -41430,18 +41764,29 @@ export default {
41430
41764
  'x-fern-sdk-method-name': 'list',
41431
41765
  'x-fern-sdk-return-value': 'webhooks',
41432
41766
  'x-response-key': 'webhooks',
41767
+ 'x-title': 'List Webhooks',
41433
41768
  },
41434
41769
  },
41435
41770
  '/webhooks/update': {
41436
41771
  post: {
41772
+ description:
41773
+ 'Updates a specified [webhook](https://docs.seam.co/latest/developer-tools/webhooks).',
41437
41774
  operationId: 'webhooksUpdatePost',
41438
41775
  requestBody: {
41439
41776
  content: {
41440
41777
  'application/json': {
41441
41778
  schema: {
41442
41779
  properties: {
41443
- event_types: { items: { type: 'string' }, type: 'array' },
41444
- webhook_id: { type: 'string' },
41780
+ event_types: {
41781
+ description:
41782
+ 'Types of events that you want the webhook to receive.',
41783
+ items: { type: 'string' },
41784
+ type: 'array',
41785
+ },
41786
+ webhook_id: {
41787
+ description: 'ID of the webhook that you want to update.',
41788
+ type: 'string',
41789
+ },
41445
41790
  },
41446
41791
  required: ['webhook_id', 'event_types'],
41447
41792
  type: 'object',
@@ -41475,16 +41820,27 @@ export default {
41475
41820
  'x-fern-sdk-group-name': ['webhooks'],
41476
41821
  'x-fern-sdk-method-name': 'update',
41477
41822
  'x-response-key': null,
41823
+ 'x-title': 'Update a Webhook',
41478
41824
  },
41479
41825
  put: {
41826
+ description:
41827
+ 'Updates a specified [webhook](https://docs.seam.co/latest/developer-tools/webhooks).',
41480
41828
  operationId: 'webhooksUpdatePut',
41481
41829
  requestBody: {
41482
41830
  content: {
41483
41831
  'application/json': {
41484
41832
  schema: {
41485
41833
  properties: {
41486
- event_types: { items: { type: 'string' }, type: 'array' },
41487
- webhook_id: { type: 'string' },
41834
+ event_types: {
41835
+ description:
41836
+ 'Types of events that you want the webhook to receive.',
41837
+ items: { type: 'string' },
41838
+ type: 'array',
41839
+ },
41840
+ webhook_id: {
41841
+ description: 'ID of the webhook that you want to update.',
41842
+ type: 'string',
41843
+ },
41488
41844
  },
41489
41845
  required: ['webhook_id', 'event_types'],
41490
41846
  type: 'object',
@@ -41517,41 +41873,72 @@ export default {
41517
41873
  tags: ['/webhooks'],
41518
41874
  'x-fern-ignore': true,
41519
41875
  'x-response-key': null,
41876
+ 'x-title': 'Update a Webhook',
41520
41877
  },
41521
41878
  },
41522
41879
  '/workspaces/create': {
41523
41880
  post: {
41881
+ description:
41882
+ 'Creates a new [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
41524
41883
  operationId: 'workspacesCreatePost',
41525
41884
  requestBody: {
41526
41885
  content: {
41527
41886
  'application/json': {
41528
41887
  schema: {
41529
41888
  properties: {
41530
- company_name: { type: 'string' },
41889
+ company_name: {
41890
+ description: 'Company name for the new workspace.',
41891
+ type: 'string',
41892
+ },
41531
41893
  connect_partner_name: {
41532
41894
  deprecated: true,
41895
+ description: 'Connect partner name for the new workspace.',
41533
41896
  nullable: true,
41534
41897
  type: 'string',
41535
41898
  'x-deprecated': 'use company_name',
41536
41899
  },
41537
41900
  connect_webview_customization: {
41901
+ description:
41902
+ '[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).',
41538
41903
  properties: {
41539
41904
  logo_shape: {
41905
+ description:
41906
+ '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).',
41540
41907
  enum: ['circle', 'square'],
41541
41908
  nullable: true,
41542
41909
  type: 'string',
41543
41910
  },
41544
- primary_button_color: { nullable: true, type: 'string' },
41911
+ primary_button_color: {
41912
+ description:
41913
+ '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).',
41914
+ nullable: true,
41915
+ type: 'string',
41916
+ },
41545
41917
  primary_button_text_color: {
41918
+ description:
41919
+ '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).',
41920
+ nullable: true,
41921
+ type: 'string',
41922
+ },
41923
+ success_message: {
41924
+ description:
41925
+ '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).',
41546
41926
  nullable: true,
41547
41927
  type: 'string',
41548
41928
  },
41549
- success_message: { nullable: true, type: 'string' },
41550
41929
  },
41551
41930
  type: 'object',
41552
41931
  },
41553
- is_sandbox: { default: false, type: 'boolean' },
41554
- name: { type: 'string' },
41932
+ is_sandbox: {
41933
+ default: false,
41934
+ description:
41935
+ 'Indicates whether the new workspace is a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).',
41936
+ type: 'boolean',
41937
+ },
41938
+ name: {
41939
+ description: 'Name of the new workspace.',
41940
+ type: 'string',
41941
+ },
41555
41942
  webview_logo_shape: {
41556
41943
  deprecated: true,
41557
41944
  enum: ['circle', 'square'],
@@ -41614,10 +42001,13 @@ export default {
41614
42001
  'x-fern-sdk-method-name': 'create',
41615
42002
  'x-fern-sdk-return-value': 'workspace',
41616
42003
  'x-response-key': 'workspace',
42004
+ 'x-title': 'Create a Workspace',
41617
42005
  },
41618
42006
  },
41619
42007
  '/workspaces/get': {
41620
42008
  get: {
42009
+ description:
42010
+ 'Returns the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.',
41621
42011
  operationId: 'workspacesGetGet',
41622
42012
  responses: {
41623
42013
  200: {
@@ -41642,14 +42032,18 @@ export default {
41642
42032
  { api_key: [] },
41643
42033
  { console_session_with_workspace: [] },
41644
42034
  { client_session: [] },
42035
+ { client_session_with_customer: [] },
41645
42036
  { pat_with_workspace: [] },
41646
42037
  ],
41647
42038
  summary: '/workspaces/get',
41648
42039
  tags: ['/workspaces'],
41649
42040
  'x-fern-ignore': true,
41650
42041
  'x-response-key': 'workspace',
42042
+ 'x-title': 'Get a Workspace',
41651
42043
  },
41652
42044
  post: {
42045
+ description:
42046
+ 'Returns the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.',
41653
42047
  operationId: 'workspacesGetPost',
41654
42048
  responses: {
41655
42049
  200: {
@@ -41674,6 +42068,7 @@ export default {
41674
42068
  { api_key: [] },
41675
42069
  { console_session_with_workspace: [] },
41676
42070
  { client_session: [] },
42071
+ { client_session_with_customer: [] },
41677
42072
  { pat_with_workspace: [] },
41678
42073
  ],
41679
42074
  summary: '/workspaces/get',
@@ -41682,10 +42077,13 @@ export default {
41682
42077
  'x-fern-sdk-method-name': 'get',
41683
42078
  'x-fern-sdk-return-value': 'workspace',
41684
42079
  'x-response-key': 'workspace',
42080
+ 'x-title': 'Get a Workspace',
41685
42081
  },
41686
42082
  },
41687
42083
  '/workspaces/list': {
41688
42084
  get: {
42085
+ description:
42086
+ 'Returns a list of [workspaces](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.',
41689
42087
  operationId: 'workspacesListGet',
41690
42088
  responses: {
41691
42089
  200: {
@@ -41721,8 +42119,11 @@ export default {
41721
42119
  tags: ['/workspaces'],
41722
42120
  'x-fern-ignore': true,
41723
42121
  'x-response-key': 'workspaces',
42122
+ 'x-title': 'List Workspaces',
41724
42123
  },
41725
42124
  post: {
42125
+ description:
42126
+ 'Returns a list of [workspaces](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.',
41726
42127
  operationId: 'workspacesListPost',
41727
42128
  responses: {
41728
42129
  200: {
@@ -41760,12 +42161,13 @@ export default {
41760
42161
  'x-fern-sdk-method-name': 'list',
41761
42162
  'x-fern-sdk-return-value': 'workspaces',
41762
42163
  'x-response-key': 'workspaces',
42164
+ 'x-title': 'List Workspaces',
41763
42165
  },
41764
42166
  },
41765
42167
  '/workspaces/reset_sandbox': {
41766
42168
  post: {
41767
42169
  description:
41768
- 'Resets a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). Note that this endpoint is only available for sandbox workspaces.',
42170
+ '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.',
41769
42171
  operationId: 'workspacesResetSandboxPost',
41770
42172
  responses: {
41771
42173
  200: {
@@ -41800,35 +42202,64 @@ export default {
41800
42202
  'x-fern-sdk-method-name': 'reset_sandbox',
41801
42203
  'x-fern-sdk-return-value': 'action_attempt',
41802
42204
  'x-response-key': 'action_attempt',
42205
+ 'x-title': 'Reset a Sandbox Workspace',
41803
42206
  },
41804
42207
  },
41805
42208
  '/workspaces/update': {
41806
42209
  patch: {
42210
+ description:
42211
+ 'Updates the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.',
41807
42212
  operationId: 'workspacesUpdatePatch',
41808
42213
  requestBody: {
41809
42214
  content: {
41810
42215
  'application/json': {
41811
42216
  schema: {
41812
42217
  properties: {
41813
- connect_partner_name: { type: 'string' },
42218
+ connect_partner_name: {
42219
+ description: 'Connect partner name for the workspace.',
42220
+ type: 'string',
42221
+ },
41814
42222
  connect_webview_customization: {
42223
+ description:
42224
+ '[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).',
41815
42225
  properties: {
41816
42226
  logo_shape: {
42227
+ description:
42228
+ '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).',
41817
42229
  enum: ['circle', 'square'],
41818
42230
  nullable: true,
41819
42231
  type: 'string',
41820
42232
  },
41821
- primary_button_color: { nullable: true, type: 'string' },
42233
+ primary_button_color: {
42234
+ description:
42235
+ '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).',
42236
+ nullable: true,
42237
+ type: 'string',
42238
+ },
41822
42239
  primary_button_text_color: {
42240
+ description:
42241
+ '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).',
42242
+ nullable: true,
42243
+ type: 'string',
42244
+ },
42245
+ success_message: {
42246
+ description:
42247
+ '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).',
41823
42248
  nullable: true,
41824
42249
  type: 'string',
41825
42250
  },
41826
- success_message: { nullable: true, type: 'string' },
41827
42251
  },
41828
42252
  type: 'object',
41829
42253
  },
41830
- is_suspended: { type: 'boolean' },
41831
- name: { type: 'string' },
42254
+ is_suspended: {
42255
+ description:
42256
+ 'Indicates whether the workspace is suspended.',
42257
+ type: 'boolean',
42258
+ },
42259
+ name: {
42260
+ description: 'Name of the workspace.',
42261
+ type: 'string',
42262
+ },
41832
42263
  },
41833
42264
  type: 'object',
41834
42265
  },
@@ -41849,33 +42280,62 @@ export default {
41849
42280
  tags: ['/workspaces'],
41850
42281
  'x-fern-ignore': true,
41851
42282
  'x-response-key': null,
42283
+ 'x-title': 'Udpate a Workspace',
41852
42284
  },
41853
42285
  post: {
42286
+ description:
42287
+ 'Updates the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.',
41854
42288
  operationId: 'workspacesUpdatePost',
41855
42289
  requestBody: {
41856
42290
  content: {
41857
42291
  'application/json': {
41858
42292
  schema: {
41859
42293
  properties: {
41860
- connect_partner_name: { type: 'string' },
42294
+ connect_partner_name: {
42295
+ description: 'Connect partner name for the workspace.',
42296
+ type: 'string',
42297
+ },
41861
42298
  connect_webview_customization: {
42299
+ description:
42300
+ '[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).',
41862
42301
  properties: {
41863
42302
  logo_shape: {
42303
+ description:
42304
+ '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).',
41864
42305
  enum: ['circle', 'square'],
41865
42306
  nullable: true,
41866
42307
  type: 'string',
41867
42308
  },
41868
- primary_button_color: { nullable: true, type: 'string' },
42309
+ primary_button_color: {
42310
+ description:
42311
+ '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).',
42312
+ nullable: true,
42313
+ type: 'string',
42314
+ },
41869
42315
  primary_button_text_color: {
42316
+ description:
42317
+ '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).',
42318
+ nullable: true,
42319
+ type: 'string',
42320
+ },
42321
+ success_message: {
42322
+ description:
42323
+ '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).',
41870
42324
  nullable: true,
41871
42325
  type: 'string',
41872
42326
  },
41873
- success_message: { nullable: true, type: 'string' },
41874
42327
  },
41875
42328
  type: 'object',
41876
42329
  },
41877
- is_suspended: { type: 'boolean' },
41878
- name: { type: 'string' },
42330
+ is_suspended: {
42331
+ description:
42332
+ 'Indicates whether the workspace is suspended.',
42333
+ type: 'boolean',
42334
+ },
42335
+ name: {
42336
+ description: 'Name of the workspace.',
42337
+ type: 'string',
42338
+ },
41879
42339
  },
41880
42340
  type: 'object',
41881
42341
  },
@@ -41897,6 +42357,7 @@ export default {
41897
42357
  'x-fern-sdk-group-name': ['workspaces'],
41898
42358
  'x-fern-sdk-method-name': 'update',
41899
42359
  'x-response-key': null,
42360
+ 'x-title': 'Udpate a Workspace',
41900
42361
  },
41901
42362
  },
41902
42363
  },