airbyte-cdk 7.4.0.post5.dev18892607199__tar.gz → 7.6.3.post2.dev20977372780__tar.gz

{airbyte_cdk-7.4.0.post5.dev18892607199 → airbyte_cdk-7.6.3.post2.dev20977372780}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: airbyte-cdk
-Version: 7.4.0.post5.dev18892607199
+Version: 7.6.3.post2.dev20977372780
 Summary: A framework for writing Airbyte Connectors.
 Home-page: https://airbyte.com
 License: MIT
@@ -46,17 +46,17 @@ Requires-Dist: isodate (>=0.6.1,<0.7.0)
 Requires-Dist: jsonref (>=1,<2)
 Requires-Dist: jsonschema (>=4.17.3,<5.0)
 Requires-Dist: langchain_community (>=0.4,<0.5) ; extra == "vector-db-based"
-Requires-Dist: langchain_core (>=1.0.0,<2.0.0) ; extra == "vector-db-based"
+Requires-Dist: langchain_core (>=1.2.5,<2.0.0) ; extra == "vector-db-based"
 Requires-Dist: langchain_text_splitters (>=1.0.0,<2.0.0) ; extra == "vector-db-based"
 Requires-Dist: markdown ; extra == "file-based"
 Requires-Dist: nltk (==3.9.1)
 Requires-Dist: openai[embeddings] (==0.27.9) ; extra == "vector-db-based"
+Requires-Dist: openpyxl (>=3.1.0,<4.0.0) ; extra == "file-based"
 Requires-Dist: orjson (>=3.10.7,<4.0.0)
 Requires-Dist: packaging
 Requires-Dist: pandas (==2.2.3)
 Requires-Dist: pdf2image (==1.16.3) ; extra == "file-based"
 Requires-Dist: pdfminer.six (==20221105) ; extra == "file-based"
-Requires-Dist: psutil (==6.1.0)
 Requires-Dist: pyarrow (>=19.0.0,<20.0.0) ; extra == "file-based"
 Requires-Dist: pydantic (>=2.7,<3.0)
 Requires-Dist: pyjwt (>=2.8.0,<3.0.0)

{airbyte_cdk-7.4.0.post5.dev18892607199 → airbyte_cdk-7.6.3.post2.dev20977372780}/airbyte_cdk/legacy/sources/declarative/declarative_stream.py

@@ -5,6 +5,8 @@ import logging
 from dataclasses import InitVar, dataclass, field
 from typing import Any, Iterable, List, Mapping, MutableMapping, Optional, Union
 
+from typing_extensions import deprecated
+
 from airbyte_cdk.legacy.sources.declarative.incremental import (
     GlobalSubstreamCursor,
     PerPartitionCursor,
@@ -13,7 +15,6 @@ from airbyte_cdk.legacy.sources.declarative.incremental import (
 from airbyte_cdk.models import SyncMode
 from airbyte_cdk.sources.declarative.interpolation import InterpolatedString
 from airbyte_cdk.sources.declarative.migrations.state_migration import StateMigration
-from airbyte_cdk.sources.declarative.retrievers import SimpleRetriever
 from airbyte_cdk.sources.declarative.retrievers.async_retriever import AsyncRetriever
 from airbyte_cdk.sources.declarative.retrievers.retriever import Retriever
 from airbyte_cdk.sources.declarative.schema import DefaultSchemaLoader
@@ -28,6 +29,7 @@ from airbyte_cdk.sources.streams.core import Stream
 from airbyte_cdk.sources.types import Config, StreamSlice
 
 
+@deprecated("DeclarativeStream has been deprecated in favor of the concurrent DefaultStream")
 @dataclass
 class DeclarativeStream(Stream):
     """
@@ -198,8 +200,6 @@ class DeclarativeStream(Stream):
         return None
 
     def get_cursor(self) -> Optional[Cursor]:
-        if self.retriever and isinstance(self.retriever, SimpleRetriever):
-            return self.retriever.cursor
         return None
 
     def _get_checkpoint_reader(

{airbyte_cdk-7.4.0.post5.dev18892607199 → airbyte_cdk-7.6.3.post2.dev20977372780}/airbyte_cdk/legacy/sources/declarative/manifest_declarative_source.py

@@ -341,29 +341,41 @@ class ManifestDeclarativeSource(DeclarativeSource):
     def _initialize_cache_for_parent_streams(
         stream_configs: List[Dict[str, Any]],
     ) -> List[Dict[str, Any]]:
+        """Enable caching for parent streams unless explicitly disabled.
+
+        Caching is enabled by default for parent streams to optimize performance when the same
+        parent data is needed by multiple child streams. However, explicit `use_cache: false`
+        settings are respected for streams that cannot use caching (e.g., scroll-based pagination
+        APIs where caching causes duplicate records).
+        """
         parent_streams = set()
 
+        def _set_cache_if_not_disabled(requester: Dict[str, Any]) -> None:
+            """Set use_cache to True only if not explicitly disabled."""
+            if requester.get("use_cache") is not False:
+                requester["use_cache"] = True
+
         def update_with_cache_parent_configs(
             parent_configs: list[dict[str, Any]],
         ) -> None:
             for parent_config in parent_configs:
                 parent_streams.add(parent_config["stream"]["name"])
                 if parent_config["stream"]["type"] == "StateDelegatingStream":
-                    parent_config["stream"]["full_refresh_stream"]["retriever"]["requester"][
-                        "use_cache"
-                    ] = True
-                    parent_config["stream"]["incremental_stream"]["retriever"]["requester"][
-                        "use_cache"
-                    ] = True
+                    _set_cache_if_not_disabled(
+                        parent_config["stream"]["full_refresh_stream"]["retriever"]["requester"]
+                    )
+                    _set_cache_if_not_disabled(
+                        parent_config["stream"]["incremental_stream"]["retriever"]["requester"]
+                    )
                 else:
-                    parent_config["stream"]["retriever"]["requester"]["use_cache"] = True
+                    _set_cache_if_not_disabled(parent_config["stream"]["retriever"]["requester"])
 
         for stream_config in stream_configs:
             if stream_config.get("incremental_sync", {}).get("parent_stream"):
                 parent_streams.add(stream_config["incremental_sync"]["parent_stream"]["name"])
-                stream_config["incremental_sync"]["parent_stream"]["retriever"]["requester"][
-                    "use_cache"
-                ] = True
+                _set_cache_if_not_disabled(
+                    stream_config["incremental_sync"]["parent_stream"]["retriever"]["requester"]
+                )
 
             elif stream_config.get("retriever", {}).get("partition_router", {}):
                 partition_router = stream_config["retriever"]["partition_router"]
@@ -380,14 +392,14 @@ class ManifestDeclarativeSource(DeclarativeSource):
         for stream_config in stream_configs:
             if stream_config["name"] in parent_streams:
                 if stream_config["type"] == "StateDelegatingStream":
-                    stream_config["full_refresh_stream"]["retriever"]["requester"]["use_cache"] = (
-                        True
+                    _set_cache_if_not_disabled(
+                        stream_config["full_refresh_stream"]["retriever"]["requester"]
                     )
-                    stream_config["incremental_stream"]["retriever"]["requester"]["use_cache"] = (
-                        True
+                    _set_cache_if_not_disabled(
+                        stream_config["incremental_stream"]["retriever"]["requester"]
                     )
                 else:
-                    stream_config["retriever"]["requester"]["use_cache"] = True
+                    _set_cache_if_not_disabled(stream_config["retriever"]["requester"])
         return stream_configs
 
     def spec(self, logger: logging.Logger) -> ConnectorSpecification:

{airbyte_cdk-7.4.0.post5.dev18892607199 → airbyte_cdk-7.6.3.post2.dev20977372780}/airbyte_cdk/manifest_server/Dockerfile

@@ -5,7 +5,7 @@
 # Example:
 # docker build -f airbyte_cdk/manifest_server/Dockerfile -t airbyte/manifest-server .
 
-FROM python:3.12-slim-bookworm
+FROM python:3.13.9-slim-bookworm@sha256:4c9fe962f6ce46ecf3633a7e9d0a9fb7f5622121ee00d628eff206da024147c9
 
 # Install git (needed for dynamic versioning) and poetry
 RUN apt-get update && \

{airbyte_cdk-7.4.0.post5.dev18892607199 → airbyte_cdk-7.6.3.post2.dev20977372780}/airbyte_cdk/sources/declarative/auth/oauth.py

@@ -5,7 +5,7 @@
 import logging
 from dataclasses import InitVar, dataclass, field
 from datetime import datetime, timedelta
-from typing import Any, List, Mapping, Optional, Union
+from typing import Any, List, Mapping, Optional, Tuple, Union
 
 from airbyte_cdk.sources.declarative.auth.declarative_authenticator import DeclarativeAuthenticator
 from airbyte_cdk.sources.declarative.interpolation.interpolated_boolean import InterpolatedBoolean
@@ -46,6 +46,9 @@ class DeclarativeOauth2Authenticator(AbstractOauth2Authenticator, DeclarativeAut
         refresh_request_headers (Optional[Mapping[str, Any]]): The request headers to send in the refresh request
         grant_type: The grant_type to request for access_token. If set to refresh_token, the refresh_token parameter has to be provided
         message_repository (MessageRepository): the message repository used to emit logs on HTTP requests
+        refresh_token_error_status_codes (Tuple[int, ...]): Status codes to identify refresh token errors in response
+        refresh_token_error_key (str): Key to identify refresh token error in response
+        refresh_token_error_values (Tuple[str, ...]): List of values to check for exception during token refresh process
     """
 
     config: Mapping[str, Any]
@@ -72,9 +75,16 @@ class DeclarativeOauth2Authenticator(AbstractOauth2Authenticator, DeclarativeAut
     message_repository: MessageRepository = NoopMessageRepository()
     profile_assertion: Optional[DeclarativeAuthenticator] = None
     use_profile_assertion: Optional[Union[InterpolatedBoolean, str, bool]] = False
+    refresh_token_error_status_codes: Tuple[int, ...] = ()
+    refresh_token_error_key: str = ""
+    refresh_token_error_values: Tuple[str, ...] = ()
 
     def __post_init__(self, parameters: Mapping[str, Any]) -> None:
-        super().__init__()
+        super().__init__(
+            refresh_token_error_status_codes=self.refresh_token_error_status_codes,
+            refresh_token_error_key=self.refresh_token_error_key,
+            refresh_token_error_values=self.refresh_token_error_values,
+        )
         if self.token_refresh_endpoint is not None:
             self._token_refresh_endpoint: Optional[InterpolatedString] = InterpolatedString.create(
                 self.token_refresh_endpoint, parameters=parameters

{airbyte_cdk-7.4.0.post5.dev18892607199 → airbyte_cdk-7.6.3.post2.dev20977372780}/airbyte_cdk/sources/declarative/concurrent_declarative_source.py

@@ -424,29 +424,41 @@ class ConcurrentDeclarativeSource(Source):
     def _initialize_cache_for_parent_streams(
         stream_configs: List[Dict[str, Any]],
     ) -> List[Dict[str, Any]]:
+        """Enable caching for parent streams unless explicitly disabled.
+
+        Caching is enabled by default for parent streams to optimize performance when the same
+        parent data is needed by multiple child streams. However, explicit `use_cache: false`
+        settings are respected for streams that cannot use caching (e.g., scroll-based pagination
+        APIs where caching causes duplicate records).
+        """
         parent_streams = set()
 
+        def _set_cache_if_not_disabled(requester: Dict[str, Any]) -> None:
+            """Set use_cache to True only if not explicitly disabled."""
+            if requester.get("use_cache") is not False:
+                requester["use_cache"] = True
+
         def update_with_cache_parent_configs(
             parent_configs: list[dict[str, Any]],
         ) -> None:
             for parent_config in parent_configs:
                 parent_streams.add(parent_config["stream"]["name"])
                 if parent_config["stream"]["type"] == "StateDelegatingStream":
-                    parent_config["stream"]["full_refresh_stream"]["retriever"]["requester"][
-                        "use_cache"
-                    ] = True
-                    parent_config["stream"]["incremental_stream"]["retriever"]["requester"][
-                        "use_cache"
-                    ] = True
+                    _set_cache_if_not_disabled(
+                        parent_config["stream"]["full_refresh_stream"]["retriever"]["requester"]
+                    )
+                    _set_cache_if_not_disabled(
+                        parent_config["stream"]["incremental_stream"]["retriever"]["requester"]
+                    )
                 else:
-                    parent_config["stream"]["retriever"]["requester"]["use_cache"] = True
+                    _set_cache_if_not_disabled(parent_config["stream"]["retriever"]["requester"])
 
         for stream_config in stream_configs:
             if stream_config.get("incremental_sync", {}).get("parent_stream"):
                 parent_streams.add(stream_config["incremental_sync"]["parent_stream"]["name"])
-                stream_config["incremental_sync"]["parent_stream"]["retriever"]["requester"][
-                    "use_cache"
-                ] = True
+                _set_cache_if_not_disabled(
+                    stream_config["incremental_sync"]["parent_stream"]["retriever"]["requester"]
+                )
 
             elif stream_config.get("retriever", {}).get("partition_router", {}):
                 partition_router = stream_config["retriever"]["partition_router"]
@@ -463,14 +475,14 @@ class ConcurrentDeclarativeSource(Source):
         for stream_config in stream_configs:
             if stream_config["name"] in parent_streams:
                 if stream_config["type"] == "StateDelegatingStream":
-                    stream_config["full_refresh_stream"]["retriever"]["requester"]["use_cache"] = (
-                        True
+                    _set_cache_if_not_disabled(
+                        stream_config["full_refresh_stream"]["retriever"]["requester"]
                     )
-                    stream_config["incremental_stream"]["retriever"]["requester"]["use_cache"] = (
-                        True
+                    _set_cache_if_not_disabled(
+                        stream_config["incremental_stream"]["retriever"]["requester"]
                     )
                 else:
-                    stream_config["retriever"]["requester"]["use_cache"] = True
+                    _set_cache_if_not_disabled(stream_config["retriever"]["requester"])
         return stream_configs
 
     def spec(self, logger: logging.Logger) -> ConnectorSpecification:

{airbyte_cdk-7.4.0.post5.dev18892607199 → airbyte_cdk-7.6.3.post2.dev20977372780}/airbyte_cdk/sources/declarative/declarative_component_schema.yaml

@@ -850,6 +850,10 @@ definitions:
         examples:
           - "created_at"
           - "{{ config['record_cursor'] }}"
+      allow_catalog_defined_cursor_field:
+        title: Allow Catalog Defined Cursor Field
+        description: Whether the cursor allows users to override the default cursor_field when configuring their connection. The user defined cursor field will be specified from within the configured catalog.
+        type: boolean
       start_value:
         title: Start Value
         description: The value that determines the earliest record that should be synced.
@@ -913,6 +917,10 @@ definitions:
         examples:
           - "created_at"
           - "{{ config['record_cursor'] }}"
+      allow_catalog_defined_cursor_field:
+        title: Allow Catalog Defined Cursor Field
+        description: Whether the cursor allows users to override the default cursor_field when configuring their connection. The user defined cursor field will be specified from within the configured catalog.
+        type: boolean
       cursor_datetime_formats:
         title: Cursor Datetime Formats
         type: array
@@ -1427,6 +1435,28 @@ definitions:
         type: string
         examples:
           - "%Y-%m-%d %H:%M:%S.%f+00:00"
+      refresh_token_error_status_codes:
+        title: Refresh Token Error Status Codes
+        description: Status Codes to Identify refresh token error in response (Refresh Token Error Key and Refresh Token Error Values should be also specified). Responses with one of the error status code and containing an error value will be flagged as a config error
+        type: array
+        items:
+          type: integer
+        examples:
+          - [400, 500]
+      refresh_token_error_key:
+        title: Refresh Token Error Key
+        description: Key to Identify refresh token error in response (Refresh Token Error Status Codes and Refresh Token Error Values should be also specified).
+        type: string
+        examples:
+          - "error"
+      refresh_token_error_values:
+        title: Refresh Token Error Values
+        description: 'List of values to check for exception during token refresh process. Used to check if the error found in the response matches the key from the Refresh Token Error Key field (e.g. response={"error": "invalid_grant"}). Only responses with one of the error status code and containing an error value will be flagged as a config error'
+        type: array
+        items:
+          type: string
+        examples:
+          - ["invalid_grant", "invalid_permissions"]
       refresh_token_updater:
         title: Refresh Token Updater
         description: When the refresh token updater is defined, new refresh tokens, access tokens and the access token expiry date are written back from the authentication response to the config object. This is important if the refresh token can only used once.
@@ -1468,7 +1498,7 @@ definitions:
             examples:
               - ["credentials", "token_expiry_date"]
           refresh_token_error_status_codes:
-            title: Refresh Token Error Status Codes
+            title: (Deprecated - Use the same field on the OAuthAuthenticator level) Refresh Token Error Status Codes
             description: Status Codes to Identify refresh token error in response (Refresh Token Error Key and Refresh Token Error Values should be also specified). Responses with one of the error status code and containing an error value will be flagged as a config error
             type: array
             items:
@@ -1477,14 +1507,14 @@ definitions:
             examples:
               - [400, 500]
           refresh_token_error_key:
-            title: Refresh Token Error Key
+            title: (Deprecated - Use the same field on the OAuthAuthenticator level) Refresh Token Error Key
             description: Key to Identify refresh token error in response (Refresh Token Error Status Codes and Refresh Token Error Values should be also specified).
             type: string
             default: ""
             examples:
               - "error"
           refresh_token_error_values:
-            title: Refresh Token Error Values
+            title: (Deprecated - Use the same field on the OAuthAuthenticator level) Refresh Token Error Values
             description: 'List of values to check for exception during token refresh process. Used to check if the error found in the response matches the key from the Refresh Token Error Key field (e.g. response={"error": "invalid_grant"}). Only responses with one of the error status code and containing an error value will be flagged as a config error'
             type: array
             items:
@@ -2256,7 +2286,7 @@ definitions:
           - "$ref": "#/definitions/CustomErrorHandler"
       use_cache:
         title: Use Cache
-        description: Enables stream requests caching. This field is automatically set by the CDK.
+        description: Enables stream requests caching. When set to true, repeated requests to the same URL will return cached responses. Parent streams automatically have caching enabled. Only set this to false if you are certain that caching should be disabled, as it may negatively impact performance when the same data is needed multiple times (e.g., for scroll-based pagination APIs where caching causes duplicate records).
         type: boolean
         default: false
       $parameters:
@@ -3353,7 +3383,7 @@ definitions:
       - ["code", "type"]
   PropertiesFromEndpoint:
     title: Properties from Endpoint
-    description: Defines the behavior for fetching the list of properties from an API that will be loaded into the requests to extract records.
+    description: Defines the behavior for fetching the list of properties from an API that will be loaded into the requests to extract records. Note that stream_slices can't be interpolated from this retriever.
     type: object
     required:
       - type

{airbyte_cdk-7.4.0.post5.dev18892607199 → airbyte_cdk-7.6.3.post2.dev20977372780}/airbyte_cdk/sources/declarative/models/declarative_component_schema.py

@@ -426,19 +426,19 @@ class RefreshTokenUpdater(BaseModel):
         [],
         description="Status Codes to Identify refresh token error in response (Refresh Token Error Key and Refresh Token Error Values should be also specified). Responses with one of the error status code and containing an error value will be flagged as a config error",
         examples=[[400, 500]],
-        title="Refresh Token Error Status Codes",
+        title="(Deprecated - Use the same field on the OAuthAuthenticator level) Refresh Token Error Status Codes",
     )
     refresh_token_error_key: Optional[str] = Field(
         "",
         description="Key to Identify refresh token error in response (Refresh Token Error Status Codes and Refresh Token Error Values should be also specified).",
         examples=["error"],
-        title="Refresh Token Error Key",
+        title="(Deprecated - Use the same field on the OAuthAuthenticator level) Refresh Token Error Key",
     )
     refresh_token_error_values: Optional[List[str]] = Field(
         [],
         description='List of values to check for exception during token refresh process. Used to check if the error found in the response matches the key from the Refresh Token Error Key field (e.g. response={"error": "invalid_grant"}). Only responses with one of the error status code and containing an error value will be flagged as a config error',
         examples=[["invalid_grant", "invalid_permissions"]],
-        title="Refresh Token Error Values",
+        title="(Deprecated - Use the same field on the OAuthAuthenticator level) Refresh Token Error Values",
     )
 
 
@@ -1586,6 +1586,11 @@ class IncrementingCountCursor(BaseModel):
         examples=["created_at", "{{ config['record_cursor'] }}"],
         title="Cursor Field",
     )
+    allow_catalog_defined_cursor_field: Optional[bool] = Field(
+        None,
+        description="Whether the cursor allows users to override the default cursor_field when configuring their connection. The user defined cursor field will be specified from within the configured catalog.",
+        title="Allow Catalog Defined Cursor Field",
+    )
     start_value: Optional[Union[str, int]] = Field(
         None,
         description="The value that determines the earliest record that should be synced.",
@@ -1613,6 +1618,11 @@ class DatetimeBasedCursor(BaseModel):
         examples=["created_at", "{{ config['record_cursor'] }}"],
         title="Cursor Field",
     )
+    allow_catalog_defined_cursor_field: Optional[bool] = Field(
+        None,
+        description="Whether the cursor allows users to override the default cursor_field when configuring their connection. The user defined cursor field will be specified from within the configured catalog.",
+        title="Allow Catalog Defined Cursor Field",
+    )
     cursor_datetime_formats: Optional[List[str]] = Field(
         None,
         description="The possible formats for the cursor field, in order of preference. The first format that matches the cursor field value will be used to parse it. If not provided, the Outgoing Datetime Format will be used.\nUse placeholders starting with \"%\" to describe the format the API is using. The following placeholders are available:\n  * **%s**: Epoch unix timestamp - `1686218963`\n  * **%s_as_float**: Epoch unix timestamp in seconds as float with microsecond precision - `1686218963.123456`\n  * **%ms**: Epoch unix timestamp - `1686218963123`\n  * **%a**: Weekday (abbreviated) - `Sun`\n  * **%A**: Weekday (full) - `Sunday`\n  * **%w**: Weekday (decimal) - `0` (Sunday), `6` (Saturday)\n  * **%d**: Day of the month (zero-padded) - `01`, `02`, ..., `31`\n  * **%b**: Month (abbreviated) - `Jan`\n  * **%B**: Month (full) - `January`\n  * **%m**: Month (zero-padded) - `01`, `02`, ..., `12`\n  * **%y**: Year (without century, zero-padded) - `00`, `01`, ..., `99`\n  * **%Y**: Year (with century) - `0001`, `0002`, ..., `9999`\n  * **%H**: Hour (24-hour, zero-padded) - `00`, `01`, ..., `23`\n  * **%I**: Hour (12-hour, zero-padded) - `01`, `02`, ..., `12`\n  * **%p**: AM/PM indicator\n  * **%M**: Minute (zero-padded) - `00`, `01`, ..., `59`\n  * **%S**: Second (zero-padded) - `00`, `01`, ..., `59`\n  * **%f**: Microsecond (zero-padded to 6 digits) - `000000`, `000001`, ..., `999999`\n  * **%_ms**: Millisecond (zero-padded to 3 digits) - `000`, `001`, ..., `999`\n  * **%z**: UTC offset - `(empty)`, `+0000`, `-04:00`\n  * **%Z**: Time zone name - `(empty)`, `UTC`, `GMT`\n  * **%j**: Day of the year (zero-padded) - `001`, `002`, ..., `366`\n  * **%U**: Week number of the year (Sunday as first day) - `00`, `01`, ..., `53`\n  * **%W**: Week number of the year (Monday as first day) - `00`, `01`, ..., `53`\n  * **%c**: Date and time representation - `Tue Aug 16 21:30:00 1988`\n  * **%x**: Date representation - `08/16/1988`\n  * **%X**: Time representation - `21:30:00`\n  * **%%**: Literal '%' character\n\n  Some placeholders depend on the locale of the underlying system - in most cases this locale is configured as en/US. For more information see the [Python documentation](https://docs.python.org/3/library/datetime.html#strftime-and-strptime-format-codes).\n",
@@ -1900,6 +1910,24 @@ class OAuthAuthenticator(BaseModel):
         examples=["%Y-%m-%d %H:%M:%S.%f+00:00"],
         title="Token Expiry Date Format",
     )
+    refresh_token_error_status_codes: Optional[List[int]] = Field(
+        None,
+        description="Status Codes to Identify refresh token error in response (Refresh Token Error Key and Refresh Token Error Values should be also specified). Responses with one of the error status code and containing an error value will be flagged as a config error",
+        examples=[[400, 500]],
+        title="Refresh Token Error Status Codes",
+    )
+    refresh_token_error_key: Optional[str] = Field(
+        None,
+        description="Key to Identify refresh token error in response (Refresh Token Error Status Codes and Refresh Token Error Values should be also specified).",
+        examples=["error"],
+        title="Refresh Token Error Key",
+    )
+    refresh_token_error_values: Optional[List[str]] = Field(
+        None,
+        description='List of values to check for exception during token refresh process. Used to check if the error found in the response matches the key from the Refresh Token Error Key field (e.g. response={"error": "invalid_grant"}). Only responses with one of the error status code and containing an error value will be flagged as a config error',
+        examples=[["invalid_grant", "invalid_permissions"]],
+        title="Refresh Token Error Values",
+    )
     refresh_token_updater: Optional[RefreshTokenUpdater] = Field(
         None,
         description="When the refresh token updater is defined, new refresh tokens, access tokens and the access token expiry date are written back from the authentication response to the config object. This is important if the refresh token can only used once.",