pipedream 2.1.19__tar.gz → 2.1.20__tar.gz

{pipedream-2.1.19 → pipedream-2.1.20}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pipedream
-Version: 2.1.19
+Version: 2.1.20
 Summary: 
 Requires-Python: >=3.10,<4.0
 Classifier: Intended Audience :: Developers

{pipedream-2.1.19 → pipedream-2.1.20}/pyproject.toml

@@ -4,7 +4,7 @@ dynamic = ["version"]
 
 [tool.poetry]
 name = "pipedream"
-version = "2.1.19"
+version = "2.1.20"
 description = ""
 readme = "README.md"
 authors = []

{pipedream-2.1.19 → pipedream-2.1.20}/src/pipedream/accounts/client.py

@@ -118,6 +118,7 @@ class AccountsClient:
         oauth_app_id: typing.Optional[str] = None,
         name: typing.Optional[str] = OMIT,
         account_id: typing.Optional[str] = OMIT,
+        app_override_id: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Account:
         """
@@ -145,6 +146,9 @@ class AccountsClient:
         account_id : typing.Optional[str]
             An existing account ID to reconnect. When provided, the account's credentials are updated instead of creating a new account. Must belong to the same external user and project environment as the connect token, and match the app identified by app_slug.
 
+        app_override_id : typing.Optional[str]
+            An app override ID. The account is linked to the override and the override's pre-defined custom field values are merged over cfmap_json; with account_id, the account is re-linked to this override. Must belong to the app identified by app_slug, and must not select an OAuth client — overrides that do can only connect through the OAuth flow.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -178,6 +182,7 @@ class AccountsClient:
             oauth_app_id=oauth_app_id,
             name=name,
             account_id=account_id,
+            app_override_id=app_override_id,
             request_options=request_options,
         )
         return _response.data
@@ -450,6 +455,7 @@ class AsyncAccountsClient:
         oauth_app_id: typing.Optional[str] = None,
         name: typing.Optional[str] = OMIT,
         account_id: typing.Optional[str] = OMIT,
+        app_override_id: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Account:
         """
@@ -477,6 +483,9 @@ class AsyncAccountsClient:
         account_id : typing.Optional[str]
             An existing account ID to reconnect. When provided, the account's credentials are updated instead of creating a new account. Must belong to the same external user and project environment as the connect token, and match the app identified by app_slug.
 
+        app_override_id : typing.Optional[str]
+            An app override ID. The account is linked to the override and the override's pre-defined custom field values are merged over cfmap_json; with account_id, the account is re-linked to this override. Must belong to the app identified by app_slug, and must not select an OAuth client — overrides that do can only connect through the OAuth flow.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -518,6 +527,7 @@ class AsyncAccountsClient:
             oauth_app_id=oauth_app_id,
             name=name,
             account_id=account_id,
+            app_override_id=app_override_id,
             request_options=request_options,
         )
         return _response.data

{pipedream-2.1.19 → pipedream-2.1.20}/src/pipedream/accounts/raw_client.py

@@ -139,6 +139,7 @@ class RawAccountsClient:
         oauth_app_id: typing.Optional[str] = None,
         name: typing.Optional[str] = OMIT,
         account_id: typing.Optional[str] = OMIT,
+        app_override_id: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[Account]:
         """
@@ -166,6 +167,9 @@ class RawAccountsClient:
         account_id : typing.Optional[str]
             An existing account ID to reconnect. When provided, the account's credentials are updated instead of creating a new account. Must belong to the same external user and project environment as the connect token, and match the app identified by app_slug.
 
+        app_override_id : typing.Optional[str]
+            An app override ID. The account is linked to the override and the override's pre-defined custom field values are merged over cfmap_json; with account_id, the account is re-linked to this override. Must belong to the app identified by app_slug, and must not select an OAuth client — overrides that do can only connect through the OAuth flow.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -187,6 +191,7 @@ class RawAccountsClient:
                 "connect_token": connect_token,
                 "name": name,
                 "account_id": account_id,
+                "app_override_id": app_override_id,
             },
             headers={
                 "content-type": "application/json",
@@ -564,6 +569,7 @@ class AsyncRawAccountsClient:
         oauth_app_id: typing.Optional[str] = None,
         name: typing.Optional[str] = OMIT,
         account_id: typing.Optional[str] = OMIT,
+        app_override_id: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[Account]:
         """
@@ -591,6 +597,9 @@ class AsyncRawAccountsClient:
         account_id : typing.Optional[str]
             An existing account ID to reconnect. When provided, the account's credentials are updated instead of creating a new account. Must belong to the same external user and project environment as the connect token, and match the app identified by app_slug.
 
+        app_override_id : typing.Optional[str]
+            An app override ID. The account is linked to the override and the override's pre-defined custom field values are merged over cfmap_json; with account_id, the account is re-linked to this override. Must belong to the app identified by app_slug, and must not select an OAuth client — overrides that do can only connect through the OAuth flow.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -612,6 +621,7 @@ class AsyncRawAccountsClient:
                 "connect_token": connect_token,
                 "name": name,
                 "account_id": account_id,
+                "app_override_id": app_override_id,
             },
             headers={
                 "content-type": "application/json",

{pipedream-2.1.19 → pipedream-2.1.20}/src/pipedream/core/client_wrapper.py

@@ -34,12 +34,12 @@ class BaseClientWrapper:
         import platform
 
         headers: typing.Dict[str, str] = {
-            "User-Agent": "pipedream/2.1.19",
+            "User-Agent": "pipedream/2.1.20",
             "X-Fern-Language": "Python",
             "X-Fern-Runtime": f"python/{platform.python_version()}",
             "X-Fern-Platform": f"{platform.system().lower()}/{platform.release()}",
             "X-Fern-SDK-Name": "pipedream",
-            "X-Fern-SDK-Version": "2.1.19",
+            "X-Fern-SDK-Version": "2.1.20",
             **(self.get_custom_headers() or {}),
         }
         if self._project_environment is not None:

{pipedream-2.1.19 → pipedream-2.1.20}/src/pipedream/tokens/client.py

@@ -39,6 +39,8 @@ class TokensClient:
         success_redirect_uri: typing.Optional[str] = OMIT,
         webhook_uri: typing.Optional[str] = OMIT,
         allow_progressive_scopes: typing.Optional[bool] = OMIT,
+        app_id: typing.Optional[str] = OMIT,
+        oauth_app_id: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> CreateTokenResponse:
         """
@@ -70,6 +72,12 @@ class TokensClient:
         allow_progressive_scopes : typing.Optional[bool]
             When true, end users may authorize a subset of the app's OAuth scopes; only the app's functional scopes (needed for the post-OAuth test request) are enforced. Defaults to false.
 
+        app_id : typing.Optional[str]
+            Scope the Connect Link to this app, identified by app ID or name slug: resolves the app's official OAuth client for your workspace (when it has one) and pins the link to the host serving that client's OAuth flow pages. Optional.
+
+        oauth_app_id : typing.Optional[str]
+            Scope the Connect Link to a specific OAuth client (overrides app_id's resolution). Optional.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -100,6 +108,8 @@ class TokensClient:
             success_redirect_uri=success_redirect_uri,
             webhook_uri=webhook_uri,
             allow_progressive_scopes=allow_progressive_scopes,
+            app_id=app_id,
+            oauth_app_id=oauth_app_id,
             request_options=request_options,
         )
         return _response.data
@@ -108,9 +118,10 @@ class TokensClient:
         self,
         ctok: ConnectToken,
         *,
-        app_id: str,
+        app_id: typing.Optional[str] = None,
         account_id: typing.Optional[str] = None,
         oauth_app_id: typing.Optional[str] = None,
+        app_override_id: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ValidateTokenResponse:
         """
@@ -120,8 +131,8 @@ class TokensClient:
         ----------
         ctok : ConnectToken
 
-        app_id : str
-            The app ID to validate against
+        app_id : typing.Optional[str]
+            The app ID to validate against. Required unless account_id or app_override_id identifies the app.
 
         account_id : typing.Optional[str]
             An existing account ID to reconnect. Must belong to the app identified by app_id.
@@ -129,6 +140,9 @@ class TokensClient:
         oauth_app_id : typing.Optional[str]
             The OAuth app ID to validate against (if the token is for an OAuth app)
 
+        app_override_id : typing.Optional[str]
+            An app override ID. Selects the override's app, pre-defined custom fields, and OAuth client. With account_id, re-links the account to this override; it must belong to the account's app, and an override that pins a different OAuth client switches the account to that client when the reconnect flow completes. A conflicting app_id or oauth_app_id is an error. To resolve an override by name, list them with GET /v1/connect/{project_id}/app_overrides and match on name.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -151,10 +165,16 @@ class TokensClient:
             app_id="app_id",
             account_id="account_id",
             oauth_app_id="oauth_app_id",
+            app_override_id="app_override_id",
         )
         """
         _response = self._raw_client.validate(
-            ctok, app_id=app_id, account_id=account_id, oauth_app_id=oauth_app_id, request_options=request_options
+            ctok,
+            app_id=app_id,
+            account_id=account_id,
+            oauth_app_id=oauth_app_id,
+            app_override_id=app_override_id,
+            request_options=request_options,
         )
         return _response.data
 
@@ -185,6 +205,8 @@ class AsyncTokensClient:
         success_redirect_uri: typing.Optional[str] = OMIT,
         webhook_uri: typing.Optional[str] = OMIT,
         allow_progressive_scopes: typing.Optional[bool] = OMIT,
+        app_id: typing.Optional[str] = OMIT,
+        oauth_app_id: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> CreateTokenResponse:
         """
@@ -216,6 +238,12 @@ class AsyncTokensClient:
         allow_progressive_scopes : typing.Optional[bool]
             When true, end users may authorize a subset of the app's OAuth scopes; only the app's functional scopes (needed for the post-OAuth test request) are enforced. Defaults to false.
 
+        app_id : typing.Optional[str]
+            Scope the Connect Link to this app, identified by app ID or name slug: resolves the app's official OAuth client for your workspace (when it has one) and pins the link to the host serving that client's OAuth flow pages. Optional.
+
+        oauth_app_id : typing.Optional[str]
+            Scope the Connect Link to a specific OAuth client (overrides app_id's resolution). Optional.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -254,6 +282,8 @@ class AsyncTokensClient:
             success_redirect_uri=success_redirect_uri,
             webhook_uri=webhook_uri,
             allow_progressive_scopes=allow_progressive_scopes,
+            app_id=app_id,
+            oauth_app_id=oauth_app_id,
             request_options=request_options,
         )
         return _response.data
@@ -262,9 +292,10 @@ class AsyncTokensClient:
         self,
         ctok: ConnectToken,
         *,
-        app_id: str,
+        app_id: typing.Optional[str] = None,
         account_id: typing.Optional[str] = None,
         oauth_app_id: typing.Optional[str] = None,
+        app_override_id: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ValidateTokenResponse:
         """
@@ -274,8 +305,8 @@ class AsyncTokensClient:
         ----------
         ctok : ConnectToken
 
-        app_id : str
-            The app ID to validate against
+        app_id : typing.Optional[str]
+            The app ID to validate against. Required unless account_id or app_override_id identifies the app.
 
         account_id : typing.Optional[str]
             An existing account ID to reconnect. Must belong to the app identified by app_id.
@@ -283,6 +314,9 @@ class AsyncTokensClient:
         oauth_app_id : typing.Optional[str]
             The OAuth app ID to validate against (if the token is for an OAuth app)
 
+        app_override_id : typing.Optional[str]
+            An app override ID. Selects the override's app, pre-defined custom fields, and OAuth client. With account_id, re-links the account to this override; it must belong to the account's app, and an override that pins a different OAuth client switches the account to that client when the reconnect flow completes. A conflicting app_id or oauth_app_id is an error. To resolve an override by name, list them with GET /v1/connect/{project_id}/app_overrides and match on name.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -310,12 +344,18 @@ class AsyncTokensClient:
                 app_id="app_id",
                 account_id="account_id",
                 oauth_app_id="oauth_app_id",
+                app_override_id="app_override_id",
             )
 
 
         asyncio.run(main())
         """
         _response = await self._raw_client.validate(
-            ctok, app_id=app_id, account_id=account_id, oauth_app_id=oauth_app_id, request_options=request_options
+            ctok,
+            app_id=app_id,
+            account_id=account_id,
+            oauth_app_id=oauth_app_id,
+            app_override_id=app_override_id,
+            request_options=request_options,
         )
         return _response.data

{pipedream-2.1.19 → pipedream-2.1.20}/src/pipedream/tokens/raw_client.py

@@ -35,6 +35,8 @@ class RawTokensClient:
         success_redirect_uri: typing.Optional[str] = OMIT,
         webhook_uri: typing.Optional[str] = OMIT,
         allow_progressive_scopes: typing.Optional[bool] = OMIT,
+        app_id: typing.Optional[str] = OMIT,
+        oauth_app_id: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[CreateTokenResponse]:
         """
@@ -66,6 +68,12 @@ class RawTokensClient:
         allow_progressive_scopes : typing.Optional[bool]
             When true, end users may authorize a subset of the app's OAuth scopes; only the app's functional scopes (needed for the post-OAuth test request) are enforced. Defaults to false.
 
+        app_id : typing.Optional[str]
+            Scope the Connect Link to this app, identified by app ID or name slug: resolves the app's official OAuth client for your workspace (when it has one) and pins the link to the host serving that client's OAuth flow pages. Optional.
+
+        oauth_app_id : typing.Optional[str]
+            Scope the Connect Link to a specific OAuth client (overrides app_id's resolution). Optional.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -86,6 +94,8 @@ class RawTokensClient:
                 "success_redirect_uri": success_redirect_uri,
                 "webhook_uri": webhook_uri,
                 "allow_progressive_scopes": allow_progressive_scopes,
+                "app_id": app_id,
+                "oauth_app_id": oauth_app_id,
             },
             headers={
                 "content-type": "application/json",
@@ -127,9 +137,10 @@ class RawTokensClient:
         self,
         ctok: ConnectToken,
         *,
-        app_id: str,
+        app_id: typing.Optional[str] = None,
         account_id: typing.Optional[str] = None,
         oauth_app_id: typing.Optional[str] = None,
+        app_override_id: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[ValidateTokenResponse]:
         """
@@ -139,8 +150,8 @@ class RawTokensClient:
         ----------
         ctok : ConnectToken
 
-        app_id : str
-            The app ID to validate against
+        app_id : typing.Optional[str]
+            The app ID to validate against. Required unless account_id or app_override_id identifies the app.
 
         account_id : typing.Optional[str]
             An existing account ID to reconnect. Must belong to the app identified by app_id.
@@ -148,6 +159,9 @@ class RawTokensClient:
         oauth_app_id : typing.Optional[str]
             The OAuth app ID to validate against (if the token is for an OAuth app)
 
+        app_override_id : typing.Optional[str]
+            An app override ID. Selects the override's app, pre-defined custom fields, and OAuth client. With account_id, re-links the account to this override; it must belong to the account's app, and an override that pins a different OAuth client switches the account to that client when the reconnect flow completes. A conflicting app_id or oauth_app_id is an error. To resolve an override by name, list them with GET /v1/connect/{project_id}/app_overrides and match on name.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -163,6 +177,7 @@ class RawTokensClient:
                 "app_id": app_id,
                 "account_id": account_id,
                 "oauth_app_id": oauth_app_id,
+                "app_override_id": app_override_id,
             },
             request_options=request_options,
         )
@@ -212,6 +227,8 @@ class AsyncRawTokensClient:
         success_redirect_uri: typing.Optional[str] = OMIT,
         webhook_uri: typing.Optional[str] = OMIT,
         allow_progressive_scopes: typing.Optional[bool] = OMIT,
+        app_id: typing.Optional[str] = OMIT,
+        oauth_app_id: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[CreateTokenResponse]:
         """
@@ -243,6 +260,12 @@ class AsyncRawTokensClient:
         allow_progressive_scopes : typing.Optional[bool]
             When true, end users may authorize a subset of the app's OAuth scopes; only the app's functional scopes (needed for the post-OAuth test request) are enforced. Defaults to false.
 
+        app_id : typing.Optional[str]
+            Scope the Connect Link to this app, identified by app ID or name slug: resolves the app's official OAuth client for your workspace (when it has one) and pins the link to the host serving that client's OAuth flow pages. Optional.
+
+        oauth_app_id : typing.Optional[str]
+            Scope the Connect Link to a specific OAuth client (overrides app_id's resolution). Optional.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -263,6 +286,8 @@ class AsyncRawTokensClient:
                 "success_redirect_uri": success_redirect_uri,
                 "webhook_uri": webhook_uri,
                 "allow_progressive_scopes": allow_progressive_scopes,
+                "app_id": app_id,
+                "oauth_app_id": oauth_app_id,
             },
             headers={
                 "content-type": "application/json",
@@ -304,9 +329,10 @@ class AsyncRawTokensClient:
         self,
         ctok: ConnectToken,
         *,
-        app_id: str,
+        app_id: typing.Optional[str] = None,
         account_id: typing.Optional[str] = None,
         oauth_app_id: typing.Optional[str] = None,
+        app_override_id: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[ValidateTokenResponse]:
         """
@@ -316,8 +342,8 @@ class AsyncRawTokensClient:
         ----------
         ctok : ConnectToken
 
-        app_id : str
-            The app ID to validate against
+        app_id : typing.Optional[str]
+            The app ID to validate against. Required unless account_id or app_override_id identifies the app.
 
         account_id : typing.Optional[str]
             An existing account ID to reconnect. Must belong to the app identified by app_id.
@@ -325,6 +351,9 @@ class AsyncRawTokensClient:
         oauth_app_id : typing.Optional[str]
             The OAuth app ID to validate against (if the token is for an OAuth app)
 
+        app_override_id : typing.Optional[str]
+            An app override ID. Selects the override's app, pre-defined custom fields, and OAuth client. With account_id, re-links the account to this override; it must belong to the account's app, and an override that pins a different OAuth client switches the account to that client when the reconnect flow completes. A conflicting app_id or oauth_app_id is an error. To resolve an override by name, list them with GET /v1/connect/{project_id}/app_overrides and match on name.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -340,6 +369,7 @@ class AsyncRawTokensClient:
                 "app_id": app_id,
                 "account_id": account_id,
                 "oauth_app_id": oauth_app_id,
+                "app_override_id": app_override_id,
             },
             request_options=request_options,
         )

{pipedream-2.1.19 → pipedream-2.1.20}/src/pipedream/types/validate_token_response.py

@@ -13,6 +13,16 @@ class ValidateTokenResponse(UniversalBaseModel):
     """
 
     app: typing.Optional[App] = None
+    app_override_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    ID of the resolved app override, echoed from the request
+    """
+
+    app_override_field_names: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
+    """
+    Names of the custom fields the resolved app override pre-defines
+    """
+
     error: typing.Optional[str] = pydantic.Field(default=None)
     """
     Error message if validation failed
@@ -33,6 +43,11 @@ class ValidateTokenResponse(UniversalBaseModel):
     True when the resolved OAuth client is the app's Workday-official client
     """
 
+    oauth_app_connect_base_url: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Base URL the Connect UI must run this client's OAuth flow on; null means the default API URL
+    """
+
     project_app_name: typing.Optional[str] = pydantic.Field(default=None)
     """
     Name of the project app