Skip to content

User Settings

delete_user_settings async 

delete_user_settings(
    auth: Annotated[
        Auth, Depends(authorize(AuthStrategy.HYBRID, []))
    ],
    db: Annotated[Session, Depends(get_db)],
    user_setting_id: Annotated[
        int, Path(alias=userSettingId)
    ],
) -> StandardStatusIdentifiedResponse

Deletes UserSetting by UserSetting ID.

Input:

  • userSettingId: ID of the user setting to delete

  • auth: Authentication details

  • db: Database session

Output:

  • StandardStatusIdentifiedResponse: Response indicating success or failure

delete_user_settings_depr async 

delete_user_settings_depr(
    auth: Annotated[
        Auth, Depends(authorize(AuthStrategy.HYBRID, []))
    ],
    db: Annotated[Session, Depends(get_db)],
    user_setting_id: Annotated[
        int, Path(alias=userSettingId)
    ],
) -> StandardStatusIdentifiedResponse

Deprecated. Delete a UserSetting by specified UserSettingID.

Input:

  • userSettingId: ID of the user setting to delete

  • auth: Authentication details

  • db: Database session

Output:

  • StandardStatusIdentifiedResponse: Response indicating success or failure

get_user_setting_by_id async 

get_user_setting_by_id(
    auth: Annotated[
        Auth, Depends(authorize(AuthStrategy.HYBRID))
    ],
    db: Annotated[Session, Depends(get_db)],
    user_setting_name: Annotated[
        str, Path(alias=userSettingName)
    ],
) -> ViewUserSettingResponse

Displays a UserSetting by given userID and UserSetting name.

Input:

  • userId: ID of the user for whom setting is to be viewed

  • userSettingName: Name of the user setting to view

  • auth: Authentication details

  • db: Database session

Output:

  • ViewUserSettingResponse: Response with details of the viewed user setting

get_user_setting_by_ids async 

get_user_setting_by_ids(
    auth: Annotated[
        Auth, Depends(authorize(AuthStrategy.HYBRID))
    ],
    db: Annotated[Session, Depends(get_db)],
    user_id: Annotated[int, Path(alias=userId)],
    user_setting_name: Annotated[
        str, Path(alias=userSettingName)
    ],
) -> GetUserSettingResponse

Deprecated. View a UserSetting by its userID and UserSetting name.

Input:

  • userId: ID of the user for whom setting is to be viewed

  • userSettingName: Name of the user setting to view

  • auth: Authentication details

  • db: Database session

Output:

  • GetUserSettingResponse: Response with details of the viewed user setting

get_user_settings async 

get_user_settings(
    auth: Annotated[
        Auth, Depends(authorize(AuthStrategy.HYBRID))
    ],
    db: Annotated[Session, Depends(get_db)],
) -> list[UserSettingResponse]

Displays all UserSettings.

Input:

  • auth: Authentication details

  • db: Database session

Output:

  • list[UserSettingResponse]: List of UserSettingResponse objects

search_user_settings async 

search_user_settings(
    auth: Annotated[
        Auth, Depends(authorize(AuthStrategy.HYBRID))
    ],
    db: Annotated[Session, Depends(get_db)],
    body: SearchUserSettingBody,
) -> list[UserSettingResponse]

Displays all UserSettings by specified parameters.

Input:

  • body: SearchUserSettingBody, Data for searching user settings

  • auth: Authentication details

  • db: Database session

Output:

  • list[UserSettingResponse]: List of UserSettingResponse objects

set_user_settings async 

set_user_settings(
    auth: Annotated[
        Auth, Depends(authorize(AuthStrategy.HYBRID, []))
    ],
    db: Annotated[Session, Depends(get_db)],
    user_setting_name: Annotated[
        str, Path(alias=userSettingName)
    ],
    body: SetUserSettingBody,
) -> SetUserSettingResponse

Create or Update a UserSetting by user ID and UserSettingName. If specified UserSetting doesn't exist, it is created.

Input:

  • auth: Authentication details

  • db: Database session

  • user_id: ID of the user for whom setting is to be set

  • user_setting_name: Name of the user setting to

  • body: SetUserSettingBody, Data for setting the user setting

Output:

  • SetUserSettingResponse: Response indicating success or failure

view_user_settings async 

view_user_settings(
    auth: Annotated[
        Auth, Depends(authorize(AuthStrategy.HYBRID))
    ],
    db: Annotated[Session, Depends(get_db)],
    user_setting_id: Annotated[
        int, Path(alias=userSettingId)
    ],
) -> ViewUserSettingResponse

Displays a UserSetting by the UserSettingID.

Input:

  • userSettingId: ID of the user setting to view

  • auth: Authentication details

  • db: Database session

Output:

  • ViewUserSettingResponse: Response with details of the viewed user setting

view_user_settings_depr async 

view_user_settings_depr(
    auth: Annotated[
        Auth, Depends(authorize(AuthStrategy.HYBRID))
    ],
    db: Annotated[Session, Depends(get_db)],
    user_setting_id: Annotated[
        int, Path(alias=userSettingId)
    ],
) -> ViewUserSettingResponse

Deprecated. View UserSetting by UserSettingID.

Input:

  • userSettingId: ID of the user setting to view

  • auth: Authentication details

  • db: Database session

Output:

  • ViewUserSettingResponse: Response with details of the viewed user setting