diff --git a/firebase_admin/_auth_client.py b/firebase_admin/_auth_client.py index 12d60592..1c9b3708 100644 --- a/firebase_admin/_auth_client.py +++ b/firebase_admin/_auth_client.py @@ -200,7 +200,7 @@ def get_users(self, identifiers): Returns: GetUsersResult: A ``GetUsersResult`` instance corresponding to the - specified identifiers. + specified identifiers. Raises: ValueError: If any of the identifiers are invalid or if more than 100 @@ -374,8 +374,8 @@ def delete_users(self, uids): Returns: DeleteUsersResult: The total number of successful/failed deletions, as - well as the array of errors that correspond to the failed - deletions. + well as the array of errors that correspond to the failed + deletions. Raises: ValueError: If any of the identifiers are invalid or if more than 1000 diff --git a/firebase_admin/_auth_providers.py b/firebase_admin/_auth_providers.py index 96f1b534..46de6fe5 100644 --- a/firebase_admin/_auth_providers.py +++ b/firebase_admin/_auth_providers.py @@ -121,7 +121,7 @@ def get_next_page(self): Returns: ListProviderConfigsPage: Next page of provider configs, or None if this is the last - page. + page. """ if self.has_next_page: return self.__class__(self._download, self.next_page_token, self._max_results) diff --git a/firebase_admin/_user_mgt.py b/firebase_admin/_user_mgt.py index 0307959f..1d97dd50 100644 --- a/firebase_admin/_user_mgt.py +++ b/firebase_admin/_user_mgt.py @@ -78,7 +78,7 @@ def last_refresh_timestamp(self): Returns: integer: Milliseconds since epoch timestamp, or `None` if the user was - never active. + never active. """ return self._last_refresh_timestamp @@ -215,7 +215,7 @@ def tokens_valid_after_timestamp(self): Returns: int: Timestamp in milliseconds since the epoch, truncated to the second. - All tokens issued before that time are considered revoked. + All tokens issued before that time are considered revoked. """ valid_since = self._data.get('validSince') if valid_since is not None: @@ -752,7 +752,7 @@ def delete_users(self, uids, force_delete=False): Returns: BatchDeleteAccountsResponse: Server's proto response, wrapped in a - python object. + python object. Raises: ValueError: If any of the identifiers are invalid or if more than 1000 diff --git a/firebase_admin/auth.py b/firebase_admin/auth.py index 5d2fe0f6..c5361bc3 100644 --- a/firebase_admin/auth.py +++ b/firebase_admin/auth.py @@ -43,6 +43,8 @@ 'ExpiredIdTokenError', 'ExpiredSessionCookieError', 'ExportedUserRecord', + 'DeleteUsersResult', + 'GetUsersResult', 'ImportUserRecord', 'InsufficientPermissionError', 'InvalidDynamicLinkDomainError', @@ -356,14 +358,14 @@ def get_users(identifiers, app=None): identifiers are supplied, this method raises a `ValueError`. Args: - identifiers (list[Identifier]): A list of ``Identifier`` instances used - to indicate which user records should be returned. Must have <= 100 - entries. + identifiers (list[UserIdentifier]): A list of ``UserIdentifier`` + instances used to indicate which user records should be returned. + Must have <= 100 entries. app: An App instance (optional). Returns: GetUsersResult: A ``GetUsersResult`` instance corresponding to the - specified identifiers. + specified identifiers. Raises: ValueError: If any of the identifiers are invalid or if more than 100 @@ -522,8 +524,7 @@ def delete_users(uids, app=None): Returns: DeleteUsersResult: The total number of successful/failed deletions, as - well as the array of errors that correspond to the failed - deletions. + well as the array of errors that correspond to the failed deletions. Raises: ValueError: If any of the identifiers are invalid or if more than 1000