@seamapi/types 1.896.0 → 1.898.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 +411 -0
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +166 -0
- package/dist/index.cjs +411 -0
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/openapi.js +411 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +166 -0
- package/package.json +1 -1
- package/src/lib/seam/connect/openapi.ts +421 -0
- package/src/lib/seam/connect/route-types.ts +172 -0
|
@@ -59724,6 +59724,395 @@ const openapi = {
|
|
|
59724
59724
|
'x-undocumented': 'Internal endpoint for Console',
|
|
59725
59725
|
},
|
|
59726
59726
|
},
|
|
59727
|
+
'/seam/console/v1/sites/create': {
|
|
59728
|
+
post: {
|
|
59729
|
+
description: 'Creates a new site, a top-level space in the property hierarchy.',
|
|
59730
|
+
operationId: 'seamConsoleV1SitesCreatePost',
|
|
59731
|
+
requestBody: {
|
|
59732
|
+
content: {
|
|
59733
|
+
'application/json': {
|
|
59734
|
+
schema: {
|
|
59735
|
+
properties: {
|
|
59736
|
+
name: {
|
|
59737
|
+
description: 'Name of the site that you want to create.',
|
|
59738
|
+
type: 'string',
|
|
59739
|
+
},
|
|
59740
|
+
site_key: {
|
|
59741
|
+
description: 'Unique key for the site within the workspace.',
|
|
59742
|
+
type: 'string',
|
|
59743
|
+
},
|
|
59744
|
+
},
|
|
59745
|
+
required: ['name'],
|
|
59746
|
+
type: 'object',
|
|
59747
|
+
},
|
|
59748
|
+
},
|
|
59749
|
+
},
|
|
59750
|
+
},
|
|
59751
|
+
responses: {
|
|
59752
|
+
200: {
|
|
59753
|
+
content: {
|
|
59754
|
+
'application/json': {
|
|
59755
|
+
schema: {
|
|
59756
|
+
properties: {
|
|
59757
|
+
ok: { type: 'boolean' },
|
|
59758
|
+
site: { $ref: '#/components/schemas/space' },
|
|
59759
|
+
},
|
|
59760
|
+
required: ['site', 'ok'],
|
|
59761
|
+
type: 'object',
|
|
59762
|
+
},
|
|
59763
|
+
},
|
|
59764
|
+
},
|
|
59765
|
+
description: 'OK',
|
|
59766
|
+
},
|
|
59767
|
+
400: { description: 'Bad Request' },
|
|
59768
|
+
401: { description: 'Unauthorized' },
|
|
59769
|
+
},
|
|
59770
|
+
security: [
|
|
59771
|
+
{ pat_with_workspace: [] },
|
|
59772
|
+
{ console_session_with_workspace: [] },
|
|
59773
|
+
{ api_key: [] },
|
|
59774
|
+
],
|
|
59775
|
+
summary: '/seam/console/v1/sites/create',
|
|
59776
|
+
tags: [],
|
|
59777
|
+
'x-fern-sdk-group-name': ['seam', 'console', 'v1', 'sites'],
|
|
59778
|
+
'x-fern-sdk-method-name': 'create',
|
|
59779
|
+
'x-fern-sdk-return-value': 'site',
|
|
59780
|
+
'x-response-key': 'site',
|
|
59781
|
+
'x-title': 'Create a Site',
|
|
59782
|
+
'x-undocumented': 'Internal endpoint for Console',
|
|
59783
|
+
},
|
|
59784
|
+
},
|
|
59785
|
+
'/seam/console/v1/sites/delete': {
|
|
59786
|
+
delete: {
|
|
59787
|
+
description: 'Deletes a site.',
|
|
59788
|
+
operationId: 'seamConsoleV1SitesDeleteDelete',
|
|
59789
|
+
requestBody: {
|
|
59790
|
+
content: {
|
|
59791
|
+
'application/json': {
|
|
59792
|
+
schema: {
|
|
59793
|
+
properties: {
|
|
59794
|
+
site_id: {
|
|
59795
|
+
description: 'ID of the site that you want to delete.',
|
|
59796
|
+
format: 'uuid',
|
|
59797
|
+
type: 'string',
|
|
59798
|
+
},
|
|
59799
|
+
},
|
|
59800
|
+
required: ['site_id'],
|
|
59801
|
+
type: 'object',
|
|
59802
|
+
},
|
|
59803
|
+
},
|
|
59804
|
+
},
|
|
59805
|
+
},
|
|
59806
|
+
responses: {
|
|
59807
|
+
200: {
|
|
59808
|
+
content: {
|
|
59809
|
+
'application/json': {
|
|
59810
|
+
schema: {
|
|
59811
|
+
properties: { ok: { type: 'boolean' } },
|
|
59812
|
+
required: ['ok'],
|
|
59813
|
+
type: 'object',
|
|
59814
|
+
},
|
|
59815
|
+
},
|
|
59816
|
+
},
|
|
59817
|
+
description: 'OK',
|
|
59818
|
+
},
|
|
59819
|
+
400: { description: 'Bad Request' },
|
|
59820
|
+
401: { description: 'Unauthorized' },
|
|
59821
|
+
},
|
|
59822
|
+
security: [
|
|
59823
|
+
{ pat_with_workspace: [] },
|
|
59824
|
+
{ console_session_with_workspace: [] },
|
|
59825
|
+
{ api_key: [] },
|
|
59826
|
+
],
|
|
59827
|
+
summary: '/seam/console/v1/sites/delete',
|
|
59828
|
+
tags: [],
|
|
59829
|
+
'x-fern-sdk-group-name': ['seam', 'console', 'v1', 'sites'],
|
|
59830
|
+
'x-fern-sdk-method-name': 'delete',
|
|
59831
|
+
'x-response-key': null,
|
|
59832
|
+
'x-title': 'Delete a Site',
|
|
59833
|
+
'x-undocumented': 'Internal endpoint for Console',
|
|
59834
|
+
},
|
|
59835
|
+
post: {
|
|
59836
|
+
description: 'Deletes a site.',
|
|
59837
|
+
operationId: 'seamConsoleV1SitesDeletePost',
|
|
59838
|
+
requestBody: {
|
|
59839
|
+
content: {
|
|
59840
|
+
'application/json': {
|
|
59841
|
+
schema: {
|
|
59842
|
+
properties: {
|
|
59843
|
+
site_id: {
|
|
59844
|
+
description: 'ID of the site that you want to delete.',
|
|
59845
|
+
format: 'uuid',
|
|
59846
|
+
type: 'string',
|
|
59847
|
+
},
|
|
59848
|
+
},
|
|
59849
|
+
required: ['site_id'],
|
|
59850
|
+
type: 'object',
|
|
59851
|
+
},
|
|
59852
|
+
},
|
|
59853
|
+
},
|
|
59854
|
+
},
|
|
59855
|
+
responses: {
|
|
59856
|
+
200: {
|
|
59857
|
+
content: {
|
|
59858
|
+
'application/json': {
|
|
59859
|
+
schema: {
|
|
59860
|
+
properties: { ok: { type: 'boolean' } },
|
|
59861
|
+
required: ['ok'],
|
|
59862
|
+
type: 'object',
|
|
59863
|
+
},
|
|
59864
|
+
},
|
|
59865
|
+
},
|
|
59866
|
+
description: 'OK',
|
|
59867
|
+
},
|
|
59868
|
+
400: { description: 'Bad Request' },
|
|
59869
|
+
401: { description: 'Unauthorized' },
|
|
59870
|
+
},
|
|
59871
|
+
security: [
|
|
59872
|
+
{ pat_with_workspace: [] },
|
|
59873
|
+
{ console_session_with_workspace: [] },
|
|
59874
|
+
{ api_key: [] },
|
|
59875
|
+
],
|
|
59876
|
+
summary: '/seam/console/v1/sites/delete',
|
|
59877
|
+
tags: [],
|
|
59878
|
+
'x-fern-sdk-group-name': ['seam', 'console', 'v1', 'sites'],
|
|
59879
|
+
'x-fern-sdk-method-name': 'delete',
|
|
59880
|
+
'x-response-key': null,
|
|
59881
|
+
'x-title': 'Delete a Site',
|
|
59882
|
+
'x-undocumented': 'Internal endpoint for Console',
|
|
59883
|
+
},
|
|
59884
|
+
},
|
|
59885
|
+
'/seam/console/v1/sites/list': {
|
|
59886
|
+
get: {
|
|
59887
|
+
description: 'Lists sites (top-level spaces) in the workspace.',
|
|
59888
|
+
operationId: 'seamConsoleV1SitesListGet',
|
|
59889
|
+
parameters: [
|
|
59890
|
+
{
|
|
59891
|
+
in: 'query',
|
|
59892
|
+
name: 'search',
|
|
59893
|
+
schema: {
|
|
59894
|
+
description: 'String for which to search. Filters sites to those with a partial match on `name` or `site_key`.',
|
|
59895
|
+
minLength: 1,
|
|
59896
|
+
type: 'string',
|
|
59897
|
+
},
|
|
59898
|
+
},
|
|
59899
|
+
],
|
|
59900
|
+
responses: {
|
|
59901
|
+
200: {
|
|
59902
|
+
content: {
|
|
59903
|
+
'application/json': {
|
|
59904
|
+
schema: {
|
|
59905
|
+
properties: {
|
|
59906
|
+
ok: { type: 'boolean' },
|
|
59907
|
+
sites: {
|
|
59908
|
+
items: { $ref: '#/components/schemas/space' },
|
|
59909
|
+
type: 'array',
|
|
59910
|
+
},
|
|
59911
|
+
},
|
|
59912
|
+
required: ['sites', 'ok'],
|
|
59913
|
+
type: 'object',
|
|
59914
|
+
},
|
|
59915
|
+
},
|
|
59916
|
+
},
|
|
59917
|
+
description: 'OK',
|
|
59918
|
+
},
|
|
59919
|
+
400: { description: 'Bad Request' },
|
|
59920
|
+
401: { description: 'Unauthorized' },
|
|
59921
|
+
},
|
|
59922
|
+
security: [
|
|
59923
|
+
{ pat_with_workspace: [] },
|
|
59924
|
+
{ console_session_with_workspace: [] },
|
|
59925
|
+
{ api_key: [] },
|
|
59926
|
+
],
|
|
59927
|
+
summary: '/seam/console/v1/sites/list',
|
|
59928
|
+
tags: [],
|
|
59929
|
+
'x-fern-sdk-group-name': ['seam', 'console', 'v1', 'sites'],
|
|
59930
|
+
'x-fern-sdk-method-name': 'list',
|
|
59931
|
+
'x-fern-sdk-return-value': 'sites',
|
|
59932
|
+
'x-response-key': 'sites',
|
|
59933
|
+
'x-title': 'List Sites',
|
|
59934
|
+
'x-undocumented': 'Internal endpoint for Console',
|
|
59935
|
+
},
|
|
59936
|
+
post: {
|
|
59937
|
+
description: 'Lists sites (top-level spaces) in the workspace.',
|
|
59938
|
+
operationId: 'seamConsoleV1SitesListPost',
|
|
59939
|
+
requestBody: {
|
|
59940
|
+
content: {
|
|
59941
|
+
'application/json': {
|
|
59942
|
+
schema: {
|
|
59943
|
+
properties: {
|
|
59944
|
+
search: {
|
|
59945
|
+
description: 'String for which to search. Filters sites to those with a partial match on `name` or `site_key`.',
|
|
59946
|
+
minLength: 1,
|
|
59947
|
+
type: 'string',
|
|
59948
|
+
},
|
|
59949
|
+
},
|
|
59950
|
+
type: 'object',
|
|
59951
|
+
},
|
|
59952
|
+
},
|
|
59953
|
+
},
|
|
59954
|
+
},
|
|
59955
|
+
responses: {
|
|
59956
|
+
200: {
|
|
59957
|
+
content: {
|
|
59958
|
+
'application/json': {
|
|
59959
|
+
schema: {
|
|
59960
|
+
properties: {
|
|
59961
|
+
ok: { type: 'boolean' },
|
|
59962
|
+
sites: {
|
|
59963
|
+
items: { $ref: '#/components/schemas/space' },
|
|
59964
|
+
type: 'array',
|
|
59965
|
+
},
|
|
59966
|
+
},
|
|
59967
|
+
required: ['sites', 'ok'],
|
|
59968
|
+
type: 'object',
|
|
59969
|
+
},
|
|
59970
|
+
},
|
|
59971
|
+
},
|
|
59972
|
+
description: 'OK',
|
|
59973
|
+
},
|
|
59974
|
+
400: { description: 'Bad Request' },
|
|
59975
|
+
401: { description: 'Unauthorized' },
|
|
59976
|
+
},
|
|
59977
|
+
security: [
|
|
59978
|
+
{ pat_with_workspace: [] },
|
|
59979
|
+
{ console_session_with_workspace: [] },
|
|
59980
|
+
{ api_key: [] },
|
|
59981
|
+
],
|
|
59982
|
+
summary: '/seam/console/v1/sites/list',
|
|
59983
|
+
tags: [],
|
|
59984
|
+
'x-fern-sdk-group-name': ['seam', 'console', 'v1', 'sites'],
|
|
59985
|
+
'x-fern-sdk-method-name': 'list',
|
|
59986
|
+
'x-fern-sdk-return-value': 'sites',
|
|
59987
|
+
'x-response-key': 'sites',
|
|
59988
|
+
'x-title': 'List Sites',
|
|
59989
|
+
'x-undocumented': 'Internal endpoint for Console',
|
|
59990
|
+
},
|
|
59991
|
+
},
|
|
59992
|
+
'/seam/console/v1/sites/update': {
|
|
59993
|
+
patch: {
|
|
59994
|
+
description: 'Updates an existing site.',
|
|
59995
|
+
operationId: 'seamConsoleV1SitesUpdatePatch',
|
|
59996
|
+
requestBody: {
|
|
59997
|
+
content: {
|
|
59998
|
+
'application/json': {
|
|
59999
|
+
schema: {
|
|
60000
|
+
properties: {
|
|
60001
|
+
name: {
|
|
60002
|
+
description: 'New name for the site.',
|
|
60003
|
+
type: 'string',
|
|
60004
|
+
},
|
|
60005
|
+
site_id: {
|
|
60006
|
+
description: 'ID of the site that you want to update.',
|
|
60007
|
+
format: 'uuid',
|
|
60008
|
+
type: 'string',
|
|
60009
|
+
},
|
|
60010
|
+
site_key: {
|
|
60011
|
+
description: 'New unique key for the site within the workspace.',
|
|
60012
|
+
type: 'string',
|
|
60013
|
+
},
|
|
60014
|
+
},
|
|
60015
|
+
required: ['site_id'],
|
|
60016
|
+
type: 'object',
|
|
60017
|
+
},
|
|
60018
|
+
},
|
|
60019
|
+
},
|
|
60020
|
+
},
|
|
60021
|
+
responses: {
|
|
60022
|
+
200: {
|
|
60023
|
+
content: {
|
|
60024
|
+
'application/json': {
|
|
60025
|
+
schema: {
|
|
60026
|
+
properties: {
|
|
60027
|
+
ok: { type: 'boolean' },
|
|
60028
|
+
site: { $ref: '#/components/schemas/space' },
|
|
60029
|
+
},
|
|
60030
|
+
required: ['site', 'ok'],
|
|
60031
|
+
type: 'object',
|
|
60032
|
+
},
|
|
60033
|
+
},
|
|
60034
|
+
},
|
|
60035
|
+
description: 'OK',
|
|
60036
|
+
},
|
|
60037
|
+
400: { description: 'Bad Request' },
|
|
60038
|
+
401: { description: 'Unauthorized' },
|
|
60039
|
+
},
|
|
60040
|
+
security: [
|
|
60041
|
+
{ pat_with_workspace: [] },
|
|
60042
|
+
{ console_session_with_workspace: [] },
|
|
60043
|
+
{ api_key: [] },
|
|
60044
|
+
],
|
|
60045
|
+
summary: '/seam/console/v1/sites/update',
|
|
60046
|
+
tags: [],
|
|
60047
|
+
'x-fern-sdk-group-name': ['seam', 'console', 'v1', 'sites'],
|
|
60048
|
+
'x-fern-sdk-method-name': 'update',
|
|
60049
|
+
'x-fern-sdk-return-value': 'site',
|
|
60050
|
+
'x-response-key': 'site',
|
|
60051
|
+
'x-title': 'Update a Site',
|
|
60052
|
+
'x-undocumented': 'Internal endpoint for Console',
|
|
60053
|
+
},
|
|
60054
|
+
post: {
|
|
60055
|
+
description: 'Updates an existing site.',
|
|
60056
|
+
operationId: 'seamConsoleV1SitesUpdatePost',
|
|
60057
|
+
requestBody: {
|
|
60058
|
+
content: {
|
|
60059
|
+
'application/json': {
|
|
60060
|
+
schema: {
|
|
60061
|
+
properties: {
|
|
60062
|
+
name: {
|
|
60063
|
+
description: 'New name for the site.',
|
|
60064
|
+
type: 'string',
|
|
60065
|
+
},
|
|
60066
|
+
site_id: {
|
|
60067
|
+
description: 'ID of the site that you want to update.',
|
|
60068
|
+
format: 'uuid',
|
|
60069
|
+
type: 'string',
|
|
60070
|
+
},
|
|
60071
|
+
site_key: {
|
|
60072
|
+
description: 'New unique key for the site within the workspace.',
|
|
60073
|
+
type: 'string',
|
|
60074
|
+
},
|
|
60075
|
+
},
|
|
60076
|
+
required: ['site_id'],
|
|
60077
|
+
type: 'object',
|
|
60078
|
+
},
|
|
60079
|
+
},
|
|
60080
|
+
},
|
|
60081
|
+
},
|
|
60082
|
+
responses: {
|
|
60083
|
+
200: {
|
|
60084
|
+
content: {
|
|
60085
|
+
'application/json': {
|
|
60086
|
+
schema: {
|
|
60087
|
+
properties: {
|
|
60088
|
+
ok: { type: 'boolean' },
|
|
60089
|
+
site: { $ref: '#/components/schemas/space' },
|
|
60090
|
+
},
|
|
60091
|
+
required: ['site', 'ok'],
|
|
60092
|
+
type: 'object',
|
|
60093
|
+
},
|
|
60094
|
+
},
|
|
60095
|
+
},
|
|
60096
|
+
description: 'OK',
|
|
60097
|
+
},
|
|
60098
|
+
400: { description: 'Bad Request' },
|
|
60099
|
+
401: { description: 'Unauthorized' },
|
|
60100
|
+
},
|
|
60101
|
+
security: [
|
|
60102
|
+
{ pat_with_workspace: [] },
|
|
60103
|
+
{ console_session_with_workspace: [] },
|
|
60104
|
+
{ api_key: [] },
|
|
60105
|
+
],
|
|
60106
|
+
summary: '/seam/console/v1/sites/update',
|
|
60107
|
+
tags: [],
|
|
60108
|
+
'x-fern-sdk-group-name': ['seam', 'console', 'v1', 'sites'],
|
|
60109
|
+
'x-fern-sdk-method-name': 'update',
|
|
60110
|
+
'x-fern-sdk-return-value': 'site',
|
|
60111
|
+
'x-response-key': 'site',
|
|
60112
|
+
'x-title': 'Update a Site',
|
|
60113
|
+
'x-undocumented': 'Internal endpoint for Console',
|
|
60114
|
+
},
|
|
60115
|
+
},
|
|
59727
60116
|
'/seam/console/v1/timelines/get': {
|
|
59728
60117
|
get: {
|
|
59729
60118
|
description: 'Returns timeline entries for a resource and its child resources, grouped by entry groups.',
|
|
@@ -72541,6 +72930,17 @@ const openapi = {
|
|
|
72541
72930
|
type: 'array',
|
|
72542
72931
|
},
|
|
72543
72932
|
name: { description: 'Name of the space.', type: 'string' },
|
|
72933
|
+
parent_space_id: {
|
|
72934
|
+
description: 'Reassign this space to the parent space (site) with this `parent_space_id`.',
|
|
72935
|
+
format: 'uuid',
|
|
72936
|
+
type: 'string',
|
|
72937
|
+
'x-undocumented': 'Only used internally.',
|
|
72938
|
+
},
|
|
72939
|
+
parent_space_key: {
|
|
72940
|
+
description: 'Reassign this space to the parent space (site) with this `parent_space_key`.',
|
|
72941
|
+
type: 'string',
|
|
72942
|
+
'x-undocumented': 'Only used internally.',
|
|
72943
|
+
},
|
|
72544
72944
|
space_id: {
|
|
72545
72945
|
description: 'ID of the space that you want to update.',
|
|
72546
72946
|
format: 'uuid',
|
|
@@ -72631,6 +73031,17 @@ const openapi = {
|
|
|
72631
73031
|
type: 'array',
|
|
72632
73032
|
},
|
|
72633
73033
|
name: { description: 'Name of the space.', type: 'string' },
|
|
73034
|
+
parent_space_id: {
|
|
73035
|
+
description: 'Reassign this space to the parent space (site) with this `parent_space_id`.',
|
|
73036
|
+
format: 'uuid',
|
|
73037
|
+
type: 'string',
|
|
73038
|
+
'x-undocumented': 'Only used internally.',
|
|
73039
|
+
},
|
|
73040
|
+
parent_space_key: {
|
|
73041
|
+
description: 'Reassign this space to the parent space (site) with this `parent_space_key`.',
|
|
73042
|
+
type: 'string',
|
|
73043
|
+
'x-undocumented': 'Only used internally.',
|
|
73044
|
+
},
|
|
72634
73045
|
space_id: {
|
|
72635
73046
|
description: 'ID of the space that you want to update.',
|
|
72636
73047
|
format: 'uuid',
|