Terarea  2
The automation project
Loading...
Searching...
No Matches
Public Member Functions | Data Fields
src.lib.components.endpoints.user_endpoints.UserEndpoints Class Reference
Collaboration diagram for src.lib.components.endpoints.user_endpoints.UserEndpoints:
Collaboration graph

Public Member Functions

None __init__ (self, RuntimeData runtime_data, int error=84, int success=0, bool debug=False)
 
Response post_login (self, Request request)
 
Response post_register (self, Request request)
 
Response post_send_email_verification (self, Request request)
 
Response put_reset_password (self, Request request)
 
Response put_user (self, Request request)
 
Response patch_user (self, Request request)
 
Response get_user (self, Request request)
 
Response delete_user (self, Request request)
 
Response put_user_favicon (self, Request request)
 
Response delete_user_favicon (self, Request request)
 
Response post_logout (self, Request request)
 
Response get_user_id (self, Request request)
 

Data Fields

RuntimeData runtime_data_initialised = runtime_data
 
int error = error
 
int success = success
 
bool debug = debug
 
Disp disp
 
PasswordHandling password_handling_initialised
 
MailManagement mail_management_initialised
 

Detailed Description

_summary_

Definition at line 15 of file user_endpoints.py.

Constructor & Destructor Documentation

◆ __init__()

None src.lib.components.endpoints.user_endpoints.UserEndpoints.__init__ ( self,
RuntimeData runtime_data,
int error = 84,
int success = 0,
bool debug = False ) 
_summary_

Definition at line 19 of file user_endpoints.py.

Member Function Documentation

◆ delete_user()

Response src.lib.components.endpoints.user_endpoints.UserEndpoints.delete_user ( self,
Request request ) 
_summary_
    Endpoint allowing the user to delete it's account.

Args:
    request (Request): _description_

Returns:
    Response: _description_

Definition at line 490 of file user_endpoints.py.

◆ delete_user_favicon()

Response src.lib.components.endpoints.user_endpoints.UserEndpoints.delete_user_favicon ( self,
Request request ) 
_summary_
    Endpoint allowing the user to delete it's favicon.

Args:
    request (Request): _description_

Returns:
    Response: _description_

Definition at line 558 of file user_endpoints.py.

◆ get_user()

Response src.lib.components.endpoints.user_endpoints.UserEndpoints.get_user ( self,
Request request ) 
_summary_
    Endpoint allowing the user to get it's account data.

Args:
    request (Request): _description_

Returns:
    Response: _description_

Definition at line 439 of file user_endpoints.py.

◆ get_user_id()

Response src.lib.components.endpoints.user_endpoints.UserEndpoints.get_user_id ( self,
Request request ) 
_summary_
    This is an endpoint that will allow the user to query it's id.

Args:
    request (Request): _description_

Returns:
    Response: _description_

Definition at line 601 of file user_endpoints.py.

◆ patch_user()

Response src.lib.components.endpoints.user_endpoints.UserEndpoints.patch_user ( self,
Request request ) 
_summary_
    Endpoint allowing the user to update it's account data.

Args:
    request (Request): _description_

Returns:
    Response: _description_

Definition at line 364 of file user_endpoints.py.

◆ post_login()

Response src.lib.components.endpoints.user_endpoints.UserEndpoints.post_login ( self,
Request request ) 
_summary_
    The endpoint allowing a user to log into the server.

Returns:
    Response: _description_: The data to send back to the user as a response.

Definition at line 52 of file user_endpoints.py.

◆ post_logout()

Response src.lib.components.endpoints.user_endpoints.UserEndpoints.post_logout ( self,
Request request ) 
_summary_
    The endpoint allowing a user to log out of the server.

Returns:
    Response: _description_: The data to send back to the user as a response.

Definition at line 569 of file user_endpoints.py.

◆ post_register()

Response src.lib.components.endpoints.user_endpoints.UserEndpoints.post_register ( self,
Request request ) 
_summary_

Args:
    request (Request): _description_

Returns:
    Response: _description_

Definition at line 97 of file user_endpoints.py.

◆ post_send_email_verification()

Response src.lib.components.endpoints.user_endpoints.UserEndpoints.post_send_email_verification ( self,
Request request ) 
_summary_

Definition at line 170 of file user_endpoints.py.

◆ put_reset_password()

Response src.lib.components.endpoints.user_endpoints.UserEndpoints.put_reset_password ( self,
Request request ) 
_summary_
    The function in charge of resetting the user's password.

Definition at line 245 of file user_endpoints.py.

◆ put_user()

Response src.lib.components.endpoints.user_endpoints.UserEndpoints.put_user ( self,
Request request ) 
_summary_
    Endpoint allowing the user to update it's account data.

Args:
    request (Request): _description_

Returns:
    Response: _description_

Definition at line 302 of file user_endpoints.py.

◆ put_user_favicon()

Response src.lib.components.endpoints.user_endpoints.UserEndpoints.put_user_favicon ( self,
Request request ) 
_summary_
    Endpoint allowing the user to update it's favicon.

Args:
    request (Request): _description_

Returns:
    Response: _description_

Definition at line 547 of file user_endpoints.py.

Field Documentation

◆ debug

bool src.lib.components.endpoints.user_endpoints.UserEndpoints.debug = debug

Definition at line 26 of file user_endpoints.py.

◆ disp

Disp src.lib.components.endpoints.user_endpoints.UserEndpoints.disp
Initial value:
= Disp(
TOML_CONF,
FILE_DESCRIPTOR,
SAVE_TO_FILE,
FILE_NAME,
debug=self.debug,
logger=self.__class__.__name__
)

Definition at line 28 of file user_endpoints.py.

◆ error

int src.lib.components.endpoints.user_endpoints.UserEndpoints.error = error

Definition at line 24 of file user_endpoints.py.

◆ mail_management_initialised

MailManagement src.lib.components.endpoints.user_endpoints.UserEndpoints.mail_management_initialised
Initial value:
= MailManagement(
self.error,
self.success,
self.debug
)

Definition at line 44 of file user_endpoints.py.

◆ password_handling_initialised

PasswordHandling src.lib.components.endpoints.user_endpoints.UserEndpoints.password_handling_initialised
Initial value:
= PasswordHandling(
self.error,
self.success,
self.debug
)

Definition at line 37 of file user_endpoints.py.

◆ runtime_data_initialised

RuntimeData src.lib.components.endpoints.user_endpoints.UserEndpoints.runtime_data_initialised = runtime_data

Definition at line 23 of file user_endpoints.py.

◆ success

int src.lib.components.endpoints.user_endpoints.UserEndpoints.success = success

Definition at line 25 of file user_endpoints.py.

The documentation for this class was generated from the following file: