newscatcher-catchall-sdk 0.1.0__py3-none-any.whl

newscatcher_catchall/__init__.py

@@ -0,0 +1,149 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+    from .types import (
+        Citation,
+        Context,
+        CreateMonitorResponseDto,
+        Error,
+        JobStatus,
+        ListMonitorsResponseDto,
+        ListUserJobsResponseDto,
+        MonitorJobItem,
+        MonitorListItem,
+        PullJobResponseDto,
+        PullJobResponseDtoDateRange,
+        PullMonitorResponseDto,
+        PullMonitorResponseDtoDateRange,
+        PullMonitorResponseDtoReferenceJob,
+        Query,
+        Record,
+        Schema,
+        StatusResponseDto,
+        SubmitResponseBody,
+        ValidationErrorDetail,
+        ValidationErrorDetailLocItem,
+        ValidationErrorResponse,
+        WebhookDto,
+        WebhookDtoMethod,
+        WebhookPayload,
+    )
+    from .errors import ForbiddenError, NotFoundError, UnprocessableEntityError
+    from . import jobs, meta, monitors
+    from .client import AsyncCatchAllApi, CatchAllApi
+    from .environment import CatchAllApiEnvironment
+    from .meta import GetVersionResponse, HealthCheckResponse
+    from .monitors import DisableMonitorResponse, EnableMonitorResponse, ListMonitorJobsRequestSort
+    from .version import __version__
+_dynamic_imports: typing.Dict[str, str] = {
+    "AsyncCatchAllApi": ".client",
+    "CatchAllApi": ".client",
+    "CatchAllApiEnvironment": ".environment",
+    "Citation": ".types",
+    "Context": ".types",
+    "CreateMonitorResponseDto": ".types",
+    "DisableMonitorResponse": ".monitors",
+    "EnableMonitorResponse": ".monitors",
+    "Error": ".types",
+    "ForbiddenError": ".errors",
+    "GetVersionResponse": ".meta",
+    "HealthCheckResponse": ".meta",
+    "JobStatus": ".types",
+    "ListMonitorJobsRequestSort": ".monitors",
+    "ListMonitorsResponseDto": ".types",
+    "ListUserJobsResponseDto": ".types",
+    "MonitorJobItem": ".types",
+    "MonitorListItem": ".types",
+    "NotFoundError": ".errors",
+    "PullJobResponseDto": ".types",
+    "PullJobResponseDtoDateRange": ".types",
+    "PullMonitorResponseDto": ".types",
+    "PullMonitorResponseDtoDateRange": ".types",
+    "PullMonitorResponseDtoReferenceJob": ".types",
+    "Query": ".types",
+    "Record": ".types",
+    "Schema": ".types",
+    "StatusResponseDto": ".types",
+    "SubmitResponseBody": ".types",
+    "UnprocessableEntityError": ".errors",
+    "ValidationErrorDetail": ".types",
+    "ValidationErrorDetailLocItem": ".types",
+    "ValidationErrorResponse": ".types",
+    "WebhookDto": ".types",
+    "WebhookDtoMethod": ".types",
+    "WebhookPayload": ".types",
+    "__version__": ".version",
+    "jobs": ".jobs",
+    "meta": ".meta",
+    "monitors": ".monitors",
+}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+    module_name = _dynamic_imports.get(attr_name)
+    if module_name is None:
+        raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+    try:
+        module = import_module(module_name, __package__)
+        if module_name == f".{attr_name}":
+            return module
+        else:
+            return getattr(module, attr_name)
+    except ImportError as e:
+        raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+    except AttributeError as e:
+        raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+    lazy_attrs = list(_dynamic_imports.keys())
+    return sorted(lazy_attrs)
+
+
+__all__ = [
+    "AsyncCatchAllApi",
+    "CatchAllApi",
+    "CatchAllApiEnvironment",
+    "Citation",
+    "Context",
+    "CreateMonitorResponseDto",
+    "DisableMonitorResponse",
+    "EnableMonitorResponse",
+    "Error",
+    "ForbiddenError",
+    "GetVersionResponse",
+    "HealthCheckResponse",
+    "JobStatus",
+    "ListMonitorJobsRequestSort",
+    "ListMonitorsResponseDto",
+    "ListUserJobsResponseDto",
+    "MonitorJobItem",
+    "MonitorListItem",
+    "NotFoundError",
+    "PullJobResponseDto",
+    "PullJobResponseDtoDateRange",
+    "PullMonitorResponseDto",
+    "PullMonitorResponseDtoDateRange",
+    "PullMonitorResponseDtoReferenceJob",
+    "Query",
+    "Record",
+    "Schema",
+    "StatusResponseDto",
+    "SubmitResponseBody",
+    "UnprocessableEntityError",
+    "ValidationErrorDetail",
+    "ValidationErrorDetailLocItem",
+    "ValidationErrorResponse",
+    "WebhookDto",
+    "WebhookDtoMethod",
+    "WebhookPayload",
+    "__version__",
+    "jobs",
+    "meta",
+    "monitors",
+]

newscatcher_catchall/client.py

@@ -0,0 +1,211 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import typing
+
+import httpx
+from .core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from .environment import CatchAllApiEnvironment
+
+if typing.TYPE_CHECKING:
+    from .jobs.client import AsyncJobsClient, JobsClient
+    from .meta.client import AsyncMetaClient, MetaClient
+    from .monitors.client import AsyncMonitorsClient, MonitorsClient
+
+
+class CatchAllApi:
+    """
+    Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propagate to these functions.
+
+    Parameters
+    ----------
+    base_url : typing.Optional[str]
+        The base url to use for requests from the client.
+
+    environment : CatchAllApiEnvironment
+        The environment to use for requests from the client. from .environment import CatchAllApiEnvironment
+
+
+
+        Defaults to CatchAllApiEnvironment.DEFAULT
+
+
+
+    api_key : str
+    headers : typing.Optional[typing.Dict[str, str]]
+        Additional headers to send with every request.
+
+    timeout : typing.Optional[float]
+        The timeout to be used, in seconds, for requests. By default the timeout is 60 seconds, unless a custom httpx client is used, in which case this default is not enforced.
+
+    follow_redirects : typing.Optional[bool]
+        Whether the default httpx client follows redirects or not, this is irrelevant if a custom httpx client is passed in.
+
+    httpx_client : typing.Optional[httpx.Client]
+        The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
+
+    Examples
+    --------
+    from newscatcher_catchall import CatchAllApi
+
+    client = CatchAllApi(
+        api_key="YOUR_API_KEY",
+    )
+    """
+
+    def __init__(
+        self,
+        *,
+        base_url: typing.Optional[str] = None,
+        environment: CatchAllApiEnvironment = CatchAllApiEnvironment.DEFAULT,
+        api_key: str,
+        headers: typing.Optional[typing.Dict[str, str]] = None,
+        timeout: typing.Optional[float] = None,
+        follow_redirects: typing.Optional[bool] = True,
+        httpx_client: typing.Optional[httpx.Client] = None,
+    ):
+        _defaulted_timeout = (
+            timeout if timeout is not None else 60 if httpx_client is None else httpx_client.timeout.read
+        )
+        self._client_wrapper = SyncClientWrapper(
+            base_url=_get_base_url(base_url=base_url, environment=environment),
+            api_key=api_key,
+            headers=headers,
+            httpx_client=httpx_client
+            if httpx_client is not None
+            else httpx.Client(timeout=_defaulted_timeout, follow_redirects=follow_redirects)
+            if follow_redirects is not None
+            else httpx.Client(timeout=_defaulted_timeout),
+            timeout=_defaulted_timeout,
+        )
+        self._jobs: typing.Optional[JobsClient] = None
+        self._monitors: typing.Optional[MonitorsClient] = None
+        self._meta: typing.Optional[MetaClient] = None
+
+    @property
+    def jobs(self):
+        if self._jobs is None:
+            from .jobs.client import JobsClient  # noqa: E402
+
+            self._jobs = JobsClient(client_wrapper=self._client_wrapper)
+        return self._jobs
+
+    @property
+    def monitors(self):
+        if self._monitors is None:
+            from .monitors.client import MonitorsClient  # noqa: E402
+
+            self._monitors = MonitorsClient(client_wrapper=self._client_wrapper)
+        return self._monitors
+
+    @property
+    def meta(self):
+        if self._meta is None:
+            from .meta.client import MetaClient  # noqa: E402
+
+            self._meta = MetaClient(client_wrapper=self._client_wrapper)
+        return self._meta
+
+
+class AsyncCatchAllApi:
+    """
+    Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propagate to these functions.
+
+    Parameters
+    ----------
+    base_url : typing.Optional[str]
+        The base url to use for requests from the client.
+
+    environment : CatchAllApiEnvironment
+        The environment to use for requests from the client. from .environment import CatchAllApiEnvironment
+
+
+
+        Defaults to CatchAllApiEnvironment.DEFAULT
+
+
+
+    api_key : str
+    headers : typing.Optional[typing.Dict[str, str]]
+        Additional headers to send with every request.
+
+    timeout : typing.Optional[float]
+        The timeout to be used, in seconds, for requests. By default the timeout is 60 seconds, unless a custom httpx client is used, in which case this default is not enforced.
+
+    follow_redirects : typing.Optional[bool]
+        Whether the default httpx client follows redirects or not, this is irrelevant if a custom httpx client is passed in.
+
+    httpx_client : typing.Optional[httpx.AsyncClient]
+        The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
+
+    Examples
+    --------
+    from newscatcher_catchall import AsyncCatchAllApi
+
+    client = AsyncCatchAllApi(
+        api_key="YOUR_API_KEY",
+    )
+    """
+
+    def __init__(
+        self,
+        *,
+        base_url: typing.Optional[str] = None,
+        environment: CatchAllApiEnvironment = CatchAllApiEnvironment.DEFAULT,
+        api_key: str,
+        headers: typing.Optional[typing.Dict[str, str]] = None,
+        timeout: typing.Optional[float] = None,
+        follow_redirects: typing.Optional[bool] = True,
+        httpx_client: typing.Optional[httpx.AsyncClient] = None,
+    ):
+        _defaulted_timeout = (
+            timeout if timeout is not None else 60 if httpx_client is None else httpx_client.timeout.read
+        )
+        self._client_wrapper = AsyncClientWrapper(
+            base_url=_get_base_url(base_url=base_url, environment=environment),
+            api_key=api_key,
+            headers=headers,
+            httpx_client=httpx_client
+            if httpx_client is not None
+            else httpx.AsyncClient(timeout=_defaulted_timeout, follow_redirects=follow_redirects)
+            if follow_redirects is not None
+            else httpx.AsyncClient(timeout=_defaulted_timeout),
+            timeout=_defaulted_timeout,
+        )
+        self._jobs: typing.Optional[AsyncJobsClient] = None
+        self._monitors: typing.Optional[AsyncMonitorsClient] = None
+        self._meta: typing.Optional[AsyncMetaClient] = None
+
+    @property
+    def jobs(self):
+        if self._jobs is None:
+            from .jobs.client import AsyncJobsClient  # noqa: E402
+
+            self._jobs = AsyncJobsClient(client_wrapper=self._client_wrapper)
+        return self._jobs
+
+    @property
+    def monitors(self):
+        if self._monitors is None:
+            from .monitors.client import AsyncMonitorsClient  # noqa: E402
+
+            self._monitors = AsyncMonitorsClient(client_wrapper=self._client_wrapper)
+        return self._monitors
+
+    @property
+    def meta(self):
+        if self._meta is None:
+            from .meta.client import AsyncMetaClient  # noqa: E402
+
+            self._meta = AsyncMetaClient(client_wrapper=self._client_wrapper)
+        return self._meta
+
+
+def _get_base_url(*, base_url: typing.Optional[str] = None, environment: CatchAllApiEnvironment) -> str:
+    if base_url is not None:
+        return base_url
+    elif environment is not None:
+        return environment.value
+    else:
+        raise Exception("Please pass in either base_url or environment to construct the client")

newscatcher_catchall/core/__init__.py

@@ -0,0 +1,105 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+    from .api_error import ApiError
+    from .client_wrapper import AsyncClientWrapper, BaseClientWrapper, SyncClientWrapper
+    from .datetime_utils import serialize_datetime
+    from .file import File, convert_file_dict_to_httpx_tuples, with_content_type
+    from .http_client import AsyncHttpClient, HttpClient
+    from .http_response import AsyncHttpResponse, HttpResponse
+    from .jsonable_encoder import jsonable_encoder
+    from .pydantic_utilities import (
+        IS_PYDANTIC_V2,
+        UniversalBaseModel,
+        UniversalRootModel,
+        parse_obj_as,
+        universal_field_validator,
+        universal_root_validator,
+        update_forward_refs,
+    )
+    from .query_encoder import encode_query
+    from .remove_none_from_dict import remove_none_from_dict
+    from .request_options import RequestOptions
+    from .serialization import FieldMetadata, convert_and_respect_annotation_metadata
+_dynamic_imports: typing.Dict[str, str] = {
+    "ApiError": ".api_error",
+    "AsyncClientWrapper": ".client_wrapper",
+    "AsyncHttpClient": ".http_client",
+    "AsyncHttpResponse": ".http_response",
+    "BaseClientWrapper": ".client_wrapper",
+    "FieldMetadata": ".serialization",
+    "File": ".file",
+    "HttpClient": ".http_client",
+    "HttpResponse": ".http_response",
+    "IS_PYDANTIC_V2": ".pydantic_utilities",
+    "RequestOptions": ".request_options",
+    "SyncClientWrapper": ".client_wrapper",
+    "UniversalBaseModel": ".pydantic_utilities",
+    "UniversalRootModel": ".pydantic_utilities",
+    "convert_and_respect_annotation_metadata": ".serialization",
+    "convert_file_dict_to_httpx_tuples": ".file",
+    "encode_query": ".query_encoder",
+    "jsonable_encoder": ".jsonable_encoder",
+    "parse_obj_as": ".pydantic_utilities",
+    "remove_none_from_dict": ".remove_none_from_dict",
+    "serialize_datetime": ".datetime_utils",
+    "universal_field_validator": ".pydantic_utilities",
+    "universal_root_validator": ".pydantic_utilities",
+    "update_forward_refs": ".pydantic_utilities",
+    "with_content_type": ".file",
+}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+    module_name = _dynamic_imports.get(attr_name)
+    if module_name is None:
+        raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+    try:
+        module = import_module(module_name, __package__)
+        if module_name == f".{attr_name}":
+            return module
+        else:
+            return getattr(module, attr_name)
+    except ImportError as e:
+        raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+    except AttributeError as e:
+        raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+    lazy_attrs = list(_dynamic_imports.keys())
+    return sorted(lazy_attrs)
+
+
+__all__ = [
+    "ApiError",
+    "AsyncClientWrapper",
+    "AsyncHttpClient",
+    "AsyncHttpResponse",
+    "BaseClientWrapper",
+    "FieldMetadata",
+    "File",
+    "HttpClient",
+    "HttpResponse",
+    "IS_PYDANTIC_V2",
+    "RequestOptions",
+    "SyncClientWrapper",
+    "UniversalBaseModel",
+    "UniversalRootModel",
+    "convert_and_respect_annotation_metadata",
+    "convert_file_dict_to_httpx_tuples",
+    "encode_query",
+    "jsonable_encoder",
+    "parse_obj_as",
+    "remove_none_from_dict",
+    "serialize_datetime",
+    "universal_field_validator",
+    "universal_root_validator",
+    "update_forward_refs",
+    "with_content_type",
+]

newscatcher_catchall/core/api_error.py

@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from typing import Any, Dict, Optional
+
+
+class ApiError(Exception):
+    headers: Optional[Dict[str, str]]
+    status_code: Optional[int]
+    body: Any
+
+    def __init__(
+        self,
+        *,
+        headers: Optional[Dict[str, str]] = None,
+        status_code: Optional[int] = None,
+        body: Any = None,
+    ) -> None:
+        self.headers = headers
+        self.status_code = status_code
+        self.body = body
+
+    def __str__(self) -> str:
+        return f"headers: {self.headers}, status_code: {self.status_code}, body: {self.body}"

newscatcher_catchall/core/client_wrapper.py

@@ -0,0 +1,79 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import httpx
+from .http_client import AsyncHttpClient, HttpClient
+
+
+class BaseClientWrapper:
+    def __init__(
+        self,
+        *,
+        api_key: str,
+        headers: typing.Optional[typing.Dict[str, str]] = None,
+        base_url: str,
+        timeout: typing.Optional[float] = None,
+    ):
+        self.api_key = api_key
+        self._headers = headers
+        self._base_url = base_url
+        self._timeout = timeout
+
+    def get_headers(self) -> typing.Dict[str, str]:
+        headers: typing.Dict[str, str] = {
+            "User-Agent": "newscatcher-catchall-sdk/0.1.0",
+            "X-Fern-Language": "Python",
+            "X-Fern-SDK-Name": "newscatcher-catchall-sdk",
+            "X-Fern-SDK-Version": "0.1.0",
+            **(self.get_custom_headers() or {}),
+        }
+        headers["x-api-key"] = self.api_key
+        return headers
+
+    def get_custom_headers(self) -> typing.Optional[typing.Dict[str, str]]:
+        return self._headers
+
+    def get_base_url(self) -> str:
+        return self._base_url
+
+    def get_timeout(self) -> typing.Optional[float]:
+        return self._timeout
+
+
+class SyncClientWrapper(BaseClientWrapper):
+    def __init__(
+        self,
+        *,
+        api_key: str,
+        headers: typing.Optional[typing.Dict[str, str]] = None,
+        base_url: str,
+        timeout: typing.Optional[float] = None,
+        httpx_client: httpx.Client,
+    ):
+        super().__init__(api_key=api_key, headers=headers, base_url=base_url, timeout=timeout)
+        self.httpx_client = HttpClient(
+            httpx_client=httpx_client,
+            base_headers=self.get_headers,
+            base_timeout=self.get_timeout,
+            base_url=self.get_base_url,
+        )
+
+
+class AsyncClientWrapper(BaseClientWrapper):
+    def __init__(
+        self,
+        *,
+        api_key: str,
+        headers: typing.Optional[typing.Dict[str, str]] = None,
+        base_url: str,
+        timeout: typing.Optional[float] = None,
+        httpx_client: httpx.AsyncClient,
+    ):
+        super().__init__(api_key=api_key, headers=headers, base_url=base_url, timeout=timeout)
+        self.httpx_client = AsyncHttpClient(
+            httpx_client=httpx_client,
+            base_headers=self.get_headers,
+            base_timeout=self.get_timeout,
+            base_url=self.get_base_url,
+        )

newscatcher_catchall/core/datetime_utils.py

@@ -0,0 +1,28 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+
+
+def serialize_datetime(v: dt.datetime) -> str:
+    """
+    Serialize a datetime including timezone info.
+
+    Uses the timezone info provided if present, otherwise uses the current runtime's timezone info.
+
+    UTC datetimes end in "Z" while all other timezones are represented as offset from UTC, e.g. +05:00.
+    """
+
+    def _serialize_zoned_datetime(v: dt.datetime) -> str:
+        if v.tzinfo is not None and v.tzinfo.tzname(None) == dt.timezone.utc.tzname(None):
+            # UTC is a special case where we use "Z" at the end instead of "+00:00"
+            return v.isoformat().replace("+00:00", "Z")
+        else:
+            # Delegate to the typical +/- offset format
+            return v.isoformat()
+
+    if v.tzinfo is not None:
+        return _serialize_zoned_datetime(v)
+    else:
+        local_tz = dt.datetime.now().astimezone().tzinfo
+        localized_dt = v.replace(tzinfo=local_tz)
+        return _serialize_zoned_datetime(localized_dt)

newscatcher_catchall/core/file.py

@@ -0,0 +1,67 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from typing import IO, Dict, List, Mapping, Optional, Tuple, Union, cast
+
+# File typing inspired by the flexibility of types within the httpx library
+# https://github.com/encode/httpx/blob/master/httpx/_types.py
+FileContent = Union[IO[bytes], bytes, str]
+File = Union[
+    # file (or bytes)
+    FileContent,
+    # (filename, file (or bytes))
+    Tuple[Optional[str], FileContent],
+    # (filename, file (or bytes), content_type)
+    Tuple[Optional[str], FileContent, Optional[str]],
+    # (filename, file (or bytes), content_type, headers)
+    Tuple[
+        Optional[str],
+        FileContent,
+        Optional[str],
+        Mapping[str, str],
+    ],
+]
+
+
+def convert_file_dict_to_httpx_tuples(
+    d: Dict[str, Union[File, List[File]]],
+) -> List[Tuple[str, File]]:
+    """
+    The format we use is a list of tuples, where the first element is the
+    name of the file and the second is the file object. Typically HTTPX wants
+    a dict, but to be able to send lists of files, you have to use the list
+    approach (which also works for non-lists)
+    https://github.com/encode/httpx/pull/1032
+    """
+
+    httpx_tuples = []
+    for key, file_like in d.items():
+        if isinstance(file_like, list):
+            for file_like_item in file_like:
+                httpx_tuples.append((key, file_like_item))
+        else:
+            httpx_tuples.append((key, file_like))
+    return httpx_tuples
+
+
+def with_content_type(*, file: File, default_content_type: str) -> File:
+    """
+    This function resolves to the file's content type, if provided, and defaults
+    to the default_content_type value if not.
+    """
+    if isinstance(file, tuple):
+        if len(file) == 2:
+            filename, content = cast(Tuple[Optional[str], FileContent], file)  # type: ignore
+            return (filename, content, default_content_type)
+        elif len(file) == 3:
+            filename, content, file_content_type = cast(Tuple[Optional[str], FileContent, Optional[str]], file)  # type: ignore
+            out_content_type = file_content_type or default_content_type
+            return (filename, content, out_content_type)
+        elif len(file) == 4:
+            filename, content, file_content_type, headers = cast(  # type: ignore
+                Tuple[Optional[str], FileContent, Optional[str], Mapping[str, str]], file
+            )
+            out_content_type = file_content_type or default_content_type
+            return (filename, content, out_content_type, headers)
+        else:
+            raise ValueError(f"Unexpected tuple length: {len(file)}")
+    return (None, file, default_content_type)

newscatcher_catchall/core/force_multipart.py

@@ -0,0 +1,18 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from typing import Any, Dict
+
+
+class ForceMultipartDict(Dict[str, Any]):
+    """
+    A dictionary subclass that always evaluates to True in boolean contexts.
+
+    This is used to force multipart/form-data encoding in HTTP requests even when
+    the dictionary is empty, which would normally evaluate to False.
+    """
+
+    def __bool__(self) -> bool:
+        return True
+
+
+FORCE_MULTIPART = ForceMultipartDict()