fix types in docstring return

Author: LioriE

descope/authmethod/password.py

@@ -26,7 +26,7 @@ def sign_up(
         user (dict) optional: Preserve additional user metadata in the form of
              {"name": "Desmond Copeland", "phone": "2125551212", "email": "[email protected]"}
 
-        Return value (dict):
+        Return value (Union[dict, Awaitable[dict]]):
         Return dict in the format
              {"jwts": [], "user": "", "firstSeen": "", "error": ""}
         Includes all the jwts tokens (session token, refresh token), token claims, and user information
@@ -71,7 +71,7 @@ def sign_in(
         login_id (str): The login ID of the user being validated
         password (str): The password to be validated
 
-        Return value (dict):
+        Return value (Union[dict, Awaitable[dict]]):
         Return dict in the format
              {"jwts": [], "user": "", "firstSeen": "", "error": ""}
         Includes all the jwts tokens (session token, refresh token), token claims, and user information
@@ -119,7 +119,7 @@ def send_reset(
                 if those are the chosen reset methods. See the Magic Link and Enchanted Link sections
                 for more details.
 
-        Return value (dict):
+        Return value (Union[dict, Awaitable[dict]]):
         Return dict in the format
              {"resetMethod": "", "pendingRef": "", "linkId": "", "maskedEmail": ""}
             The contents will differ according to the chosen reset method. 'pendingRef'
@@ -202,7 +202,7 @@ def replace(
         old_password (str): The user's current active password
         new_password (str): The new password to use
 
-                        Return value (dict):
+                        Return value (Union[dict, Awaitable[dict]]):
         Return dict in the format
              {"jwts": [], "user": "", "firstSeen": false, "error": ""}
         Includes all the jwts tokens (session token, refresh token), token claims, and user information
@@ -250,7 +250,7 @@ def get_policy(self) -> Union[dict, Awaitable[dict]]:
         Get a subset of the password policy defined in the Descope console and enforced
         by Descope. The goal is to enable client-side validations to give users a better UX
 
-        Return value (dict):
+        Return value (Union[dict, Awaitable[dict]]):
         Return dict in the format
              {"minLength": 8, "lowercase": true, "uppercase": true, "number": true, "nonAlphanumeric": true}
             minLength - the minimum length of a password

descope/authmethod/sso.py

@@ -19,7 +19,7 @@ def start(
         """
         Start tenant sso session (saml/oidc based on tenant settings)
 
-        Return value (dict): the redirect url for the login page
+        Return value (Union[dict, Awaitable[dict]]): the redirect url for the login page
         Return dict in the format
              {'url': 'http://dummy.com/login..'}
         """

descope/authmethod/totp.py

@@ -24,7 +24,7 @@ def sign_up(
         user (dict) optional: Preserve additional user metadata in the form of,
              {"name": "Desmond Copeland", "phone": "2125551212", "email": "[email protected]"}
 
-        Return value (dict):
+        Return value (Union[dict, Awaitable[dict]]):
         Return dict in the format
              {"provisioningURL": "", "image": "", "key": ""}
         Includes 3 different ways to allow the user to save their credentials in
@@ -63,7 +63,7 @@ def sign_in_code(
         login_options (LoginOptions): Optional advanced controls over login parameters
         refresh_token: Optional refresh token is needed for specific login options
 
-        Return value (dict):
+        Return value (Union[dict, Awaitable[dict]]):
         Return dict in the format
              {"jwts": [], "user": "", "firstSeen": "", "error": ""}
         Includes all the jwts tokens (session token, refresh token), token claims, and user information
@@ -107,7 +107,7 @@ def update_user(
         login_id (str): The login ID of the user whose information is being updated
         refresh_token (str): The session's refresh token (used for verification)
 
-        Return value (dict):
+        Return value (Union[dict, Awaitable[dict]]):
         Return dict in the format
              {"provisioningURL": "", "image": "", "key": ""}
         Includes 3 different ways to allow the user to save their credentials in

descope/descope_client.py

@@ -125,7 +125,7 @@ def get_matched_permissions(
         jwt_response (dict): The jwt_response object which includes all JWT claims information
         permissions (List[str]): List of permissions to validate for this jwt_response
 
-        Return value (List[str]): returns the list of permissions that are granted
+        Return value (list[str]): returns the list of permissions that are granted
         """
         return self.get_matched_tenant_permissions(jwt_response, "", permissions)
 
@@ -177,7 +177,7 @@ def get_matched_tenant_permissions(
         tenant (str): TenantId
         permissions (List[str]): List of permissions to validate for this jwt_response
 
-        Return value (List[str]): returns the list of permissions that are granted
+        Return value (list[str]): returns the list of permissions that are granted
         """
         if not jwt_response:
             return []
@@ -224,7 +224,7 @@ def get_matched_roles(self, jwt_response: dict, roles: list[str]) -> list[str]:
         jwt_response (dict): The jwt_response object which includes all JWT claims information
         roles (List[str]): List of roles to validate for this jwt_response
 
-        Return value (List[str]): returns the list of roles that are granted
+        Return value (list[str]): returns the list of roles that are granted
         """
         return self.get_matched_tenant_roles(jwt_response, "", roles)
 
@@ -274,7 +274,7 @@ def get_matched_tenant_roles(
         tenant (str): TenantId
         roles (List[str]): List of roles to validate for this jwt_response
 
-        Return value (List[str]): returns the list of roles that are granted
+        Return value (list[str]): returns the list of roles that are granted
         """
         if not jwt_response:
             return []
@@ -312,7 +312,7 @@ def validate_session(
         session_token (str): The session token to be validated
         audience (str|Iterable[str]|None): Optional recipients that the JWT is intended for (must be equal to the 'aud' claim on the provided token)
 
-        Return value (dict):
+        Return value (Union[dict, Awaitable[dict]]):
         Return dict includes the session token and all JWT claims
 
         Raise:
@@ -330,7 +330,7 @@ def refresh_session(
         refresh_token (str): The refresh token that will be used to refresh the session
         audience (str|Iterable[str]|None): Optional recipients that the JWT is intended for (must be equal to the 'aud' claim on the provided token)
 
-        Return value (dict):
+        Return value (Union[dict, Awaitable[dict]]):
         Return dict includes the session token, refresh token, and all JWT claims
 
         Raise:
@@ -355,7 +355,7 @@ def validate_and_refresh_session(
         refresh_token (str): The refresh token that will be used to refresh the session token, if needed
         audience (str|Iterable[str]|None): Optional recipients that the JWT is intended for (must be equal to the 'aud' claim on the provided token)
 
-        Return value (dict):
+        Return value (Union[dict, Awaitable[dict]]):
         Return dict includes the session token, refresh token, and all JWT claims
 
         Raise:
@@ -375,7 +375,7 @@ def logout(
         Args:
         refresh_token (str): The refresh token
 
-        Return value (httpx.Response): returns the response from the Descope server
+        Return value (Union[httpx.Response, Awaitable[httpx.Response]]): returns the response from the Descope server
 
         Raise:
         AuthException: Exception is raised if session is not authorized or another error occurs
@@ -401,7 +401,7 @@ def logout_all(
         Args:
         refresh_token (str): The refresh token
 
-        Return value (httpx.Response): returns the response from the Descope server
+        Return value (Union[httpx.Response, Awaitable[httpx.Response]]): returns the response from the Descope server
 
         Raise:
         AuthException: Exception is raised if session is not authorized or another error occurs
@@ -425,7 +425,7 @@ def me(self, refresh_token: str) -> Union[dict, Awaitable[dict]]:
         Args:
         refresh_token (str): The refresh token
 
-        Return value (dict): returns the user details from the server
+        Return value (Union[dict, Awaitable[dict]]): returns the user details from the server
             (email:str, name:str, phone:str, loginIds[str], verifiedEmail:bool, verifiedPhone:bool)
 
         Raise:
@@ -458,7 +458,7 @@ def my_tenants(
         ids (List[str]): Get the list of tenants
         refresh_token (str): The refresh token
 
-        Return value (dict): returns the tenant requested from the server
+        Return value (Union[dict, Awaitable[dict]]): returns the tenant requested from the server
             (id:str, name:str, customAttributes:dict)
 
         Raise:
@@ -498,7 +498,7 @@ def history(self, refresh_token: str) -> Union[list[dict], Awaitable[list[dict]]
         Args:
         refresh_token (str): The refresh token
 
-        Return value (List[dict]):
+        Return value (Union[list[dict], Awaitable[list[dict]]]):
         Return List in the format
              [
                 {
@@ -564,7 +564,7 @@ def select_tenant(
         refresh_token (str): The refresh token that will be used to refresh the session token, if needed
         tenant_id (str): The tenant id to place on JWT
 
-        Return value (dict):
+        Return value (Union[dict, Awaitable[dict]]):
         Return dict includes the session token, refresh token, with the tenant id on the jwt
 
         Raise:

descope/management/access_key.py

@@ -37,7 +37,7 @@ def create(
         description (str): an optional text the access key can hold.
         permitted_ips: (List[str]): An optional list of IP addresses or CIDR ranges that are allowed to use the access key.
 
-        Return value (dict):
+        Return value (Union[dict, Awaitable[dict]]):
         Return dict in the format
             {
                 "key": {},
@@ -78,7 +78,7 @@ def load(
         Args:
         id (str): The id of the access key to be loaded.
 
-        Return value (dict):
+        Return value (Union[dict, Awaitable[dict]]):
         Return dict in the format
              {"key": {}}
         Containing the loaded access key information.
@@ -103,7 +103,7 @@ def search_all_access_keys(
         Args:
         tenant_ids (List[str]): Optional list of tenant IDs to filter by
 
-        Return value (dict):
+        Return value (Union[dict, Awaitable[dict]]):
         Return dict in the format
              {"keys": []}
         "keys" contains a list of all of the found users and their information

descope/management/audit.py

@@ -41,7 +41,7 @@ def search(
         from_ts (datetime): Retrieve records newer than given time but not older than 30 days
         to_ts (datetime): Retrieve records older than given time
 
-        Return value (dict):
+        Return value (Union[dict, Awaitable[dict]]):
         Return dict in the format
              {
                 "audits": [

descope/management/authz.py

@@ -66,7 +66,7 @@ def delete_schema(self) -> Union[None, Awaitable[None]]:
     def load_schema(self) -> Union[dict, Awaitable[dict]]:
         """
         Load the schema for the project
-        Return value (dict):
+        Return value (Union[dict, Awaitable[dict]]):
         Return dict in the format of schema as above (see save_schema)
         Raise:
         AuthException: raised if load schema fails
@@ -277,7 +277,7 @@ def has_relations(
                 "target": "the target that has the relation - usually users or other resources"
             }
 
-        Return value (List[dict]):
+        Return value (Union[List[dict], Awaitable[List[dict]]]):
         Return List in the format
              [
                 {
@@ -310,7 +310,7 @@ def who_can_access(
         relation_definition (str): the RD we are checking
         namespace (str): the namespace for the RD
 
-        Return value (List[str]): list of targets (user IDs usually that have the access)
+        Return value (Union[List[dict], Awaitable[List[dict]]]): list of targets (user IDs usually that have the access)
         Raise:
         AuthException: raised if query fails
         """
@@ -333,7 +333,7 @@ def resource_relations(
         Args:
         resource (str): the resource we are listing relations for
 
-        Return value (List[dict]):
+        Return value (Union[List[dict], Awaitable[List[dict]]]):
         Return List of relations each in the format of a relation as documented in create_relations
         Raise:
         AuthException: raised if query fails
@@ -353,7 +353,7 @@ def targets_relations(
         Args:
         targets (List[str]): the list of targets we are returning the relations for
 
-        Return value (List[dict]):
+        Return value (Union[List[dict], Awaitable[List[dict]]]):
         Return List of relations each in the format of a relation as documented in create_relations
         Raise:
         AuthException: raised if query fails
@@ -373,7 +373,7 @@ def what_can_target_access(
         Args:
         target (str): the target we are returning the relations for
 
-        Return value (List[dict]):
+        Return value (Union[List[dict], Awaitable[List[dict]]]):
         Return List of relations each in the format of a relation as documented in create_relations
         Raise:
         AuthException: raised if query fails
@@ -395,7 +395,7 @@ def what_can_target_access_with_relation(
         relation_definition (str): the RD we are checking
         namespace (str): the namespace for the RD
 
-        Return value (List[dict]):
+        Return value (Union[List[dict], Awaitable[List[dict]]]):
         Return List of relations each in the format of a relation as documented in create_relations
         Raise:
         AuthException: raised if query fails
@@ -419,7 +419,7 @@ def get_modified(
         Args:
         since (datetime): only return changes from this given datetime
 
-        Return value (dict):
+        Return value (Union[dict, Awaitable[dict]]):
         Dict including "resources" list of strings, "targets" list of strings and "schemaChanged" bool
         Raise:
         AuthException: raised if query fails

descope/management/fga.py

@@ -114,7 +114,7 @@ def check(
                 "targetType": "the type of the target (namespace)"
             }
 
-        Return value (List[dict]):
+        Return value (Union[List[dict], Awaitable[List[dict]]]):
         Return List in the format
              [
                 {

descope/management/flow.py

@@ -12,7 +12,7 @@ def list_flows(
         """
         List all project flows
 
-        Return value (dict):
+        Return value (Union[dict, Awaitable[dict]]):
         Return dict in the format
             { "flows": [{"id": "", "name": "", "description": "", "disabled": False}], total: number}
 
@@ -64,7 +64,7 @@ def export_flow(
         Args:
         flow_id (str): the flow id to export.
 
-        Return value (dict):
+        Return value (Union[dict, Awaitable[dict]]):
         Return dict in the format
             { "flow": {"id": "", "name": "", "description": "", "disabled": False, "etag": "", "dsl": {}}, screens: [{ "id": "", "inputs": [], "interactions": [] }] }
 
@@ -100,7 +100,7 @@ def import_flow(
         screens (List[dict]): the flow screens to import. list of dictss in the format:
             { "id": "", "inputs": [], "interactions": [] }
 
-        Return value (dict):
+        Return value (Union[dict, Awaitable[dict]]):
         Return dict in the format
             { "flow": {"id": "", "name": "", "description": "", "disabled": False, "etag": "", "dsl": {}}, screens: [{ "id": "", "inputs": [], "interactions": [] }] }
 
@@ -127,7 +127,7 @@ def export_theme(
         """
         Export the current project theme.
 
-        Return value (dict):
+        Return value (Union[dict, Awaitable[dict]]):
         Return dict in the format
             {"id": "", "cssTemplate": {} }
 
@@ -156,7 +156,7 @@ def import_theme(
         theme (Theme): the theme to import. dict in the format
             {"id": "", "cssTemplate": {} }
 
-        Return value (dict):
+        Return value (Union[dict, Awaitable[dict]]):
         Return dict in the format
             {"id": "", "cssTemplate": {} }
 

descope/management/group.py

@@ -16,7 +16,7 @@ def load_all_groups(
         Args:
         tenant_id (str): Tenant ID to load groups from.
 
-        Return value (dict):
+        Return value (Union[dict, Awaitable[dict]]):
         Return dict in the format
              [
                 {
@@ -62,7 +62,7 @@ def load_all_groups_for_members(
         user_ids (List[str]): Optional List of user IDs, with the format of "U2J5ES9S8TkvCgOvcrkpzUgVTEBM" (example), which can be found on the user's JWT.
         login_ids (List[str]): Optional List of login IDs, how the users identify when logging in.
 
-        Return value (dict):
+        Return value (Union[dict, Awaitable[dict]]):
         Return dict in the format
              [
                 {
@@ -111,7 +111,7 @@ def load_all_group_members(
         tenant_id (str): Tenant ID to load groups from.
         group_id (str): Group ID to load members for.
 
-        Return value (dict):
+        Return value (Union[dict, Awaitable[dict]]):
         Return dict in the format
              [
                 {