anaplan-sdk 0.4.4a1__tar.gz → 0.4.4a3__tar.gz

{anaplan_sdk-0.4.4a1 → anaplan_sdk-0.4.4a3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: anaplan-sdk
-Version: 0.4.4a1
+Version: 0.4.4a3
 Summary: Streamlined Python Interface for Anaplan
 Project-URL: Homepage, https://vinzenzklass.github.io/anaplan-sdk/
 Project-URL: Repository, https://github.com/VinzenzKlass/anaplan-sdk

{anaplan_sdk-0.4.4a1 → anaplan_sdk-0.4.4a3}/anaplan_sdk/_auth.py

@@ -159,7 +159,7 @@ class AnaplanOAuthCodeAuth(_AnaplanAuth):
         self,
         client_id: str,
         client_secret: str,
-        redirect_url: str,
+        redirect_uri: str,
         token: dict[str, str] | None = None,
         authorization_url: str = "https://us1a.app.anaplan.com/auth/prelogin",
         token_url: str = "https://us1a.app.anaplan.com/oauth/token",
@@ -175,7 +175,7 @@ class AnaplanOAuthCodeAuth(_AnaplanAuth):
         :param client_id: The client ID of your Anaplan Oauth 2.0 application. This Application
                must be an Authorization Code Grant application.
         :param client_secret: The client secret of your Anaplan Oauth 2.0 application.
-        :param redirect_url: The URL to which the user will be redirected after authorizing the
+        :param redirect_uri: The URL to which the user will be redirected after authorizing the
                application.
         :param authorization_url: The URL to which the user will be redirected to authorize the
                application. Defaults to the Anaplan Prelogin Page, where the user can select the
@@ -193,7 +193,7 @@ class AnaplanOAuthCodeAuth(_AnaplanAuth):
         self._oauth = _OAuthRequestFactory(
             client_id=client_id,
             client_secret=client_secret,
-            redirect_url=redirect_url,
+            redirect_uri=redirect_uri,
             scope=scope,
             authorization_url=authorization_url,
             token_url=token_url,
@@ -237,7 +237,7 @@ class AnaplanRefreshTokenAuth(_AnaplanAuth):
         self,
         client_id: str,
         client_secret: str,
-        redirect_url: str,
+        redirect_uri: str,
         token: dict[str, str],
         token_url: str = "https://us1a.app.anaplan.com/oauth/token",
     ):
@@ -245,11 +245,14 @@ class AnaplanRefreshTokenAuth(_AnaplanAuth):
         This class is a utility class for long-lived `Client` or `AsyncClient` instances that use
         OAuth. It expects that you have a valid OAuth token with a refresh token, which will be used
         to refresh the access token when it expires.
+
         :param client_id: The client ID of your Anaplan Oauth 2.0 application. This Application
                must be an Authorization Code Grant application.
         :param client_secret: The client secret of your Anaplan Oauth 2.0 application.
-        :param redirect_url: The URL to which the user will be redirected after authorizing the
+        :param redirect_uri: The URL to which the user will be redirected after authorizing the
                application.
+        :param token: The OAuth token dictionary containing at least the `access_token` and
+               `refresh_token`.
         :param token_url: The URL to post the refresh token request to in order to fetch the access
                token.
         """
@@ -257,10 +260,10 @@ class AnaplanRefreshTokenAuth(_AnaplanAuth):
         self._oauth = _OAuthRequestFactory(
             client_id=client_id,
             client_secret=client_secret,
-            redirect_url=redirect_url,
+            redirect_uri=redirect_uri,
             token_url=token_url,
         )
-        super().__init__(self._token)
+        super().__init__(self._oauth_token["access_token"])
 
     def _build_auth_request(self) -> httpx.Request:
         return self._oauth.refresh_token_request(self._oauth_token["refresh_token"])

{anaplan_sdk-0.4.4a1 → anaplan_sdk-0.4.4a3}/anaplan_sdk/_oauth.py

@@ -13,7 +13,7 @@ class _BaseOauth:
         self,
         client_id: str,
         client_secret: str,
-        redirect_url: str,
+        redirect_uri: str,
         authorization_url: str = "https://us1a.app.anaplan.com/auth/prelogin",
         token_url: str = "https://us1a.app.anaplan.com/oauth/token",
         validation_url: str = "https://auth.anaplan.com/token/validate",
@@ -38,7 +38,7 @@ class _BaseOauth:
         :param client_id: The client ID of your Anaplan Oauth 2.0 application. This Application
                must be an Authorization Code Grant application.
         :param client_secret: The client secret of your Anaplan Oauth 2.0 application.
-        :param redirect_url: The URL to which the user will be redirected after authorizing the
+        :param redirect_uri: The URL to which the user will be redirected after authorizing the
                application.
         :param authorization_url: The URL to which the user will be redirected to authorize the
                application. Defaults to the Anaplan Prelogin Page, where the user can select the
@@ -53,7 +53,7 @@ class _BaseOauth:
         """
         self._client_id = client_id
         self._client_secret = client_secret
-        self._redirect_url = redirect_url
+        self._redirect_uri = redirect_uri
         self._authorization_url = authorization_url
         self._token_url = token_url
         self._validation_url = validation_url
@@ -86,7 +86,7 @@ class _BaseOauth:
         auth_url = authorization_url or self._authorization_url
         state = state or self._state_generator()
         url, _, _ = self._oauth.prepare_authorization_request(
-            auth_url, state, self._redirect_url, self._scope
+            auth_url, state, self._redirect_uri, self._scope
         )
         return url, state
 
@@ -94,7 +94,7 @@ class _BaseOauth:
         url, headers, body = self._oauth.prepare_token_request(
             authorization_response=authorization_response,
             token_url=self._token_url,
-            redirect_url=self._redirect_url,
+            redirect_url=self._redirect_uri,
             client_secret=self._client_secret,
         )
         return httpx.Request(method="POST", url=url, headers=headers, content=body)
@@ -206,7 +206,7 @@ class Oauth(_BaseOauth):
             url, headers, body = self._oauth.prepare_token_request(
                 authorization_response=authorization_response,
                 token_url=self._token_url,
-                redirect_url=self._redirect_url,
+                redirect_url=self._redirect_uri,
                 client_secret=self._client_secret,
             )
             with httpx.Client() as client:

{anaplan_sdk-0.4.4a1 → anaplan_sdk-0.4.4a3}/docs/guides/authentication.md

@@ -114,7 +114,6 @@ An example for FastAPI is shown below, but you can use any other Web Framework.
         ```
     This will install [OAuthLib](https://oauthlib.readthedocs.io/en/latest/index.html) to securely construct the authentication request.
 
-
 ```python
 import os
 from typing import Annotated
@@ -127,7 +126,7 @@ from anaplan_sdk import AsyncClient, AsyncOauth, exceptions
 _oauth = AsyncOauth(
     client_id=os.environ["OAUTH_CLIENT_ID"],
     client_secret=os.environ["OAUTH_CLIENT_SECRET"],
-    redirect_url="https://vinzenzklass.github.io/anaplan-sdk/oauth/callback",
+    redirect_uri="https://vinzenzklass.github.io/anaplan-sdk/oauth/callback",
 )
 
 app = FastAPI()
@@ -182,7 +181,7 @@ when it expires.
             token=token,
             client_id=os.environ["OAUTH_CLIENT_ID"],
             client_secret=os.environ["OAUTH_CLIENT_SECRET"],
-            redirect_url="https://vinzenzklass.github.io/anaplan-sdk",
+            redirect_uri="https://vinzenzklass.github.io/anaplan-sdk",
         )
     )
     ```
@@ -193,7 +192,7 @@ when it expires.
             token=token,
             client_id=os.environ["OAUTH_CLIENT_ID"],
             client_secret=os.environ["OAUTH_CLIENT_SECRET"],
-            redirect_url="https://vinzenzklass.github.io/anaplan-sdk",
+            redirect_uri="https://vinzenzklass.github.io/anaplan-sdk",
         )
     )
     ```
@@ -226,7 +225,7 @@ and the subsequent token refreshes.
         auth=AnaplanOAuthCodeAuth(
             client_id=os.environ["OAUTH_CLIENT_ID"],
             client_secret=os.environ["OAUTH_CLIENT_SECRET"],
-            redirect_url="https://vinzenzklass.github.io/anaplan-sdk",
+            redirect_uri="https://vinzenzklass.github.io/anaplan-sdk",
         )
     )
     ```
@@ -236,7 +235,7 @@ and the subsequent token refreshes.
         auth=AnaplanOAuthCodeAuth(
             client_id=os.environ["OAUTH_CLIENT_ID"],
             client_secret=os.environ["OAUTH_CLIENT_SECRET"],
-            redirect_url="https://vinzenzklass.github.io/anaplan-sdk",
+            redirect_uri="https://vinzenzklass.github.io/anaplan-sdk",
         )
     )
     ```

{anaplan_sdk-0.4.4a1 → anaplan_sdk-0.4.4a3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "anaplan-sdk"
-version = "0.4.4a1"
+version = "0.4.4a3"
 description = "Streamlined Python Interface for Anaplan"
 license = "Apache-2.0"
 authors = [{ name = "Vinzenz Klass", email = "vinzenz.klass@valantic.com" }]