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

python_alfresco_api/models/alfresco_search_sql_models.py

@@ -0,0 +1,91 @@
+# generated by datamodel-codegen:
+#   filename:  alfresco-search-sql.yaml
+#   timestamp: 2025-06-25T01:56:57+00:00
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from pydantic import BaseModel, Field, RootModel
+
+
+class Error1(BaseModel):
+    briefSummary: str | None = None
+    descriptionURL: str | None = None
+    errorKey: str | None = None
+    logId: str | None = None
+    stackTrace: str | None = None
+    statusCode: int | None = None
+
+
+class Error(BaseModel):
+    error: Error1
+
+
+class Pagination(BaseModel):
+    count: Annotated[int, Field(description='The number of objects in the entries array.\n')]
+    hasMoreItems: Annotated[
+        bool,
+        Field(
+            description='A boolean value which is **true** if there are more entities in the collection\nbeyond those in this response. A true value means a request with a larger value\nfor the **skipCount** or the **maxItems** parameter will return more entities.\n'
+        ),
+    ]
+    maxItems: Annotated[
+        int,
+        Field(
+            description='The value of the **maxItems** parameter used to generate this list,\nor if there was no **maxItems** parameter the default value is 100\n'
+        ),
+    ]
+    skipCount: Annotated[
+        int,
+        Field(
+            description='An integer describing how many entities exist in the collection before\nthose included in this list.\n'
+        ),
+    ]
+    totalItems: Annotated[
+        int | None,
+        Field(
+            description='An integer describing the total number of entities in the collection.\nThe API might not be able to determine this value,\nin which case this property will not be present.\n'
+        ),
+    ] = None
+
+
+class SQLResultSetRowEntry(BaseModel):
+    label: str | None = None
+    value: str | None = None
+
+
+class SQLSearchRequest(BaseModel):
+    filterQueries: list[str] | None = None
+    format: str | None = None
+    includeMetadata: bool | None = None
+    locales: list[str] | None = None
+    stmt: str | None = None
+    timezone: str | None = None
+
+
+class Doc(BaseModel):
+    label: str | None = None
+    value: str | None = None
+
+
+class Docs(RootModel[list[Doc]]):
+    root: Annotated[
+        list[Doc],
+        Field(
+            description='Array of documents returned by the query, note that this is a Solr convention.'
+        ),
+    ]
+
+
+class List(BaseModel):
+    entries: list[SQLResultSetRowEntry] | None = None
+    pagination: Pagination | None = None
+
+
+class SQLResultSetPaging(BaseModel):
+    list: List | None = None
+
+
+class SolrResultSet(BaseModel):
+    result_set: Annotated[Docs | None, Field(alias='result-set')] = None

python_alfresco_api/models/alfresco_workflow_models.py

@@ -0,0 +1,357 @@
+# generated by datamodel-codegen:
+#   filename:  alfresco-workflow.yaml
+#   timestamp: 2025-06-25T01:56:54+00:00
+
+from __future__ import annotations
+
+from datetime import datetime
+from enum import Enum
+from typing import Annotated
+
+from pydantic import BaseModel, Field
+
+
+class CandidateType(Enum):
+    user = 'user'
+    group = 'group'
+
+
+class Candidate(BaseModel):
+    candidateId: str | None = None
+    candidateType: CandidateType | None = None
+
+
+class CandidateEntry(BaseModel):
+    entry: Candidate | None = None
+
+
+class Company(BaseModel):
+    address1: str | None = None
+    address2: str | None = None
+    address3: str | None = None
+    email: str | None = None
+    fax: str | None = None
+    organization: str | None = None
+    postcode: str | None = None
+    telephone: str | None = None
+
+
+class Deployment(BaseModel):
+    category: str | None = None
+    deployedAt: datetime | None = None
+    id: str
+    name: str | None = None
+
+
+class DeploymentEntry(BaseModel):
+    entry: Deployment | None = None
+
+
+class Error1(BaseModel):
+    briefSummary: str | None = None
+    descriptionURL: str | None = None
+    errorKey: str | None = None
+    logId: str | None = None
+    stackTrace: str | None = None
+    statusCode: int | None = None
+
+
+class Error(BaseModel):
+    error: Error1
+
+
+class ItemBody(BaseModel):
+    id: str | None = None
+
+
+class Pagination(BaseModel):
+    count: Annotated[
+        int | None, Field(description='The number of objects in the entries array.\n')
+    ] = None
+    hasMoreItems: Annotated[
+        bool | None,
+        Field(
+            description='A boolean value which is **true** if there are more entities in the collection\nbeyond those in this response. A true value means a request with a larger value\nfor the **skipCount** or the **maxItems** parameter will return more entities.\n'
+        ),
+    ] = None
+    maxItems: Annotated[
+        int | None,
+        Field(
+            description='The value of the **maxItems** parameter used to generate this list,\nor if there was no **maxItems** parameter the default value, 10\n'
+        ),
+    ] = None
+    skipCount: Annotated[
+        int | None,
+        Field(
+            description='An integer describing how many entities exist in the collection before\nthose included in this list.\n'
+        ),
+    ] = None
+    totalItems: Annotated[
+        int | None,
+        Field(
+            description='An integer describing the total number of entities in the collection.\nThe API might not be able to determine this value,\nin which case this property will not be present.\n'
+        ),
+    ] = None
+
+
+class Person(BaseModel):
+    avatarId: str | None = None
+    company: Company | None = None
+    description: str | None = None
+    email: str | None = None
+    emailNotificationsEnabled: bool | None = None
+    enabled: bool | None = True
+    firstName: str | None = None
+    googleId: str | None = None
+    id: str
+    instantMessageId: str | None = None
+    jobTitle: str | None = None
+    lastName: str | None = None
+    location: str | None = None
+    mobile: str | None = None
+    skypeId: str | None = None
+    statusUpdatedAt: datetime | None = None
+    telephone: str | None = None
+    userStatus: str | None = None
+
+
+class Process(BaseModel):
+    businessKey: Annotated[str | None, Field(description='The business key')] = None
+    deleteReason: Annotated[
+        str | None, Field(description='The reason this process was canceled')
+    ] = None
+    durationInMs: Annotated[int | None, Field(description='The duration of this process')] = None
+    endActivityDefinitionId: Annotated[
+        str | None, Field(description='The id of the last activity in the process')
+    ] = None
+    endedAt: Annotated[datetime | None, Field(description='The date time this process started')] = (
+        None
+    )
+    id: Annotated[str, Field(description='The unique id of this process')]
+    processDefinitionId: Annotated[
+        str | None, Field(description='The unique identity of the owning process definition')
+    ] = None
+    startActivityDefinitionId: Annotated[
+        str | None, Field(description='The id of the first activity in the process')
+    ] = None
+    startUserId: Annotated[
+        str | None, Field(description='The id of the user who started the process')
+    ] = None
+    startedAt: Annotated[
+        datetime | None, Field(description='The date time this process started')
+    ] = None
+
+
+class ProcessBodyVariable(BaseModel):
+    bpm_assignee: str | None = None
+    bpm_sendEMailNotifications: bool | None = None
+    bpm_workflowPriority: int | None = None
+
+
+class ProcessDefinition(BaseModel):
+    category: Annotated[
+        str | None, Field(description='The category to which this process definition belongs')
+    ] = None
+    deploymentId: Annotated[
+        str | None, Field(description='The deployment of which this process definition is a part')
+    ] = None
+    description: Annotated[
+        str | None, Field(description='The description of this process definition')
+    ] = None
+    graphicNotationDefined: bool | None = None
+    id: Annotated[str, Field(description='The unique id of this process definition')]
+    key: Annotated[str | None, Field(description='The key of this process definition')] = None
+    name: Annotated[str | None, Field(description='The name of this process definition')] = None
+    startFormResourceKey: Annotated[str | None, Field(description='The start form key')] = None
+    title: Annotated[str | None, Field(description='The title of this process definition')] = None
+
+
+class ProcessDefinitionEntry(BaseModel):
+    entry: ProcessDefinition | None = None
+
+
+class List3(BaseModel):
+    entries: list[ProcessDefinitionEntry] | None = None
+    pagination: Pagination | None = None
+
+
+class ProcessDefinitionPaging(BaseModel):
+    list: List3 | None = None
+
+
+class ProcessEntry(BaseModel):
+    entry: Process | None = None
+
+
+class List4(BaseModel):
+    entries: list[ProcessEntry] | None = None
+    pagination: Pagination | None = None
+
+
+class ProcessPaging(BaseModel):
+    list: List4 | None = None
+
+
+class State(Enum):
+    unclaimed = 'unclaimed'
+    claimed = 'claimed'
+    completed = 'completed'
+    resolved = 'resolved'
+
+
+class TaskFormModel(BaseModel):
+    allowedValues: Annotated[
+        list[str] | None, Field(description='An array of allowed values for this item')
+    ] = None
+    dataType: str | None = None
+    defaultValue: str | None = None
+    name: str | None = None
+    qualifiedName: str | None = None
+    required: bool | None = None
+    title: str | None = None
+
+
+class TaskFormModelEntry(BaseModel):
+    entry: TaskFormModel | None = None
+
+
+class List5(BaseModel):
+    entries: list[TaskFormModelEntry] | None = None
+    pagination: Pagination | None = None
+
+
+class TaskFormModelPaging(BaseModel):
+    list: List5 | None = None
+
+
+class Variable(BaseModel):
+    name: str | None = None
+    scope: str | None = None
+    type: str | None = None
+    value: int | None = None
+
+
+class VariableBody(BaseModel):
+    name: str | None = None
+    type: str | None = None
+    value: int | None = None
+
+
+class VariableEntry(BaseModel):
+    entry: Variable | None = None
+
+
+class List7(BaseModel):
+    entries: list[VariableEntry] | None = None
+    pagination: Pagination | None = None
+
+
+class VariablePaging(BaseModel):
+    list: List7 | None = None
+
+
+class List(BaseModel):
+    entries: list[CandidateEntry] | None = None
+    pagination: Pagination | None = None
+
+
+class CandidatePaging(BaseModel):
+    list: List | None = None
+
+
+class List1(BaseModel):
+    entries: list[DeploymentEntry] | None = None
+    pagination: Pagination | None = None
+
+
+class DeploymentPaging(BaseModel):
+    list: List1 | None = None
+
+
+class Item(BaseModel):
+    createdAt: datetime | None = None
+    createdBy: Person | None = None
+    description: str | None = None
+    edited: bool | None = None
+    id: str | None = None
+    mimeType: str | None = None
+    modifiedAt: datetime | None = None
+    modifiedBy: Person | None = None
+    name: str | None = None
+    size: int | None = None
+    title: str | None = None
+    value: int | None = None
+
+
+class ItemEntry(BaseModel):
+    entry: Item | None = None
+
+
+class List2(BaseModel):
+    entries: list[ItemEntry] | None = None
+    pagination: Pagination | None = None
+
+
+class ItemPaging(BaseModel):
+    list: List2 | None = None
+
+
+class ProcessBody(BaseModel):
+    processDefinitionKey: str | None = None
+    variables: ProcessBodyVariable | None = None
+
+
+class Task(BaseModel):
+    activityDefinitionId: Annotated[
+        str | None, Field(description='The activity id of this task')
+    ] = None
+    assignee: Annotated[
+        str | None, Field(description='The id of the user who is currently assigned this task')
+    ] = None
+    description: Annotated[str | None, Field(description='The description of this task')] = None
+    dueAt: Annotated[datetime | None, Field(description='The date time this task is due')] = None
+    durationInMs: Annotated[int | None, Field(description='The duration of this task')] = None
+    endedAt: Annotated[datetime | None, Field(description='The date time this task started')] = None
+    formResourceKey: Annotated[
+        str | None, Field(description='The key of the form for this task')
+    ] = None
+    id: Annotated[str, Field(description='The unique id of this task')]
+    name: Annotated[str | None, Field(description='The text name of this task')] = None
+    owner: Annotated[str | None, Field(description='The id of the user who owns this task')] = None
+    priority: Annotated[int | None, Field(description='The numeric priority of this task')] = None
+    processDefinitionId: Annotated[
+        str | None, Field(description='The unique identity of the owning process definition')
+    ] = None
+    processId: Annotated[str | None, Field(description="The containing process's unique id")] = None
+    startedAt: Annotated[datetime | None, Field(description='The date time this task started')] = (
+        None
+    )
+    state: Annotated[State | None, Field(description='The state of this task')] = None
+    variables: Annotated[
+        list[Variable] | None, Field(description='An array of variables for this task')
+    ] = None
+
+
+class TaskBody(BaseModel):
+    description: Annotated[str | None, Field(description='The description of this task')] = None
+    dueAt: Annotated[datetime | None, Field(description='The date time this task is due')] = None
+    name: Annotated[str | None, Field(description='The text name of this task')] = None
+    owner: Annotated[str | None, Field(description='The id of the user who owns this task')] = None
+    priority: Annotated[int | None, Field(description='The numeric priority of this task')] = None
+    state: Annotated[State | None, Field(description='The state of this task')] = None
+    variables: Annotated[
+        list[Variable] | None, Field(description='An array of variables for this task')
+    ] = None
+
+
+class TaskEntry(BaseModel):
+    entry: Task | None = None
+
+
+class List6(BaseModel):
+    entries: list[TaskEntry] | None = None
+    pagination: Pagination | None = None
+
+
+class TaskPaging(BaseModel):
+    list: List6 | None = None

python_alfresco_api/raw_clients/alfresco_auth_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_auth_client/README.md

@@ -0,0 +1,124 @@
+# auth_client
+A client library for accessing Alfresco Content Services REST API
+
+## Usage
+First, create a client:
+
+```python
+from auth_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 auth_client import AuthenticatedClient
+
+client = AuthenticatedClient(base_url="https://api.example.com", token="SuperSecretToken")
+```
+
+Now call your endpoint and use your models:
+
+```python
+from auth_client.models import MyDataModel
+from auth_client.api.my_tag import get_my_data_model
+from auth_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 auth_client.models import MyDataModel
+from auth_client.api.my_tag import get_my_data_model
+from auth_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 `auth_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 auth_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 auth_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_auth_client/auth_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_auth_client/auth_client/api/__init__.py

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

python_alfresco_api/raw_clients/alfresco_auth_client/auth_client/api/authentication/__init__.py

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