@seamapi/types 1.410.1 → 1.411.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/connect.cjs +680 -354
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +486 -177
- package/lib/seam/connect/internal/schemas.d.ts +1 -1
- package/lib/seam/connect/internal/schemas.js +1 -1
- package/lib/seam/connect/internal/schemas.js.map +1 -1
- package/lib/seam/connect/models/partner/magic-link.d.ts +4 -4
- package/lib/seam/connect/models/partner/magic-link.js +1 -0
- package/lib/seam/connect/models/partner/magic-link.js.map +1 -1
- package/lib/seam/connect/models/partner/resources.d.ts +17 -0
- package/lib/seam/connect/models/partner/resources.js +11 -0
- package/lib/seam/connect/models/partner/resources.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +284 -47
- package/lib/seam/connect/openapi.js +655 -330
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +198 -126
- package/package.json +1 -1
- package/src/lib/seam/connect/internal/schemas.ts +1 -0
- package/src/lib/seam/connect/models/partner/magic-link.ts +1 -0
- package/src/lib/seam/connect/models/partner/resources.ts +15 -0
- package/src/lib/seam/connect/openapi.ts +786 -342
- package/src/lib/seam/connect/route-types.ts +211 -134
|
@@ -15970,7 +15970,12 @@ export default {
|
|
|
15970
15970
|
magic_link: {
|
|
15971
15971
|
properties: {
|
|
15972
15972
|
building_block_type: {
|
|
15973
|
-
enum: [
|
|
15973
|
+
enum: [
|
|
15974
|
+
'connect_accounts',
|
|
15975
|
+
'manage_devices',
|
|
15976
|
+
'organize_spaces',
|
|
15977
|
+
'console',
|
|
15978
|
+
],
|
|
15974
15979
|
type: 'string',
|
|
15975
15980
|
},
|
|
15976
15981
|
created_at: { format: 'date-time', type: 'string' },
|
|
@@ -22253,6 +22258,7 @@ export default {
|
|
|
22253
22258
|
},
|
|
22254
22259
|
security: [
|
|
22255
22260
|
{ client_session: [] },
|
|
22261
|
+
{ client_session_with_customer: [] },
|
|
22256
22262
|
{ pat_with_workspace: [] },
|
|
22257
22263
|
{ console_session_with_workspace: [] },
|
|
22258
22264
|
{ api_key: [] },
|
|
@@ -22401,6 +22407,7 @@ export default {
|
|
|
22401
22407
|
},
|
|
22402
22408
|
security: [
|
|
22403
22409
|
{ client_session: [] },
|
|
22410
|
+
{ client_session_with_customer: [] },
|
|
22404
22411
|
{ pat_with_workspace: [] },
|
|
22405
22412
|
{ console_session_with_workspace: [] },
|
|
22406
22413
|
{ api_key: [] },
|
|
@@ -22550,6 +22557,7 @@ export default {
|
|
|
22550
22557
|
},
|
|
22551
22558
|
security: [
|
|
22552
22559
|
{ client_session: [] },
|
|
22560
|
+
{ client_session_with_customer: [] },
|
|
22553
22561
|
{ pat_with_workspace: [] },
|
|
22554
22562
|
{ console_session_with_workspace: [] },
|
|
22555
22563
|
{ api_key: [] },
|
|
@@ -29136,6 +29144,7 @@ export default {
|
|
|
29136
29144
|
},
|
|
29137
29145
|
security: [
|
|
29138
29146
|
{ client_session: [] },
|
|
29147
|
+
{ client_session_with_customer: [] },
|
|
29139
29148
|
{ api_key: [] },
|
|
29140
29149
|
{ pat_with_workspace: [] },
|
|
29141
29150
|
{ console_session_with_workspace: [] },
|
|
@@ -29926,6 +29935,7 @@ export default {
|
|
|
29926
29935
|
{ api_key: [] },
|
|
29927
29936
|
{ pat_with_workspace: [] },
|
|
29928
29937
|
{ console_session_with_workspace: [] },
|
|
29938
|
+
{ client_session_with_customer: [] },
|
|
29929
29939
|
],
|
|
29930
29940
|
summary: '/devices/simulate/connect',
|
|
29931
29941
|
tags: ['/devices'],
|
|
@@ -29978,6 +29988,7 @@ export default {
|
|
|
29978
29988
|
{ api_key: [] },
|
|
29979
29989
|
{ pat_with_workspace: [] },
|
|
29980
29990
|
{ console_session_with_workspace: [] },
|
|
29991
|
+
{ client_session_with_customer: [] },
|
|
29981
29992
|
],
|
|
29982
29993
|
summary: '/devices/simulate/disconnect',
|
|
29983
29994
|
tags: ['/devices'],
|
|
@@ -30030,6 +30041,7 @@ export default {
|
|
|
30030
30041
|
{ api_key: [] },
|
|
30031
30042
|
{ pat_with_workspace: [] },
|
|
30032
30043
|
{ console_session_with_workspace: [] },
|
|
30044
|
+
{ client_session_with_customer: [] },
|
|
30033
30045
|
],
|
|
30034
30046
|
summary: '/devices/simulate/remove',
|
|
30035
30047
|
tags: ['/devices'],
|
|
@@ -30629,6 +30641,7 @@ export default {
|
|
|
30629
30641
|
{ pat_with_workspace: [] },
|
|
30630
30642
|
{ console_session_with_workspace: [] },
|
|
30631
30643
|
{ client_session: [] },
|
|
30644
|
+
{ client_session_with_customer: [] },
|
|
30632
30645
|
],
|
|
30633
30646
|
summary: '/devices/update',
|
|
30634
30647
|
tags: ['/devices'],
|
|
@@ -30711,6 +30724,7 @@ export default {
|
|
|
30711
30724
|
{ pat_with_workspace: [] },
|
|
30712
30725
|
{ console_session_with_workspace: [] },
|
|
30713
30726
|
{ client_session: [] },
|
|
30727
|
+
{ client_session_with_customer: [] },
|
|
30714
30728
|
],
|
|
30715
30729
|
summary: '/devices/update',
|
|
30716
30730
|
tags: ['/devices'],
|
|
@@ -30777,6 +30791,7 @@ export default {
|
|
|
30777
30791
|
{ api_key: [] },
|
|
30778
30792
|
{ pat_with_workspace: [] },
|
|
30779
30793
|
{ console_session_with_workspace: [] },
|
|
30794
|
+
{ client_session_with_customer: [] },
|
|
30780
30795
|
],
|
|
30781
30796
|
summary: '/events/get',
|
|
30782
30797
|
tags: ['/events'],
|
|
@@ -32661,7 +32676,8 @@ export default {
|
|
|
32661
32676
|
schema: {
|
|
32662
32677
|
properties: {
|
|
32663
32678
|
device_id: {
|
|
32664
|
-
description:
|
|
32679
|
+
description:
|
|
32680
|
+
'Device ID of the phone that you want to deactivate.',
|
|
32665
32681
|
type: 'string',
|
|
32666
32682
|
},
|
|
32667
32683
|
},
|
|
@@ -32704,7 +32720,7 @@ export default {
|
|
|
32704
32720
|
'/phones/get': {
|
|
32705
32721
|
post: {
|
|
32706
32722
|
description:
|
|
32707
|
-
'Returns a
|
|
32723
|
+
'Returns a specified [phone](https://docs.seam.co/latest/capability-guides/mobile-access/managing-phones-for-a-user-identity).',
|
|
32708
32724
|
operationId: 'phonesGetPost',
|
|
32709
32725
|
requestBody: {
|
|
32710
32726
|
content: {
|
|
@@ -32712,7 +32728,7 @@ export default {
|
|
|
32712
32728
|
schema: {
|
|
32713
32729
|
properties: {
|
|
32714
32730
|
device_id: {
|
|
32715
|
-
description: 'Device ID of the
|
|
32731
|
+
description: 'Device ID of the phone that you want to get.',
|
|
32716
32732
|
format: 'uuid',
|
|
32717
32733
|
type: 'string',
|
|
32718
32734
|
},
|
|
@@ -32753,13 +32769,13 @@ export default {
|
|
|
32753
32769
|
'x-fern-sdk-method-name': 'get',
|
|
32754
32770
|
'x-fern-sdk-return-value': 'phone',
|
|
32755
32771
|
'x-response-key': 'phone',
|
|
32756
|
-
'x-title': 'Get Phone',
|
|
32772
|
+
'x-title': 'Get a Phone',
|
|
32757
32773
|
},
|
|
32758
32774
|
},
|
|
32759
32775
|
'/phones/list': {
|
|
32760
32776
|
post: {
|
|
32761
32777
|
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.',
|
|
32778
|
+
'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
32779
|
operationId: 'phonesListPost',
|
|
32764
32780
|
requestBody: {
|
|
32765
32781
|
content: {
|
|
@@ -32768,13 +32784,13 @@ export default {
|
|
|
32768
32784
|
properties: {
|
|
32769
32785
|
acs_credential_id: {
|
|
32770
32786
|
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.',
|
|
32787
|
+
'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
32788
|
format: 'uuid',
|
|
32773
32789
|
type: 'string',
|
|
32774
32790
|
},
|
|
32775
32791
|
owner_user_identity_id: {
|
|
32776
32792
|
description:
|
|
32777
|
-
'ID of the user identity that represents the owner by which to filter the list of returned phones.',
|
|
32793
|
+
'ID of the user identity that represents the owner by which you want to filter the list of returned phones.',
|
|
32778
32794
|
format: 'uuid',
|
|
32779
32795
|
type: 'string',
|
|
32780
32796
|
},
|
|
@@ -32823,7 +32839,7 @@ export default {
|
|
|
32823
32839
|
'/phones/simulate/create_sandbox_phone': {
|
|
32824
32840
|
post: {
|
|
32825
32841
|
description:
|
|
32826
|
-
'Creates a new simulated phone in a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).
|
|
32842
|
+
'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
32843
|
operationId: 'phonesSimulateCreateSandboxPhonePost',
|
|
32828
32844
|
requestBody: {
|
|
32829
32845
|
content: {
|
|
@@ -32833,7 +32849,7 @@ export default {
|
|
|
32833
32849
|
assa_abloy_metadata: {
|
|
32834
32850
|
default: {},
|
|
32835
32851
|
description:
|
|
32836
|
-
'ASSA ABLOY metadata to associate with the simulated phone.',
|
|
32852
|
+
'ASSA ABLOY metadata that you want to associate with the simulated phone.',
|
|
32837
32853
|
properties: {
|
|
32838
32854
|
application_version: {
|
|
32839
32855
|
default: '1.0.0',
|
|
@@ -32877,13 +32893,13 @@ export default {
|
|
|
32877
32893
|
},
|
|
32878
32894
|
custom_sdk_installation_id: {
|
|
32879
32895
|
description:
|
|
32880
|
-
'ID of the custom SDK installation to use for the simulated phone.',
|
|
32896
|
+
'ID of the custom SDK installation that you want to use for the simulated phone.',
|
|
32881
32897
|
type: 'string',
|
|
32882
32898
|
},
|
|
32883
32899
|
phone_metadata: {
|
|
32884
32900
|
default: {},
|
|
32885
32901
|
description:
|
|
32886
|
-
'Metadata to associate with the simulated phone.',
|
|
32902
|
+
'Metadata that you want to associate with the simulated phone.',
|
|
32887
32903
|
properties: {
|
|
32888
32904
|
device_manufacturer: {
|
|
32889
32905
|
default: 'Samsung',
|
|
@@ -32915,7 +32931,7 @@ export default {
|
|
|
32915
32931
|
},
|
|
32916
32932
|
user_identity_id: {
|
|
32917
32933
|
description:
|
|
32918
|
-
'ID of the user identity to associate with the simulated phone.',
|
|
32934
|
+
'ID of the user identity that you want to associate with the simulated phone.',
|
|
32919
32935
|
format: 'uuid',
|
|
32920
32936
|
type: 'string',
|
|
32921
32937
|
},
|
|
@@ -32961,16 +32977,29 @@ export default {
|
|
|
32961
32977
|
},
|
|
32962
32978
|
'/seam/bridge/v1/bridge_client_sessions/create': {
|
|
32963
32979
|
post: {
|
|
32964
|
-
description:
|
|
32980
|
+
description:
|
|
32981
|
+
'Creates a new [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client session.',
|
|
32965
32982
|
operationId: 'seamBridgeV1BridgeClientSessionsCreatePost',
|
|
32966
32983
|
requestBody: {
|
|
32967
32984
|
content: {
|
|
32968
32985
|
'application/json': {
|
|
32969
32986
|
schema: {
|
|
32970
32987
|
properties: {
|
|
32971
|
-
bridge_client_machine_identifier_key: {
|
|
32972
|
-
|
|
32973
|
-
|
|
32988
|
+
bridge_client_machine_identifier_key: {
|
|
32989
|
+
description:
|
|
32990
|
+
'Identifier key of the client machine for the Seam Bridge client that you want to create.',
|
|
32991
|
+
type: 'string',
|
|
32992
|
+
},
|
|
32993
|
+
bridge_client_name: {
|
|
32994
|
+
description:
|
|
32995
|
+
'Name of the Seam Bridge client that you want to create.',
|
|
32996
|
+
type: 'string',
|
|
32997
|
+
},
|
|
32998
|
+
bridge_client_time_zone: {
|
|
32999
|
+
description:
|
|
33000
|
+
'Time zone for the Seam Bridge that you want to create.',
|
|
33001
|
+
type: 'string',
|
|
33002
|
+
},
|
|
32974
33003
|
},
|
|
32975
33004
|
required: [
|
|
32976
33005
|
'bridge_client_name',
|
|
@@ -33156,13 +33185,13 @@ export default {
|
|
|
33156
33185
|
'x-fern-sdk-return-value': 'bridge_client_session',
|
|
33157
33186
|
'x-response-key': 'bridge_client_session',
|
|
33158
33187
|
'x-title': 'Create a Bridge Client Session',
|
|
33159
|
-
'x-undocumented': 'Seam Bridge
|
|
33188
|
+
'x-undocumented': 'Seam Bridge client only.',
|
|
33160
33189
|
},
|
|
33161
33190
|
},
|
|
33162
33191
|
'/seam/bridge/v1/bridge_client_sessions/get': {
|
|
33163
33192
|
get: {
|
|
33164
33193
|
description:
|
|
33165
|
-
'Returns the bridge client session associated with the session token used.',
|
|
33194
|
+
'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
33195
|
operationId: 'seamBridgeV1BridgeClientSessionsGetGet',
|
|
33167
33196
|
responses: {
|
|
33168
33197
|
200: {
|
|
@@ -33330,12 +33359,12 @@ export default {
|
|
|
33330
33359
|
tags: [],
|
|
33331
33360
|
'x-fern-ignore': true,
|
|
33332
33361
|
'x-response-key': 'bridge_client_session',
|
|
33333
|
-
'x-title': 'Get a Bridge Client Session',
|
|
33362
|
+
'x-title': 'Get a Seam Bridge Client Session',
|
|
33334
33363
|
'x-undocumented': 'Seam Bridge Client only.',
|
|
33335
33364
|
},
|
|
33336
33365
|
post: {
|
|
33337
33366
|
description:
|
|
33338
|
-
'Returns the bridge client session associated with the session token used.',
|
|
33367
|
+
'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
33368
|
operationId: 'seamBridgeV1BridgeClientSessionsGetPost',
|
|
33340
33369
|
responses: {
|
|
33341
33370
|
200: {
|
|
@@ -33510,14 +33539,14 @@ export default {
|
|
|
33510
33539
|
'x-fern-sdk-method-name': 'get',
|
|
33511
33540
|
'x-fern-sdk-return-value': 'bridge_client_session',
|
|
33512
33541
|
'x-response-key': 'bridge_client_session',
|
|
33513
|
-
'x-title': 'Get a Bridge Client Session',
|
|
33542
|
+
'x-title': 'Get a Seam Bridge Client Session',
|
|
33514
33543
|
'x-undocumented': 'Seam Bridge Client only.',
|
|
33515
33544
|
},
|
|
33516
33545
|
},
|
|
33517
33546
|
'/seam/bridge/v1/bridge_client_sessions/refresh_telemetry_token': {
|
|
33518
33547
|
post: {
|
|
33519
33548
|
description:
|
|
33520
|
-
'Returns the bridge client session associated with the session token and refreshed telemetry token.',
|
|
33549
|
+
'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
33550
|
operationId:
|
|
33522
33551
|
'seamBridgeV1BridgeClientSessionsRefreshTelemetryTokenPost',
|
|
33523
33552
|
responses: {
|
|
@@ -33694,14 +33723,15 @@ export default {
|
|
|
33694
33723
|
'x-fern-sdk-method-name': 'refresh_telemetry_token',
|
|
33695
33724
|
'x-fern-sdk-return-value': 'bridge_client_session',
|
|
33696
33725
|
'x-response-key': 'bridge_client_session',
|
|
33697
|
-
'x-title':
|
|
33726
|
+
'x-title':
|
|
33727
|
+
'Refresh the Telemetry Token for a Seam Bridge Client Session',
|
|
33698
33728
|
'x-undocumented': 'Seam Bridge Client only.',
|
|
33699
33729
|
},
|
|
33700
33730
|
},
|
|
33701
33731
|
'/seam/bridge/v1/bridge_client_sessions/regenerate_pairing_code': {
|
|
33702
33732
|
post: {
|
|
33703
33733
|
description:
|
|
33704
|
-
'Generate a new pairing code and return the updated bridge client session.',
|
|
33734
|
+
'Generate a new pairing code and return the updated [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client session.',
|
|
33705
33735
|
operationId:
|
|
33706
33736
|
'seamBridgeV1BridgeClientSessionsRegeneratePairingCodePost',
|
|
33707
33737
|
responses: {
|
|
@@ -33878,21 +33908,30 @@ export default {
|
|
|
33878
33908
|
'x-fern-sdk-method-name': 'regenerate_pairing_code',
|
|
33879
33909
|
'x-fern-sdk-return-value': 'bridge_client_session',
|
|
33880
33910
|
'x-response-key': 'bridge_client_session',
|
|
33881
|
-
'x-title': 'Regenerate a Bridge Client Session Pairing Code',
|
|
33911
|
+
'x-title': 'Regenerate a Seam Bridge Client Session Pairing Code',
|
|
33882
33912
|
'x-undocumented': 'Seam Bridge Client only.',
|
|
33883
33913
|
},
|
|
33884
33914
|
},
|
|
33885
33915
|
'/seam/bridge/v1/bridge_client_sessions/report_status': {
|
|
33886
33916
|
post: {
|
|
33887
|
-
description:
|
|
33917
|
+
description:
|
|
33918
|
+
'Report the status of a [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client.',
|
|
33888
33919
|
operationId: 'seamBridgeV1BridgeClientSessionsReportStatusPost',
|
|
33889
33920
|
requestBody: {
|
|
33890
33921
|
content: {
|
|
33891
33922
|
'application/json': {
|
|
33892
33923
|
schema: {
|
|
33893
33924
|
properties: {
|
|
33894
|
-
is_tailscale_connected: {
|
|
33895
|
-
|
|
33925
|
+
is_tailscale_connected: {
|
|
33926
|
+
description: 'Indicates whether Tailscale is connected.',
|
|
33927
|
+
nullable: true,
|
|
33928
|
+
type: 'boolean',
|
|
33929
|
+
},
|
|
33930
|
+
tailscale_ip_v4: {
|
|
33931
|
+
description: 'Tailscale IPv4 address.',
|
|
33932
|
+
nullable: true,
|
|
33933
|
+
type: 'string',
|
|
33934
|
+
},
|
|
33896
33935
|
},
|
|
33897
33936
|
required: ['is_tailscale_connected', 'tailscale_ip_v4'],
|
|
33898
33937
|
type: 'object',
|
|
@@ -33927,14 +33966,14 @@ export default {
|
|
|
33927
33966
|
],
|
|
33928
33967
|
'x-fern-sdk-method-name': 'report_status',
|
|
33929
33968
|
'x-response-key': null,
|
|
33930
|
-
'x-title':
|
|
33969
|
+
'x-title': 'Report the Status of a Seam Bridge Client',
|
|
33931
33970
|
'x-undocumented': 'Seam Bridge Client only.',
|
|
33932
33971
|
},
|
|
33933
33972
|
},
|
|
33934
33973
|
'/seam/bridge/v1/bridge_connected_systems/list': {
|
|
33935
33974
|
get: {
|
|
33936
33975
|
description:
|
|
33937
|
-
'Returns the bridge
|
|
33976
|
+
'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
33977
|
operationId: 'seamBridgeV1BridgeConnectedSystemsListGet',
|
|
33939
33978
|
responses: {
|
|
33940
33979
|
200: {
|
|
@@ -33997,12 +34036,12 @@ export default {
|
|
|
33997
34036
|
tags: [],
|
|
33998
34037
|
'x-fern-ignore': true,
|
|
33999
34038
|
'x-response-key': 'bridge_connected_systems',
|
|
34000
|
-
'x-title': 'List Bridge
|
|
34039
|
+
'x-title': 'List Bridge-Connected Systems',
|
|
34001
34040
|
'x-undocumented': 'Seam Bridge Client only.',
|
|
34002
34041
|
},
|
|
34003
34042
|
post: {
|
|
34004
34043
|
description:
|
|
34005
|
-
'Returns the bridge
|
|
34044
|
+
'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
34045
|
operationId: 'seamBridgeV1BridgeConnectedSystemsListPost',
|
|
34007
34046
|
responses: {
|
|
34008
34047
|
200: {
|
|
@@ -34072,14 +34111,14 @@ export default {
|
|
|
34072
34111
|
'x-fern-sdk-method-name': 'list',
|
|
34073
34112
|
'x-fern-sdk-return-value': 'bridge_connected_systems',
|
|
34074
34113
|
'x-response-key': 'bridge_connected_systems',
|
|
34075
|
-
'x-title': 'List Bridge
|
|
34114
|
+
'x-title': 'List Bridge-Connected Systems',
|
|
34076
34115
|
'x-undocumented': 'Seam Bridge Client only.',
|
|
34077
34116
|
},
|
|
34078
34117
|
},
|
|
34079
34118
|
'/seam/instant_key/v1/client_sessions/exchange_short_code': {
|
|
34080
34119
|
post: {
|
|
34081
34120
|
description:
|
|
34082
|
-
'Exchanges a short code for a
|
|
34121
|
+
'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
34122
|
operationId: 'seamInstantKeyV1ClientSessionsExchangeShortCodePost',
|
|
34084
34123
|
requestBody: {
|
|
34085
34124
|
content: {
|
|
@@ -34088,7 +34127,7 @@ export default {
|
|
|
34088
34127
|
properties: {
|
|
34089
34128
|
short_code: {
|
|
34090
34129
|
description:
|
|
34091
|
-
'
|
|
34130
|
+
'Short code that you want to exchange for a client session token.',
|
|
34092
34131
|
type: 'string',
|
|
34093
34132
|
},
|
|
34094
34133
|
},
|
|
@@ -34137,7 +34176,8 @@ export default {
|
|
|
34137
34176
|
},
|
|
34138
34177
|
'/seam/mobile_sdk/v1/acs/credentials/list': {
|
|
34139
34178
|
post: {
|
|
34140
|
-
description:
|
|
34179
|
+
description:
|
|
34180
|
+
'Returns a list of all [credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
34141
34181
|
operationId: 'seamMobileSdkV1AcsCredentialsListPost',
|
|
34142
34182
|
requestBody: {
|
|
34143
34183
|
content: {
|
|
@@ -34185,15 +34225,21 @@ export default {
|
|
|
34185
34225
|
},
|
|
34186
34226
|
'/seam/mobile_sdk/v1/phone_sessions/get_or_create': {
|
|
34187
34227
|
post: {
|
|
34188
|
-
description: '
|
|
34228
|
+
description: 'Gets or creates a session for a mobile SDK phone.',
|
|
34189
34229
|
operationId: 'seamMobileSdkV1PhoneSessionsGetOrCreatePost',
|
|
34190
34230
|
requestBody: {
|
|
34191
34231
|
content: {
|
|
34192
34232
|
'application/json': {
|
|
34193
34233
|
schema: {
|
|
34194
34234
|
properties: {
|
|
34195
|
-
custom_sdk_installation_id: {
|
|
34235
|
+
custom_sdk_installation_id: {
|
|
34236
|
+
description:
|
|
34237
|
+
'ID of the custom SDK installation that you want to use for the new session.',
|
|
34238
|
+
type: 'string',
|
|
34239
|
+
},
|
|
34196
34240
|
phone_device_metadata: {
|
|
34241
|
+
description:
|
|
34242
|
+
'Phone device metadata that you want to use for the new session.',
|
|
34197
34243
|
properties: {
|
|
34198
34244
|
manufacturer: { type: 'string' },
|
|
34199
34245
|
model: { type: 'string' },
|
|
@@ -34201,7 +34247,12 @@ export default {
|
|
|
34201
34247
|
},
|
|
34202
34248
|
type: 'object',
|
|
34203
34249
|
},
|
|
34204
|
-
phone_os: {
|
|
34250
|
+
phone_os: {
|
|
34251
|
+
description:
|
|
34252
|
+
'Phone operating system that you want to use for the new session.',
|
|
34253
|
+
enum: ['ios', 'android'],
|
|
34254
|
+
type: 'string',
|
|
34255
|
+
},
|
|
34205
34256
|
},
|
|
34206
34257
|
required: ['custom_sdk_installation_id', 'phone_os'],
|
|
34207
34258
|
type: 'object',
|
|
@@ -34244,13 +34295,18 @@ export default {
|
|
|
34244
34295
|
'/seam/partner/v1/building_blocks/spaces/auto_map': {
|
|
34245
34296
|
post: {
|
|
34246
34297
|
description:
|
|
34247
|
-
'Auto
|
|
34298
|
+
'Auto-maps partner resources that have been pushed to Seam.',
|
|
34248
34299
|
operationId: 'seamPartnerV1BuildingBlocksSpacesAutoMapPost',
|
|
34249
34300
|
requestBody: {
|
|
34250
34301
|
content: {
|
|
34251
34302
|
'application/json': {
|
|
34252
34303
|
schema: {
|
|
34253
|
-
properties: {
|
|
34304
|
+
properties: {
|
|
34305
|
+
collection_key: {
|
|
34306
|
+
description: 'Collection key.',
|
|
34307
|
+
type: 'string',
|
|
34308
|
+
},
|
|
34309
|
+
},
|
|
34254
34310
|
required: ['collection_key'],
|
|
34255
34311
|
type: 'object',
|
|
34256
34312
|
},
|
|
@@ -34331,13 +34387,13 @@ export default {
|
|
|
34331
34387
|
'x-fern-sdk-method-name': 'auto_map',
|
|
34332
34388
|
'x-fern-sdk-return-value': 'spaces',
|
|
34333
34389
|
'x-response-key': 'spaces',
|
|
34334
|
-
'x-title': 'Do
|
|
34390
|
+
'x-title': 'Do Auto-Mapping for Partner Resources that Map to Spaces',
|
|
34335
34391
|
'x-undocumented': 'Partner building blocks/UI only.',
|
|
34336
34392
|
},
|
|
34337
34393
|
},
|
|
34338
34394
|
'/seam/partner/v1/resources/list': {
|
|
34339
34395
|
post: {
|
|
34340
|
-
description: '
|
|
34396
|
+
description: 'Lists partner resources that have been pushed to Seam.',
|
|
34341
34397
|
operationId: 'seamPartnerV1ResourcesListPost',
|
|
34342
34398
|
requestBody: {
|
|
34343
34399
|
content: {
|
|
@@ -34345,7 +34401,8 @@ export default {
|
|
|
34345
34401
|
schema: {
|
|
34346
34402
|
properties: {
|
|
34347
34403
|
resource_type_alias: {
|
|
34348
|
-
description:
|
|
34404
|
+
description:
|
|
34405
|
+
'Resource type alias by which you want to filter partner resources.',
|
|
34349
34406
|
type: 'string',
|
|
34350
34407
|
},
|
|
34351
34408
|
},
|
|
@@ -34412,13 +34469,14 @@ export default {
|
|
|
34412
34469
|
'x-fern-sdk-method-name': 'list',
|
|
34413
34470
|
'x-fern-sdk-return-value': 'partner_resources',
|
|
34414
34471
|
'x-response-key': 'partner_resources',
|
|
34415
|
-
'x-title': 'List
|
|
34472
|
+
'x-title': 'List Partner Resources at Seam',
|
|
34416
34473
|
'x-undocumented': 'Partner building blocks/UI only.',
|
|
34417
34474
|
},
|
|
34418
34475
|
},
|
|
34419
34476
|
'/spaces/add_acs_entrances': {
|
|
34420
34477
|
post: {
|
|
34421
|
-
description:
|
|
34478
|
+
description:
|
|
34479
|
+
'Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific space.',
|
|
34422
34480
|
operationId: 'spacesAddAcsEntrancesPost',
|
|
34423
34481
|
requestBody: {
|
|
34424
34482
|
content: {
|
|
@@ -34426,11 +34484,18 @@ export default {
|
|
|
34426
34484
|
schema: {
|
|
34427
34485
|
properties: {
|
|
34428
34486
|
acs_entrance_ids: {
|
|
34487
|
+
description:
|
|
34488
|
+
'IDs of the entrances that you want to add to the space.',
|
|
34429
34489
|
items: { format: 'uuid', type: 'string' },
|
|
34430
34490
|
minItems: 1,
|
|
34431
34491
|
type: 'array',
|
|
34432
34492
|
},
|
|
34433
|
-
space_id: {
|
|
34493
|
+
space_id: {
|
|
34494
|
+
description:
|
|
34495
|
+
'ID of the space to which you want to add entrances.',
|
|
34496
|
+
format: 'uuid',
|
|
34497
|
+
type: 'string',
|
|
34498
|
+
},
|
|
34434
34499
|
},
|
|
34435
34500
|
required: ['space_id', 'acs_entrance_ids'],
|
|
34436
34501
|
type: 'object',
|
|
@@ -34465,10 +34530,11 @@ export default {
|
|
|
34465
34530
|
'x-fern-sdk-group-name': ['spaces'],
|
|
34466
34531
|
'x-fern-sdk-method-name': 'add_acs_entrances',
|
|
34467
34532
|
'x-response-key': null,
|
|
34468
|
-
'x-title': 'Add
|
|
34533
|
+
'x-title': 'Add Entrances to a Space',
|
|
34469
34534
|
},
|
|
34470
34535
|
put: {
|
|
34471
|
-
description:
|
|
34536
|
+
description:
|
|
34537
|
+
'Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific space.',
|
|
34472
34538
|
operationId: 'spacesAddAcsEntrancesPut',
|
|
34473
34539
|
requestBody: {
|
|
34474
34540
|
content: {
|
|
@@ -34476,11 +34542,18 @@ export default {
|
|
|
34476
34542
|
schema: {
|
|
34477
34543
|
properties: {
|
|
34478
34544
|
acs_entrance_ids: {
|
|
34545
|
+
description:
|
|
34546
|
+
'IDs of the entrances that you want to add to the space.',
|
|
34479
34547
|
items: { format: 'uuid', type: 'string' },
|
|
34480
34548
|
minItems: 1,
|
|
34481
34549
|
type: 'array',
|
|
34482
34550
|
},
|
|
34483
|
-
space_id: {
|
|
34551
|
+
space_id: {
|
|
34552
|
+
description:
|
|
34553
|
+
'ID of the space to which you want to add entrances.',
|
|
34554
|
+
format: 'uuid',
|
|
34555
|
+
type: 'string',
|
|
34556
|
+
},
|
|
34484
34557
|
},
|
|
34485
34558
|
required: ['space_id', 'acs_entrance_ids'],
|
|
34486
34559
|
type: 'object',
|
|
@@ -34514,12 +34587,12 @@ export default {
|
|
|
34514
34587
|
'x-draft': 'Early access.',
|
|
34515
34588
|
'x-fern-ignore': true,
|
|
34516
34589
|
'x-response-key': null,
|
|
34517
|
-
'x-title': 'Add
|
|
34590
|
+
'x-title': 'Add Entrances to a Space',
|
|
34518
34591
|
},
|
|
34519
34592
|
},
|
|
34520
34593
|
'/spaces/add_devices': {
|
|
34521
34594
|
post: {
|
|
34522
|
-
description: '
|
|
34595
|
+
description: 'Adds devices to a specific space.',
|
|
34523
34596
|
operationId: 'spacesAddDevicesPost',
|
|
34524
34597
|
requestBody: {
|
|
34525
34598
|
content: {
|
|
@@ -34527,11 +34600,18 @@ export default {
|
|
|
34527
34600
|
schema: {
|
|
34528
34601
|
properties: {
|
|
34529
34602
|
device_ids: {
|
|
34603
|
+
description:
|
|
34604
|
+
'IDs of the devices that you want to add to the space.',
|
|
34530
34605
|
items: { format: 'uuid', type: 'string' },
|
|
34531
34606
|
minItems: 1,
|
|
34532
34607
|
type: 'array',
|
|
34533
34608
|
},
|
|
34534
|
-
space_id: {
|
|
34609
|
+
space_id: {
|
|
34610
|
+
description:
|
|
34611
|
+
'ID of the space to which you want to add devices.',
|
|
34612
|
+
format: 'uuid',
|
|
34613
|
+
type: 'string',
|
|
34614
|
+
},
|
|
34535
34615
|
},
|
|
34536
34616
|
required: ['space_id', 'device_ids'],
|
|
34537
34617
|
type: 'object',
|
|
@@ -34566,10 +34646,10 @@ export default {
|
|
|
34566
34646
|
'x-fern-sdk-group-name': ['spaces'],
|
|
34567
34647
|
'x-fern-sdk-method-name': 'add_devices',
|
|
34568
34648
|
'x-response-key': null,
|
|
34569
|
-
'x-title': 'Add Space
|
|
34649
|
+
'x-title': 'Add Devices to a Space',
|
|
34570
34650
|
},
|
|
34571
34651
|
put: {
|
|
34572
|
-
description: '
|
|
34652
|
+
description: 'Adds devices to a specific space.',
|
|
34573
34653
|
operationId: 'spacesAddDevicesPut',
|
|
34574
34654
|
requestBody: {
|
|
34575
34655
|
content: {
|
|
@@ -34577,11 +34657,18 @@ export default {
|
|
|
34577
34657
|
schema: {
|
|
34578
34658
|
properties: {
|
|
34579
34659
|
device_ids: {
|
|
34660
|
+
description:
|
|
34661
|
+
'IDs of the devices that you want to add to the space.',
|
|
34580
34662
|
items: { format: 'uuid', type: 'string' },
|
|
34581
34663
|
minItems: 1,
|
|
34582
34664
|
type: 'array',
|
|
34583
34665
|
},
|
|
34584
|
-
space_id: {
|
|
34666
|
+
space_id: {
|
|
34667
|
+
description:
|
|
34668
|
+
'ID of the space to which you want to add devices.',
|
|
34669
|
+
format: 'uuid',
|
|
34670
|
+
type: 'string',
|
|
34671
|
+
},
|
|
34585
34672
|
},
|
|
34586
34673
|
required: ['space_id', 'device_ids'],
|
|
34587
34674
|
type: 'object',
|
|
@@ -34615,12 +34702,12 @@ export default {
|
|
|
34615
34702
|
'x-draft': 'Early access.',
|
|
34616
34703
|
'x-fern-ignore': true,
|
|
34617
34704
|
'x-response-key': null,
|
|
34618
|
-
'x-title': 'Add Space
|
|
34705
|
+
'x-title': 'Add Devices to a Space',
|
|
34619
34706
|
},
|
|
34620
34707
|
},
|
|
34621
34708
|
'/spaces/create': {
|
|
34622
34709
|
post: {
|
|
34623
|
-
description: '
|
|
34710
|
+
description: 'Creates a new space.',
|
|
34624
34711
|
operationId: 'spacesCreatePost',
|
|
34625
34712
|
requestBody: {
|
|
34626
34713
|
content: {
|
|
@@ -34628,14 +34715,21 @@ export default {
|
|
|
34628
34715
|
schema: {
|
|
34629
34716
|
properties: {
|
|
34630
34717
|
acs_entrance_ids: {
|
|
34718
|
+
description:
|
|
34719
|
+
'IDs of the entrances that you want to add to the new space.',
|
|
34631
34720
|
items: { format: 'uuid', type: 'string' },
|
|
34632
34721
|
type: 'array',
|
|
34633
34722
|
},
|
|
34634
34723
|
device_ids: {
|
|
34724
|
+
description:
|
|
34725
|
+
'IDs of the devices that you want to add to the new space.',
|
|
34635
34726
|
items: { format: 'uuid', type: 'string' },
|
|
34636
34727
|
type: 'array',
|
|
34637
34728
|
},
|
|
34638
|
-
name: {
|
|
34729
|
+
name: {
|
|
34730
|
+
description: 'Name of the space that you want to create.',
|
|
34731
|
+
type: 'string',
|
|
34732
|
+
},
|
|
34639
34733
|
},
|
|
34640
34734
|
required: ['name'],
|
|
34641
34735
|
type: 'object',
|
|
@@ -34674,18 +34768,24 @@ export default {
|
|
|
34674
34768
|
'x-fern-sdk-method-name': 'create',
|
|
34675
34769
|
'x-fern-sdk-return-value': 'space',
|
|
34676
34770
|
'x-response-key': 'space',
|
|
34677
|
-
'x-title': 'Create Space',
|
|
34771
|
+
'x-title': 'Create a Space',
|
|
34678
34772
|
},
|
|
34679
34773
|
},
|
|
34680
34774
|
'/spaces/delete': {
|
|
34681
34775
|
post: {
|
|
34682
|
-
description: '
|
|
34776
|
+
description: 'Deletes a space.',
|
|
34683
34777
|
operationId: 'spacesDeletePost',
|
|
34684
34778
|
requestBody: {
|
|
34685
34779
|
content: {
|
|
34686
34780
|
'application/json': {
|
|
34687
34781
|
schema: {
|
|
34688
|
-
properties: {
|
|
34782
|
+
properties: {
|
|
34783
|
+
space_id: {
|
|
34784
|
+
description: 'ID of the space that you want to delete.',
|
|
34785
|
+
format: 'uuid',
|
|
34786
|
+
type: 'string',
|
|
34787
|
+
},
|
|
34788
|
+
},
|
|
34689
34789
|
required: ['space_id'],
|
|
34690
34790
|
type: 'object',
|
|
34691
34791
|
},
|
|
@@ -34715,21 +34815,28 @@ export default {
|
|
|
34715
34815
|
],
|
|
34716
34816
|
summary: '/spaces/delete',
|
|
34717
34817
|
tags: [],
|
|
34818
|
+
'x-draft': 'Early access.',
|
|
34718
34819
|
'x-fern-sdk-group-name': ['spaces'],
|
|
34719
34820
|
'x-fern-sdk-method-name': 'delete',
|
|
34720
34821
|
'x-response-key': null,
|
|
34721
|
-
'x-title': 'Delete Space',
|
|
34822
|
+
'x-title': 'Delete a Space',
|
|
34722
34823
|
},
|
|
34723
34824
|
},
|
|
34724
34825
|
'/spaces/get': {
|
|
34725
34826
|
post: {
|
|
34726
|
-
description: '
|
|
34827
|
+
description: 'Gets a space.',
|
|
34727
34828
|
operationId: 'spacesGetPost',
|
|
34728
34829
|
requestBody: {
|
|
34729
34830
|
content: {
|
|
34730
34831
|
'application/json': {
|
|
34731
34832
|
schema: {
|
|
34732
|
-
properties: {
|
|
34833
|
+
properties: {
|
|
34834
|
+
space_id: {
|
|
34835
|
+
description: 'ID of the space that you want to get.',
|
|
34836
|
+
format: 'uuid',
|
|
34837
|
+
type: 'string',
|
|
34838
|
+
},
|
|
34839
|
+
},
|
|
34733
34840
|
required: ['space_id'],
|
|
34734
34841
|
type: 'object',
|
|
34735
34842
|
},
|
|
@@ -34762,11 +34869,12 @@ export default {
|
|
|
34762
34869
|
],
|
|
34763
34870
|
summary: '/spaces/get',
|
|
34764
34871
|
tags: [],
|
|
34872
|
+
'x-draft': 'Early access.',
|
|
34765
34873
|
'x-fern-sdk-group-name': ['spaces'],
|
|
34766
34874
|
'x-fern-sdk-method-name': 'get',
|
|
34767
34875
|
'x-fern-sdk-return-value': 'space',
|
|
34768
34876
|
'x-response-key': 'space',
|
|
34769
|
-
'x-title': 'Get Space',
|
|
34877
|
+
'x-title': 'Get a Space',
|
|
34770
34878
|
},
|
|
34771
34879
|
},
|
|
34772
34880
|
'/spaces/list': {
|
|
@@ -34849,7 +34957,8 @@ export default {
|
|
|
34849
34957
|
},
|
|
34850
34958
|
'/spaces/remove_acs_entrances': {
|
|
34851
34959
|
post: {
|
|
34852
|
-
description:
|
|
34960
|
+
description:
|
|
34961
|
+
'Removes [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) from a specific space.',
|
|
34853
34962
|
operationId: 'spacesRemoveAcsEntrancesPost',
|
|
34854
34963
|
requestBody: {
|
|
34855
34964
|
content: {
|
|
@@ -34857,10 +34966,17 @@ export default {
|
|
|
34857
34966
|
schema: {
|
|
34858
34967
|
properties: {
|
|
34859
34968
|
acs_entrance_ids: {
|
|
34969
|
+
description:
|
|
34970
|
+
'IDs of the entrances that you want to remove from the space.',
|
|
34860
34971
|
items: { format: 'uuid', type: 'string' },
|
|
34861
34972
|
type: 'array',
|
|
34862
34973
|
},
|
|
34863
|
-
space_id: {
|
|
34974
|
+
space_id: {
|
|
34975
|
+
description:
|
|
34976
|
+
'ID of the space from which you want to remove entrances.',
|
|
34977
|
+
format: 'uuid',
|
|
34978
|
+
type: 'string',
|
|
34979
|
+
},
|
|
34864
34980
|
},
|
|
34865
34981
|
required: ['space_id', 'acs_entrance_ids'],
|
|
34866
34982
|
type: 'object',
|
|
@@ -34895,12 +35011,12 @@ export default {
|
|
|
34895
35011
|
'x-fern-sdk-group-name': ['spaces'],
|
|
34896
35012
|
'x-fern-sdk-method-name': 'remove_acs_entrances',
|
|
34897
35013
|
'x-response-key': null,
|
|
34898
|
-
'x-title': 'Remove
|
|
35014
|
+
'x-title': 'Remove Entrances from a Space',
|
|
34899
35015
|
},
|
|
34900
35016
|
},
|
|
34901
35017
|
'/spaces/remove_devices': {
|
|
34902
35018
|
post: {
|
|
34903
|
-
description: '
|
|
35019
|
+
description: 'Removes devices from a specific space.',
|
|
34904
35020
|
operationId: 'spacesRemoveDevicesPost',
|
|
34905
35021
|
requestBody: {
|
|
34906
35022
|
content: {
|
|
@@ -34908,10 +35024,17 @@ export default {
|
|
|
34908
35024
|
schema: {
|
|
34909
35025
|
properties: {
|
|
34910
35026
|
device_ids: {
|
|
35027
|
+
description:
|
|
35028
|
+
'IDs of the devices that you want to remove from the space.',
|
|
34911
35029
|
items: { format: 'uuid', type: 'string' },
|
|
34912
35030
|
type: 'array',
|
|
34913
35031
|
},
|
|
34914
|
-
space_id: {
|
|
35032
|
+
space_id: {
|
|
35033
|
+
description:
|
|
35034
|
+
'ID of the space from which you want to remove devices.',
|
|
35035
|
+
format: 'uuid',
|
|
35036
|
+
type: 'string',
|
|
35037
|
+
},
|
|
34915
35038
|
},
|
|
34916
35039
|
required: ['space_id', 'device_ids'],
|
|
34917
35040
|
type: 'object',
|
|
@@ -34946,20 +35069,24 @@ export default {
|
|
|
34946
35069
|
'x-fern-sdk-group-name': ['spaces'],
|
|
34947
35070
|
'x-fern-sdk-method-name': 'remove_devices',
|
|
34948
35071
|
'x-response-key': null,
|
|
34949
|
-
'x-title': 'Remove Space
|
|
35072
|
+
'x-title': 'Remove Devices from a Space',
|
|
34950
35073
|
},
|
|
34951
35074
|
},
|
|
34952
35075
|
'/spaces/update': {
|
|
34953
35076
|
patch: {
|
|
34954
|
-
description: '
|
|
35077
|
+
description: 'Updates an existing space.',
|
|
34955
35078
|
operationId: 'spacesUpdatePatch',
|
|
34956
35079
|
requestBody: {
|
|
34957
35080
|
content: {
|
|
34958
35081
|
'application/json': {
|
|
34959
35082
|
schema: {
|
|
34960
35083
|
properties: {
|
|
34961
|
-
name: { type: 'string' },
|
|
34962
|
-
space_id: {
|
|
35084
|
+
name: { description: 'Name of the space.', type: 'string' },
|
|
35085
|
+
space_id: {
|
|
35086
|
+
description: 'ID of the space that you want to update.',
|
|
35087
|
+
format: 'uuid',
|
|
35088
|
+
type: 'string',
|
|
35089
|
+
},
|
|
34963
35090
|
},
|
|
34964
35091
|
required: ['space_id'],
|
|
34965
35092
|
type: 'object',
|
|
@@ -34996,18 +35123,22 @@ export default {
|
|
|
34996
35123
|
'x-draft': 'Early access.',
|
|
34997
35124
|
'x-fern-ignore': true,
|
|
34998
35125
|
'x-response-key': 'space',
|
|
34999
|
-
'x-title': 'Update Space',
|
|
35126
|
+
'x-title': 'Update a Space',
|
|
35000
35127
|
},
|
|
35001
35128
|
post: {
|
|
35002
|
-
description: '
|
|
35129
|
+
description: 'Updates an existing space.',
|
|
35003
35130
|
operationId: 'spacesUpdatePost',
|
|
35004
35131
|
requestBody: {
|
|
35005
35132
|
content: {
|
|
35006
35133
|
'application/json': {
|
|
35007
35134
|
schema: {
|
|
35008
35135
|
properties: {
|
|
35009
|
-
name: { type: 'string' },
|
|
35010
|
-
space_id: {
|
|
35136
|
+
name: { description: 'Name of the space.', type: 'string' },
|
|
35137
|
+
space_id: {
|
|
35138
|
+
description: 'ID of the space that you want to update.',
|
|
35139
|
+
format: 'uuid',
|
|
35140
|
+
type: 'string',
|
|
35141
|
+
},
|
|
35011
35142
|
},
|
|
35012
35143
|
required: ['space_id'],
|
|
35013
35144
|
type: 'object',
|
|
@@ -35046,7 +35177,7 @@ export default {
|
|
|
35046
35177
|
'x-fern-sdk-method-name': 'update',
|
|
35047
35178
|
'x-fern-sdk-return-value': 'space',
|
|
35048
35179
|
'x-response-key': 'space',
|
|
35049
|
-
'x-title': 'Update Space',
|
|
35180
|
+
'x-title': 'Update a Space',
|
|
35050
35181
|
},
|
|
35051
35182
|
},
|
|
35052
35183
|
'/thermostats/activate_climate_preset': {
|
|
@@ -35125,13 +35256,13 @@ export default {
|
|
|
35125
35256
|
properties: {
|
|
35126
35257
|
cooling_set_point_celsius: {
|
|
35127
35258
|
description:
|
|
35128
|
-
'
|
|
35259
|
+
'[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
35260
|
format: 'float',
|
|
35130
35261
|
type: 'number',
|
|
35131
35262
|
},
|
|
35132
35263
|
cooling_set_point_fahrenheit: {
|
|
35133
35264
|
description:
|
|
35134
|
-
'
|
|
35265
|
+
'[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
35266
|
format: 'float',
|
|
35136
35267
|
type: 'number',
|
|
35137
35268
|
},
|
|
@@ -35303,7 +35434,7 @@ export default {
|
|
|
35303
35434
|
'/thermostats/daily_programs/create': {
|
|
35304
35435
|
post: {
|
|
35305
35436
|
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.',
|
|
35437
|
+
'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
35438
|
operationId: 'thermostatsDailyProgramsCreatePost',
|
|
35308
35439
|
requestBody: {
|
|
35309
35440
|
content: {
|
|
@@ -35317,8 +35448,7 @@ export default {
|
|
|
35317
35448
|
type: 'string',
|
|
35318
35449
|
},
|
|
35319
35450
|
name: {
|
|
35320
|
-
description:
|
|
35321
|
-
'User-friendly name to identify the thermostat daily program.',
|
|
35451
|
+
description: 'Name of the thermostat daily program.',
|
|
35322
35452
|
type: 'string',
|
|
35323
35453
|
},
|
|
35324
35454
|
periods: {
|
|
@@ -35518,7 +35648,7 @@ export default {
|
|
|
35518
35648
|
properties: {
|
|
35519
35649
|
name: {
|
|
35520
35650
|
description:
|
|
35521
|
-
'
|
|
35651
|
+
'Name of the thermostat daily program that you want to update.',
|
|
35522
35652
|
type: 'string',
|
|
35523
35653
|
},
|
|
35524
35654
|
periods: {
|
|
@@ -35603,7 +35733,7 @@ export default {
|
|
|
35603
35733
|
properties: {
|
|
35604
35734
|
name: {
|
|
35605
35735
|
description:
|
|
35606
|
-
'
|
|
35736
|
+
'Name of the thermostat daily program that you want to update.',
|
|
35607
35737
|
type: 'string',
|
|
35608
35738
|
},
|
|
35609
35739
|
periods: {
|
|
@@ -35741,7 +35871,7 @@ export default {
|
|
|
35741
35871
|
'/thermostats/get': {
|
|
35742
35872
|
post: {
|
|
35743
35873
|
description:
|
|
35744
|
-
'Returns a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
|
|
35874
|
+
'Returns a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). **Deprecated:** Will be removed. Use `/devices/get` instead.',
|
|
35745
35875
|
operationId: 'thermostatsGetPost',
|
|
35746
35876
|
requestBody: {
|
|
35747
35877
|
content: {
|
|
@@ -35750,13 +35880,13 @@ export default {
|
|
|
35750
35880
|
properties: {
|
|
35751
35881
|
device_id: {
|
|
35752
35882
|
description:
|
|
35753
|
-
'ID of the thermostat device that you want to
|
|
35883
|
+
'ID of the thermostat device that you want to get.',
|
|
35754
35884
|
format: 'uuid',
|
|
35755
35885
|
type: 'string',
|
|
35756
35886
|
},
|
|
35757
35887
|
name: {
|
|
35758
35888
|
description:
|
|
35759
|
-
'
|
|
35889
|
+
'Name of the thermostat device that you want to retrieve.',
|
|
35760
35890
|
type: 'string',
|
|
35761
35891
|
},
|
|
35762
35892
|
},
|
|
@@ -35819,13 +35949,13 @@ export default {
|
|
|
35819
35949
|
},
|
|
35820
35950
|
heating_set_point_celsius: {
|
|
35821
35951
|
description:
|
|
35822
|
-
'
|
|
35952
|
+
'[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
35953
|
format: 'float',
|
|
35824
35954
|
type: 'number',
|
|
35825
35955
|
},
|
|
35826
35956
|
heating_set_point_fahrenheit: {
|
|
35827
35957
|
description:
|
|
35828
|
-
'
|
|
35958
|
+
'[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
35959
|
format: 'float',
|
|
35830
35960
|
type: 'number',
|
|
35831
35961
|
},
|
|
@@ -35890,13 +36020,13 @@ export default {
|
|
|
35890
36020
|
properties: {
|
|
35891
36021
|
cooling_set_point_celsius: {
|
|
35892
36022
|
description:
|
|
35893
|
-
'
|
|
36023
|
+
'[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
36024
|
format: 'float',
|
|
35895
36025
|
type: 'number',
|
|
35896
36026
|
},
|
|
35897
36027
|
cooling_set_point_fahrenheit: {
|
|
35898
36028
|
description:
|
|
35899
|
-
'
|
|
36029
|
+
'[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
36030
|
format: 'float',
|
|
35901
36031
|
type: 'number',
|
|
35902
36032
|
},
|
|
@@ -35908,13 +36038,13 @@ export default {
|
|
|
35908
36038
|
},
|
|
35909
36039
|
heating_set_point_celsius: {
|
|
35910
36040
|
description:
|
|
35911
|
-
'
|
|
36041
|
+
'[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
36042
|
format: 'float',
|
|
35913
36043
|
type: 'number',
|
|
35914
36044
|
},
|
|
35915
36045
|
heating_set_point_fahrenheit: {
|
|
35916
36046
|
description:
|
|
35917
|
-
'
|
|
36047
|
+
'[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
36048
|
format: 'float',
|
|
35919
36049
|
type: 'number',
|
|
35920
36050
|
},
|
|
@@ -36021,7 +36151,7 @@ export default {
|
|
|
36021
36151
|
},
|
|
36022
36152
|
device_type: {
|
|
36023
36153
|
description:
|
|
36024
|
-
'Device type by which to filter thermostat devices.',
|
|
36154
|
+
'Device type by which you want to filter thermostat devices.',
|
|
36025
36155
|
enum: [
|
|
36026
36156
|
'ecobee_thermostat',
|
|
36027
36157
|
'nest_thermostat',
|
|
@@ -36034,7 +36164,7 @@ export default {
|
|
|
36034
36164
|
},
|
|
36035
36165
|
device_types: {
|
|
36036
36166
|
description:
|
|
36037
|
-
'Array of device types by which to filter thermostat devices.',
|
|
36167
|
+
'Array of device types by which you want to filter thermostat devices.',
|
|
36038
36168
|
items: {
|
|
36039
36169
|
description: 'Device type for thermostats.\n ',
|
|
36040
36170
|
enum: [
|
|
@@ -36098,7 +36228,7 @@ export default {
|
|
|
36098
36228
|
},
|
|
36099
36229
|
manufacturer: {
|
|
36100
36230
|
description:
|
|
36101
|
-
'Manufacturer by which to filter thermostat devices.',
|
|
36231
|
+
'Manufacturer by which you want to filter thermostat devices.',
|
|
36102
36232
|
enum: [
|
|
36103
36233
|
'ecobee',
|
|
36104
36234
|
'honeywell_resideo',
|
|
@@ -36248,7 +36378,7 @@ export default {
|
|
|
36248
36378
|
'/thermostats/schedules/create': {
|
|
36249
36379
|
post: {
|
|
36250
36380
|
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).',
|
|
36381
|
+
'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
36382
|
operationId: 'thermostatsSchedulesCreatePost',
|
|
36253
36383
|
requestBody: {
|
|
36254
36384
|
content: {
|
|
@@ -36257,21 +36387,22 @@ export default {
|
|
|
36257
36387
|
properties: {
|
|
36258
36388
|
climate_preset_key: {
|
|
36259
36389
|
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.',
|
|
36390
|
+
'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
36391
|
type: 'string',
|
|
36262
36392
|
},
|
|
36263
36393
|
device_id: {
|
|
36264
|
-
description:
|
|
36394
|
+
description:
|
|
36395
|
+
'ID of the thermostat device for which you want to create a schedule.',
|
|
36265
36396
|
type: 'string',
|
|
36266
36397
|
},
|
|
36267
36398
|
ends_at: {
|
|
36268
36399
|
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.',
|
|
36400
|
+
'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
36401
|
type: 'string',
|
|
36271
36402
|
},
|
|
36272
36403
|
is_override_allowed: {
|
|
36273
36404
|
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).",
|
|
36405
|
+
"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
36406
|
type: 'boolean',
|
|
36276
36407
|
},
|
|
36277
36408
|
max_override_period_minutes: {
|
|
@@ -36283,13 +36414,12 @@ export default {
|
|
|
36283
36414
|
type: 'integer',
|
|
36284
36415
|
},
|
|
36285
36416
|
name: {
|
|
36286
|
-
description:
|
|
36287
|
-
'User-friendly name to identify the thermostat schedule.',
|
|
36417
|
+
description: 'Name of the thermostat schedule.',
|
|
36288
36418
|
type: 'string',
|
|
36289
36419
|
},
|
|
36290
36420
|
starts_at: {
|
|
36291
36421
|
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.',
|
|
36422
|
+
'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
36423
|
type: 'string',
|
|
36294
36424
|
},
|
|
36295
36425
|
},
|
|
@@ -36351,7 +36481,8 @@ export default {
|
|
|
36351
36481
|
schema: {
|
|
36352
36482
|
properties: {
|
|
36353
36483
|
thermostat_schedule_id: {
|
|
36354
|
-
description:
|
|
36484
|
+
description:
|
|
36485
|
+
'ID of the thermostat schedule that you want to delete.',
|
|
36355
36486
|
format: 'uuid',
|
|
36356
36487
|
type: 'string',
|
|
36357
36488
|
},
|
|
@@ -36403,7 +36534,8 @@ export default {
|
|
|
36403
36534
|
schema: {
|
|
36404
36535
|
properties: {
|
|
36405
36536
|
thermostat_schedule_id: {
|
|
36406
|
-
description:
|
|
36537
|
+
description:
|
|
36538
|
+
'ID of the thermostat schedule that you want to get.',
|
|
36407
36539
|
format: 'uuid',
|
|
36408
36540
|
type: 'string',
|
|
36409
36541
|
},
|
|
@@ -36461,7 +36593,8 @@ export default {
|
|
|
36461
36593
|
schema: {
|
|
36462
36594
|
properties: {
|
|
36463
36595
|
device_id: {
|
|
36464
|
-
description:
|
|
36596
|
+
description:
|
|
36597
|
+
'ID of the thermostat device for which you want to list schedules.',
|
|
36465
36598
|
format: 'uuid',
|
|
36466
36599
|
type: 'string',
|
|
36467
36600
|
},
|
|
@@ -36550,8 +36683,7 @@ export default {
|
|
|
36550
36683
|
type: 'integer',
|
|
36551
36684
|
},
|
|
36552
36685
|
name: {
|
|
36553
|
-
description:
|
|
36554
|
-
'User-friendly name to identify the thermostat schedule.',
|
|
36686
|
+
description: 'Name of the thermostat schedule.',
|
|
36555
36687
|
type: 'string',
|
|
36556
36688
|
},
|
|
36557
36689
|
starts_at: {
|
|
@@ -36560,7 +36692,8 @@ export default {
|
|
|
36560
36692
|
type: 'string',
|
|
36561
36693
|
},
|
|
36562
36694
|
thermostat_schedule_id: {
|
|
36563
|
-
description:
|
|
36695
|
+
description:
|
|
36696
|
+
'ID of the thermostat schedule that you want to update.',
|
|
36564
36697
|
format: 'uuid',
|
|
36565
36698
|
type: 'string',
|
|
36566
36699
|
},
|
|
@@ -36632,8 +36765,7 @@ export default {
|
|
|
36632
36765
|
type: 'integer',
|
|
36633
36766
|
},
|
|
36634
36767
|
name: {
|
|
36635
|
-
description:
|
|
36636
|
-
'User-friendly name to identify the thermostat schedule.',
|
|
36768
|
+
description: 'Name of the thermostat schedule.',
|
|
36637
36769
|
type: 'string',
|
|
36638
36770
|
},
|
|
36639
36771
|
starts_at: {
|
|
@@ -36642,7 +36774,8 @@ export default {
|
|
|
36642
36774
|
type: 'string',
|
|
36643
36775
|
},
|
|
36644
36776
|
thermostat_schedule_id: {
|
|
36645
|
-
description:
|
|
36777
|
+
description:
|
|
36778
|
+
'ID of the thermostat schedule that you want to update.',
|
|
36646
36779
|
format: 'uuid',
|
|
36647
36780
|
type: 'string',
|
|
36648
36781
|
},
|
|
@@ -36764,7 +36897,7 @@ export default {
|
|
|
36764
36897
|
},
|
|
36765
36898
|
fan_mode_setting: {
|
|
36766
36899
|
description:
|
|
36767
|
-
'
|
|
36900
|
+
'[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
36901
|
enum: ['auto', 'on', 'circulate'],
|
|
36769
36902
|
type: 'string',
|
|
36770
36903
|
},
|
|
@@ -36845,13 +36978,13 @@ export default {
|
|
|
36845
36978
|
properties: {
|
|
36846
36979
|
cooling_set_point_celsius: {
|
|
36847
36980
|
description:
|
|
36848
|
-
'
|
|
36981
|
+
'[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
36982
|
format: 'float',
|
|
36850
36983
|
type: 'number',
|
|
36851
36984
|
},
|
|
36852
36985
|
cooling_set_point_fahrenheit: {
|
|
36853
36986
|
description:
|
|
36854
|
-
'
|
|
36987
|
+
'[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
36988
|
format: 'float',
|
|
36856
36989
|
type: 'number',
|
|
36857
36990
|
},
|
|
@@ -36876,13 +37009,13 @@ export default {
|
|
|
36876
37009
|
},
|
|
36877
37010
|
heating_set_point_celsius: {
|
|
36878
37011
|
description:
|
|
36879
|
-
'
|
|
37012
|
+
'[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
37013
|
format: 'float',
|
|
36881
37014
|
type: 'number',
|
|
36882
37015
|
},
|
|
36883
37016
|
heating_set_point_fahrenheit: {
|
|
36884
37017
|
description:
|
|
36885
|
-
'
|
|
37018
|
+
'[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
37019
|
format: 'float',
|
|
36887
37020
|
type: 'number',
|
|
36888
37021
|
},
|
|
@@ -36895,13 +37028,13 @@ export default {
|
|
|
36895
37028
|
properties: {
|
|
36896
37029
|
cooling_set_point_celsius: {
|
|
36897
37030
|
description:
|
|
36898
|
-
'
|
|
37031
|
+
'[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
37032
|
format: 'float',
|
|
36900
37033
|
type: 'number',
|
|
36901
37034
|
},
|
|
36902
37035
|
cooling_set_point_fahrenheit: {
|
|
36903
37036
|
description:
|
|
36904
|
-
'
|
|
37037
|
+
'[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
37038
|
format: 'float',
|
|
36906
37039
|
type: 'number',
|
|
36907
37040
|
},
|
|
@@ -36913,13 +37046,13 @@ export default {
|
|
|
36913
37046
|
},
|
|
36914
37047
|
heating_set_point_celsius: {
|
|
36915
37048
|
description:
|
|
36916
|
-
'
|
|
37049
|
+
'[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
37050
|
format: 'float',
|
|
36918
37051
|
type: 'number',
|
|
36919
37052
|
},
|
|
36920
37053
|
heating_set_point_fahrenheit: {
|
|
36921
37054
|
description:
|
|
36922
|
-
'
|
|
37055
|
+
'[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
37056
|
format: 'float',
|
|
36924
37057
|
type: 'number',
|
|
36925
37058
|
},
|
|
@@ -37152,13 +37285,13 @@ export default {
|
|
|
37152
37285
|
{
|
|
37153
37286
|
properties: {
|
|
37154
37287
|
device_id: {
|
|
37155
|
-
description:
|
|
37288
|
+
description:
|
|
37289
|
+
'ID of the thermostat device for which you want to simulate having adjusted the HVAC mode.',
|
|
37156
37290
|
format: 'uuid',
|
|
37157
37291
|
type: 'string',
|
|
37158
37292
|
},
|
|
37159
37293
|
hvac_mode: {
|
|
37160
|
-
description:
|
|
37161
|
-
'Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate.',
|
|
37294
|
+
description: 'HVAC mode that you want to simulate.',
|
|
37162
37295
|
enum: ['off'],
|
|
37163
37296
|
type: 'string',
|
|
37164
37297
|
},
|
|
@@ -37170,24 +37303,24 @@ export default {
|
|
|
37170
37303
|
properties: {
|
|
37171
37304
|
cooling_set_point_celsius: {
|
|
37172
37305
|
description:
|
|
37173
|
-
'
|
|
37306
|
+
'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
37307
|
format: 'float',
|
|
37175
37308
|
type: 'number',
|
|
37176
37309
|
},
|
|
37177
37310
|
cooling_set_point_fahrenheit: {
|
|
37178
37311
|
description:
|
|
37179
|
-
'
|
|
37312
|
+
'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
37313
|
format: 'float',
|
|
37181
37314
|
type: 'number',
|
|
37182
37315
|
},
|
|
37183
37316
|
device_id: {
|
|
37184
|
-
description:
|
|
37317
|
+
description:
|
|
37318
|
+
'ID of the thermostat device for which you want to simulate having adjusted the HVAC mode.',
|
|
37185
37319
|
format: 'uuid',
|
|
37186
37320
|
type: 'string',
|
|
37187
37321
|
},
|
|
37188
37322
|
hvac_mode: {
|
|
37189
|
-
description:
|
|
37190
|
-
'Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate.',
|
|
37323
|
+
description: 'HVAC mode that you want to simulate.',
|
|
37191
37324
|
enum: ['cool'],
|
|
37192
37325
|
type: 'string',
|
|
37193
37326
|
},
|
|
@@ -37198,25 +37331,25 @@ export default {
|
|
|
37198
37331
|
{
|
|
37199
37332
|
properties: {
|
|
37200
37333
|
device_id: {
|
|
37201
|
-
description:
|
|
37334
|
+
description:
|
|
37335
|
+
'ID of the thermostat device for which you want to simulate having adjusted the HVAC mode.',
|
|
37202
37336
|
format: 'uuid',
|
|
37203
37337
|
type: 'string',
|
|
37204
37338
|
},
|
|
37205
37339
|
heating_set_point_celsius: {
|
|
37206
37340
|
description:
|
|
37207
|
-
'
|
|
37341
|
+
'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
37342
|
format: 'float',
|
|
37209
37343
|
type: 'number',
|
|
37210
37344
|
},
|
|
37211
37345
|
heating_set_point_fahrenheit: {
|
|
37212
37346
|
description:
|
|
37213
|
-
'
|
|
37347
|
+
'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
37348
|
format: 'float',
|
|
37215
37349
|
type: 'number',
|
|
37216
37350
|
},
|
|
37217
37351
|
hvac_mode: {
|
|
37218
|
-
description:
|
|
37219
|
-
'Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate.',
|
|
37352
|
+
description: 'HVAC mode that you want to simulate.',
|
|
37220
37353
|
enum: ['heat'],
|
|
37221
37354
|
type: 'string',
|
|
37222
37355
|
},
|
|
@@ -37228,36 +37361,36 @@ export default {
|
|
|
37228
37361
|
properties: {
|
|
37229
37362
|
cooling_set_point_celsius: {
|
|
37230
37363
|
description:
|
|
37231
|
-
'
|
|
37364
|
+
'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
37365
|
format: 'float',
|
|
37233
37366
|
type: 'number',
|
|
37234
37367
|
},
|
|
37235
37368
|
cooling_set_point_fahrenheit: {
|
|
37236
37369
|
description:
|
|
37237
|
-
'
|
|
37370
|
+
'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
37371
|
format: 'float',
|
|
37239
37372
|
type: 'number',
|
|
37240
37373
|
},
|
|
37241
37374
|
device_id: {
|
|
37242
|
-
description:
|
|
37375
|
+
description:
|
|
37376
|
+
'ID of the thermostat device for which you want to simulate having adjusted the HVAC mode.',
|
|
37243
37377
|
format: 'uuid',
|
|
37244
37378
|
type: 'string',
|
|
37245
37379
|
},
|
|
37246
37380
|
heating_set_point_celsius: {
|
|
37247
37381
|
description:
|
|
37248
|
-
'
|
|
37382
|
+
'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
37383
|
format: 'float',
|
|
37250
37384
|
type: 'number',
|
|
37251
37385
|
},
|
|
37252
37386
|
heating_set_point_fahrenheit: {
|
|
37253
37387
|
description:
|
|
37254
|
-
'
|
|
37388
|
+
'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
37389
|
format: 'float',
|
|
37256
37390
|
type: 'number',
|
|
37257
37391
|
},
|
|
37258
37392
|
hvac_mode: {
|
|
37259
|
-
description:
|
|
37260
|
-
'Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate.',
|
|
37393
|
+
description: 'HVAC mode that you want to simulate.',
|
|
37261
37394
|
enum: ['heat_cool'],
|
|
37262
37395
|
type: 'string',
|
|
37263
37396
|
},
|
|
@@ -37310,19 +37443,20 @@ export default {
|
|
|
37310
37443
|
schema: {
|
|
37311
37444
|
properties: {
|
|
37312
37445
|
device_id: {
|
|
37313
|
-
description:
|
|
37446
|
+
description:
|
|
37447
|
+
'ID of the thermostat device that you want to simulate reaching a specified temperature.',
|
|
37314
37448
|
format: 'uuid',
|
|
37315
37449
|
type: 'string',
|
|
37316
37450
|
},
|
|
37317
37451
|
temperature_celsius: {
|
|
37318
37452
|
description:
|
|
37319
|
-
'
|
|
37453
|
+
'Temperature in °C that you want simulate the thermostat reaching. You must set `temperature_celsius` or `temperature_fahrenheit`.',
|
|
37320
37454
|
format: 'float',
|
|
37321
37455
|
type: 'number',
|
|
37322
37456
|
},
|
|
37323
37457
|
temperature_fahrenheit: {
|
|
37324
37458
|
description:
|
|
37325
|
-
'
|
|
37459
|
+
'Temperature in °F that you want simulate the thermostat reaching. You must set `temperature_fahrenheit` or `temperature_celsius`.',
|
|
37326
37460
|
format: 'float',
|
|
37327
37461
|
type: 'number',
|
|
37328
37462
|
},
|
|
@@ -37701,7 +37835,7 @@ export default {
|
|
|
37701
37835
|
properties: {
|
|
37702
37836
|
user_identity_id: {
|
|
37703
37837
|
description:
|
|
37704
|
-
'ID of user identity for whom
|
|
37838
|
+
'ID of user identity for whom you want to grant access.',
|
|
37705
37839
|
format: 'uuid',
|
|
37706
37840
|
type: 'string',
|
|
37707
37841
|
},
|
|
@@ -37713,7 +37847,7 @@ export default {
|
|
|
37713
37847
|
properties: {
|
|
37714
37848
|
user_identity: {
|
|
37715
37849
|
description:
|
|
37716
|
-
'When used, creates a new user identity with the
|
|
37850
|
+
'User identity. When used, creates a new user identity with the specified details and grants them access.',
|
|
37717
37851
|
properties: {
|
|
37718
37852
|
email_address: {
|
|
37719
37853
|
description:
|
|
@@ -37747,14 +37881,14 @@ export default {
|
|
|
37747
37881
|
acs_entrance_ids: {
|
|
37748
37882
|
default: [],
|
|
37749
37883
|
description:
|
|
37750
|
-
'
|
|
37884
|
+
'IDs of the [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to which you want to grant access.',
|
|
37751
37885
|
items: { format: 'uuid', type: 'string' },
|
|
37752
37886
|
type: 'array',
|
|
37753
37887
|
},
|
|
37754
37888
|
device_ids: {
|
|
37755
37889
|
default: [],
|
|
37756
37890
|
description:
|
|
37757
|
-
'
|
|
37891
|
+
'IDs of the devices to which you want to grant access.',
|
|
37758
37892
|
items: { format: 'uuid', type: 'string' },
|
|
37759
37893
|
type: 'array',
|
|
37760
37894
|
},
|
|
@@ -37766,7 +37900,7 @@ export default {
|
|
|
37766
37900
|
},
|
|
37767
37901
|
location: {
|
|
37768
37902
|
description:
|
|
37769
|
-
'When used, creates a new location with the
|
|
37903
|
+
'Location. When used, creates a new location with the specified entrances and devices, and gives the user access to this location.',
|
|
37770
37904
|
properties: {
|
|
37771
37905
|
acs_entrance_ids: {
|
|
37772
37906
|
default: [],
|
|
@@ -37801,8 +37935,7 @@ export default {
|
|
|
37801
37935
|
items: {
|
|
37802
37936
|
properties: {
|
|
37803
37937
|
mode: {
|
|
37804
|
-
description:
|
|
37805
|
-
'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
37938
|
+
description: 'Access method mode.',
|
|
37806
37939
|
enum: ['code', 'card', 'mobile_key'],
|
|
37807
37940
|
type: 'string',
|
|
37808
37941
|
},
|
|
@@ -37814,7 +37947,7 @@ export default {
|
|
|
37814
37947
|
},
|
|
37815
37948
|
space_ids: {
|
|
37816
37949
|
description:
|
|
37817
|
-
'
|
|
37950
|
+
'IDs of the existing spaces to which you want to grant access.',
|
|
37818
37951
|
items: { format: 'uuid', type: 'string' },
|
|
37819
37952
|
type: 'array',
|
|
37820
37953
|
},
|
|
@@ -37971,7 +38104,7 @@ export default {
|
|
|
37971
38104
|
},
|
|
37972
38105
|
'/unstable_access_grants/delete': {
|
|
37973
38106
|
post: {
|
|
37974
|
-
description: '
|
|
38107
|
+
description: 'Deletes an access grant.',
|
|
37975
38108
|
operationId: 'unstableAccessGrantsDeletePost',
|
|
37976
38109
|
requestBody: {
|
|
37977
38110
|
content: {
|
|
@@ -37979,7 +38112,7 @@ export default {
|
|
|
37979
38112
|
schema: {
|
|
37980
38113
|
properties: {
|
|
37981
38114
|
access_grant_id: {
|
|
37982
|
-
description: 'ID of access grant to delete.',
|
|
38115
|
+
description: 'ID of access grant that you want to delete.',
|
|
37983
38116
|
format: 'uuid',
|
|
37984
38117
|
type: 'string',
|
|
37985
38118
|
},
|
|
@@ -38023,7 +38156,7 @@ export default {
|
|
|
38023
38156
|
},
|
|
38024
38157
|
'/unstable_access_grants/get': {
|
|
38025
38158
|
post: {
|
|
38026
|
-
description: '
|
|
38159
|
+
description: 'Gets an access grant.',
|
|
38027
38160
|
operationId: 'unstableAccessGrantsGetPost',
|
|
38028
38161
|
requestBody: {
|
|
38029
38162
|
content: {
|
|
@@ -38031,7 +38164,7 @@ export default {
|
|
|
38031
38164
|
schema: {
|
|
38032
38165
|
properties: {
|
|
38033
38166
|
access_grant_id: {
|
|
38034
|
-
description: 'ID of access grant to get.',
|
|
38167
|
+
description: 'ID of access grant that you want to get.',
|
|
38035
38168
|
format: 'uuid',
|
|
38036
38169
|
type: 'string',
|
|
38037
38170
|
},
|
|
@@ -38180,7 +38313,7 @@ export default {
|
|
|
38180
38313
|
},
|
|
38181
38314
|
'/unstable_access_grants/list': {
|
|
38182
38315
|
post: {
|
|
38183
|
-
description: '
|
|
38316
|
+
description: 'Returns a list of all access grants.',
|
|
38184
38317
|
operationId: 'unstableAccessGrantsListPost',
|
|
38185
38318
|
requestBody: {
|
|
38186
38319
|
content: {
|
|
@@ -38189,13 +38322,13 @@ export default {
|
|
|
38189
38322
|
properties: {
|
|
38190
38323
|
acs_entrance_id: {
|
|
38191
38324
|
description:
|
|
38192
|
-
'ID of entrance to filter list of access grants
|
|
38325
|
+
'ID of the entrance by which you want to filter the list of access grants.',
|
|
38193
38326
|
format: 'uuid',
|
|
38194
38327
|
type: 'string',
|
|
38195
38328
|
},
|
|
38196
38329
|
acs_system_id: {
|
|
38197
38330
|
description:
|
|
38198
|
-
'ID of system to filter list of access grants
|
|
38331
|
+
'ID of the access system by which you want to filter the list of access grants.',
|
|
38199
38332
|
format: 'uuid',
|
|
38200
38333
|
type: 'string',
|
|
38201
38334
|
},
|
|
@@ -38207,13 +38340,13 @@ export default {
|
|
|
38207
38340
|
},
|
|
38208
38341
|
space_id: {
|
|
38209
38342
|
description:
|
|
38210
|
-
'ID of space to filter list of access grants
|
|
38343
|
+
'ID of the space by which you want to filter the list of access grants.',
|
|
38211
38344
|
format: 'uuid',
|
|
38212
38345
|
type: 'string',
|
|
38213
38346
|
},
|
|
38214
38347
|
user_identity_id: {
|
|
38215
38348
|
description:
|
|
38216
|
-
'ID of user identity to filter list of access grants
|
|
38349
|
+
'ID of the user identity by which you want to filter the list of access grants.',
|
|
38217
38350
|
format: 'uuid',
|
|
38218
38351
|
type: 'string',
|
|
38219
38352
|
},
|
|
@@ -38364,7 +38497,7 @@ export default {
|
|
|
38364
38497
|
},
|
|
38365
38498
|
'/unstable_access_methods/delete': {
|
|
38366
38499
|
post: {
|
|
38367
|
-
description: '
|
|
38500
|
+
description: 'Deletes an access method.',
|
|
38368
38501
|
operationId: 'unstableAccessMethodsDeletePost',
|
|
38369
38502
|
requestBody: {
|
|
38370
38503
|
content: {
|
|
@@ -38372,7 +38505,8 @@ export default {
|
|
|
38372
38505
|
schema: {
|
|
38373
38506
|
properties: {
|
|
38374
38507
|
access_method_id: {
|
|
38375
|
-
description:
|
|
38508
|
+
description:
|
|
38509
|
+
'ID of the access method that you want to delete.',
|
|
38376
38510
|
format: 'uuid',
|
|
38377
38511
|
type: 'string',
|
|
38378
38512
|
},
|
|
@@ -38415,7 +38549,7 @@ export default {
|
|
|
38415
38549
|
},
|
|
38416
38550
|
'/unstable_access_methods/get': {
|
|
38417
38551
|
post: {
|
|
38418
|
-
description: '
|
|
38552
|
+
description: 'Gets an access method.',
|
|
38419
38553
|
operationId: 'unstableAccessMethodsGetPost',
|
|
38420
38554
|
requestBody: {
|
|
38421
38555
|
content: {
|
|
@@ -38423,7 +38557,8 @@ export default {
|
|
|
38423
38557
|
schema: {
|
|
38424
38558
|
properties: {
|
|
38425
38559
|
access_method_id: {
|
|
38426
|
-
description:
|
|
38560
|
+
description:
|
|
38561
|
+
'ID of the access method that you want to get.',
|
|
38427
38562
|
format: 'uuid',
|
|
38428
38563
|
type: 'string',
|
|
38429
38564
|
},
|
|
@@ -38527,7 +38662,7 @@ export default {
|
|
|
38527
38662
|
'/unstable_access_methods/list': {
|
|
38528
38663
|
post: {
|
|
38529
38664
|
description:
|
|
38530
|
-
'
|
|
38665
|
+
'Lists all access methods, usually filtered by access grant.',
|
|
38531
38666
|
operationId: 'unstableAccessMethodsListPost',
|
|
38532
38667
|
requestBody: {
|
|
38533
38668
|
content: {
|
|
@@ -38536,7 +38671,7 @@ export default {
|
|
|
38536
38671
|
properties: {
|
|
38537
38672
|
access_grant_id: {
|
|
38538
38673
|
description:
|
|
38539
|
-
'ID of access grant to list access methods
|
|
38674
|
+
'ID of the access grant by which to filter the list of access methods.',
|
|
38540
38675
|
format: 'uuid',
|
|
38541
38676
|
type: 'string',
|
|
38542
38677
|
},
|
|
@@ -38642,7 +38777,8 @@ export default {
|
|
|
38642
38777
|
},
|
|
38643
38778
|
'/unstable_locations/add_acs_entrances': {
|
|
38644
38779
|
post: {
|
|
38645
|
-
description:
|
|
38780
|
+
description:
|
|
38781
|
+
'Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific location.',
|
|
38646
38782
|
operationId: 'unstableLocationsAddAcsEntrancesPost',
|
|
38647
38783
|
requestBody: {
|
|
38648
38784
|
content: {
|
|
@@ -38650,11 +38786,18 @@ export default {
|
|
|
38650
38786
|
schema: {
|
|
38651
38787
|
properties: {
|
|
38652
38788
|
acs_entrance_ids: {
|
|
38789
|
+
description:
|
|
38790
|
+
'IDs of the entrances that you want to add to the location.',
|
|
38653
38791
|
items: { format: 'uuid', type: 'string' },
|
|
38654
38792
|
minItems: 1,
|
|
38655
38793
|
type: 'array',
|
|
38656
38794
|
},
|
|
38657
|
-
location_id: {
|
|
38795
|
+
location_id: {
|
|
38796
|
+
description:
|
|
38797
|
+
'ID of the location to which you want to add entrances.',
|
|
38798
|
+
format: 'uuid',
|
|
38799
|
+
type: 'string',
|
|
38800
|
+
},
|
|
38658
38801
|
},
|
|
38659
38802
|
required: ['location_id', 'acs_entrance_ids'],
|
|
38660
38803
|
type: 'object',
|
|
@@ -38688,11 +38831,12 @@ export default {
|
|
|
38688
38831
|
'x-fern-sdk-group-name': ['unstable_locations'],
|
|
38689
38832
|
'x-fern-sdk-method-name': 'add_acs_entrances',
|
|
38690
38833
|
'x-response-key': null,
|
|
38691
|
-
'x-title': 'Add
|
|
38834
|
+
'x-title': 'Add Entrances to a Location',
|
|
38692
38835
|
'x-undocumented': 'Experimental locations.',
|
|
38693
38836
|
},
|
|
38694
38837
|
put: {
|
|
38695
|
-
description:
|
|
38838
|
+
description:
|
|
38839
|
+
'Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific location.',
|
|
38696
38840
|
operationId: 'unstableLocationsAddAcsEntrancesPut',
|
|
38697
38841
|
requestBody: {
|
|
38698
38842
|
content: {
|
|
@@ -38700,11 +38844,18 @@ export default {
|
|
|
38700
38844
|
schema: {
|
|
38701
38845
|
properties: {
|
|
38702
38846
|
acs_entrance_ids: {
|
|
38847
|
+
description:
|
|
38848
|
+
'IDs of the entrances that you want to add to the location.',
|
|
38703
38849
|
items: { format: 'uuid', type: 'string' },
|
|
38704
38850
|
minItems: 1,
|
|
38705
38851
|
type: 'array',
|
|
38706
38852
|
},
|
|
38707
|
-
location_id: {
|
|
38853
|
+
location_id: {
|
|
38854
|
+
description:
|
|
38855
|
+
'ID of the location to which you want to add entrances.',
|
|
38856
|
+
format: 'uuid',
|
|
38857
|
+
type: 'string',
|
|
38858
|
+
},
|
|
38708
38859
|
},
|
|
38709
38860
|
required: ['location_id', 'acs_entrance_ids'],
|
|
38710
38861
|
type: 'object',
|
|
@@ -38737,13 +38888,13 @@ export default {
|
|
|
38737
38888
|
tags: [],
|
|
38738
38889
|
'x-fern-ignore': true,
|
|
38739
38890
|
'x-response-key': null,
|
|
38740
|
-
'x-title': 'Add
|
|
38891
|
+
'x-title': 'Add Entrances to a Location',
|
|
38741
38892
|
'x-undocumented': 'Experimental locations.',
|
|
38742
38893
|
},
|
|
38743
38894
|
},
|
|
38744
38895
|
'/unstable_locations/add_devices': {
|
|
38745
38896
|
post: {
|
|
38746
|
-
description: '
|
|
38897
|
+
description: 'Adds devices to a specific location.',
|
|
38747
38898
|
operationId: 'unstableLocationsAddDevicesPost',
|
|
38748
38899
|
requestBody: {
|
|
38749
38900
|
content: {
|
|
@@ -38751,11 +38902,18 @@ export default {
|
|
|
38751
38902
|
schema: {
|
|
38752
38903
|
properties: {
|
|
38753
38904
|
device_ids: {
|
|
38905
|
+
description:
|
|
38906
|
+
'IDs of the devices that you want to add to the location.',
|
|
38754
38907
|
items: { format: 'uuid', type: 'string' },
|
|
38755
38908
|
minItems: 1,
|
|
38756
38909
|
type: 'array',
|
|
38757
38910
|
},
|
|
38758
|
-
location_id: {
|
|
38911
|
+
location_id: {
|
|
38912
|
+
description:
|
|
38913
|
+
'ID of the location to which you want to add devices.',
|
|
38914
|
+
format: 'uuid',
|
|
38915
|
+
type: 'string',
|
|
38916
|
+
},
|
|
38759
38917
|
},
|
|
38760
38918
|
required: ['location_id', 'device_ids'],
|
|
38761
38919
|
type: 'object',
|
|
@@ -38789,11 +38947,11 @@ export default {
|
|
|
38789
38947
|
'x-fern-sdk-group-name': ['unstable_locations'],
|
|
38790
38948
|
'x-fern-sdk-method-name': 'add_devices',
|
|
38791
38949
|
'x-response-key': null,
|
|
38792
|
-
'x-title': 'Add Location
|
|
38950
|
+
'x-title': 'Add Devices to a Location',
|
|
38793
38951
|
'x-undocumented': 'Experimental locations.',
|
|
38794
38952
|
},
|
|
38795
38953
|
put: {
|
|
38796
|
-
description: '
|
|
38954
|
+
description: 'Adds devices to a specific location.',
|
|
38797
38955
|
operationId: 'unstableLocationsAddDevicesPut',
|
|
38798
38956
|
requestBody: {
|
|
38799
38957
|
content: {
|
|
@@ -38801,11 +38959,18 @@ export default {
|
|
|
38801
38959
|
schema: {
|
|
38802
38960
|
properties: {
|
|
38803
38961
|
device_ids: {
|
|
38962
|
+
description:
|
|
38963
|
+
'IDs of the devices that you want to add to the location.',
|
|
38804
38964
|
items: { format: 'uuid', type: 'string' },
|
|
38805
38965
|
minItems: 1,
|
|
38806
38966
|
type: 'array',
|
|
38807
38967
|
},
|
|
38808
|
-
location_id: {
|
|
38968
|
+
location_id: {
|
|
38969
|
+
description:
|
|
38970
|
+
'ID of the location to which you want to add devices.',
|
|
38971
|
+
format: 'uuid',
|
|
38972
|
+
type: 'string',
|
|
38973
|
+
},
|
|
38809
38974
|
},
|
|
38810
38975
|
required: ['location_id', 'device_ids'],
|
|
38811
38976
|
type: 'object',
|
|
@@ -38838,13 +39003,13 @@ export default {
|
|
|
38838
39003
|
tags: [],
|
|
38839
39004
|
'x-fern-ignore': true,
|
|
38840
39005
|
'x-response-key': null,
|
|
38841
|
-
'x-title': 'Add Location
|
|
39006
|
+
'x-title': 'Add Devices to a Location',
|
|
38842
39007
|
'x-undocumented': 'Experimental locations.',
|
|
38843
39008
|
},
|
|
38844
39009
|
},
|
|
38845
39010
|
'/unstable_locations/create': {
|
|
38846
39011
|
post: {
|
|
38847
|
-
description: '
|
|
39012
|
+
description: 'Creates a new location.',
|
|
38848
39013
|
operationId: 'unstableLocationsCreatePost',
|
|
38849
39014
|
requestBody: {
|
|
38850
39015
|
content: {
|
|
@@ -38852,14 +39017,19 @@ export default {
|
|
|
38852
39017
|
schema: {
|
|
38853
39018
|
properties: {
|
|
38854
39019
|
acs_entrance_ids: {
|
|
39020
|
+
description:
|
|
39021
|
+
'IDs of the entrances that you want to add to the new location.',
|
|
38855
39022
|
items: { format: 'uuid', type: 'string' },
|
|
38856
39023
|
type: 'array',
|
|
38857
39024
|
},
|
|
38858
39025
|
device_ids: {
|
|
39026
|
+
description:
|
|
39027
|
+
'IDs of the devices that you want to add to the new location.',
|
|
38859
39028
|
items: { format: 'uuid', type: 'string' },
|
|
38860
39029
|
type: 'array',
|
|
38861
39030
|
},
|
|
38862
39031
|
geolocation: {
|
|
39032
|
+
description: 'Geolocation of the new location.',
|
|
38863
39033
|
properties: {
|
|
38864
39034
|
latitude: { format: 'float', type: 'number' },
|
|
38865
39035
|
longitude: { format: 'float', type: 'number' },
|
|
@@ -38867,8 +39037,14 @@ export default {
|
|
|
38867
39037
|
required: ['latitude', 'longitude'],
|
|
38868
39038
|
type: 'object',
|
|
38869
39039
|
},
|
|
38870
|
-
name: {
|
|
38871
|
-
|
|
39040
|
+
name: {
|
|
39041
|
+
description: 'Name of the new location.',
|
|
39042
|
+
type: 'string',
|
|
39043
|
+
},
|
|
39044
|
+
time_zone: {
|
|
39045
|
+
description: 'Time zone of the new location.',
|
|
39046
|
+
type: 'string',
|
|
39047
|
+
},
|
|
38872
39048
|
},
|
|
38873
39049
|
required: ['name'],
|
|
38874
39050
|
type: 'object',
|
|
@@ -38955,19 +39131,25 @@ export default {
|
|
|
38955
39131
|
'x-fern-sdk-method-name': 'create',
|
|
38956
39132
|
'x-fern-sdk-return-value': 'location',
|
|
38957
39133
|
'x-response-key': 'location',
|
|
38958
|
-
'x-title': 'Create Location',
|
|
39134
|
+
'x-title': 'Create a Location',
|
|
38959
39135
|
'x-undocumented': 'Experimental locations.',
|
|
38960
39136
|
},
|
|
38961
39137
|
},
|
|
38962
39138
|
'/unstable_locations/delete': {
|
|
38963
39139
|
post: {
|
|
38964
|
-
description: '
|
|
39140
|
+
description: 'Deletes a location.',
|
|
38965
39141
|
operationId: 'unstableLocationsDeletePost',
|
|
38966
39142
|
requestBody: {
|
|
38967
39143
|
content: {
|
|
38968
39144
|
'application/json': {
|
|
38969
39145
|
schema: {
|
|
38970
|
-
properties: {
|
|
39146
|
+
properties: {
|
|
39147
|
+
location_id: {
|
|
39148
|
+
description: 'ID of the location that you want to delete.',
|
|
39149
|
+
format: 'uuid',
|
|
39150
|
+
type: 'string',
|
|
39151
|
+
},
|
|
39152
|
+
},
|
|
38971
39153
|
required: ['location_id'],
|
|
38972
39154
|
type: 'object',
|
|
38973
39155
|
},
|
|
@@ -39000,19 +39182,25 @@ export default {
|
|
|
39000
39182
|
'x-fern-sdk-group-name': ['unstable_locations'],
|
|
39001
39183
|
'x-fern-sdk-method-name': 'delete',
|
|
39002
39184
|
'x-response-key': null,
|
|
39003
|
-
'x-title': 'Delete Location',
|
|
39185
|
+
'x-title': 'Delete a Location',
|
|
39004
39186
|
'x-undocumented': 'Experimental locations.',
|
|
39005
39187
|
},
|
|
39006
39188
|
},
|
|
39007
39189
|
'/unstable_locations/get': {
|
|
39008
39190
|
post: {
|
|
39009
|
-
description: '
|
|
39191
|
+
description: 'Gets a location.',
|
|
39010
39192
|
operationId: 'unstableLocationsGetPost',
|
|
39011
39193
|
requestBody: {
|
|
39012
39194
|
content: {
|
|
39013
39195
|
'application/json': {
|
|
39014
39196
|
schema: {
|
|
39015
|
-
properties: {
|
|
39197
|
+
properties: {
|
|
39198
|
+
location_id: {
|
|
39199
|
+
description: 'ID of the location that you want to get.',
|
|
39200
|
+
format: 'uuid',
|
|
39201
|
+
type: 'string',
|
|
39202
|
+
},
|
|
39203
|
+
},
|
|
39016
39204
|
required: ['location_id'],
|
|
39017
39205
|
type: 'object',
|
|
39018
39206
|
},
|
|
@@ -39098,7 +39286,7 @@ export default {
|
|
|
39098
39286
|
'x-fern-sdk-method-name': 'get',
|
|
39099
39287
|
'x-fern-sdk-return-value': 'location',
|
|
39100
39288
|
'x-response-key': 'location',
|
|
39101
|
-
'x-title': 'Get Location',
|
|
39289
|
+
'x-title': 'Get a Location',
|
|
39102
39290
|
'x-undocumented': 'Experimental locations.',
|
|
39103
39291
|
},
|
|
39104
39292
|
},
|
|
@@ -39282,7 +39470,7 @@ export default {
|
|
|
39282
39470
|
},
|
|
39283
39471
|
'/unstable_locations/remove_acs_entrances': {
|
|
39284
39472
|
post: {
|
|
39285
|
-
description: '
|
|
39473
|
+
description: 'Removes entrances from a specific location.',
|
|
39286
39474
|
operationId: 'unstableLocationsRemoveAcsEntrancesPost',
|
|
39287
39475
|
requestBody: {
|
|
39288
39476
|
content: {
|
|
@@ -39290,10 +39478,17 @@ export default {
|
|
|
39290
39478
|
schema: {
|
|
39291
39479
|
properties: {
|
|
39292
39480
|
acs_entrance_ids: {
|
|
39481
|
+
description:
|
|
39482
|
+
'IDs of the entrances that you want to remove from the location.',
|
|
39293
39483
|
items: { format: 'uuid', type: 'string' },
|
|
39294
39484
|
type: 'array',
|
|
39295
39485
|
},
|
|
39296
|
-
location_id: {
|
|
39486
|
+
location_id: {
|
|
39487
|
+
description:
|
|
39488
|
+
'ID of the location from which you want to remove entrances.',
|
|
39489
|
+
format: 'uuid',
|
|
39490
|
+
type: 'string',
|
|
39491
|
+
},
|
|
39297
39492
|
},
|
|
39298
39493
|
required: ['location_id', 'acs_entrance_ids'],
|
|
39299
39494
|
type: 'object',
|
|
@@ -39327,13 +39522,13 @@ export default {
|
|
|
39327
39522
|
'x-fern-sdk-group-name': ['unstable_locations'],
|
|
39328
39523
|
'x-fern-sdk-method-name': 'remove_acs_entrances',
|
|
39329
39524
|
'x-response-key': null,
|
|
39330
|
-
'x-title': 'Remove
|
|
39525
|
+
'x-title': 'Remove Entrances from a Location',
|
|
39331
39526
|
'x-undocumented': 'Experimental locations.',
|
|
39332
39527
|
},
|
|
39333
39528
|
},
|
|
39334
39529
|
'/unstable_locations/remove_devices': {
|
|
39335
39530
|
post: {
|
|
39336
|
-
description: '
|
|
39531
|
+
description: 'Removes devices from a specific location.',
|
|
39337
39532
|
operationId: 'unstableLocationsRemoveDevicesPost',
|
|
39338
39533
|
requestBody: {
|
|
39339
39534
|
content: {
|
|
@@ -39341,10 +39536,17 @@ export default {
|
|
|
39341
39536
|
schema: {
|
|
39342
39537
|
properties: {
|
|
39343
39538
|
device_ids: {
|
|
39539
|
+
description:
|
|
39540
|
+
'IDs of the devices that you want to remove from the location.',
|
|
39344
39541
|
items: { format: 'uuid', type: 'string' },
|
|
39345
39542
|
type: 'array',
|
|
39346
39543
|
},
|
|
39347
|
-
location_id: {
|
|
39544
|
+
location_id: {
|
|
39545
|
+
description:
|
|
39546
|
+
'ID of the location from which you want to remove devices.',
|
|
39547
|
+
format: 'uuid',
|
|
39548
|
+
type: 'string',
|
|
39549
|
+
},
|
|
39348
39550
|
},
|
|
39349
39551
|
required: ['location_id', 'device_ids'],
|
|
39350
39552
|
type: 'object',
|
|
@@ -39378,13 +39580,13 @@ export default {
|
|
|
39378
39580
|
'x-fern-sdk-group-name': ['unstable_locations'],
|
|
39379
39581
|
'x-fern-sdk-method-name': 'remove_devices',
|
|
39380
39582
|
'x-response-key': null,
|
|
39381
|
-
'x-title': 'Remove Location
|
|
39583
|
+
'x-title': 'Remove Devices from a Location',
|
|
39382
39584
|
'x-undocumented': 'Experimental locations.',
|
|
39383
39585
|
},
|
|
39384
39586
|
},
|
|
39385
39587
|
'/unstable_locations/update': {
|
|
39386
39588
|
patch: {
|
|
39387
|
-
description: '
|
|
39589
|
+
description: 'Updates a location.',
|
|
39388
39590
|
operationId: 'unstableLocationsUpdatePatch',
|
|
39389
39591
|
requestBody: {
|
|
39390
39592
|
content: {
|
|
@@ -39392,6 +39594,7 @@ export default {
|
|
|
39392
39594
|
schema: {
|
|
39393
39595
|
properties: {
|
|
39394
39596
|
geolocation: {
|
|
39597
|
+
description: 'Geolocation of the location.',
|
|
39395
39598
|
properties: {
|
|
39396
39599
|
latitude: { format: 'float', type: 'number' },
|
|
39397
39600
|
longitude: { format: 'float', type: 'number' },
|
|
@@ -39399,9 +39602,19 @@ export default {
|
|
|
39399
39602
|
required: ['latitude', 'longitude'],
|
|
39400
39603
|
type: 'object',
|
|
39401
39604
|
},
|
|
39402
|
-
location_id: {
|
|
39403
|
-
|
|
39404
|
-
|
|
39605
|
+
location_id: {
|
|
39606
|
+
description: 'ID of the location that you want to update.',
|
|
39607
|
+
format: 'uuid',
|
|
39608
|
+
type: 'string',
|
|
39609
|
+
},
|
|
39610
|
+
name: {
|
|
39611
|
+
description: 'Name of the location.',
|
|
39612
|
+
type: 'string',
|
|
39613
|
+
},
|
|
39614
|
+
time_zone: {
|
|
39615
|
+
description: 'Time zone of the the location.',
|
|
39616
|
+
type: 'string',
|
|
39617
|
+
},
|
|
39405
39618
|
},
|
|
39406
39619
|
required: ['location_id'],
|
|
39407
39620
|
type: 'object',
|
|
@@ -39486,11 +39699,11 @@ export default {
|
|
|
39486
39699
|
tags: [],
|
|
39487
39700
|
'x-fern-ignore': true,
|
|
39488
39701
|
'x-response-key': 'location',
|
|
39489
|
-
'x-title': 'Update Location',
|
|
39702
|
+
'x-title': 'Update a Location',
|
|
39490
39703
|
'x-undocumented': 'Experimental locations.',
|
|
39491
39704
|
},
|
|
39492
39705
|
post: {
|
|
39493
|
-
description: '
|
|
39706
|
+
description: 'Updates a location.',
|
|
39494
39707
|
operationId: 'unstableLocationsUpdatePost',
|
|
39495
39708
|
requestBody: {
|
|
39496
39709
|
content: {
|
|
@@ -39498,6 +39711,7 @@ export default {
|
|
|
39498
39711
|
schema: {
|
|
39499
39712
|
properties: {
|
|
39500
39713
|
geolocation: {
|
|
39714
|
+
description: 'Geolocation of the location.',
|
|
39501
39715
|
properties: {
|
|
39502
39716
|
latitude: { format: 'float', type: 'number' },
|
|
39503
39717
|
longitude: { format: 'float', type: 'number' },
|
|
@@ -39505,9 +39719,19 @@ export default {
|
|
|
39505
39719
|
required: ['latitude', 'longitude'],
|
|
39506
39720
|
type: 'object',
|
|
39507
39721
|
},
|
|
39508
|
-
location_id: {
|
|
39509
|
-
|
|
39510
|
-
|
|
39722
|
+
location_id: {
|
|
39723
|
+
description: 'ID of the location that you want to update.',
|
|
39724
|
+
format: 'uuid',
|
|
39725
|
+
type: 'string',
|
|
39726
|
+
},
|
|
39727
|
+
name: {
|
|
39728
|
+
description: 'Name of the location.',
|
|
39729
|
+
type: 'string',
|
|
39730
|
+
},
|
|
39731
|
+
time_zone: {
|
|
39732
|
+
description: 'Time zone of the the location.',
|
|
39733
|
+
type: 'string',
|
|
39734
|
+
},
|
|
39511
39735
|
},
|
|
39512
39736
|
required: ['location_id'],
|
|
39513
39737
|
type: 'object',
|
|
@@ -39594,7 +39818,7 @@ export default {
|
|
|
39594
39818
|
'x-fern-sdk-method-name': 'update',
|
|
39595
39819
|
'x-fern-sdk-return-value': 'location',
|
|
39596
39820
|
'x-response-key': 'location',
|
|
39597
|
-
'x-title': 'Update Location',
|
|
39821
|
+
'x-title': 'Update a Location',
|
|
39598
39822
|
'x-undocumented': 'Experimental locations.',
|
|
39599
39823
|
},
|
|
39600
39824
|
},
|
|
@@ -39607,7 +39831,13 @@ export default {
|
|
|
39607
39831
|
content: {
|
|
39608
39832
|
'application/json': {
|
|
39609
39833
|
schema: {
|
|
39610
|
-
properties: {
|
|
39834
|
+
properties: {
|
|
39835
|
+
customer_key: {
|
|
39836
|
+
description:
|
|
39837
|
+
'Customer key for which you want to connect accounts.',
|
|
39838
|
+
type: 'string',
|
|
39839
|
+
},
|
|
39840
|
+
},
|
|
39611
39841
|
required: ['customer_key'],
|
|
39612
39842
|
type: 'object',
|
|
39613
39843
|
},
|
|
@@ -39644,7 +39874,7 @@ export default {
|
|
|
39644
39874
|
'x-fern-sdk-method-name': 'connect_accounts',
|
|
39645
39875
|
'x-fern-sdk-return-value': 'magic_link',
|
|
39646
39876
|
'x-response-key': 'magic_link',
|
|
39647
|
-
'x-title': 'Connect Accounts',
|
|
39877
|
+
'x-title': 'Generate a Connect Accounts Building Block Magic Link',
|
|
39648
39878
|
'x-undocumented': 'Experimental partner building blocks.',
|
|
39649
39879
|
},
|
|
39650
39880
|
},
|
|
@@ -39656,61 +39886,46 @@ export default {
|
|
|
39656
39886
|
content: {
|
|
39657
39887
|
'application/json': {
|
|
39658
39888
|
schema: {
|
|
39659
|
-
|
|
39660
|
-
{
|
|
39661
|
-
|
|
39662
|
-
|
|
39663
|
-
|
|
39664
|
-
|
|
39665
|
-
|
|
39666
|
-
|
|
39667
|
-
|
|
39668
|
-
|
|
39669
|
-
type: '
|
|
39889
|
+
properties: {
|
|
39890
|
+
building_block_type: {
|
|
39891
|
+
description:
|
|
39892
|
+
'Type of building block to create a magic link for.',
|
|
39893
|
+
enum: [
|
|
39894
|
+
'connect_accounts',
|
|
39895
|
+
'organize_spaces',
|
|
39896
|
+
'console',
|
|
39897
|
+
'manage_devices',
|
|
39898
|
+
],
|
|
39899
|
+
type: 'string',
|
|
39670
39900
|
},
|
|
39671
|
-
{
|
|
39672
|
-
|
|
39673
|
-
|
|
39674
|
-
|
|
39675
|
-
type: 'string',
|
|
39676
|
-
},
|
|
39677
|
-
customer_key: { type: 'string' },
|
|
39678
|
-
},
|
|
39679
|
-
required: ['building_block_type', 'customer_key'],
|
|
39680
|
-
type: 'object',
|
|
39901
|
+
customer_key: {
|
|
39902
|
+
description:
|
|
39903
|
+
'Customer key for which you want to create a new building block magic link.',
|
|
39904
|
+
type: 'string',
|
|
39681
39905
|
},
|
|
39682
|
-
{
|
|
39683
|
-
|
|
39684
|
-
|
|
39685
|
-
|
|
39686
|
-
|
|
39687
|
-
|
|
39688
|
-
|
|
39689
|
-
partner_resources: {
|
|
39690
|
-
description:
|
|
39691
|
-
'Optional list of partner resources to include in the magic link.',
|
|
39692
|
-
items: {
|
|
39693
|
-
properties: {
|
|
39694
|
-
custom_metadata: {
|
|
39695
|
-
additionalProperties: { type: 'string' },
|
|
39696
|
-
type: 'object',
|
|
39697
|
-
},
|
|
39698
|
-
description: { type: 'string' },
|
|
39699
|
-
name: { type: 'string' },
|
|
39700
|
-
partner_resource_key: { type: 'string' },
|
|
39701
|
-
},
|
|
39702
|
-
required: ['partner_resource_key', 'name'],
|
|
39906
|
+
spaces: {
|
|
39907
|
+
description:
|
|
39908
|
+
'Optional list of spaces that you want to include in the new building block magic link.',
|
|
39909
|
+
items: {
|
|
39910
|
+
properties: {
|
|
39911
|
+
custom_metadata: {
|
|
39912
|
+
additionalProperties: { type: 'string' },
|
|
39703
39913
|
type: 'object',
|
|
39704
|
-
'x-route-path': '/unstable_partner/resources',
|
|
39705
|
-
'x-undocumented': 'Unreleased.',
|
|
39706
39914
|
},
|
|
39707
|
-
type: '
|
|
39915
|
+
description: { type: 'string' },
|
|
39916
|
+
name: { type: 'string' },
|
|
39917
|
+
space_key: { type: 'string' },
|
|
39708
39918
|
},
|
|
39919
|
+
required: ['space_key', 'name'],
|
|
39920
|
+
type: 'object',
|
|
39921
|
+
'x-route-path': '/unstable_partner/resources',
|
|
39922
|
+
'x-undocumented': 'Unreleased.',
|
|
39709
39923
|
},
|
|
39710
|
-
|
|
39711
|
-
type: 'object',
|
|
39924
|
+
type: 'array',
|
|
39712
39925
|
},
|
|
39713
|
-
|
|
39926
|
+
},
|
|
39927
|
+
required: ['building_block_type', 'customer_key'],
|
|
39928
|
+
type: 'object',
|
|
39714
39929
|
},
|
|
39715
39930
|
},
|
|
39716
39931
|
},
|
|
@@ -39745,7 +39960,7 @@ export default {
|
|
|
39745
39960
|
'x-fern-sdk-method-name': 'generate_magic_link',
|
|
39746
39961
|
'x-fern-sdk-return-value': 'magic_link',
|
|
39747
39962
|
'x-response-key': 'magic_link',
|
|
39748
|
-
'x-title': 'Generate a
|
|
39963
|
+
'x-title': 'Generate a Building Block Magic Link',
|
|
39749
39964
|
'x-undocumented': 'Experimental partner building blocks.',
|
|
39750
39965
|
},
|
|
39751
39966
|
},
|
|
@@ -39758,7 +39973,13 @@ export default {
|
|
|
39758
39973
|
content: {
|
|
39759
39974
|
'application/json': {
|
|
39760
39975
|
schema: {
|
|
39761
|
-
properties: {
|
|
39976
|
+
properties: {
|
|
39977
|
+
customer_key: {
|
|
39978
|
+
description:
|
|
39979
|
+
'Customer key for which you want to manage devices.',
|
|
39980
|
+
type: 'string',
|
|
39981
|
+
},
|
|
39982
|
+
},
|
|
39762
39983
|
required: ['customer_key'],
|
|
39763
39984
|
type: 'object',
|
|
39764
39985
|
},
|
|
@@ -39795,7 +40016,7 @@ export default {
|
|
|
39795
40016
|
'x-fern-sdk-method-name': 'manage_devices',
|
|
39796
40017
|
'x-fern-sdk-return-value': 'magic_link',
|
|
39797
40018
|
'x-response-key': 'magic_link',
|
|
39798
|
-
'x-title': 'Manage Devices',
|
|
40019
|
+
'x-title': 'Generate a Manage Devices Building Block Magic Link',
|
|
39799
40020
|
'x-undocumented': 'Experimental partner building blocks.',
|
|
39800
40021
|
},
|
|
39801
40022
|
},
|
|
@@ -39809,8 +40030,14 @@ export default {
|
|
|
39809
40030
|
'application/json': {
|
|
39810
40031
|
schema: {
|
|
39811
40032
|
properties: {
|
|
39812
|
-
customer_key: {
|
|
39813
|
-
|
|
40033
|
+
customer_key: {
|
|
40034
|
+
description:
|
|
40035
|
+
'Customer key for which you want to organize spaces.',
|
|
40036
|
+
type: 'string',
|
|
40037
|
+
},
|
|
40038
|
+
spaces: {
|
|
40039
|
+
description:
|
|
40040
|
+
'Optional list of spaces that you want to include in the new building block magic link.',
|
|
39814
40041
|
items: {
|
|
39815
40042
|
properties: {
|
|
39816
40043
|
custom_metadata: {
|
|
@@ -39819,9 +40046,9 @@ export default {
|
|
|
39819
40046
|
},
|
|
39820
40047
|
description: { type: 'string' },
|
|
39821
40048
|
name: { type: 'string' },
|
|
39822
|
-
|
|
40049
|
+
space_key: { type: 'string' },
|
|
39823
40050
|
},
|
|
39824
|
-
required: ['
|
|
40051
|
+
required: ['space_key', 'name'],
|
|
39825
40052
|
type: 'object',
|
|
39826
40053
|
'x-route-path': '/unstable_partner/resources',
|
|
39827
40054
|
'x-undocumented': 'Unreleased.',
|
|
@@ -39865,13 +40092,13 @@ export default {
|
|
|
39865
40092
|
'x-fern-sdk-method-name': 'organize_spaces',
|
|
39866
40093
|
'x-fern-sdk-return-value': 'magic_link',
|
|
39867
40094
|
'x-response-key': 'magic_link',
|
|
39868
|
-
'x-title': 'Organize Spaces',
|
|
40095
|
+
'x-title': 'Generate an Organize Spaces Building Block Magic Link',
|
|
39869
40096
|
'x-undocumented': 'Experimental partner building blocks.',
|
|
39870
40097
|
},
|
|
39871
40098
|
},
|
|
39872
40099
|
'/unstable_partner/resources/push': {
|
|
39873
40100
|
post: {
|
|
39874
|
-
description: '
|
|
40101
|
+
description: 'Sends Seam some of your resources.',
|
|
39875
40102
|
operationId: 'unstablePartnerResourcesPushPost',
|
|
39876
40103
|
requestBody: {
|
|
39877
40104
|
content: {
|
|
@@ -39885,7 +40112,11 @@ export default {
|
|
|
39885
40112
|
additionalProperties: { type: 'string' },
|
|
39886
40113
|
type: 'object',
|
|
39887
40114
|
},
|
|
39888
|
-
customer_key: {
|
|
40115
|
+
customer_key: {
|
|
40116
|
+
description:
|
|
40117
|
+
'Customer key associated with the resource that you want to push to Seam.',
|
|
40118
|
+
type: 'string',
|
|
40119
|
+
},
|
|
39889
40120
|
description: { type: 'string' },
|
|
39890
40121
|
email_address: { type: 'string' },
|
|
39891
40122
|
ends_at: { type: 'string' },
|
|
@@ -39894,8 +40125,16 @@ export default {
|
|
|
39894
40125
|
type: 'array',
|
|
39895
40126
|
},
|
|
39896
40127
|
name: { type: 'string' },
|
|
39897
|
-
partner_resource_key: {
|
|
39898
|
-
|
|
40128
|
+
partner_resource_key: {
|
|
40129
|
+
description:
|
|
40130
|
+
'Key of the resource that you want to push to Seam.',
|
|
40131
|
+
type: 'string',
|
|
40132
|
+
},
|
|
40133
|
+
partner_resource_type: {
|
|
40134
|
+
description:
|
|
40135
|
+
'Type of the resource that you want to push to Seam.',
|
|
40136
|
+
type: 'string',
|
|
40137
|
+
},
|
|
39899
40138
|
phone_number: { type: 'string' },
|
|
39900
40139
|
starts_at: { type: 'string' },
|
|
39901
40140
|
user_identity_key: { type: 'string' },
|
|
@@ -39912,7 +40151,11 @@ export default {
|
|
|
39912
40151
|
additionalProperties: { type: 'string' },
|
|
39913
40152
|
type: 'object',
|
|
39914
40153
|
},
|
|
39915
|
-
customer_key: {
|
|
40154
|
+
customer_key: {
|
|
40155
|
+
description:
|
|
40156
|
+
'Customer key associated with the resource that you want to push to Seam.',
|
|
40157
|
+
type: 'string',
|
|
40158
|
+
},
|
|
39916
40159
|
description: { type: 'string' },
|
|
39917
40160
|
email_address: { type: 'string' },
|
|
39918
40161
|
ends_at: { type: 'string' },
|
|
@@ -39921,8 +40164,16 @@ export default {
|
|
|
39921
40164
|
type: 'array',
|
|
39922
40165
|
},
|
|
39923
40166
|
name: { type: 'string' },
|
|
39924
|
-
partner_resource_key: {
|
|
39925
|
-
|
|
40167
|
+
partner_resource_key: {
|
|
40168
|
+
description:
|
|
40169
|
+
'Key of the resource that you want to push to Seam.',
|
|
40170
|
+
type: 'string',
|
|
40171
|
+
},
|
|
40172
|
+
partner_resource_type: {
|
|
40173
|
+
description:
|
|
40174
|
+
'Type of the resource that you want to push to Seam.',
|
|
40175
|
+
type: 'string',
|
|
40176
|
+
},
|
|
39926
40177
|
phone_number: { type: 'string' },
|
|
39927
40178
|
starts_at: { type: 'string' },
|
|
39928
40179
|
user_identity_key: { type: 'string' },
|
|
@@ -39962,14 +40213,14 @@ export default {
|
|
|
39962
40213
|
'x-fern-sdk-group-name': ['unstable_partner', 'resources'],
|
|
39963
40214
|
'x-fern-sdk-method-name': 'push',
|
|
39964
40215
|
'x-response-key': null,
|
|
39965
|
-
'x-title': 'Push
|
|
40216
|
+
'x-title': 'Push Partner Resources at Seam',
|
|
39966
40217
|
'x-undocumented': 'Experimental partner resources.',
|
|
39967
40218
|
},
|
|
39968
40219
|
},
|
|
39969
40220
|
'/user_identities/add_acs_user': {
|
|
39970
40221
|
post: {
|
|
39971
40222
|
description:
|
|
39972
|
-
'Adds a specified [
|
|
40223
|
+
'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).',
|
|
39973
40224
|
operationId: 'userIdentitiesAddAcsUserPost',
|
|
39974
40225
|
requestBody: {
|
|
39975
40226
|
content: {
|
|
@@ -39977,12 +40228,14 @@ export default {
|
|
|
39977
40228
|
schema: {
|
|
39978
40229
|
properties: {
|
|
39979
40230
|
acs_user_id: {
|
|
39980
|
-
description:
|
|
40231
|
+
description:
|
|
40232
|
+
'ID of the access system user that you want to add to the user identity.',
|
|
39981
40233
|
format: 'uuid',
|
|
39982
40234
|
type: 'string',
|
|
39983
40235
|
},
|
|
39984
40236
|
user_identity_id: {
|
|
39985
|
-
description:
|
|
40237
|
+
description:
|
|
40238
|
+
'ID of the user identity to which you want to add an access system user.',
|
|
39986
40239
|
format: 'uuid',
|
|
39987
40240
|
type: 'string',
|
|
39988
40241
|
},
|
|
@@ -40023,7 +40276,7 @@ export default {
|
|
|
40023
40276
|
},
|
|
40024
40277
|
put: {
|
|
40025
40278
|
description:
|
|
40026
|
-
'Adds a specified [
|
|
40279
|
+
'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).',
|
|
40027
40280
|
operationId: 'userIdentitiesAddAcsUserPut',
|
|
40028
40281
|
requestBody: {
|
|
40029
40282
|
content: {
|
|
@@ -40031,12 +40284,14 @@ export default {
|
|
|
40031
40284
|
schema: {
|
|
40032
40285
|
properties: {
|
|
40033
40286
|
acs_user_id: {
|
|
40034
|
-
description:
|
|
40287
|
+
description:
|
|
40288
|
+
'ID of the access system user that you want to add to the user identity.',
|
|
40035
40289
|
format: 'uuid',
|
|
40036
40290
|
type: 'string',
|
|
40037
40291
|
},
|
|
40038
40292
|
user_identity_id: {
|
|
40039
|
-
description:
|
|
40293
|
+
description:
|
|
40294
|
+
'ID of the user identity to which you want to add an access system user.',
|
|
40040
40295
|
format: 'uuid',
|
|
40041
40296
|
type: 'string',
|
|
40042
40297
|
},
|
|
@@ -40087,31 +40342,32 @@ export default {
|
|
|
40087
40342
|
properties: {
|
|
40088
40343
|
acs_system_ids: {
|
|
40089
40344
|
description:
|
|
40090
|
-
"List of
|
|
40345
|
+
"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.",
|
|
40091
40346
|
items: { format: 'uuid', type: 'string' },
|
|
40092
40347
|
type: 'array',
|
|
40093
40348
|
},
|
|
40094
40349
|
email_address: {
|
|
40095
|
-
description:
|
|
40350
|
+
description:
|
|
40351
|
+
'Unique email address for the new user identity.',
|
|
40096
40352
|
format: 'email',
|
|
40097
40353
|
nullable: true,
|
|
40098
40354
|
type: 'string',
|
|
40099
40355
|
},
|
|
40100
40356
|
full_name: {
|
|
40101
40357
|
description:
|
|
40102
|
-
'Full name of the user associated with the user identity.',
|
|
40358
|
+
'Full name of the user associated with the new user identity.',
|
|
40103
40359
|
minLength: 1,
|
|
40104
40360
|
nullable: true,
|
|
40105
40361
|
type: 'string',
|
|
40106
40362
|
},
|
|
40107
40363
|
phone_number: {
|
|
40108
40364
|
description:
|
|
40109
|
-
'Unique phone number for the user identity in E.164 format (for example, +15555550100).',
|
|
40365
|
+
'Unique phone number for the new user identity in E.164 format (for example, +15555550100).',
|
|
40110
40366
|
nullable: true,
|
|
40111
40367
|
type: 'string',
|
|
40112
40368
|
},
|
|
40113
40369
|
user_identity_key: {
|
|
40114
|
-
description: 'Unique key for the user identity.',
|
|
40370
|
+
description: 'Unique key for the new user identity.',
|
|
40115
40371
|
minLength: 1,
|
|
40116
40372
|
nullable: true,
|
|
40117
40373
|
type: 'string',
|
|
@@ -40168,7 +40424,8 @@ export default {
|
|
|
40168
40424
|
schema: {
|
|
40169
40425
|
properties: {
|
|
40170
40426
|
user_identity_id: {
|
|
40171
|
-
description:
|
|
40427
|
+
description:
|
|
40428
|
+
'ID of the user identity that you want to delete.',
|
|
40172
40429
|
format: 'uuid',
|
|
40173
40430
|
type: 'string',
|
|
40174
40431
|
},
|
|
@@ -40219,7 +40476,8 @@ export default {
|
|
|
40219
40476
|
schema: {
|
|
40220
40477
|
properties: {
|
|
40221
40478
|
enrollment_automation_id: {
|
|
40222
|
-
description:
|
|
40479
|
+
description:
|
|
40480
|
+
'ID of the enrollment automation that you want to delete.',
|
|
40223
40481
|
format: 'uuid',
|
|
40224
40482
|
type: 'string',
|
|
40225
40483
|
},
|
|
@@ -40270,7 +40528,8 @@ export default {
|
|
|
40270
40528
|
schema: {
|
|
40271
40529
|
properties: {
|
|
40272
40530
|
enrollment_automation_id: {
|
|
40273
|
-
description:
|
|
40531
|
+
description:
|
|
40532
|
+
'ID of the enrollment automation that you want to get.',
|
|
40274
40533
|
format: 'uuid',
|
|
40275
40534
|
type: 'string',
|
|
40276
40535
|
},
|
|
@@ -40329,7 +40588,7 @@ export default {
|
|
|
40329
40588
|
properties: {
|
|
40330
40589
|
acs_credential_pool_id: {
|
|
40331
40590
|
description:
|
|
40332
|
-
'ID of the
|
|
40591
|
+
'ID of the credential pool from which to obtain credentials for the user identity.',
|
|
40333
40592
|
format: 'uuid',
|
|
40334
40593
|
type: 'string',
|
|
40335
40594
|
},
|
|
@@ -40340,18 +40599,19 @@ export default {
|
|
|
40340
40599
|
},
|
|
40341
40600
|
credential_manager_acs_system_id: {
|
|
40342
40601
|
description:
|
|
40343
|
-
'ID of the desired
|
|
40602
|
+
'ID of the desired access system that serves as the credential manager for the enrollment automation.',
|
|
40344
40603
|
format: 'uuid',
|
|
40345
40604
|
type: 'string',
|
|
40346
40605
|
},
|
|
40347
40606
|
credential_manager_acs_user_id: {
|
|
40348
40607
|
description:
|
|
40349
|
-
'ID of the associated
|
|
40608
|
+
'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`.',
|
|
40350
40609
|
format: 'uuid',
|
|
40351
40610
|
type: 'string',
|
|
40352
40611
|
},
|
|
40353
40612
|
user_identity_id: {
|
|
40354
|
-
description:
|
|
40613
|
+
description:
|
|
40614
|
+
'ID of the user identity for which you want to launch an enrollment automation.',
|
|
40355
40615
|
format: 'uuid',
|
|
40356
40616
|
type: 'string',
|
|
40357
40617
|
},
|
|
@@ -40437,7 +40697,7 @@ export default {
|
|
|
40437
40697
|
properties: {
|
|
40438
40698
|
user_identity_id: {
|
|
40439
40699
|
description:
|
|
40440
|
-
'ID of the user identity for which you want to retrieve
|
|
40700
|
+
'ID of the user identity for which you want to retrieve enrollment automations.',
|
|
40441
40701
|
format: 'uuid',
|
|
40442
40702
|
type: 'string',
|
|
40443
40703
|
},
|
|
@@ -40500,7 +40760,7 @@ export default {
|
|
|
40500
40760
|
max_use_count: {
|
|
40501
40761
|
default: 1,
|
|
40502
40762
|
description:
|
|
40503
|
-
'
|
|
40763
|
+
'Maximum number of times the instant key can be used. Default: 1.',
|
|
40504
40764
|
format: 'float',
|
|
40505
40765
|
type: 'number',
|
|
40506
40766
|
},
|
|
@@ -40563,7 +40823,8 @@ export default {
|
|
|
40563
40823
|
{
|
|
40564
40824
|
properties: {
|
|
40565
40825
|
user_identity_id: {
|
|
40566
|
-
description:
|
|
40826
|
+
description:
|
|
40827
|
+
'ID of the user identity that you want to get.',
|
|
40567
40828
|
format: 'uuid',
|
|
40568
40829
|
type: 'string',
|
|
40569
40830
|
},
|
|
@@ -40627,12 +40888,14 @@ export default {
|
|
|
40627
40888
|
schema: {
|
|
40628
40889
|
properties: {
|
|
40629
40890
|
device_id: {
|
|
40630
|
-
description:
|
|
40891
|
+
description:
|
|
40892
|
+
'ID of the managed device to which you want to grant access to the user identity.',
|
|
40631
40893
|
format: 'uuid',
|
|
40632
40894
|
type: 'string',
|
|
40633
40895
|
},
|
|
40634
40896
|
user_identity_id: {
|
|
40635
|
-
description:
|
|
40897
|
+
description:
|
|
40898
|
+
'ID of the user identity that you want to grant access to a device.',
|
|
40636
40899
|
format: 'uuid',
|
|
40637
40900
|
type: 'string',
|
|
40638
40901
|
},
|
|
@@ -40681,12 +40944,14 @@ export default {
|
|
|
40681
40944
|
schema: {
|
|
40682
40945
|
properties: {
|
|
40683
40946
|
device_id: {
|
|
40684
|
-
description:
|
|
40947
|
+
description:
|
|
40948
|
+
'ID of the managed device to which you want to grant access to the user identity.',
|
|
40685
40949
|
format: 'uuid',
|
|
40686
40950
|
type: 'string',
|
|
40687
40951
|
},
|
|
40688
40952
|
user_identity_id: {
|
|
40689
|
-
description:
|
|
40953
|
+
description:
|
|
40954
|
+
'ID of the user identity that you want to grant access to a device.',
|
|
40690
40955
|
format: 'uuid',
|
|
40691
40956
|
type: 'string',
|
|
40692
40957
|
},
|
|
@@ -40736,6 +41001,8 @@ export default {
|
|
|
40736
41001
|
schema: {
|
|
40737
41002
|
properties: {
|
|
40738
41003
|
credential_manager_acs_system_id: {
|
|
41004
|
+
description:
|
|
41005
|
+
'`acs_system_id` of the credential manager by which you want to filter the list of user identities.',
|
|
40739
41006
|
format: 'uuid',
|
|
40740
41007
|
type: 'string',
|
|
40741
41008
|
},
|
|
@@ -40815,7 +41082,7 @@ export default {
|
|
|
40815
41082
|
deprecated: true,
|
|
40816
41083
|
items: { $ref: '#/components/schemas/device' },
|
|
40817
41084
|
type: 'array',
|
|
40818
|
-
'x-deprecated': '
|
|
41085
|
+
'x-deprecated': 'Use devices.',
|
|
40819
41086
|
},
|
|
40820
41087
|
devices: {
|
|
40821
41088
|
items: { $ref: '#/components/schemas/device' },
|
|
@@ -40850,7 +41117,7 @@ export default {
|
|
|
40850
41117
|
'/user_identities/list_acs_systems': {
|
|
40851
41118
|
post: {
|
|
40852
41119
|
description:
|
|
40853
|
-
'Returns a list of all [access
|
|
41120
|
+
'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).',
|
|
40854
41121
|
operationId: 'userIdentitiesListAcsSystemsPost',
|
|
40855
41122
|
requestBody: {
|
|
40856
41123
|
content: {
|
|
@@ -40859,7 +41126,7 @@ export default {
|
|
|
40859
41126
|
properties: {
|
|
40860
41127
|
user_identity_id: {
|
|
40861
41128
|
description:
|
|
40862
|
-
'ID of the user identity for which you want to retrieve all access
|
|
41129
|
+
'ID of the user identity for which you want to retrieve all access systems.',
|
|
40863
41130
|
format: 'uuid',
|
|
40864
41131
|
type: 'string',
|
|
40865
41132
|
},
|
|
@@ -40910,7 +41177,7 @@ export default {
|
|
|
40910
41177
|
'/user_identities/list_acs_users': {
|
|
40911
41178
|
post: {
|
|
40912
41179
|
description:
|
|
40913
|
-
'Returns a list of all [
|
|
41180
|
+
'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).',
|
|
40914
41181
|
operationId: 'userIdentitiesListAcsUsersPost',
|
|
40915
41182
|
requestBody: {
|
|
40916
41183
|
content: {
|
|
@@ -40919,7 +41186,7 @@ export default {
|
|
|
40919
41186
|
properties: {
|
|
40920
41187
|
user_identity_id: {
|
|
40921
41188
|
description:
|
|
40922
|
-
'ID of the user identity for which you want to retrieve all
|
|
41189
|
+
'ID of the user identity for which you want to retrieve all access system users.',
|
|
40923
41190
|
format: 'uuid',
|
|
40924
41191
|
type: 'string',
|
|
40925
41192
|
},
|
|
@@ -40969,7 +41236,7 @@ export default {
|
|
|
40969
41236
|
'/user_identities/remove_acs_user': {
|
|
40970
41237
|
post: {
|
|
40971
41238
|
description:
|
|
40972
|
-
'Removes a specified [
|
|
41239
|
+
'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).',
|
|
40973
41240
|
operationId: 'userIdentitiesRemoveAcsUserPost',
|
|
40974
41241
|
requestBody: {
|
|
40975
41242
|
content: {
|
|
@@ -40977,12 +41244,14 @@ export default {
|
|
|
40977
41244
|
schema: {
|
|
40978
41245
|
properties: {
|
|
40979
41246
|
acs_user_id: {
|
|
40980
|
-
description:
|
|
41247
|
+
description:
|
|
41248
|
+
'ID of the access system user that you want to remove from the user identity..',
|
|
40981
41249
|
format: 'uuid',
|
|
40982
41250
|
type: 'string',
|
|
40983
41251
|
},
|
|
40984
41252
|
user_identity_id: {
|
|
40985
|
-
description:
|
|
41253
|
+
description:
|
|
41254
|
+
'ID of the user identity from which you want to remove an access system user.',
|
|
40986
41255
|
format: 'uuid',
|
|
40987
41256
|
type: 'string',
|
|
40988
41257
|
},
|
|
@@ -41033,12 +41302,14 @@ export default {
|
|
|
41033
41302
|
schema: {
|
|
41034
41303
|
properties: {
|
|
41035
41304
|
device_id: {
|
|
41036
|
-
description:
|
|
41305
|
+
description:
|
|
41306
|
+
'ID of the managed device to which you want to revoke access from the user identity.',
|
|
41037
41307
|
format: 'uuid',
|
|
41038
41308
|
type: 'string',
|
|
41039
41309
|
},
|
|
41040
41310
|
user_identity_id: {
|
|
41041
|
-
description:
|
|
41311
|
+
description:
|
|
41312
|
+
'ID of the user identity from which you want to revoke access to a device.',
|
|
41042
41313
|
format: 'uuid',
|
|
41043
41314
|
type: 'string',
|
|
41044
41315
|
},
|
|
@@ -41080,6 +41351,8 @@ export default {
|
|
|
41080
41351
|
},
|
|
41081
41352
|
'/user_identities/update': {
|
|
41082
41353
|
patch: {
|
|
41354
|
+
description:
|
|
41355
|
+
'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).',
|
|
41083
41356
|
operationId: 'userIdentitiesUpdatePatch',
|
|
41084
41357
|
requestBody: {
|
|
41085
41358
|
content: {
|
|
@@ -41092,15 +41365,21 @@ export default {
|
|
|
41092
41365
|
nullable: true,
|
|
41093
41366
|
type: 'string',
|
|
41094
41367
|
},
|
|
41095
|
-
full_name: {
|
|
41096
|
-
phone_number: {
|
|
41368
|
+
full_name: {
|
|
41097
41369
|
description:
|
|
41098
|
-
'
|
|
41370
|
+
'Full name of the user associated with the user identity.',
|
|
41371
|
+
minLength: 1,
|
|
41372
|
+
nullable: true,
|
|
41373
|
+
type: 'string',
|
|
41374
|
+
},
|
|
41375
|
+
phone_number: {
|
|
41376
|
+
description: 'Unique phone number for the user identity.',
|
|
41099
41377
|
nullable: true,
|
|
41100
41378
|
type: 'string',
|
|
41101
41379
|
},
|
|
41102
41380
|
user_identity_id: {
|
|
41103
|
-
description:
|
|
41381
|
+
description:
|
|
41382
|
+
'ID of the user identity that you want to update.',
|
|
41104
41383
|
format: 'uuid',
|
|
41105
41384
|
type: 'string',
|
|
41106
41385
|
},
|
|
@@ -41145,6 +41424,8 @@ export default {
|
|
|
41145
41424
|
'x-title': 'Update a User Identity',
|
|
41146
41425
|
},
|
|
41147
41426
|
post: {
|
|
41427
|
+
description:
|
|
41428
|
+
'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).',
|
|
41148
41429
|
operationId: 'userIdentitiesUpdatePost',
|
|
41149
41430
|
requestBody: {
|
|
41150
41431
|
content: {
|
|
@@ -41157,15 +41438,21 @@ export default {
|
|
|
41157
41438
|
nullable: true,
|
|
41158
41439
|
type: 'string',
|
|
41159
41440
|
},
|
|
41160
|
-
full_name: {
|
|
41161
|
-
phone_number: {
|
|
41441
|
+
full_name: {
|
|
41162
41442
|
description:
|
|
41163
|
-
'
|
|
41443
|
+
'Full name of the user associated with the user identity.',
|
|
41444
|
+
minLength: 1,
|
|
41445
|
+
nullable: true,
|
|
41446
|
+
type: 'string',
|
|
41447
|
+
},
|
|
41448
|
+
phone_number: {
|
|
41449
|
+
description: 'Unique phone number for the user identity.',
|
|
41164
41450
|
nullable: true,
|
|
41165
41451
|
type: 'string',
|
|
41166
41452
|
},
|
|
41167
41453
|
user_identity_id: {
|
|
41168
|
-
description:
|
|
41454
|
+
description:
|
|
41455
|
+
'ID of the user identity that you want to update.',
|
|
41169
41456
|
format: 'uuid',
|
|
41170
41457
|
type: 'string',
|
|
41171
41458
|
},
|
|
@@ -41213,6 +41500,8 @@ export default {
|
|
|
41213
41500
|
},
|
|
41214
41501
|
'/webhooks/create': {
|
|
41215
41502
|
post: {
|
|
41503
|
+
description:
|
|
41504
|
+
'Creates a new [webhook](https://docs.seam.co/latest/developer-tools/webhooks).',
|
|
41216
41505
|
operationId: 'webhooksCreatePost',
|
|
41217
41506
|
requestBody: {
|
|
41218
41507
|
content: {
|
|
@@ -41221,10 +41510,16 @@ export default {
|
|
|
41221
41510
|
properties: {
|
|
41222
41511
|
event_types: {
|
|
41223
41512
|
default: ['*'],
|
|
41513
|
+
description:
|
|
41514
|
+
'Types of events that you want the new webhook to receive.',
|
|
41224
41515
|
items: { type: 'string' },
|
|
41225
41516
|
type: 'array',
|
|
41226
41517
|
},
|
|
41227
|
-
url: {
|
|
41518
|
+
url: {
|
|
41519
|
+
description: 'URL for the new webhook.',
|
|
41520
|
+
format: 'uri',
|
|
41521
|
+
type: 'string',
|
|
41522
|
+
},
|
|
41228
41523
|
},
|
|
41229
41524
|
required: ['url'],
|
|
41230
41525
|
type: 'object',
|
|
@@ -41262,16 +41557,24 @@ export default {
|
|
|
41262
41557
|
'x-fern-sdk-method-name': 'create',
|
|
41263
41558
|
'x-fern-sdk-return-value': 'webhook',
|
|
41264
41559
|
'x-response-key': 'webhook',
|
|
41560
|
+
'x-title': 'Create a Webhook',
|
|
41265
41561
|
},
|
|
41266
41562
|
},
|
|
41267
41563
|
'/webhooks/delete': {
|
|
41268
41564
|
post: {
|
|
41565
|
+
description:
|
|
41566
|
+
'Deletes a specified [webhook](https://docs.seam.co/latest/developer-tools/webhooks).',
|
|
41269
41567
|
operationId: 'webhooksDeletePost',
|
|
41270
41568
|
requestBody: {
|
|
41271
41569
|
content: {
|
|
41272
41570
|
'application/json': {
|
|
41273
41571
|
schema: {
|
|
41274
|
-
properties: {
|
|
41572
|
+
properties: {
|
|
41573
|
+
webhook_id: {
|
|
41574
|
+
description: 'ID of the webhook that you want to delete.',
|
|
41575
|
+
type: 'string',
|
|
41576
|
+
},
|
|
41577
|
+
},
|
|
41275
41578
|
required: ['webhook_id'],
|
|
41276
41579
|
type: 'object',
|
|
41277
41580
|
},
|
|
@@ -41304,16 +41607,24 @@ export default {
|
|
|
41304
41607
|
'x-fern-sdk-group-name': ['webhooks'],
|
|
41305
41608
|
'x-fern-sdk-method-name': 'delete',
|
|
41306
41609
|
'x-response-key': null,
|
|
41610
|
+
'x-title': 'Delete a Webhook',
|
|
41307
41611
|
},
|
|
41308
41612
|
},
|
|
41309
41613
|
'/webhooks/get': {
|
|
41310
41614
|
post: {
|
|
41615
|
+
description:
|
|
41616
|
+
'Gets a specified [webhook](https://docs.seam.co/latest/developer-tools/webhooks).',
|
|
41311
41617
|
operationId: 'webhooksGetPost',
|
|
41312
41618
|
requestBody: {
|
|
41313
41619
|
content: {
|
|
41314
41620
|
'application/json': {
|
|
41315
41621
|
schema: {
|
|
41316
|
-
properties: {
|
|
41622
|
+
properties: {
|
|
41623
|
+
webhook_id: {
|
|
41624
|
+
description: 'ID of the webhook that you want to get.',
|
|
41625
|
+
type: 'string',
|
|
41626
|
+
},
|
|
41627
|
+
},
|
|
41317
41628
|
required: ['webhook_id'],
|
|
41318
41629
|
type: 'object',
|
|
41319
41630
|
},
|
|
@@ -41350,10 +41661,13 @@ export default {
|
|
|
41350
41661
|
'x-fern-sdk-method-name': 'get',
|
|
41351
41662
|
'x-fern-sdk-return-value': 'webhook',
|
|
41352
41663
|
'x-response-key': 'webhook',
|
|
41664
|
+
'x-title': 'Get a Webhook',
|
|
41353
41665
|
},
|
|
41354
41666
|
},
|
|
41355
41667
|
'/webhooks/list': {
|
|
41356
41668
|
get: {
|
|
41669
|
+
description:
|
|
41670
|
+
'Returns a list of all [webhooks](https://docs.seam.co/latest/developer-tools/webhooks).',
|
|
41357
41671
|
operationId: 'webhooksListGet',
|
|
41358
41672
|
responses: {
|
|
41359
41673
|
200: {
|
|
@@ -41386,8 +41700,11 @@ export default {
|
|
|
41386
41700
|
tags: ['/webhooks'],
|
|
41387
41701
|
'x-fern-ignore': true,
|
|
41388
41702
|
'x-response-key': 'webhooks',
|
|
41703
|
+
'x-title': 'List Webhooks',
|
|
41389
41704
|
},
|
|
41390
41705
|
post: {
|
|
41706
|
+
description:
|
|
41707
|
+
'Returns a list of all [webhooks](https://docs.seam.co/latest/developer-tools/webhooks).',
|
|
41391
41708
|
operationId: 'webhooksListPost',
|
|
41392
41709
|
responses: {
|
|
41393
41710
|
200: {
|
|
@@ -41422,18 +41739,29 @@ export default {
|
|
|
41422
41739
|
'x-fern-sdk-method-name': 'list',
|
|
41423
41740
|
'x-fern-sdk-return-value': 'webhooks',
|
|
41424
41741
|
'x-response-key': 'webhooks',
|
|
41742
|
+
'x-title': 'List Webhooks',
|
|
41425
41743
|
},
|
|
41426
41744
|
},
|
|
41427
41745
|
'/webhooks/update': {
|
|
41428
41746
|
post: {
|
|
41747
|
+
description:
|
|
41748
|
+
'Updates a specified [webhook](https://docs.seam.co/latest/developer-tools/webhooks).',
|
|
41429
41749
|
operationId: 'webhooksUpdatePost',
|
|
41430
41750
|
requestBody: {
|
|
41431
41751
|
content: {
|
|
41432
41752
|
'application/json': {
|
|
41433
41753
|
schema: {
|
|
41434
41754
|
properties: {
|
|
41435
|
-
event_types: {
|
|
41436
|
-
|
|
41755
|
+
event_types: {
|
|
41756
|
+
description:
|
|
41757
|
+
'Types of events that you want the webhook to receive.',
|
|
41758
|
+
items: { type: 'string' },
|
|
41759
|
+
type: 'array',
|
|
41760
|
+
},
|
|
41761
|
+
webhook_id: {
|
|
41762
|
+
description: 'ID of the webhook that you want to update.',
|
|
41763
|
+
type: 'string',
|
|
41764
|
+
},
|
|
41437
41765
|
},
|
|
41438
41766
|
required: ['webhook_id', 'event_types'],
|
|
41439
41767
|
type: 'object',
|
|
@@ -41467,16 +41795,27 @@ export default {
|
|
|
41467
41795
|
'x-fern-sdk-group-name': ['webhooks'],
|
|
41468
41796
|
'x-fern-sdk-method-name': 'update',
|
|
41469
41797
|
'x-response-key': null,
|
|
41798
|
+
'x-title': 'Update a Webhook',
|
|
41470
41799
|
},
|
|
41471
41800
|
put: {
|
|
41801
|
+
description:
|
|
41802
|
+
'Updates a specified [webhook](https://docs.seam.co/latest/developer-tools/webhooks).',
|
|
41472
41803
|
operationId: 'webhooksUpdatePut',
|
|
41473
41804
|
requestBody: {
|
|
41474
41805
|
content: {
|
|
41475
41806
|
'application/json': {
|
|
41476
41807
|
schema: {
|
|
41477
41808
|
properties: {
|
|
41478
|
-
event_types: {
|
|
41479
|
-
|
|
41809
|
+
event_types: {
|
|
41810
|
+
description:
|
|
41811
|
+
'Types of events that you want the webhook to receive.',
|
|
41812
|
+
items: { type: 'string' },
|
|
41813
|
+
type: 'array',
|
|
41814
|
+
},
|
|
41815
|
+
webhook_id: {
|
|
41816
|
+
description: 'ID of the webhook that you want to update.',
|
|
41817
|
+
type: 'string',
|
|
41818
|
+
},
|
|
41480
41819
|
},
|
|
41481
41820
|
required: ['webhook_id', 'event_types'],
|
|
41482
41821
|
type: 'object',
|
|
@@ -41509,41 +41848,72 @@ export default {
|
|
|
41509
41848
|
tags: ['/webhooks'],
|
|
41510
41849
|
'x-fern-ignore': true,
|
|
41511
41850
|
'x-response-key': null,
|
|
41851
|
+
'x-title': 'Update a Webhook',
|
|
41512
41852
|
},
|
|
41513
41853
|
},
|
|
41514
41854
|
'/workspaces/create': {
|
|
41515
41855
|
post: {
|
|
41856
|
+
description:
|
|
41857
|
+
'Creates a new [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
|
|
41516
41858
|
operationId: 'workspacesCreatePost',
|
|
41517
41859
|
requestBody: {
|
|
41518
41860
|
content: {
|
|
41519
41861
|
'application/json': {
|
|
41520
41862
|
schema: {
|
|
41521
41863
|
properties: {
|
|
41522
|
-
company_name: {
|
|
41864
|
+
company_name: {
|
|
41865
|
+
description: 'Company name for the new workspace.',
|
|
41866
|
+
type: 'string',
|
|
41867
|
+
},
|
|
41523
41868
|
connect_partner_name: {
|
|
41524
41869
|
deprecated: true,
|
|
41870
|
+
description: 'Connect partner name for the new workspace.',
|
|
41525
41871
|
nullable: true,
|
|
41526
41872
|
type: 'string',
|
|
41527
41873
|
'x-deprecated': 'use company_name',
|
|
41528
41874
|
},
|
|
41529
41875
|
connect_webview_customization: {
|
|
41876
|
+
description:
|
|
41877
|
+
'[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).',
|
|
41530
41878
|
properties: {
|
|
41531
41879
|
logo_shape: {
|
|
41880
|
+
description:
|
|
41881
|
+
'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).',
|
|
41532
41882
|
enum: ['circle', 'square'],
|
|
41533
41883
|
nullable: true,
|
|
41534
41884
|
type: 'string',
|
|
41535
41885
|
},
|
|
41536
|
-
primary_button_color: {
|
|
41886
|
+
primary_button_color: {
|
|
41887
|
+
description:
|
|
41888
|
+
'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).',
|
|
41889
|
+
nullable: true,
|
|
41890
|
+
type: 'string',
|
|
41891
|
+
},
|
|
41537
41892
|
primary_button_text_color: {
|
|
41893
|
+
description:
|
|
41894
|
+
'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).',
|
|
41895
|
+
nullable: true,
|
|
41896
|
+
type: 'string',
|
|
41897
|
+
},
|
|
41898
|
+
success_message: {
|
|
41899
|
+
description:
|
|
41900
|
+
'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).',
|
|
41538
41901
|
nullable: true,
|
|
41539
41902
|
type: 'string',
|
|
41540
41903
|
},
|
|
41541
|
-
success_message: { nullable: true, type: 'string' },
|
|
41542
41904
|
},
|
|
41543
41905
|
type: 'object',
|
|
41544
41906
|
},
|
|
41545
|
-
is_sandbox: {
|
|
41546
|
-
|
|
41907
|
+
is_sandbox: {
|
|
41908
|
+
default: false,
|
|
41909
|
+
description:
|
|
41910
|
+
'Indicates whether the new workspace is a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).',
|
|
41911
|
+
type: 'boolean',
|
|
41912
|
+
},
|
|
41913
|
+
name: {
|
|
41914
|
+
description: 'Name of the new workspace.',
|
|
41915
|
+
type: 'string',
|
|
41916
|
+
},
|
|
41547
41917
|
webview_logo_shape: {
|
|
41548
41918
|
deprecated: true,
|
|
41549
41919
|
enum: ['circle', 'square'],
|
|
@@ -41606,10 +41976,13 @@ export default {
|
|
|
41606
41976
|
'x-fern-sdk-method-name': 'create',
|
|
41607
41977
|
'x-fern-sdk-return-value': 'workspace',
|
|
41608
41978
|
'x-response-key': 'workspace',
|
|
41979
|
+
'x-title': 'Create a Workspace',
|
|
41609
41980
|
},
|
|
41610
41981
|
},
|
|
41611
41982
|
'/workspaces/get': {
|
|
41612
41983
|
get: {
|
|
41984
|
+
description:
|
|
41985
|
+
'Returns the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.',
|
|
41613
41986
|
operationId: 'workspacesGetGet',
|
|
41614
41987
|
responses: {
|
|
41615
41988
|
200: {
|
|
@@ -41634,14 +42007,18 @@ export default {
|
|
|
41634
42007
|
{ api_key: [] },
|
|
41635
42008
|
{ console_session_with_workspace: [] },
|
|
41636
42009
|
{ client_session: [] },
|
|
42010
|
+
{ client_session_with_customer: [] },
|
|
41637
42011
|
{ pat_with_workspace: [] },
|
|
41638
42012
|
],
|
|
41639
42013
|
summary: '/workspaces/get',
|
|
41640
42014
|
tags: ['/workspaces'],
|
|
41641
42015
|
'x-fern-ignore': true,
|
|
41642
42016
|
'x-response-key': 'workspace',
|
|
42017
|
+
'x-title': 'Get a Workspace',
|
|
41643
42018
|
},
|
|
41644
42019
|
post: {
|
|
42020
|
+
description:
|
|
42021
|
+
'Returns the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.',
|
|
41645
42022
|
operationId: 'workspacesGetPost',
|
|
41646
42023
|
responses: {
|
|
41647
42024
|
200: {
|
|
@@ -41666,6 +42043,7 @@ export default {
|
|
|
41666
42043
|
{ api_key: [] },
|
|
41667
42044
|
{ console_session_with_workspace: [] },
|
|
41668
42045
|
{ client_session: [] },
|
|
42046
|
+
{ client_session_with_customer: [] },
|
|
41669
42047
|
{ pat_with_workspace: [] },
|
|
41670
42048
|
],
|
|
41671
42049
|
summary: '/workspaces/get',
|
|
@@ -41674,10 +42052,13 @@ export default {
|
|
|
41674
42052
|
'x-fern-sdk-method-name': 'get',
|
|
41675
42053
|
'x-fern-sdk-return-value': 'workspace',
|
|
41676
42054
|
'x-response-key': 'workspace',
|
|
42055
|
+
'x-title': 'Get a Workspace',
|
|
41677
42056
|
},
|
|
41678
42057
|
},
|
|
41679
42058
|
'/workspaces/list': {
|
|
41680
42059
|
get: {
|
|
42060
|
+
description:
|
|
42061
|
+
'Returns a list of [workspaces](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.',
|
|
41681
42062
|
operationId: 'workspacesListGet',
|
|
41682
42063
|
responses: {
|
|
41683
42064
|
200: {
|
|
@@ -41713,8 +42094,11 @@ export default {
|
|
|
41713
42094
|
tags: ['/workspaces'],
|
|
41714
42095
|
'x-fern-ignore': true,
|
|
41715
42096
|
'x-response-key': 'workspaces',
|
|
42097
|
+
'x-title': 'List Workspaces',
|
|
41716
42098
|
},
|
|
41717
42099
|
post: {
|
|
42100
|
+
description:
|
|
42101
|
+
'Returns a list of [workspaces](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.',
|
|
41718
42102
|
operationId: 'workspacesListPost',
|
|
41719
42103
|
responses: {
|
|
41720
42104
|
200: {
|
|
@@ -41752,12 +42136,13 @@ export default {
|
|
|
41752
42136
|
'x-fern-sdk-method-name': 'list',
|
|
41753
42137
|
'x-fern-sdk-return-value': 'workspaces',
|
|
41754
42138
|
'x-response-key': 'workspaces',
|
|
42139
|
+
'x-title': 'List Workspaces',
|
|
41755
42140
|
},
|
|
41756
42141
|
},
|
|
41757
42142
|
'/workspaces/reset_sandbox': {
|
|
41758
42143
|
post: {
|
|
41759
42144
|
description:
|
|
41760
|
-
'Resets
|
|
42145
|
+
'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.',
|
|
41761
42146
|
operationId: 'workspacesResetSandboxPost',
|
|
41762
42147
|
responses: {
|
|
41763
42148
|
200: {
|
|
@@ -41792,35 +42177,64 @@ export default {
|
|
|
41792
42177
|
'x-fern-sdk-method-name': 'reset_sandbox',
|
|
41793
42178
|
'x-fern-sdk-return-value': 'action_attempt',
|
|
41794
42179
|
'x-response-key': 'action_attempt',
|
|
42180
|
+
'x-title': 'Reset a Sandbox Workspace',
|
|
41795
42181
|
},
|
|
41796
42182
|
},
|
|
41797
42183
|
'/workspaces/update': {
|
|
41798
42184
|
patch: {
|
|
42185
|
+
description:
|
|
42186
|
+
'Updates the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.',
|
|
41799
42187
|
operationId: 'workspacesUpdatePatch',
|
|
41800
42188
|
requestBody: {
|
|
41801
42189
|
content: {
|
|
41802
42190
|
'application/json': {
|
|
41803
42191
|
schema: {
|
|
41804
42192
|
properties: {
|
|
41805
|
-
connect_partner_name: {
|
|
42193
|
+
connect_partner_name: {
|
|
42194
|
+
description: 'Connect partner name for the workspace.',
|
|
42195
|
+
type: 'string',
|
|
42196
|
+
},
|
|
41806
42197
|
connect_webview_customization: {
|
|
42198
|
+
description:
|
|
42199
|
+
'[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).',
|
|
41807
42200
|
properties: {
|
|
41808
42201
|
logo_shape: {
|
|
42202
|
+
description:
|
|
42203
|
+
'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).',
|
|
41809
42204
|
enum: ['circle', 'square'],
|
|
41810
42205
|
nullable: true,
|
|
41811
42206
|
type: 'string',
|
|
41812
42207
|
},
|
|
41813
|
-
primary_button_color: {
|
|
42208
|
+
primary_button_color: {
|
|
42209
|
+
description:
|
|
42210
|
+
'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).',
|
|
42211
|
+
nullable: true,
|
|
42212
|
+
type: 'string',
|
|
42213
|
+
},
|
|
41814
42214
|
primary_button_text_color: {
|
|
42215
|
+
description:
|
|
42216
|
+
'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).',
|
|
42217
|
+
nullable: true,
|
|
42218
|
+
type: 'string',
|
|
42219
|
+
},
|
|
42220
|
+
success_message: {
|
|
42221
|
+
description:
|
|
42222
|
+
'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).',
|
|
41815
42223
|
nullable: true,
|
|
41816
42224
|
type: 'string',
|
|
41817
42225
|
},
|
|
41818
|
-
success_message: { nullable: true, type: 'string' },
|
|
41819
42226
|
},
|
|
41820
42227
|
type: 'object',
|
|
41821
42228
|
},
|
|
41822
|
-
is_suspended: {
|
|
41823
|
-
|
|
42229
|
+
is_suspended: {
|
|
42230
|
+
description:
|
|
42231
|
+
'Indicates whether the workspace is suspended.',
|
|
42232
|
+
type: 'boolean',
|
|
42233
|
+
},
|
|
42234
|
+
name: {
|
|
42235
|
+
description: 'Name of the workspace.',
|
|
42236
|
+
type: 'string',
|
|
42237
|
+
},
|
|
41824
42238
|
},
|
|
41825
42239
|
type: 'object',
|
|
41826
42240
|
},
|
|
@@ -41841,33 +42255,62 @@ export default {
|
|
|
41841
42255
|
tags: ['/workspaces'],
|
|
41842
42256
|
'x-fern-ignore': true,
|
|
41843
42257
|
'x-response-key': null,
|
|
42258
|
+
'x-title': 'Udpate a Workspace',
|
|
41844
42259
|
},
|
|
41845
42260
|
post: {
|
|
42261
|
+
description:
|
|
42262
|
+
'Updates the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.',
|
|
41846
42263
|
operationId: 'workspacesUpdatePost',
|
|
41847
42264
|
requestBody: {
|
|
41848
42265
|
content: {
|
|
41849
42266
|
'application/json': {
|
|
41850
42267
|
schema: {
|
|
41851
42268
|
properties: {
|
|
41852
|
-
connect_partner_name: {
|
|
42269
|
+
connect_partner_name: {
|
|
42270
|
+
description: 'Connect partner name for the workspace.',
|
|
42271
|
+
type: 'string',
|
|
42272
|
+
},
|
|
41853
42273
|
connect_webview_customization: {
|
|
42274
|
+
description:
|
|
42275
|
+
'[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).',
|
|
41854
42276
|
properties: {
|
|
41855
42277
|
logo_shape: {
|
|
42278
|
+
description:
|
|
42279
|
+
'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).',
|
|
41856
42280
|
enum: ['circle', 'square'],
|
|
41857
42281
|
nullable: true,
|
|
41858
42282
|
type: 'string',
|
|
41859
42283
|
},
|
|
41860
|
-
primary_button_color: {
|
|
42284
|
+
primary_button_color: {
|
|
42285
|
+
description:
|
|
42286
|
+
'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).',
|
|
42287
|
+
nullable: true,
|
|
42288
|
+
type: 'string',
|
|
42289
|
+
},
|
|
41861
42290
|
primary_button_text_color: {
|
|
42291
|
+
description:
|
|
42292
|
+
'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).',
|
|
42293
|
+
nullable: true,
|
|
42294
|
+
type: 'string',
|
|
42295
|
+
},
|
|
42296
|
+
success_message: {
|
|
42297
|
+
description:
|
|
42298
|
+
'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).',
|
|
41862
42299
|
nullable: true,
|
|
41863
42300
|
type: 'string',
|
|
41864
42301
|
},
|
|
41865
|
-
success_message: { nullable: true, type: 'string' },
|
|
41866
42302
|
},
|
|
41867
42303
|
type: 'object',
|
|
41868
42304
|
},
|
|
41869
|
-
is_suspended: {
|
|
41870
|
-
|
|
42305
|
+
is_suspended: {
|
|
42306
|
+
description:
|
|
42307
|
+
'Indicates whether the workspace is suspended.',
|
|
42308
|
+
type: 'boolean',
|
|
42309
|
+
},
|
|
42310
|
+
name: {
|
|
42311
|
+
description: 'Name of the workspace.',
|
|
42312
|
+
type: 'string',
|
|
42313
|
+
},
|
|
41871
42314
|
},
|
|
41872
42315
|
type: 'object',
|
|
41873
42316
|
},
|
|
@@ -41889,6 +42332,7 @@ export default {
|
|
|
41889
42332
|
'x-fern-sdk-group-name': ['workspaces'],
|
|
41890
42333
|
'x-fern-sdk-method-name': 'update',
|
|
41891
42334
|
'x-response-key': null,
|
|
42335
|
+
'x-title': 'Udpate a Workspace',
|
|
41892
42336
|
},
|
|
41893
42337
|
},
|
|
41894
42338
|
},
|