frameio 0.0.28__py3-none-any.whl

frameio/comments/types/__init__.py

@@ -0,0 +1,40 @@
+# 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 .comments_show_request_include import CommentsShowRequestInclude
+    from .create_comment_params_data import CreateCommentParamsData
+    from .update_comment_params_data import UpdateCommentParamsData
+_dynamic_imports: typing.Dict[str, str] = {
+    "CommentsShowRequestInclude": ".comments_show_request_include",
+    "CreateCommentParamsData": ".create_comment_params_data",
+    "UpdateCommentParamsData": ".update_comment_params_data",
+}
+
+
+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__ = ["CommentsShowRequestInclude", "CreateCommentParamsData", "UpdateCommentParamsData"]

frameio/comments/types/comments_show_request_include.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+CommentsShowRequestInclude = typing.Union[typing.Literal["owner", "replies"], typing.Any]

frameio/comments/types/create_comment_params_data.py

@@ -0,0 +1,33 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.unchecked_base_model import UncheckedBaseModel
+from ...types.time_stamp import TimeStamp
+
+
+class CreateCommentParamsData(UncheckedBaseModel):
+    annotation: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    JSON geometry for on-screen drawings. Allowed for document, image, video, or stream file types. JSON must be stringified.
+    """
+
+    completed: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Comment completion status
+    """
+
+    page: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Document page. Only allowed when file type is a pdf document
+    """
+
+    text: str = pydantic.Field()
+    """
+    Comment text (required)
+    """
+
+    timestamp: typing.Optional[TimeStamp] = None
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)

frameio/comments/types/update_comment_params_data.py

@@ -0,0 +1,33 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.unchecked_base_model import UncheckedBaseModel
+from ...types.time_stamp import TimeStamp
+
+
+class UpdateCommentParamsData(UncheckedBaseModel):
+    annotation: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    JSON geometry for on-screen drawings. Allowed for document, image, video, or stream file types. JSON must be stringified.
+    """
+
+    completed: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Comment completion status
+    """
+
+    page: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Document page. Only allowed when file type is a pdf document
+    """
+
+    text: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Comment text
+    """
+
+    timestamp: typing.Optional[TimeStamp] = None
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)

frameio/core/__init__.py

@@ -0,0 +1,122 @@
+# 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 .custom_pagination import AsyncCustomPager, SyncCustomPager
+    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 .pagination import AsyncPager, SyncPager
+    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
+    from .unchecked_base_model import UncheckedBaseModel, UnionMetadata, construct_type
+_dynamic_imports: typing.Dict[str, str] = {
+    "ApiError": ".api_error",
+    "AsyncClientWrapper": ".client_wrapper",
+    "AsyncCustomPager": ".custom_pagination",
+    "AsyncHttpClient": ".http_client",
+    "AsyncHttpResponse": ".http_response",
+    "AsyncPager": ".pagination",
+    "BaseClientWrapper": ".client_wrapper",
+    "FieldMetadata": ".serialization",
+    "File": ".file",
+    "HttpClient": ".http_client",
+    "HttpResponse": ".http_response",
+    "IS_PYDANTIC_V2": ".pydantic_utilities",
+    "RequestOptions": ".request_options",
+    "SyncClientWrapper": ".client_wrapper",
+    "SyncCustomPager": ".custom_pagination",
+    "SyncPager": ".pagination",
+    "UncheckedBaseModel": ".unchecked_base_model",
+    "UnionMetadata": ".unchecked_base_model",
+    "UniversalBaseModel": ".pydantic_utilities",
+    "UniversalRootModel": ".pydantic_utilities",
+    "construct_type": ".unchecked_base_model",
+    "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",
+    "AsyncCustomPager",
+    "AsyncHttpClient",
+    "AsyncHttpResponse",
+    "AsyncPager",
+    "BaseClientWrapper",
+    "FieldMetadata",
+    "File",
+    "HttpClient",
+    "HttpResponse",
+    "IS_PYDANTIC_V2",
+    "RequestOptions",
+    "SyncClientWrapper",
+    "SyncCustomPager",
+    "SyncPager",
+    "UncheckedBaseModel",
+    "UnionMetadata",
+    "UniversalBaseModel",
+    "UniversalRootModel",
+    "construct_type",
+    "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",
+]

frameio/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}"

frameio/core/client_wrapper.py

@@ -0,0 +1,95 @@
+# 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,
+        *,
+        token: typing.Union[str, typing.Callable[[], str]],
+        headers: typing.Optional[typing.Dict[str, str]] = None,
+        base_url: str,
+        timeout: typing.Optional[float] = None,
+    ):
+        self._token = token
+        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": "frameio/0.0.28",
+            "X-Fern-Language": "Python",
+            "X-Fern-SDK-Name": "frameio",
+            "X-Fern-SDK-Version": "0.0.28",
+            **(self.get_custom_headers() or {}),
+        }
+        headers["Authorization"] = f"Bearer {self._get_token()}"
+        return headers
+
+    def _get_token(self) -> str:
+        if isinstance(self._token, str):
+            return self._token
+        else:
+            return self._token()
+
+    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,
+        *,
+        token: typing.Union[str, typing.Callable[[], str]],
+        headers: typing.Optional[typing.Dict[str, str]] = None,
+        base_url: str,
+        timeout: typing.Optional[float] = None,
+        httpx_client: httpx.Client,
+    ):
+        super().__init__(token=token, 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,
+        *,
+        token: typing.Union[str, typing.Callable[[], str]],
+        headers: typing.Optional[typing.Dict[str, str]] = None,
+        base_url: str,
+        timeout: typing.Optional[float] = None,
+        async_token: typing.Optional[typing.Callable[[], typing.Awaitable[str]]] = None,
+        httpx_client: httpx.AsyncClient,
+    ):
+        super().__init__(token=token, headers=headers, base_url=base_url, timeout=timeout)
+        self._async_token = async_token
+        self.httpx_client = AsyncHttpClient(
+            httpx_client=httpx_client,
+            base_headers=self.get_headers,
+            base_timeout=self.get_timeout,
+            base_url=self.get_base_url,
+            async_base_headers=self.async_get_headers,
+        )
+
+    async def async_get_headers(self) -> typing.Dict[str, str]:
+        headers = self.get_headers()
+        if self._async_token is not None:
+            token = await self._async_token()
+            headers["Authorization"] = f"Bearer {token}"
+        return headers

frameio/core/custom_pagination.py

@@ -0,0 +1,152 @@
+# This file was auto-generated by Fern from our API Definition.
+
+"""
+Custom Pagination Support
+
+This file is designed to be modified by SDK users to implement their own
+pagination logic. The generator will import SyncCustomPager and AsyncCustomPager
+from this module when custom pagination is used.
+
+Users should:
+1. Implement their custom pager (e.g., PayrocPager, MyCustomPager, etc.)
+2. Create adapter classes (SyncCustomPager/AsyncCustomPager) that bridge
+   between the generated SDK code and their custom pager implementation
+"""
+
+from __future__ import annotations
+
+from typing import Any, AsyncIterator, Generic, Iterator, TypeVar
+
+# Import the base utilities you'll need
+# Adjust these imports based on your actual structure
+try:
+    from .client_wrapper import AsyncClientWrapper, SyncClientWrapper
+except ImportError:
+    # Fallback for type hints
+    AsyncClientWrapper = Any  # type: ignore
+    SyncClientWrapper = Any  # type: ignore
+
+TItem = TypeVar("TItem")
+TResponse = TypeVar("TResponse")
+
+
+class SyncCustomPager(Generic[TItem, TResponse]):
+    """
+    Adapter for custom synchronous pagination.
+
+    The generator will call this with:
+        SyncCustomPager(initial_response=response, client_wrapper=client_wrapper)
+
+    Implement this class to extract pagination metadata from your response
+    and delegate to your custom pager implementation.
+
+    Example implementation:
+
+        class SyncCustomPager(Generic[TItem, TResponse]):
+            def __init__(
+                self,
+                *,
+                initial_response: TResponse,
+                client_wrapper: SyncClientWrapper,
+            ):
+                # Extract data and pagination metadata from response
+                data = initial_response.data  # Adjust based on your response structure
+                links = initial_response.links
+
+                # Initialize your custom pager
+                self._pager = MyCustomPager(
+                    current_page=Page(data),
+                    httpx_client=client_wrapper.httpx_client,
+                    get_headers=client_wrapper.get_headers,
+                    # ... other parameters
+                )
+
+            def __iter__(self):
+                return iter(self._pager)
+
+            # Delegate other methods to your pager...
+    """
+
+    def __init__(
+        self,
+        *,
+        initial_response: TResponse,
+        client_wrapper: SyncClientWrapper,
+    ):
+        """
+        Initialize the custom pager.
+
+        Args:
+            initial_response: The parsed API response from the first request
+            client_wrapper: The client wrapper providing HTTP client and utilities
+        """
+        raise NotImplementedError(
+            "SyncCustomPager must be implemented. "
+            "Please implement this class in core/custom_pagination.py to define your pagination logic. "
+            "See the class docstring for examples."
+        )
+
+    def __iter__(self) -> Iterator[TItem]:
+        """Iterate through all items across all pages."""
+        raise NotImplementedError("Must implement __iter__ method")
+
+
+class AsyncCustomPager(Generic[TItem, TResponse]):
+    """
+    Adapter for custom asynchronous pagination.
+
+    The generator will call this with:
+        AsyncCustomPager(initial_response=response, client_wrapper=client_wrapper)
+
+    Implement this class to extract pagination metadata from your response
+    and delegate to your custom async pager implementation.
+
+    Example implementation:
+
+        class AsyncCustomPager(Generic[TItem, TResponse]):
+            def __init__(
+                self,
+                *,
+                initial_response: TResponse,
+                client_wrapper: AsyncClientWrapper,
+            ):
+                # Extract data and pagination metadata from response
+                data = initial_response.data  # Adjust based on your response structure
+                links = initial_response.links
+
+                # Initialize your custom async pager
+                self._pager = MyAsyncCustomPager(
+                    current_page=Page(data),
+                    httpx_client=client_wrapper.httpx_client,
+                    get_headers=client_wrapper.get_headers,
+                    # ... other parameters
+                )
+
+            async def __aiter__(self):
+                return self._pager.__aiter__()
+
+            # Delegate other methods to your pager...
+    """
+
+    def __init__(
+        self,
+        *,
+        initial_response: TResponse,
+        client_wrapper: AsyncClientWrapper,
+    ):
+        """
+        Initialize the custom async pager.
+
+        Args:
+            initial_response: The parsed API response from the first request
+            client_wrapper: The client wrapper providing HTTP client and utilities
+        """
+        raise NotImplementedError(
+            "AsyncCustomPager must be implemented. "
+            "Please implement this class in core/custom_pagination.py to define your pagination logic. "
+            "See the class docstring for examples."
+        )
+
+    async def __aiter__(self) -> AsyncIterator[TItem]:
+        """Asynchronously iterate through all items across all pages."""
+        raise NotImplementedError("Must implement __aiter__ method")

frameio/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)

frameio/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)

frameio/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()