python-alfresco-api 1.0.0__py3-none-any.whl

python_alfresco_api/raw_clients/alfresco_discovery_client/discovery_client/models/repository_info.py

@@ -0,0 +1,132 @@
+from collections.abc import Mapping
+from typing import TYPE_CHECKING, Any, TypeVar, Union
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..types import UNSET, Unset
+
+if TYPE_CHECKING:
+    from ..models.license_info import LicenseInfo
+    from ..models.module_info import ModuleInfo
+    from ..models.status_info import StatusInfo
+    from ..models.version_info import VersionInfo
+
+
+T = TypeVar("T", bound="RepositoryInfo")
+
+
+@_attrs_define
+class RepositoryInfo:
+    """
+    Attributes:
+        edition (str):
+        id (str):
+        status (StatusInfo):
+        version (VersionInfo):
+        license_ (Union[Unset, LicenseInfo]):
+        modules (Union[Unset, list['ModuleInfo']]):
+    """
+
+    edition: str
+    id: str
+    status: "StatusInfo"
+    version: "VersionInfo"
+    license_: Union[Unset, "LicenseInfo"] = UNSET
+    modules: Union[Unset, list["ModuleInfo"]] = UNSET
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        edition = self.edition
+
+        id = self.id
+
+        status = self.status.to_dict()
+
+        version = self.version.to_dict()
+
+        license_: Union[Unset, dict[str, Any]] = UNSET
+        if not isinstance(self.license_, Unset):
+            license_ = self.license_.to_dict()
+
+        modules: Union[Unset, list[dict[str, Any]]] = UNSET
+        if not isinstance(self.modules, Unset):
+            modules = []
+            for modules_item_data in self.modules:
+                modules_item = modules_item_data.to_dict()
+                modules.append(modules_item)
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "edition": edition,
+                "id": id,
+                "status": status,
+                "version": version,
+            }
+        )
+        if license_ is not UNSET:
+            field_dict["license"] = license_
+        if modules is not UNSET:
+            field_dict["modules"] = modules
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        from ..models.license_info import LicenseInfo
+        from ..models.module_info import ModuleInfo
+        from ..models.status_info import StatusInfo
+        from ..models.version_info import VersionInfo
+
+        d = dict(src_dict)
+        edition = d.pop("edition")
+
+        id = d.pop("id")
+
+        status = StatusInfo.from_dict(d.pop("status"))
+
+        version = VersionInfo.from_dict(d.pop("version"))
+
+        _license_ = d.pop("license", UNSET)
+        license_: Union[Unset, LicenseInfo]
+        if isinstance(_license_, Unset):
+            license_ = UNSET
+        else:
+            license_ = LicenseInfo.from_dict(_license_)
+
+        modules = []
+        _modules = d.pop("modules", UNSET)
+        for modules_item_data in _modules or []:
+            modules_item = ModuleInfo.from_dict(modules_item_data)
+
+            modules.append(modules_item)
+
+        repository_info = cls(
+            edition=edition,
+            id=id,
+            status=status,
+            version=version,
+            license_=license_,
+            modules=modules,
+        )
+
+        repository_info.additional_properties = d
+        return repository_info
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

python_alfresco_api/raw_clients/alfresco_discovery_client/discovery_client/models/status_info.py

@@ -0,0 +1,83 @@
+from collections.abc import Mapping
+from typing import Any, TypeVar
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+T = TypeVar("T", bound="StatusInfo")
+
+
+@_attrs_define
+class StatusInfo:
+    """
+    Attributes:
+        is_audit_enabled (bool):
+        is_quick_share_enabled (bool):
+        is_read_only (bool):  Default: False.
+        is_thumbnail_generation_enabled (bool):
+    """
+
+    is_audit_enabled: bool
+    is_quick_share_enabled: bool
+    is_thumbnail_generation_enabled: bool
+    is_read_only: bool = False
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        is_audit_enabled = self.is_audit_enabled
+
+        is_quick_share_enabled = self.is_quick_share_enabled
+
+        is_read_only = self.is_read_only
+
+        is_thumbnail_generation_enabled = self.is_thumbnail_generation_enabled
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "isAuditEnabled": is_audit_enabled,
+                "isQuickShareEnabled": is_quick_share_enabled,
+                "isReadOnly": is_read_only,
+                "isThumbnailGenerationEnabled": is_thumbnail_generation_enabled,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+        is_audit_enabled = d.pop("isAuditEnabled")
+
+        is_quick_share_enabled = d.pop("isQuickShareEnabled")
+
+        is_read_only = d.pop("isReadOnly")
+
+        is_thumbnail_generation_enabled = d.pop("isThumbnailGenerationEnabled")
+
+        status_info = cls(
+            is_audit_enabled=is_audit_enabled,
+            is_quick_share_enabled=is_quick_share_enabled,
+            is_read_only=is_read_only,
+            is_thumbnail_generation_enabled=is_thumbnail_generation_enabled,
+        )
+
+        status_info.additional_properties = d
+        return status_info
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

python_alfresco_api/raw_clients/alfresco_discovery_client/discovery_client/models/version_info.py

@@ -0,0 +1,107 @@
+from collections.abc import Mapping
+from typing import Any, TypeVar
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+T = TypeVar("T", bound="VersionInfo")
+
+
+@_attrs_define
+class VersionInfo:
+    """
+    Attributes:
+        display (str):
+        hotfix (str):
+        label (str):
+        major (str):
+        minor (str):
+        patch (str):
+        schema (int):
+    """
+
+    display: str
+    hotfix: str
+    label: str
+    major: str
+    minor: str
+    patch: str
+    schema: int
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        display = self.display
+
+        hotfix = self.hotfix
+
+        label = self.label
+
+        major = self.major
+
+        minor = self.minor
+
+        patch = self.patch
+
+        schema = self.schema
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "display": display,
+                "hotfix": hotfix,
+                "label": label,
+                "major": major,
+                "minor": minor,
+                "patch": patch,
+                "schema": schema,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+        display = d.pop("display")
+
+        hotfix = d.pop("hotfix")
+
+        label = d.pop("label")
+
+        major = d.pop("major")
+
+        minor = d.pop("minor")
+
+        patch = d.pop("patch")
+
+        schema = d.pop("schema")
+
+        version_info = cls(
+            display=display,
+            hotfix=hotfix,
+            label=label,
+            major=major,
+            minor=minor,
+            patch=patch,
+            schema=schema,
+        )
+
+        version_info.additional_properties = d
+        return version_info
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

python_alfresco_api/raw_clients/alfresco_discovery_client/discovery_client/py.typed

@@ -0,0 +1 @@
+# Marker file for PEP 561

python_alfresco_api/raw_clients/alfresco_discovery_client/discovery_client/types.py

@@ -0,0 +1,54 @@
+"""Contains some shared types for properties"""
+
+from collections.abc import Mapping, MutableMapping
+from http import HTTPStatus
+from typing import IO, BinaryIO, Generic, Literal, Optional, TypeVar, Union
+
+from attrs import define
+
+
+class Unset:
+    def __bool__(self) -> Literal[False]:
+        return False
+
+
+UNSET: Unset = Unset()
+
+# The types that `httpx.Client(files=)` can accept, copied from that library.
+FileContent = Union[IO[bytes], bytes, str]
+FileTypes = Union[
+    # (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]],
+]
+RequestFiles = list[tuple[str, FileTypes]]
+
+
+@define
+class File:
+    """Contains information for file uploads"""
+
+    payload: BinaryIO
+    file_name: Optional[str] = None
+    mime_type: Optional[str] = None
+
+    def to_tuple(self) -> FileTypes:
+        """Return a tuple representation that httpx will accept for multipart/form-data"""
+        return self.file_name, self.payload, self.mime_type
+
+
+T = TypeVar("T")
+
+
+@define
+class Response(Generic[T]):
+    """A response from an endpoint"""
+
+    status_code: HTTPStatus
+    content: bytes
+    headers: MutableMapping[str, str]
+    parsed: Optional[T]
+
+
+__all__ = ["UNSET", "File", "FileTypes", "RequestFiles", "Response", "Unset"]

python_alfresco_api/raw_clients/alfresco_discovery_client/pyproject.toml

@@ -0,0 +1,27 @@
+[tool.poetry]
+name = "discovery_client"
+version = "1"
+description = "A client library for accessing Alfresco Content Services REST API"
+authors = []
+readme = "README.md"
+packages = [
+    {include = "discovery_client"},
+]
+include = ["CHANGELOG.md", "discovery_client/py.typed"]
+
+
+[tool.poetry.dependencies]
+python = "^3.9"
+httpx = ">=0.23.0,<0.29.0"
+attrs = ">=22.2.0"
+python-dateutil = "^2.8.0"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+select = ["F", "I", "UP"]

python_alfresco_api/raw_clients/alfresco_model_client/.gitignore

@@ -0,0 +1,23 @@
+__pycache__/
+build/
+dist/
+*.egg-info/
+.pytest_cache/
+
+# pyenv
+.python-version
+
+# Environments
+.env
+.venv
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# JetBrains
+.idea/
+
+/coverage.xml
+/.coverage

python_alfresco_api/raw_clients/alfresco_model_client/README.md

@@ -0,0 +1,124 @@
+# model_client
+A client library for accessing Alfresco Content Services REST API
+
+## Usage
+First, create a client:
+
+```python
+from model_client import Client
+
+client = Client(base_url="https://api.example.com")
+```
+
+If the endpoints you're going to hit require authentication, use `AuthenticatedClient` instead:
+
+```python
+from model_client import AuthenticatedClient
+
+client = AuthenticatedClient(base_url="https://api.example.com", token="SuperSecretToken")
+```
+
+Now call your endpoint and use your models:
+
+```python
+from model_client.models import MyDataModel
+from model_client.api.my_tag import get_my_data_model
+from model_client.types import Response
+
+with client as client:
+    my_data: MyDataModel = get_my_data_model.sync(client=client)
+    # or if you need more info (e.g. status_code)
+    response: Response[MyDataModel] = get_my_data_model.sync_detailed(client=client)
+```
+
+Or do the same thing with an async version:
+
+```python
+from model_client.models import MyDataModel
+from model_client.api.my_tag import get_my_data_model
+from model_client.types import Response
+
+async with client as client:
+    my_data: MyDataModel = await get_my_data_model.asyncio(client=client)
+    response: Response[MyDataModel] = await get_my_data_model.asyncio_detailed(client=client)
+```
+
+By default, when you're calling an HTTPS API it will attempt to verify that SSL is working correctly. Using certificate verification is highly recommended most of the time, but sometimes you may need to authenticate to a server (especially an internal server) using a custom certificate bundle.
+
+```python
+client = AuthenticatedClient(
+    base_url="https://internal_api.example.com", 
+    token="SuperSecretToken",
+    verify_ssl="/path/to/certificate_bundle.pem",
+)
+```
+
+You can also disable certificate validation altogether, but beware that **this is a security risk**.
+
+```python
+client = AuthenticatedClient(
+    base_url="https://internal_api.example.com", 
+    token="SuperSecretToken", 
+    verify_ssl=False
+)
+```
+
+Things to know:
+1. Every path/method combo becomes a Python module with four functions:
+    1. `sync`: Blocking request that returns parsed data (if successful) or `None`
+    1. `sync_detailed`: Blocking request that always returns a `Request`, optionally with `parsed` set if the request was successful.
+    1. `asyncio`: Like `sync` but async instead of blocking
+    1. `asyncio_detailed`: Like `sync_detailed` but async instead of blocking
+
+1. All path/query params, and bodies become method arguments.
+1. If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)
+1. Any endpoint which did not have a tag will be in `model_client.api.default`
+
+## Advanced customizations
+
+There are more settings on the generated `Client` class which let you control more runtime behavior, check out the docstring on that class for more info. You can also customize the underlying `httpx.Client` or `httpx.AsyncClient` (depending on your use-case):
+
+```python
+from model_client import Client
+
+def log_request(request):
+    print(f"Request event hook: {request.method} {request.url} - Waiting for response")
+
+def log_response(response):
+    request = response.request
+    print(f"Response event hook: {request.method} {request.url} - Status {response.status_code}")
+
+client = Client(
+    base_url="https://api.example.com",
+    httpx_args={"event_hooks": {"request": [log_request], "response": [log_response]}},
+)
+
+# Or get the underlying httpx client to modify directly with client.get_httpx_client() or client.get_async_httpx_client()
+```
+
+You can even set the httpx client directly, but beware that this will override any existing settings (e.g., base_url):
+
+```python
+import httpx
+from model_client import Client
+
+client = Client(
+    base_url="https://api.example.com",
+)
+# Note that base_url needs to be re-set, as would any shared cookies, headers, etc.
+client.set_httpx_client(httpx.Client(base_url="https://api.example.com", proxies="http://localhost:8030"))
+```
+
+## Building / publishing this package
+This project uses [Poetry](https://python-poetry.org/) to manage dependencies  and packaging.  Here are the basics:
+1. Update the metadata in pyproject.toml (e.g. authors, version)
+1. If you're using a private repository, configure it with Poetry
+    1. `poetry config repositories.<your-repository-name> <url-to-your-repository>`
+    1. `poetry config http-basic.<your-repository-name> <username> <password>`
+1. Publish the client with `poetry publish --build -r <your-repository-name>` or, if for public PyPI, just `poetry publish --build`
+
+If you want to install this client into another project without publishing it (e.g. for development) then:
+1. If that project **is using Poetry**, you can simply do `poetry add <path-to-this-client>` from that project
+1. If that project is not using Poetry:
+    1. Build a wheel with `poetry build -f wheel`
+    1. Install that wheel from the other project `pip install <path-to-wheel>`

python_alfresco_api/raw_clients/alfresco_model_client/model_client/__init__.py

@@ -0,0 +1,8 @@
+"""A client library for accessing Alfresco Content Services REST API"""
+
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)

python_alfresco_api/raw_clients/alfresco_model_client/model_client/api/__init__.py

@@ -0,0 +1 @@
+"""Contains methods for accessing the API"""

python_alfresco_api/raw_clients/alfresco_model_client/model_client/api/aspects/__init__.py

@@ -0,0 +1 @@
+"""Contains endpoint functions for accessing the API"""

python_alfresco_api/raw_clients/alfresco_model_client/model_client/api/aspects/get_aspect.py

@@ -0,0 +1,103 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...types import Response
+
+
+def _get_kwargs(
+    aspect_id: str,
+) -> dict[str, Any]:
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": f"/aspects/{aspect_id}",
+    }
+
+    return _kwargs
+
+
+def _parse_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Optional[Any]:
+    if response.status_code == 400:
+        return None
+    if response.status_code == 401:
+        return None
+    if response.status_code == 404:
+        return None
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Response[Any]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    aspect_id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Response[Any]:
+    """Get an aspect
+
+     **Note:** This is available in Alfresco 7.0.0 and newer versions.
+    Get information for aspect **aspectId**.
+
+    Args:
+        aspect_id (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Any]
+    """
+
+    kwargs = _get_kwargs(
+        aspect_id=aspect_id,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio_detailed(
+    aspect_id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Response[Any]:
+    """Get an aspect
+
+     **Note:** This is available in Alfresco 7.0.0 and newer versions.
+    Get information for aspect **aspectId**.
+
+    Args:
+        aspect_id (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Any]
+    """
+
+    kwargs = _get_kwargs(
+        aspect_id=aspect_id,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)