packages/api-client/SpaceSpaceApiApi.md
All URIs are relative to http://backend/api/v1
| Method | HTTP request | Description |
|---|---|---|
| cancel | POST /space/cancel/{spaceId} | Undo delete space |
| capacity | GET /space/capacity | Get space capacity info |
| create1 | POST /space/create | Create Space |
| del | DELETE /space/del | Delete space immediately |
| delete7 | DELETE /space/delete/{spaceId} | Delete space |
| feature | GET /space/features | Get space feature |
| getCreditUsages | GET /space/{spaceId}/credit/chart | Gets message credit chart data for the space |
| getSpaceResource | GET /space/resource | Get user space resource |
| info | GET /space/info/{spaceId} | Get space info |
| list | GET /space/list | Get space list |
| quit | POST /space/quit/{spaceId} | Quit space |
| subscribe | GET /space/subscribe/{spaceId} | Gets subscription information for the space |
| switchSpace | POST /space/{spaceId}/switch | switch space |
| update1 | POST /space/update | Update space |
| updateSecuritySetting | POST /space/updateSecuritySetting | Update security setting |
ResponseDataVoid cancel()
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .SpaceSpaceApiApi(configuration);
let body:.SpaceSpaceApiApiCancelRequest = {
// string | space id
spaceId: "spc8mXUeiXyVo",
};
apiInstance.cancel(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| spaceId | [string] | space id | defaults to undefined |
ResponseDataVoid
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataSpaceCapacityVO capacity()
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .SpaceSpaceApiApi(configuration);
let body:.SpaceSpaceApiApiCapacityRequest = {
// string | space id
xSpaceId: "spczJrh2i3tLW",
};
apiInstance.capacity(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| xSpaceId | [string] | space id | defaults to undefined |
ResponseDataSpaceCapacityVO
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataCreateSpaceResultVo create1(spaceOpRo)
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .SpaceSpaceApiApi(configuration);
let body:.SpaceSpaceApiApiCreate1Request = {
// SpaceOpRo
spaceOpRo: {
name: "This is a space",
},
};
apiInstance.create1(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| spaceOpRo | SpaceOpRo |
ResponseDataCreateSpaceResultVo
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataVoid del()
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .SpaceSpaceApiApi(configuration);
let body:any = {};
apiInstance.del(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
This endpoint does not need any parameter.
ResponseDataVoid
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataVoid delete7(spaceDeleteRo, )
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .SpaceSpaceApiApi(configuration);
let body:.SpaceSpaceApiApiDelete7Request = {
// SpaceDeleteRo
spaceDeleteRo: {
type: "sms_code",
code: "123456",
},
// string | space id
spaceId: "spc8mXUeiXyVo",
};
apiInstance.delete7(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| spaceDeleteRo | SpaceDeleteRo | ||
| spaceId | [string] | space id | defaults to undefined |
ResponseDataVoid
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataSpaceGlobalFeature feature()
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .SpaceSpaceApiApi(configuration);
let body:.SpaceSpaceApiApiFeatureRequest = {
// string | space id
xSpaceId: "spcyQkKp9XJEl",
};
apiInstance.feature(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| xSpaceId | [string] | space id | defaults to undefined |
ResponseDataSpaceGlobalFeature
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataCreditUsages getCreditUsages()
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .SpaceSpaceApiApi(configuration);
let body:.SpaceSpaceApiApiGetCreditUsagesRequest = {
// string | space id
spaceId: "spc8mXUeiXyVo",
// string (optional)
timeDimension: "WEEKDAY",
};
apiInstance.getCreditUsages(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| spaceId | [string] | space id | defaults to undefined |
| timeDimension | [string] | (optional) defaults to 'WEEKDAY' |
ResponseDataCreditUsages
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataUserSpaceVo getSpaceResource()
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .SpaceSpaceApiApi(configuration);
let body:.SpaceSpaceApiApiGetSpaceResourceRequest = {
// string | space id
xSpaceId: "spcyQkKp9XJEl",
};
apiInstance.getSpaceResource(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| xSpaceId | [string] | space id | defaults to undefined |
ResponseDataUserSpaceVo
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataSpaceInfoVO info()
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .SpaceSpaceApiApi(configuration);
let body:.SpaceSpaceApiApiInfoRequest = {
// string | space id
spaceId: "spc8mXUeiXyVo",
};
apiInstance.info(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| spaceId | [string] | space id | defaults to undefined |
ResponseDataSpaceInfoVO
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataListSpaceVO list()
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .SpaceSpaceApiApi(configuration);
let body:.SpaceSpaceApiApiListRequest = {
// boolean | Whether to query only the managed space list. By default, not include (optional)
onlyManageable: true,
};
apiInstance.list(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| onlyManageable | [boolean] | Whether to query only the managed space list. By default, not include | (optional) defaults to undefined |
ResponseDataListSpaceVO
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataVoid quit()
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .SpaceSpaceApiApi(configuration);
let body:.SpaceSpaceApiApiQuitRequest = {
// string | space id
spaceId: "spc8mXUeiXyVo",
};
apiInstance.quit(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| spaceId | [string] | space id | defaults to undefined |
ResponseDataVoid
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataSpaceSubscribeVo subscribe()
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .SpaceSpaceApiApi(configuration);
let body:.SpaceSpaceApiApiSubscribeRequest = {
// string | space id
spaceId: "spc8mXUeiXyVo",
};
apiInstance.subscribe(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| spaceId | [string] | space id | defaults to undefined |
ResponseDataSpaceSubscribeVo
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataVoid switchSpace()
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .SpaceSpaceApiApi(configuration);
let body:.SpaceSpaceApiApiSwitchSpaceRequest = {
// string | space id
spaceId: "spc8mXUeiXyVo",
};
apiInstance.switchSpace(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| spaceId | [string] | space id | defaults to undefined |
ResponseDataVoid
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataVoid update1(spaceUpdateOpRo, )
at least one item is name and logo
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .SpaceSpaceApiApi(configuration);
let body:.SpaceSpaceApiApiUpdate1Request = {
// SpaceUpdateOpRo
spaceUpdateOpRo: {
name: "This is a new space name",
logo: "https://...",
},
// string | space id
xSpaceId: "spcyQkKp9XJEl",
};
apiInstance.update1(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| spaceUpdateOpRo | SpaceUpdateOpRo | ||
| xSpaceId | [string] | space id | defaults to undefined |
ResponseDataVoid
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataVoid updateSecuritySetting(spaceSecuritySettingRo, )
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .SpaceSpaceApiApi(configuration);
let body:.SpaceSpaceApiApiUpdateSecuritySettingRequest = {
// SpaceSecuritySettingRo
spaceSecuritySettingRo: {
fileSharable: true,
invitable: true,
joinable: false,
allowDownloadAttachment: true,
allowCopyDataToExternal: true,
mobileShowable: false,
watermarkEnable: false,
exportLevel: 2,
orgIsolated: false,
rootManageable: false,
},
// string | space id
xSpaceId: "spczJrh2i3tLW",
};
apiInstance.updateSecuritySetting(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| spaceSecuritySettingRo | SpaceSecuritySettingRo | ||
| xSpaceId | [string] | space id | defaults to undefined |
ResponseDataVoid
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]