SpaceService - gws_core

Attributes

AUTH_API_KEY_HEADER_PREFIX: strAUTH_HEADER_KEY: strUSER_ID_HEADER_KEY: str

Functions

__INIT__

Constructor of the SpaceService

Otherwise the current user is used for authentication, defaults to None

Parameters:

Name	Type	Default value	Description
access_token	`Optional`		If access token is provided, it is used to authenticate. [str], optional

ADD_OR_REPLACE_TAGS_ON_OBJECT

Call the space api to create a child folder

Parameters:

Name	Type	Default value	Description
entity_id	`str`
tags	`List`

Return type:

List

ADD_TAGS_TO_OBJECT

Call the space api to create a child folder

Parameters:

Name	Type	Default value	Description
entity_id	`str`
tags	`List`

Return type:

List

CHECK_2_FA

Check the credential of an email/password by calling space and return true if ok

Parameters:

Name	Type	Default value	Description
credentials	`UserCredentials2Fa`

Return type:

UserSpace

CHECK_API_KEY

Parameters:

Name	Type	Default value	Description
api_key	`str`

Return type:

bool

CHECK_CREDENTIALS

Check the credential of an email/password by calling space, with 2Fa if needed

Parameters:

Name	Type	Default value	Description
credentials	`UserCredentialsDTO`
for_login	`bool`	True

Return type:

ExternalCheckCredentialResponse

CREATE_CHILD_FOLDER

Call the space api to create a child folder

Parameters:

Name	Type	Default value	Description
parent_id	`str`
folder	`ExternalSpaceCreateFolder`

Return type:

ExternalSpaceFolder

CREATE_ROOT_FOLDER

Call the space api to create a root folder

Parameters:

Name	Type	Default value	Description
folder	`ExternalSpaceCreateFolder`

Return type:

ExternalSpaceFolder

DELETE_NOTE

Parameters:

Name	Type	Default value	Description
folder_id	`str`
note_id	`str`

DELETE_SCENARIO

Parameters:

Name	Type	Default value	Description
folder_id	`str`
scenario_id	`str`

DELETE_TAGS_ON_OBJECT

Call the space api to create a child folder

Parameters:

Name	Type	Default value	Description
entity_id	`str`
tags	`List`

GET_ALL_LAB_FOLDERS

Call the space api to get the list of folder for this lab

Return type:

ExternalSpaceFolders

GET_ALL_LAB_USERS

Call the space api to get the list of users for this lab

Return type:

List

GET_LAB_ROOT_FOLDER

Call the space api to get the a folder for this lab

Parameters:

Name	Type	Default value	Description
id_	`str`

Return type:

ExternalSpaceFolder

GET_MODIFICATIONS

Parameters:

Name	Type	Default value	Description
old_content	`RichTextDTO`
new_content	`RichTextDTO`
old_modifications	`Optional`

Return type:

RichTextModificationsDTO

GET_UNDO_CONTENT

Parameters:

Name	Type	Default value	Description
content	`RichTextDTO`
modifications	`RichTextModificationsDTO`
modification_id	`str`

Return type:

RichTextDTO

GET_USER_INFO

Call the space api to get the user info

Parameters:

Name	Type	Default value	Description
user_id	`str`

Return type:

UserFullDTO

REGISTER_LAB_START

Call the space api to mark the lab as started

Parameters:

Name	Type	Default value	Description
lab_config	`LabConfigModelDTO`

Return type:

bool

SAVE_NOTE

Parameters:

Name	Type	Default value	Description
folder_id	`str`
note	`SaveNoteToSpaceDTO`
file_paths	`List`

SAVE_SCENARIO

Parameters:

Name	Type	Default value	Description
folder_id	`str`
save_scenario_dto	`SaveScenarioToSpaceDTO`

SEND_MAIL

Parameters:

Name	Type	Default value	Description
send_mail_dto	`SpaceSendMailDTO`

Return type:

Response

SHARE_RESOURCE

Parameters:

Name	Type	Default value	Description
folder_id	`str`
resource_dto	`ShareResourceWithSpaceDTO`

UPDATE_NOTE_FOLDER

Parameters:

Name	Type	Default value	Description
current_folder_id	`str`
note_id	`str`
new_folder_id	`str`

UPDATE_SCENARIO_FOLDER

Parameters:

Name	Type	Default value	Description
current_folder_id	`str`
scenario_id	`str`
new_folder_id	`str`

SEND_MAIL_TO_MAILS - @classmethod

Parameters:

Name	Type	Default value	Description
send_mail_to_mails_dto	`SpaceSendMailToMailsDTO`

Return type:

Response

CREATE_WITH_ACCESS_TOKEN - @staticmethod

Return a new instance of the SpaceService that use the access token for authentication

Return type:

SpaceService

GET_INSTANCE - @staticmethod

Return a new instance of the SpaceService that use the current user for authentication

Return type:

SpaceService