pangea-sdk 6.2.0b1__py3-none-any.whl → 6.3.0__py3-none-any.whl

pangea/services/authn/authn.py

@@ -1,7 +1,12 @@
 # Copyright 2022 Pangea Cyber Corporation
 # Author: Pangea Cyber Corporation
+
+# TODO: Modernize.
+# ruff: noqa: UP006, UP035
+
 from __future__ import annotations
 
+from collections.abc import Mapping
 from typing import Dict, List, Literal, Optional, Union
 
 import pangea.services.authn.models as m
@@ -128,7 +133,7 @@ class AuthN(ServiceBase):
             Returns:
                 A PangeaResponse with a list of sessions in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/session#/v2/session/list).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/session#/v2/session/list-post).
 
             Examples:
                 response = authn.session.list()
@@ -192,7 +197,7 @@ class AuthN(ServiceBase):
             Returns:
                 A PangeaResponse with credentials for a login session in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/client/userinfo).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/client/userinfo-post).
 
             Examples:
                 response = authn.client.userinfo(
@@ -217,7 +222,7 @@ class AuthN(ServiceBase):
             Returns:
                 A PangeaResponse with jwt verification keys in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/jwt#/v2/client/jwks).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/jwt#/v2/client/jwks-post).
 
             Examples:
                 response = authn.client.jwks()
@@ -290,7 +295,7 @@ class AuthN(ServiceBase):
                 Returns:
                     A PangeaResponse with a list of sessions in the response.result field.
                         Available response fields can be found in our
-                        [API Documentation](https://pangea.cloud/docs/api/authn/session#/v2/client/session/list).
+                        [API Documentation](https://pangea.cloud/docs/api/authn/session#/v2/client/session/list-post).
 
                 Examples:
                     response = authn.client.session.list(
@@ -349,7 +354,7 @@ class AuthN(ServiceBase):
                 Returns:
                     A PangeaResponse with credentials for a login session in the response.result field.
                         Available response fields can be found in our
-                        [API Documentation](https://pangea.cloud/docs/api/authn/session#/v2/client/session/refresh).
+                        [API Documentation](https://pangea.cloud/docs/api/authn/session#/v2/client/session/refresh-post).
 
                 Examples:
                     response = authn.client.session.refresh(
@@ -433,7 +438,7 @@ class AuthN(ServiceBase):
             ):
                 super().__init__(token, config, logger_name=logger_name)
 
-            def check(self, token: str) -> PangeaResponse[m.ClientTokenCheckResult]:
+            def check(self, token: m.Token) -> PangeaResponse[m.ClientTokenCheckResult]:
                 """
                 Check a token
 
@@ -442,22 +447,19 @@ class AuthN(ServiceBase):
                 OperationId: authn_post_v2_client_token_check
 
                 Args:
-                    token (str): A token value
+                    token: A token value
 
                 Returns:
                     A PangeaResponse with a token and its information in the response.result field.
                         Available response fields can be found in our
-                        [API Documentation](https://pangea.cloud/docs/api/authn/flow#/v2/client/token/check).
+                        [API Documentation](https://pangea.cloud/docs/api/authn/flow#/v2/client/token/check-post).
 
                 Examples:
                     response = authn.client.token_endpoints.check(
                         token="ptu_wuk7tvtpswyjtlsx52b7yyi2l7zotv4a",
                     )
                 """
-                input = m.ClientTokenCheckRequest(token=token)
-                return self.request.post(
-                    "v2/client/token/check", m.ClientTokenCheckResult, data=input.model_dump(exclude_none=True)
-                )
+                return self.request.post("v2/client/token/check", m.ClientTokenCheckResult, data={"token": token})
 
     class User(ServiceBase):
         service_name = _SERVICE_NAME
@@ -477,7 +479,7 @@ class AuthN(ServiceBase):
         def create(
             self,
             email: str,
-            profile: m.Profile,
+            profile: Mapping[str, str],
             *,
             username: str | None = None,
         ) -> PangeaResponse[m.UserCreateResult]:
@@ -496,7 +498,7 @@ class AuthN(ServiceBase):
             Returns:
                 A PangeaResponse with a user and its information in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/user/create).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/user/create-post).
 
             Examples:
                 response = authn.user.create(
@@ -561,7 +563,7 @@ class AuthN(ServiceBase):
             Returns:
                 A PangeaResponse with a pending user invitation in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/invite#/v2/user/invite).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/invite#/v2/user/invite-post).
 
             Examples:
                 response = authn.user.invite(
@@ -606,7 +608,7 @@ class AuthN(ServiceBase):
             Returns:
                 A PangeaResponse with a user and its information in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/user/update).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/user/update-post).
 
             Examples:
                 response = authn.user.update(
@@ -649,7 +651,7 @@ class AuthN(ServiceBase):
             Returns:
                 A PangeaResponse with a list of users in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/user/list).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/user/list-post).
 
             Examples:
                 response = authn.user.list()
@@ -703,7 +705,7 @@ class AuthN(ServiceBase):
                 Returns:
                     A PangeaResponse with a list of pending user invitations in the response.result field.
                         Available response fields can be found in our
-                        [API Documentation](https://pangea.cloud/docs/api/authn/invite#/v2/user/invite/list).
+                        [API Documentation](https://pangea.cloud/docs/api/authn/invite#/v2/user/invite/list-post).
                 Examples:
                     response = authn.user.invites.list()
                 """
@@ -807,7 +809,7 @@ class AuthN(ServiceBase):
                 Returns:
                     A PangeaResponse with a list of authenticators in the response.result field.
                         Available response fields can be found in our
-                        [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/user/authenticators/list).
+                        [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/user/authenticators/list-post).
 
                 Examples:
                     response = authn.user.authenticators.list(
@@ -850,7 +852,7 @@ class AuthN(ServiceBase):
                 Returns:
                     A PangeaResponse with a user and its information in the response.result field.
                         Available response fields can be found in our
-                        [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/user/profile/get).
+                        [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/user/profile/get-post).
 
                 Examples:
                     response = authn.user.profile.get(
@@ -864,7 +866,7 @@ class AuthN(ServiceBase):
 
             def update(
                 self,
-                profile: m.Profile,
+                profile: Mapping[str, str],
                 id: str | None = None,
                 email: str | None = None,
                 *,
@@ -886,7 +888,7 @@ class AuthN(ServiceBase):
                 Returns:
                     A PangeaResponse with a user and its information in the response.result field.
                         Available response fields can be found in our
-                        [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/user/profile/update).
+                        [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/user/profile/update-post).
 
                 Examples:
                     response = authn.user.profile.update(
@@ -980,7 +982,7 @@ class AuthN(ServiceBase):
             Returns:
                 A PangeaResponse with credentials for a login session in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/flow#/v2/flow/complete).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/flow#/v2/flow/complete-post).
 
             Examples:
                 response = authn.flow.complete(
@@ -991,7 +993,10 @@ class AuthN(ServiceBase):
             return self.request.post("v2/flow/complete", m.FlowCompleteResult, data=input.model_dump(exclude_none=True))
 
         def restart(
-            self, flow_id: str, choice: m.FlowChoice, data: m.FlowRestartData = {}
+            self,
+            flow_id: str,
+            choice: m.FlowChoice,
+            data: m.FlowRestartData = {},  # noqa: B006
         ) -> PangeaResponse[m.FlowRestartResult]:
             """
             Restart a sign-up/sign-in flow
@@ -1009,7 +1014,7 @@ class AuthN(ServiceBase):
                 A PangeaResponse with information about next steps needed
                     to complete a flow in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/flow#/v2/flow/restart).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/flow#/v2/flow/restart-post).
 
             Examples:
                 response = authn.flow.restart(
@@ -1046,7 +1051,7 @@ class AuthN(ServiceBase):
                 A PangeaResponse with information about next steps needed
                     to complete a flow in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/flow#/v2/flow/start).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/flow#/v2/flow/start-post).
 
             Examples:
                 response = authn.flow.start(
@@ -1062,7 +1067,10 @@ class AuthN(ServiceBase):
             return self.request.post("v2/flow/start", m.FlowStartResult, data=input.model_dump(exclude_none=True))
 
         def update(
-            self, flow_id: str, choice: m.FlowChoice, data: m.FlowUpdateData = {}
+            self,
+            flow_id: str,
+            choice: m.FlowChoice,
+            data: m.FlowUpdateData = {},  # noqa: B006
         ) -> PangeaResponse[m.FlowUpdateResult]:
             """
             Update a sign-up/sign-in flow
@@ -1080,7 +1088,7 @@ class AuthN(ServiceBase):
                 A PangeaResponse with information about next steps needed
                     to complete a flow in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/flow#/v2/flow/update).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/flow#/v2/flow/update-post).
 
             Examples:
                 response = authn.flow.update(
@@ -1125,7 +1133,7 @@ class AuthN(ServiceBase):
             Returns:
                 A PangeaResponse with a EULA object in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/agreements#/v2/agreements/create).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/agreements#/v2/agreements/create-post).
 
             Examples:
                 response = authn.agreements.create(
@@ -1192,7 +1200,7 @@ class AuthN(ServiceBase):
             Returns:
                 A PangeaResponse with a list of EULA objects in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/agreements#/v2/agreements/list).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/agreements#/v2/agreements/list-post).
 
             Examples:
                 response = authn.agreements.list()
@@ -1231,7 +1239,7 @@ class AuthN(ServiceBase):
             Returns:
                 A PangeaResponse with the updated EULA object in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/agreements#/v2/agreements/update).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/agreements#/v2/agreements/update-post).
 
             Examples:
                 response = authn.agreements.update(