Back to Apitable

.SpaceSpaceApiApi

packages/api-client/SpaceSpaceApiApi.md

1.13.0-beta.120.2 KB
Original Source

.SpaceSpaceApiApi

All URIs are relative to http://backend/api/v1

MethodHTTP requestDescription
cancelPOST /space/cancel/{spaceId}Undo delete space
capacityGET /space/capacityGet space capacity info
create1POST /space/createCreate Space
delDELETE /space/delDelete space immediately
delete7DELETE /space/delete/{spaceId}Delete space
featureGET /space/featuresGet space feature
getCreditUsagesGET /space/{spaceId}/credit/chartGets message credit chart data for the space
getSpaceResourceGET /space/resourceGet user space resource
infoGET /space/info/{spaceId}Get space info
listGET /space/listGet space list
quitPOST /space/quit/{spaceId}Quit space
subscribeGET /space/subscribe/{spaceId}Gets subscription information for the space
switchSpacePOST /space/{spaceId}/switchswitch space
update1POST /space/updateUpdate space
updateSecuritySettingPOST /space/updateSecuritySettingUpdate security setting

cancel

ResponseDataVoid cancel()

Example

typescript
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));

Parameters

NameTypeDescriptionNotes
spaceId[string]space iddefaults to undefined

Return type

ResponseDataVoid

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

capacity

ResponseDataSpaceCapacityVO capacity()

Example

typescript
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));

Parameters

NameTypeDescriptionNotes
xSpaceId[string]space iddefaults to undefined

Return type

ResponseDataSpaceCapacityVO

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create1

ResponseDataCreateSpaceResultVo create1(spaceOpRo)

Example

typescript
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));

Parameters

NameTypeDescriptionNotes
spaceOpRoSpaceOpRo

Return type

ResponseDataCreateSpaceResultVo

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

del

ResponseDataVoid del()

Example

typescript
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));

Parameters

This endpoint does not need any parameter.

Return type

ResponseDataVoid

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete7

ResponseDataVoid delete7(spaceDeleteRo, )

Example

typescript
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));

Parameters

NameTypeDescriptionNotes
spaceDeleteRoSpaceDeleteRo
spaceId[string]space iddefaults to undefined

Return type

ResponseDataVoid

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

feature

ResponseDataSpaceGlobalFeature feature()

Example

typescript
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));

Parameters

NameTypeDescriptionNotes
xSpaceId[string]space iddefaults to undefined

Return type

ResponseDataSpaceGlobalFeature

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getCreditUsages

ResponseDataCreditUsages getCreditUsages()

Example

typescript
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));

Parameters

NameTypeDescriptionNotes
spaceId[string]space iddefaults to undefined
timeDimension[string](optional) defaults to 'WEEKDAY'

Return type

ResponseDataCreditUsages

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSpaceResource

ResponseDataUserSpaceVo getSpaceResource()

Example

typescript
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));

Parameters

NameTypeDescriptionNotes
xSpaceId[string]space iddefaults to undefined

Return type

ResponseDataUserSpaceVo

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

info

ResponseDataSpaceInfoVO info()

Example

typescript
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));

Parameters

NameTypeDescriptionNotes
spaceId[string]space iddefaults to undefined

Return type

ResponseDataSpaceInfoVO

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list

ResponseDataListSpaceVO list()

Example

typescript
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));

Parameters

NameTypeDescriptionNotes
onlyManageable[boolean]Whether to query only the managed space list. By default, not include(optional) defaults to undefined

Return type

ResponseDataListSpaceVO

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

quit

ResponseDataVoid quit()

Example

typescript
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));

Parameters

NameTypeDescriptionNotes
spaceId[string]space iddefaults to undefined

Return type

ResponseDataVoid

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

subscribe

ResponseDataSpaceSubscribeVo subscribe()

Example

typescript
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));

Parameters

NameTypeDescriptionNotes
spaceId[string]space iddefaults to undefined

Return type

ResponseDataSpaceSubscribeVo

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

switchSpace

ResponseDataVoid switchSpace()

Example

typescript
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));

Parameters

NameTypeDescriptionNotes
spaceId[string]space iddefaults to undefined

Return type

ResponseDataVoid

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update1

ResponseDataVoid update1(spaceUpdateOpRo, )

at least one item is name and logo

Example

typescript
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));

Parameters

NameTypeDescriptionNotes
spaceUpdateOpRoSpaceUpdateOpRo
xSpaceId[string]space iddefaults to undefined

Return type

ResponseDataVoid

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateSecuritySetting

ResponseDataVoid updateSecuritySetting(spaceSecuritySettingRo, )

Example

typescript
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));

Parameters

NameTypeDescriptionNotes
spaceSecuritySettingRoSpaceSecuritySettingRo
xSpaceId[string]space iddefaults to undefined

Return type

ResponseDataVoid

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]