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

python_alfresco_api/raw_clients/alfresco_workflow_client/workflow_client/api/tasks/update_task_variable.py

@@ -0,0 +1,202 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union, cast
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.variable import Variable
+from ...models.variable_entry import VariableEntry
+from ...types import Response
+
+
+def _get_kwargs(
+    task_id: str,
+    variable_name: str,
+    *,
+    body: Variable,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "put",
+        "url": f"/tasks/{task_id}/variables/{variable_name}",
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[Any, VariableEntry]]:
+    if response.status_code == 200:
+        response_200 = VariableEntry.from_dict(response.json())
+
+        return response_200
+    if response.status_code == 400:
+        response_400 = cast(Any, None)
+        return response_400
+    if response.status_code == 401:
+        response_401 = cast(Any, None)
+        return response_401
+    if response.status_code == 404:
+        response_404 = cast(Any, None)
+        return response_404
+    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[Union[Any, VariableEntry]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    task_id: str,
+    variable_name: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: Variable,
+) -> Response[Union[Any, VariableEntry]]:
+    """Create or update a variable
+
+     Creates or updates a specific variable **variableName** for a given task **taskId**.
+
+    Args:
+        task_id (str):
+        variable_name (str):
+        body (Variable): A task variable.
+
+    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[Union[Any, VariableEntry]]
+    """
+
+    kwargs = _get_kwargs(
+        task_id=task_id,
+        variable_name=variable_name,
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    task_id: str,
+    variable_name: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: Variable,
+) -> Optional[Union[Any, VariableEntry]]:
+    """Create or update a variable
+
+     Creates or updates a specific variable **variableName** for a given task **taskId**.
+
+    Args:
+        task_id (str):
+        variable_name (str):
+        body (Variable): A task variable.
+
+    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:
+        Union[Any, VariableEntry]
+    """
+
+    return sync_detailed(
+        task_id=task_id,
+        variable_name=variable_name,
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    task_id: str,
+    variable_name: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: Variable,
+) -> Response[Union[Any, VariableEntry]]:
+    """Create or update a variable
+
+     Creates or updates a specific variable **variableName** for a given task **taskId**.
+
+    Args:
+        task_id (str):
+        variable_name (str):
+        body (Variable): A task variable.
+
+    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[Union[Any, VariableEntry]]
+    """
+
+    kwargs = _get_kwargs(
+        task_id=task_id,
+        variable_name=variable_name,
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    task_id: str,
+    variable_name: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: Variable,
+) -> Optional[Union[Any, VariableEntry]]:
+    """Create or update a variable
+
+     Creates or updates a specific variable **variableName** for a given task **taskId**.
+
+    Args:
+        task_id (str):
+        variable_name (str):
+        body (Variable): A task variable.
+
+    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:
+        Union[Any, VariableEntry]
+    """
+
+    return (
+        await asyncio_detailed(
+            task_id=task_id,
+            variable_name=variable_name,
+            client=client,
+            body=body,
+        )
+    ).parsed

python_alfresco_api/raw_clients/alfresco_workflow_client/workflow_client/client.py

@@ -0,0 +1,268 @@
+import ssl
+from typing import Any, Optional, Union
+
+import httpx
+from attrs import define, evolve, field
+
+
+@define
+class Client:
+    """A class for keeping track of data related to the API
+
+    The following are accepted as keyword arguments and will be used to construct httpx Clients internally:
+
+        ``base_url``: The base URL for the API, all requests are made to a relative path to this URL
+
+        ``cookies``: A dictionary of cookies to be sent with every request
+
+        ``headers``: A dictionary of headers to be sent with every request
+
+        ``timeout``: The maximum amount of a time a request can take. API functions will raise
+        httpx.TimeoutException if this is exceeded.
+
+        ``verify_ssl``: Whether or not to verify the SSL certificate of the API server. This should be True in production,
+        but can be set to False for testing purposes.
+
+        ``follow_redirects``: Whether or not to follow redirects. Default value is False.
+
+        ``httpx_args``: A dictionary of additional arguments to be passed to the ``httpx.Client`` and ``httpx.AsyncClient`` constructor.
+
+
+    Attributes:
+        raise_on_unexpected_status: Whether or not to raise an errors.UnexpectedStatus if the API returns a
+            status code that was not documented in the source OpenAPI document. Can also be provided as a keyword
+            argument to the constructor.
+    """
+
+    raise_on_unexpected_status: bool = field(default=False, kw_only=True)
+    _base_url: str = field(alias="base_url")
+    _cookies: dict[str, str] = field(factory=dict, kw_only=True, alias="cookies")
+    _headers: dict[str, str] = field(factory=dict, kw_only=True, alias="headers")
+    _timeout: Optional[httpx.Timeout] = field(default=None, kw_only=True, alias="timeout")
+    _verify_ssl: Union[str, bool, ssl.SSLContext] = field(default=True, kw_only=True, alias="verify_ssl")
+    _follow_redirects: bool = field(default=False, kw_only=True, alias="follow_redirects")
+    _httpx_args: dict[str, Any] = field(factory=dict, kw_only=True, alias="httpx_args")
+    _client: Optional[httpx.Client] = field(default=None, init=False)
+    _async_client: Optional[httpx.AsyncClient] = field(default=None, init=False)
+
+    def with_headers(self, headers: dict[str, str]) -> "Client":
+        """Get a new client matching this one with additional headers"""
+        if self._client is not None:
+            self._client.headers.update(headers)
+        if self._async_client is not None:
+            self._async_client.headers.update(headers)
+        return evolve(self, headers={**self._headers, **headers})
+
+    def with_cookies(self, cookies: dict[str, str]) -> "Client":
+        """Get a new client matching this one with additional cookies"""
+        if self._client is not None:
+            self._client.cookies.update(cookies)
+        if self._async_client is not None:
+            self._async_client.cookies.update(cookies)
+        return evolve(self, cookies={**self._cookies, **cookies})
+
+    def with_timeout(self, timeout: httpx.Timeout) -> "Client":
+        """Get a new client matching this one with a new timeout (in seconds)"""
+        if self._client is not None:
+            self._client.timeout = timeout
+        if self._async_client is not None:
+            self._async_client.timeout = timeout
+        return evolve(self, timeout=timeout)
+
+    def set_httpx_client(self, client: httpx.Client) -> "Client":
+        """Manually set the underlying httpx.Client
+
+        **NOTE**: This will override any other settings on the client, including cookies, headers, and timeout.
+        """
+        self._client = client
+        return self
+
+    def get_httpx_client(self) -> httpx.Client:
+        """Get the underlying httpx.Client, constructing a new one if not previously set"""
+        if self._client is None:
+            self._client = httpx.Client(
+                base_url=self._base_url,
+                cookies=self._cookies,
+                headers=self._headers,
+                timeout=self._timeout,
+                verify=self._verify_ssl,
+                follow_redirects=self._follow_redirects,
+                **self._httpx_args,
+            )
+        return self._client
+
+    def __enter__(self) -> "Client":
+        """Enter a context manager for self.client—you cannot enter twice (see httpx docs)"""
+        self.get_httpx_client().__enter__()
+        return self
+
+    def __exit__(self, *args: Any, **kwargs: Any) -> None:
+        """Exit a context manager for internal httpx.Client (see httpx docs)"""
+        self.get_httpx_client().__exit__(*args, **kwargs)
+
+    def set_async_httpx_client(self, async_client: httpx.AsyncClient) -> "Client":
+        """Manually the underlying httpx.AsyncClient
+
+        **NOTE**: This will override any other settings on the client, including cookies, headers, and timeout.
+        """
+        self._async_client = async_client
+        return self
+
+    def get_async_httpx_client(self) -> httpx.AsyncClient:
+        """Get the underlying httpx.AsyncClient, constructing a new one if not previously set"""
+        if self._async_client is None:
+            self._async_client = httpx.AsyncClient(
+                base_url=self._base_url,
+                cookies=self._cookies,
+                headers=self._headers,
+                timeout=self._timeout,
+                verify=self._verify_ssl,
+                follow_redirects=self._follow_redirects,
+                **self._httpx_args,
+            )
+        return self._async_client
+
+    async def __aenter__(self) -> "Client":
+        """Enter a context manager for underlying httpx.AsyncClient—you cannot enter twice (see httpx docs)"""
+        await self.get_async_httpx_client().__aenter__()
+        return self
+
+    async def __aexit__(self, *args: Any, **kwargs: Any) -> None:
+        """Exit a context manager for underlying httpx.AsyncClient (see httpx docs)"""
+        await self.get_async_httpx_client().__aexit__(*args, **kwargs)
+
+
+@define
+class AuthenticatedClient:
+    """A Client which has been authenticated for use on secured endpoints
+
+    The following are accepted as keyword arguments and will be used to construct httpx Clients internally:
+
+        ``base_url``: The base URL for the API, all requests are made to a relative path to this URL
+
+        ``cookies``: A dictionary of cookies to be sent with every request
+
+        ``headers``: A dictionary of headers to be sent with every request
+
+        ``timeout``: The maximum amount of a time a request can take. API functions will raise
+        httpx.TimeoutException if this is exceeded.
+
+        ``verify_ssl``: Whether or not to verify the SSL certificate of the API server. This should be True in production,
+        but can be set to False for testing purposes.
+
+        ``follow_redirects``: Whether or not to follow redirects. Default value is False.
+
+        ``httpx_args``: A dictionary of additional arguments to be passed to the ``httpx.Client`` and ``httpx.AsyncClient`` constructor.
+
+
+    Attributes:
+        raise_on_unexpected_status: Whether or not to raise an errors.UnexpectedStatus if the API returns a
+            status code that was not documented in the source OpenAPI document. Can also be provided as a keyword
+            argument to the constructor.
+        token: The token to use for authentication
+        prefix: The prefix to use for the Authorization header
+        auth_header_name: The name of the Authorization header
+    """
+
+    raise_on_unexpected_status: bool = field(default=False, kw_only=True)
+    _base_url: str = field(alias="base_url")
+    _cookies: dict[str, str] = field(factory=dict, kw_only=True, alias="cookies")
+    _headers: dict[str, str] = field(factory=dict, kw_only=True, alias="headers")
+    _timeout: Optional[httpx.Timeout] = field(default=None, kw_only=True, alias="timeout")
+    _verify_ssl: Union[str, bool, ssl.SSLContext] = field(default=True, kw_only=True, alias="verify_ssl")
+    _follow_redirects: bool = field(default=False, kw_only=True, alias="follow_redirects")
+    _httpx_args: dict[str, Any] = field(factory=dict, kw_only=True, alias="httpx_args")
+    _client: Optional[httpx.Client] = field(default=None, init=False)
+    _async_client: Optional[httpx.AsyncClient] = field(default=None, init=False)
+
+    token: str
+    prefix: str = "Bearer"
+    auth_header_name: str = "Authorization"
+
+    def with_headers(self, headers: dict[str, str]) -> "AuthenticatedClient":
+        """Get a new client matching this one with additional headers"""
+        if self._client is not None:
+            self._client.headers.update(headers)
+        if self._async_client is not None:
+            self._async_client.headers.update(headers)
+        return evolve(self, headers={**self._headers, **headers})
+
+    def with_cookies(self, cookies: dict[str, str]) -> "AuthenticatedClient":
+        """Get a new client matching this one with additional cookies"""
+        if self._client is not None:
+            self._client.cookies.update(cookies)
+        if self._async_client is not None:
+            self._async_client.cookies.update(cookies)
+        return evolve(self, cookies={**self._cookies, **cookies})
+
+    def with_timeout(self, timeout: httpx.Timeout) -> "AuthenticatedClient":
+        """Get a new client matching this one with a new timeout (in seconds)"""
+        if self._client is not None:
+            self._client.timeout = timeout
+        if self._async_client is not None:
+            self._async_client.timeout = timeout
+        return evolve(self, timeout=timeout)
+
+    def set_httpx_client(self, client: httpx.Client) -> "AuthenticatedClient":
+        """Manually set the underlying httpx.Client
+
+        **NOTE**: This will override any other settings on the client, including cookies, headers, and timeout.
+        """
+        self._client = client
+        return self
+
+    def get_httpx_client(self) -> httpx.Client:
+        """Get the underlying httpx.Client, constructing a new one if not previously set"""
+        if self._client is None:
+            self._headers[self.auth_header_name] = f"{self.prefix} {self.token}" if self.prefix else self.token
+            self._client = httpx.Client(
+                base_url=self._base_url,
+                cookies=self._cookies,
+                headers=self._headers,
+                timeout=self._timeout,
+                verify=self._verify_ssl,
+                follow_redirects=self._follow_redirects,
+                **self._httpx_args,
+            )
+        return self._client
+
+    def __enter__(self) -> "AuthenticatedClient":
+        """Enter a context manager for self.client—you cannot enter twice (see httpx docs)"""
+        self.get_httpx_client().__enter__()
+        return self
+
+    def __exit__(self, *args: Any, **kwargs: Any) -> None:
+        """Exit a context manager for internal httpx.Client (see httpx docs)"""
+        self.get_httpx_client().__exit__(*args, **kwargs)
+
+    def set_async_httpx_client(self, async_client: httpx.AsyncClient) -> "AuthenticatedClient":
+        """Manually the underlying httpx.AsyncClient
+
+        **NOTE**: This will override any other settings on the client, including cookies, headers, and timeout.
+        """
+        self._async_client = async_client
+        return self
+
+    def get_async_httpx_client(self) -> httpx.AsyncClient:
+        """Get the underlying httpx.AsyncClient, constructing a new one if not previously set"""
+        if self._async_client is None:
+            self._headers[self.auth_header_name] = f"{self.prefix} {self.token}" if self.prefix else self.token
+            self._async_client = httpx.AsyncClient(
+                base_url=self._base_url,
+                cookies=self._cookies,
+                headers=self._headers,
+                timeout=self._timeout,
+                verify=self._verify_ssl,
+                follow_redirects=self._follow_redirects,
+                **self._httpx_args,
+            )
+        return self._async_client
+
+    async def __aenter__(self) -> "AuthenticatedClient":
+        """Enter a context manager for underlying httpx.AsyncClient—you cannot enter twice (see httpx docs)"""
+        await self.get_async_httpx_client().__aenter__()
+        return self
+
+    async def __aexit__(self, *args: Any, **kwargs: Any) -> None:
+        """Exit a context manager for underlying httpx.AsyncClient (see httpx docs)"""
+        await self.get_async_httpx_client().__aexit__(*args, **kwargs)

python_alfresco_api/raw_clients/alfresco_workflow_client/workflow_client/errors.py

@@ -0,0 +1,16 @@
+"""Contains shared errors types that can be raised from API functions"""
+
+
+class UnexpectedStatus(Exception):
+    """Raised by api functions when the response status an undocumented status and Client.raise_on_unexpected_status is True"""
+
+    def __init__(self, status_code: int, content: bytes):
+        self.status_code = status_code
+        self.content = content
+
+        super().__init__(
+            f"Unexpected status code: {status_code}\n\nResponse content:\n{content.decode(errors='ignore')}"
+        )
+
+
+__all__ = ["UnexpectedStatus"]

python_alfresco_api/raw_clients/alfresco_workflow_client/workflow_client/models/__init__.py

@@ -0,0 +1,95 @@
+"""Contains all the data models used in inputs/outputs"""
+
+from .candidate import Candidate
+from .candidate_candidate_type import CandidateCandidateType
+from .candidate_entry import CandidateEntry
+from .candidate_paging import CandidatePaging
+from .candidate_paging_list import CandidatePagingList
+from .company import Company
+from .deployment import Deployment
+from .deployment_entry import DeploymentEntry
+from .deployment_paging import DeploymentPaging
+from .deployment_paging_list import DeploymentPagingList
+from .error import Error
+from .error_error import ErrorError
+from .item import Item
+from .item_body import ItemBody
+from .item_entry import ItemEntry
+from .item_paging import ItemPaging
+from .item_paging_list import ItemPagingList
+from .pagination import Pagination
+from .person import Person
+from .process import Process
+from .process_body import ProcessBody
+from .process_body_variable import ProcessBodyVariable
+from .process_definition import ProcessDefinition
+from .process_definition_entry import ProcessDefinitionEntry
+from .process_definition_paging import ProcessDefinitionPaging
+from .process_definition_paging_list import ProcessDefinitionPagingList
+from .process_entry import ProcessEntry
+from .process_paging import ProcessPaging
+from .process_paging_list import ProcessPagingList
+from .task import Task
+from .task_body import TaskBody
+from .task_body_state import TaskBodyState
+from .task_entry import TaskEntry
+from .task_form_model import TaskFormModel
+from .task_form_model_entry import TaskFormModelEntry
+from .task_form_model_paging import TaskFormModelPaging
+from .task_form_model_paging_list import TaskFormModelPagingList
+from .task_paging import TaskPaging
+from .task_paging_list import TaskPagingList
+from .task_state import TaskState
+from .variable import Variable
+from .variable_body import VariableBody
+from .variable_entry import VariableEntry
+from .variable_paging import VariablePaging
+from .variable_paging_list import VariablePagingList
+
+__all__ = (
+    "Candidate",
+    "CandidateCandidateType",
+    "CandidateEntry",
+    "CandidatePaging",
+    "CandidatePagingList",
+    "Company",
+    "Deployment",
+    "DeploymentEntry",
+    "DeploymentPaging",
+    "DeploymentPagingList",
+    "Error",
+    "ErrorError",
+    "Item",
+    "ItemBody",
+    "ItemEntry",
+    "ItemPaging",
+    "ItemPagingList",
+    "Pagination",
+    "Person",
+    "Process",
+    "ProcessBody",
+    "ProcessBodyVariable",
+    "ProcessDefinition",
+    "ProcessDefinitionEntry",
+    "ProcessDefinitionPaging",
+    "ProcessDefinitionPagingList",
+    "ProcessEntry",
+    "ProcessPaging",
+    "ProcessPagingList",
+    "Task",
+    "TaskBody",
+    "TaskBodyState",
+    "TaskEntry",
+    "TaskFormModel",
+    "TaskFormModelEntry",
+    "TaskFormModelPaging",
+    "TaskFormModelPagingList",
+    "TaskPaging",
+    "TaskPagingList",
+    "TaskState",
+    "Variable",
+    "VariableBody",
+    "VariableEntry",
+    "VariablePaging",
+    "VariablePagingList",
+)

python_alfresco_api/raw_clients/alfresco_workflow_client/workflow_client/models/candidate.py

@@ -0,0 +1,77 @@
+from collections.abc import Mapping
+from typing import Any, TypeVar, Union
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..models.candidate_candidate_type import CandidateCandidateType
+from ..types import UNSET, Unset
+
+T = TypeVar("T", bound="Candidate")
+
+
+@_attrs_define
+class Candidate:
+    """A candidate item.
+
+    Attributes:
+        candidate_id (Union[Unset, str]):
+        candidate_type (Union[Unset, CandidateCandidateType]):
+    """
+
+    candidate_id: Union[Unset, str] = UNSET
+    candidate_type: Union[Unset, CandidateCandidateType] = UNSET
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        candidate_id = self.candidate_id
+
+        candidate_type: Union[Unset, str] = UNSET
+        if not isinstance(self.candidate_type, Unset):
+            candidate_type = self.candidate_type.value
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update({})
+        if candidate_id is not UNSET:
+            field_dict["candidateId"] = candidate_id
+        if candidate_type is not UNSET:
+            field_dict["candidateType"] = candidate_type
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+        candidate_id = d.pop("candidateId", UNSET)
+
+        _candidate_type = d.pop("candidateType", UNSET)
+        candidate_type: Union[Unset, CandidateCandidateType]
+        if isinstance(_candidate_type, Unset):
+            candidate_type = UNSET
+        else:
+            candidate_type = CandidateCandidateType(_candidate_type)
+
+        candidate = cls(
+            candidate_id=candidate_id,
+            candidate_type=candidate_type,
+        )
+
+        candidate.additional_properties = d
+        return candidate
+
+    @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_workflow_client/workflow_client/models/candidate_candidate_type.py

@@ -0,0 +1,9 @@
+from enum import Enum
+
+
+class CandidateCandidateType(str, Enum):
+    GROUP = "group"
+    USER = "user"
+
+    def __str__(self) -> str:
+        return str(self.value)