zosmfrestapi 0.1.0__tar.gz

zosmfrestapi-0.1.0/LICENSE

@@ -0,0 +1,10 @@
+ The MIT License (MIT)
+
+Copyright © 2026 Oscar Curero Sastre
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

zosmfrestapi-0.1.0/PKG-INFO

@@ -0,0 +1,178 @@
+Metadata-Version: 2.4
+Name: zosmfrestapi
+Version: 0.1.0
+Summary: A Python wrapper for the z/OSMF REST API
+License-Expression: MIT
+License-File: LICENSE
+Keywords: z/OSMF,IBM Z,mainframe,REST API
+Author: Oscar Curero
+Author-email: dev@curero.es
+Requires-Python: >=3.12
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: dacite (>=1.9.2,<2.0.0)
+Requires-Dist: httpx2 (>=2.12.0,<3.0.0)
+Requires-Dist: pendulum (>=3.2.0,<4.0.0)
+Project-URL: Homepage, https://sr.ht/~ocurero/zosmfrestapi/
+Project-URL: PyPI, https://pypi.org/project/zosmfrestapi/
+Project-URL: Repository, https://sr.ht/~ocurero/zosmfrestapi/
+Description-Content-Type: text/markdown
+
+A Python wrapper for the z/OSMF© REST API
+=========================================
+
+[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) [![builds.sr.ht status](https://builds.sr.ht/~ocurero/zosmfrestapi/commits/main/.build.yml.svg)](https://builds.sr.ht/~ocurero/zosmfrestapi/commits/main/.build.yml?) ![z/OS](https://img.shields.io/badge/works%20on-z/OS-8A2BE2)
+
+* Open Source: MIT License.
+* Website: <https://sr.ht/~ocurero/zosmfrestapi/>
+* Pypi: <https://pypi.org/project/zosmfrestapi/>
+
+
+Install
+-------
+
+**zosmfrestapi** requires Python 3.12 or newer and access to a z/OSMF server.
+You can check your Python version with:
+
+```console
+python --version
+```
+
+It is a good idea to use a virtual environment so this package does not affect
+other Python projects. From a terminal, create and activate one in your project
+folder:
+
+```console
+# Windows (PowerShell)
+py -3.12 -m venv .venv
+.venv\Scripts\Activate.ps1
+
+# macOS or Linux
+python3 -m venv .venv
+source .venv/bin/activate
+```
+
+Then install the package from PyPI:
+
+```console
+python -m pip install zosmfrestapi
+```
+
+If you have downloaded or cloned the source code, run this from the project's
+root folder instead:
+
+```console
+python -m pip install .
+```
+
+## First request
+
+Save this as `example.py` and run it with `python example.py`. Enter the base
+URL of your z/OSMF server when prompted (for example,
+`https://zosmf.example.com:443`). The URL should include `https://` and any
+required port, but not an API path such as `/zosmf`.
+
+The password is requested without displaying it and is not stored in the
+script. Replace the sample operation with one your z/OSMF user is authorized to
+perform.
+
+```python
+from getpass import getpass
+
+from zosmfrestapi import ZosmfClient, ZosmfError
+
+server = input("z/OSMF server URL: ").strip().rstrip("/")
+username = input("User ID: ").strip()
+password = getpass("Password: ")
+
+try:
+    with ZosmfClient(server, username=username, password=password) as client:
+        for instance in client.list_swis():
+            print(f"{instance.name} ({instance.system})")
+except ZosmfError as error:
+    print(f"The z/OSMF request failed: {error}")
+```
+
+The `with` block closes the network connection automatically, even if a request
+fails. `list_swis()` returns Python objects; the example prints each software
+instance's name and system. You can also query systems or read a data set. Put
+these calls inside the `with` block shown above, before it ends:
+
+```python
+systems = client.get_systems()
+contents = client.read_dataset("USER.DATASET")
+```
+
+These calls must be made inside the `with` block, before the client is closed.
+For a partitioned data set member, use a name such as
+`USER.PDS(MEMBER)`.
+
+## Authentication and TLS
+
+The client uses the server's normal TLS certificate checks by default. Keep
+those checks enabled for routine use. The HTTP transport is HTTPX2, a fork of
+HTTPX; HTTPX2 uses `truststore` to integrate operating-system certificate
+stores when it creates its default TLS context. This package currently passes
+its own context, created with Python's `ssl.create_default_context()`, so the
+certificates available to Python are used. If the z/OSMF server's CA is not
+trusted in that environment, pass its certificate file with `cafile` below.
+
+| Situation | Client option |
+| --- | --- |
+| User ID and password | `username="...", password="..."` |
+| Client certificate and key in separate files | `cert=("client.crt", "client.key")` |
+| Client certificate and key in one PEM file | `cert="client.pem"` |
+| Internal certificate authority | `cafile="company-ca.pem"` |
+| Existing LTPA or JWT token | `ltpa_token="..."` or `jwt_token="..."` |
+| Network proxy | `proxy="http://proxy.example.com:8080"` |
+
+For example, to trust an internal certificate authority, pass `cafile` when
+creating the client:
+
+```python
+with ZosmfClient(server, username=username, password=password,
+                 cafile="company-ca.pem") as client:
+    systems = client.get_systems()
+```
+
+Avoid putting passwords or tokens directly in scripts, committing them to
+version control, or sharing them in logs. The `insecure=True` option disables
+TLS certificate verification; use it only for temporary diagnostics, never as
+a production fix. It cannot be combined with `cert` or `cafile`.
+
+## What you can do
+
+The client provides synchronous methods for:
+
+* Authentication (`authenticate`).
+* z/OSMF groups and systems (`get_groups`, `get_systems`).
+* Data sets (`read_dataset`).
+* Software instances and SMP/E information (`list_swis`, `get_swi_by_name`,
+    `get_swi_by_uuid`, and related query methods).
+* Workflows (list, inspect, create, start, wait for, cancel, and archive).
+* Software updates (search, inspect, start, monitor, and cancel).
+
+Some operations change z/OSMF state. Check the method documentation and make
+sure your account has the required permissions before using them.
+
+## Troubleshooting
+
+* **Python version error:** install Python 3.12 or newer, then recreate the
+    virtual environment with that interpreter.
+* **401 / unauthorized:** check the server URL, user ID, password or token, and
+    whether the account is authorized for the requested API.
+* **Certificate verification error:** ask your z/OSMF administrator for the
+    correct CA certificate and pass its path with `cafile`.
+* **Connection or timeout error:** check that the server and port are reachable
+    from your machine and that any required proxy is configured.
+* **PowerShell will not activate the virtual environment:** use the Python
+    executable inside `.venv\Scripts\python.exe` to run commands, or follow your
+    organization's PowerShell policy guidance. Do not change the machine-wide
+    execution policy just to install this package.
+
+For the complete API, parameters, and return types, see the docstrings in the
+package source and the project website.
+

zosmfrestapi-0.1.0/README.md

@@ -0,0 +1,154 @@
+A Python wrapper for the z/OSMF© REST API
+=========================================
+
+[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) [![builds.sr.ht status](https://builds.sr.ht/~ocurero/zosmfrestapi/commits/main/.build.yml.svg)](https://builds.sr.ht/~ocurero/zosmfrestapi/commits/main/.build.yml?) ![z/OS](https://img.shields.io/badge/works%20on-z/OS-8A2BE2)
+
+* Open Source: MIT License.
+* Website: <https://sr.ht/~ocurero/zosmfrestapi/>
+* Pypi: <https://pypi.org/project/zosmfrestapi/>
+
+
+Install
+-------
+
+**zosmfrestapi** requires Python 3.12 or newer and access to a z/OSMF server.
+You can check your Python version with:
+
+```console
+python --version
+```
+
+It is a good idea to use a virtual environment so this package does not affect
+other Python projects. From a terminal, create and activate one in your project
+folder:
+
+```console
+# Windows (PowerShell)
+py -3.12 -m venv .venv
+.venv\Scripts\Activate.ps1
+
+# macOS or Linux
+python3 -m venv .venv
+source .venv/bin/activate
+```
+
+Then install the package from PyPI:
+
+```console
+python -m pip install zosmfrestapi
+```
+
+If you have downloaded or cloned the source code, run this from the project's
+root folder instead:
+
+```console
+python -m pip install .
+```
+
+## First request
+
+Save this as `example.py` and run it with `python example.py`. Enter the base
+URL of your z/OSMF server when prompted (for example,
+`https://zosmf.example.com:443`). The URL should include `https://` and any
+required port, but not an API path such as `/zosmf`.
+
+The password is requested without displaying it and is not stored in the
+script. Replace the sample operation with one your z/OSMF user is authorized to
+perform.
+
+```python
+from getpass import getpass
+
+from zosmfrestapi import ZosmfClient, ZosmfError
+
+server = input("z/OSMF server URL: ").strip().rstrip("/")
+username = input("User ID: ").strip()
+password = getpass("Password: ")
+
+try:
+    with ZosmfClient(server, username=username, password=password) as client:
+        for instance in client.list_swis():
+            print(f"{instance.name} ({instance.system})")
+except ZosmfError as error:
+    print(f"The z/OSMF request failed: {error}")
+```
+
+The `with` block closes the network connection automatically, even if a request
+fails. `list_swis()` returns Python objects; the example prints each software
+instance's name and system. You can also query systems or read a data set. Put
+these calls inside the `with` block shown above, before it ends:
+
+```python
+systems = client.get_systems()
+contents = client.read_dataset("USER.DATASET")
+```
+
+These calls must be made inside the `with` block, before the client is closed.
+For a partitioned data set member, use a name such as
+`USER.PDS(MEMBER)`.
+
+## Authentication and TLS
+
+The client uses the server's normal TLS certificate checks by default. Keep
+those checks enabled for routine use. The HTTP transport is HTTPX2, a fork of
+HTTPX; HTTPX2 uses `truststore` to integrate operating-system certificate
+stores when it creates its default TLS context. This package currently passes
+its own context, created with Python's `ssl.create_default_context()`, so the
+certificates available to Python are used. If the z/OSMF server's CA is not
+trusted in that environment, pass its certificate file with `cafile` below.
+
+| Situation | Client option |
+| --- | --- |
+| User ID and password | `username="...", password="..."` |
+| Client certificate and key in separate files | `cert=("client.crt", "client.key")` |
+| Client certificate and key in one PEM file | `cert="client.pem"` |
+| Internal certificate authority | `cafile="company-ca.pem"` |
+| Existing LTPA or JWT token | `ltpa_token="..."` or `jwt_token="..."` |
+| Network proxy | `proxy="http://proxy.example.com:8080"` |
+
+For example, to trust an internal certificate authority, pass `cafile` when
+creating the client:
+
+```python
+with ZosmfClient(server, username=username, password=password,
+                 cafile="company-ca.pem") as client:
+    systems = client.get_systems()
+```
+
+Avoid putting passwords or tokens directly in scripts, committing them to
+version control, or sharing them in logs. The `insecure=True` option disables
+TLS certificate verification; use it only for temporary diagnostics, never as
+a production fix. It cannot be combined with `cert` or `cafile`.
+
+## What you can do
+
+The client provides synchronous methods for:
+
+* Authentication (`authenticate`).
+* z/OSMF groups and systems (`get_groups`, `get_systems`).
+* Data sets (`read_dataset`).
+* Software instances and SMP/E information (`list_swis`, `get_swi_by_name`,
+    `get_swi_by_uuid`, and related query methods).
+* Workflows (list, inspect, create, start, wait for, cancel, and archive).
+* Software updates (search, inspect, start, monitor, and cancel).
+
+Some operations change z/OSMF state. Check the method documentation and make
+sure your account has the required permissions before using them.
+
+## Troubleshooting
+
+* **Python version error:** install Python 3.12 or newer, then recreate the
+    virtual environment with that interpreter.
+* **401 / unauthorized:** check the server URL, user ID, password or token, and
+    whether the account is authorized for the requested API.
+* **Certificate verification error:** ask your z/OSMF administrator for the
+    correct CA certificate and pass its path with `cafile`.
+* **Connection or timeout error:** check that the server and port are reachable
+    from your machine and that any required proxy is configured.
+* **PowerShell will not activate the virtual environment:** use the Python
+    executable inside `.venv\Scripts\python.exe` to run commands, or follow your
+    organization's PowerShell policy guidance. Do not change the machine-wide
+    execution policy just to install this package.
+
+For the complete API, parameters, and return types, see the docstrings in the
+package source and the project website.

zosmfrestapi-0.1.0/pyproject.toml

@@ -0,0 +1,50 @@
+[project]
+name = "zosmfrestapi"
+version = "0.1.0"
+description = "A Python wrapper for the z/OSMF REST API"
+readme = "README.md"
+authors = [
+    {name = "Oscar Curero",email = "dev@curero.es"}
+]
+license = "MIT"
+requires-python = ">=3.12"
+keywords = ["z/OSMF", "IBM Z", "mainframe", "REST API"]
+classifiers = [
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Internet :: WWW/HTTP",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = [
+    "httpx2 (>=2.12.0,<3.0.0)",
+    "pendulum (>=3.2.0,<4.0.0)",
+    "dacite (>=1.9.2,<2.0.0)",
+]
+
+[project.urls]
+Homepage = "https://sr.ht/~ocurero/zosmfrestapi/"
+Repository = "https://sr.ht/~ocurero/zosmfrestapi/"
+PyPI = "https://pypi.org/project/zosmfrestapi/"
+
+[dependency-groups]
+dev = [
+    "pytest (>=9.1.1,<10.0.0)",
+    "black (>=26.5.1,<27.0.0)",
+    "pytest-recording (>=0.14.0,<0.15.0)",
+    "pytest-httpx2 (>=1.0.0,<2.0.0)",
+    "pytest-cov (>=7.1.0,<8.0.0)",
+]
+
+[tool.black]
+line-length = 88
+target-version = ["py312"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = ["-ra", "--record-mode=none", "--cov-fail-under=100", "--cov=zosmfrestapi"]
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"
+

zosmfrestapi-0.1.0/zosmfrestapi/__init__.py

@@ -0,0 +1,91 @@
+"""Synchronous Python client for the z/OSMF REST API.
+
+The package root re-exports :class:`ZosmfClient`, response models, and public
+exceptions. Create one client per server/configuration and use it as a context
+manager to close the shared HTTP session when finished.
+"""
+
+from zosmfrestapi.client import ZosmfClient
+from zosmfrestapi.exceptions import ZosmfAuthError, ZosmfError
+from zosmfrestapi.exceptions.authentication import ZosmfLoginError
+from zosmfrestapi.exceptions.dataset import ZosmfDatasetNotFoundError
+from zosmfrestapi.exceptions.software import (
+    ZosmfSoftwareInstanceNotFoundError,
+    ZosmfSoftwareManagementError,
+    ZosmfSoftwareManagementRequestError,
+)
+from zosmfrestapi.exceptions.workflow import ZosmfWorkflowBaseError, ZosmfWorkflowError
+from zosmfrestapi.models.authentication import LoginOk
+from zosmfrestapi.models.software import (
+    CsiEntry,
+    DataSet,
+    Feature,
+    Fmid,
+    NonSmpeManagedDataset,
+    Product,
+    SmpeManagedDataset,
+    SmpeManagedDatasetZoneDddef,
+    SmpeManagedUnixDataset,
+    SoftwareInstance,
+    SoftwareInstanceWorkflow,
+    WorkflowLocation,
+)
+from zosmfrestapi.models.software_updates import (
+    MissingFixcat,
+    MissingUpdate,
+    MissingUpdateResolver,
+    SoftwareUpdate,
+    SoftwareUpdateZone,
+    UpdateErrorResults,
+    UpdateProcess,
+    UpdateResult,
+    UpdateSelection,
+)
+from zosmfrestapi.models.topology import Group, System
+from zosmfrestapi.models.workflow import (
+    WorkflowArchivedListItem,
+    WorkflowInstance,
+    WorkflowItem,
+    WorkflowListItem,
+)
+
+__all__ = [
+    "ZosmfClient",
+    "LoginOk",
+    "ZosmfDatasetNotFoundError",
+    "ZosmfError",
+    "ZosmfAuthError",
+    "ZosmfLoginError",
+    "System",
+    "Group",
+    "CsiEntry",
+    "DataSet",
+    "Feature",
+    "Fmid",
+    "NonSmpeManagedDataset",
+    "Product",
+    "SmpeManagedDataset",
+    "SmpeManagedDatasetZoneDddef",
+    "SmpeManagedUnixDataset",
+    "SoftwareInstance",
+    "SoftwareInstanceWorkflow",
+    "WorkflowLocation",
+    "ZosmfSoftwareManagementError",
+    "ZosmfSoftwareInstanceNotFoundError",
+    "ZosmfSoftwareManagementRequestError",
+    "MissingFixcat",
+    "MissingUpdate",
+    "MissingUpdateResolver",
+    "SoftwareUpdate",
+    "SoftwareUpdateZone",
+    "UpdateErrorResults",
+    "UpdateProcess",
+    "UpdateResult",
+    "UpdateSelection",
+    "WorkflowArchivedListItem",
+    "WorkflowInstance",
+    "WorkflowItem",
+    "WorkflowListItem",
+    "ZosmfWorkflowBaseError",
+    "ZosmfWorkflowError",
+]

zosmfrestapi-0.1.0/zosmfrestapi/client.py

@@ -0,0 +1,46 @@
+from zosmfrestapi.services.authentication import AuthenticationServices
+from zosmfrestapi.services.dataset import DatasetServices
+from zosmfrestapi.services.software import SoftwareServices
+from zosmfrestapi.services.software_updates import SoftwareUpdatesServices
+from zosmfrestapi.services.topology import TopologyServices
+from zosmfrestapi.services.workflow import WorkflowServices
+
+
+class ZosmfClient(
+    AuthenticationServices,
+    DatasetServices,
+    TopologyServices,
+    WorkflowServices,
+    SoftwareServices,
+    SoftwareUpdatesServices,
+):
+    """Synchronous client for the z/OSMF REST APIs.
+
+    The client combines authentication, datasets, topology, workflows,
+    software-instance management, and software-update operations around one
+    reusable HTTP session. Update-start and resume methods can change the
+    selected target zone; use them only when those changes are intended.
+
+    Use it as a context manager to close the underlying HTTP session reliably.
+
+    Examples:
+        Use a context manager when making requests:
+
+            with ZosmfClient("https://zosmf.example",
+                             username="demouser", password="DEMOPASS") as client:
+                systems = client.get_systems()
+
+        Use a client without using a context manager:
+
+            client = ZosmfClient("https://zosmf.example",
+                                 username="demouser", password="DEMOPASS")
+            systems = client.get_systems()
+            client.close()
+
+        Use a client with mTLS authentication:
+
+            with ZosmfClient("https://zosmf.example",
+                             username="demouser", password="DEMOPASS",
+                             cert=("/path/to/cert", "/path/to/key")) as client:
+                systems = client.get_systems()
+    """

zosmfrestapi-0.1.0/zosmfrestapi/exceptions/__init__.py

@@ -0,0 +1,18 @@
+import httpx2
+
+
+class ZosmfError(Exception):
+    """Base exception for errors raised by the z/OSMF REST API client."""
+
+    pass
+
+
+class ZosmfAuthError(ZosmfError):
+    """Raised when z/OSMF rejects a request with HTTP 401.
+
+    The triggering ``httpx2.HTTPStatusError`` is available as
+    :attr:`http_exception`.
+    """
+
+    def __init__(self, exc: httpx2.HTTPStatusError) -> None:
+        self.http_exception = exc

zosmfrestapi-0.1.0/zosmfrestapi/exceptions/authentication.py

@@ -0,0 +1,17 @@
+import httpx2
+
+from . import ZosmfError
+
+
+class ZosmfLoginError(ZosmfError):
+    """Raised when the authentication endpoint rejects a login request.
+
+    The response's return code, reason code, and message are exposed as
+    ``return_code``, ``reason_code``, and ``message``.
+    """
+
+    def __init__(self, response: httpx2.Response) -> None:
+        self.http_exception = None
+        self.return_code = response.json()["returnCode"]
+        self.reason_code = response.json()["reasonCode"]
+        self.message = response.json()["message"]

zosmfrestapi-0.1.0/zosmfrestapi/exceptions/dataset.py

@@ -0,0 +1,17 @@
+import logging
+
+import httpx2
+from zosmfrestapi.exceptions import ZosmfError
+
+logger = logging.getLogger(__name__)
+
+
+class ZosmfDatasetError(ZosmfError):
+    """Raised when a data set REST request fails with an HTTP status error."""
+
+
+class ZosmfDatasetNotFoundError(ZosmfDatasetError):
+    """Raised when z/OSMF reports that the requested data set is not found."""
+
+    def __init__(self, response: httpx2.Response) -> None:
+        pass

zosmfrestapi-0.1.0/zosmfrestapi/exceptions/software.py

@@ -0,0 +1,34 @@
+from . import ZosmfError
+
+
+class ZosmfSoftwareManagementError(ZosmfError):
+    """Base exception for z/OSMF Software Management operations."""
+
+
+class ZosmfSoftwareManagementRequestError(ZosmfSoftwareManagementError):
+    """Raised when a Software Management request fails with an HTTP status.
+
+    When the response includes the corresponding fields, ``status_code``,
+    ``reason_code``, ``messages``, and ``body`` provide response details.
+    """
+
+    def __init__(self, error=None) -> None:
+        self.status_code = error.response.status_code if error else None
+        self.reason_code = error.response.json()["reason"] if error else None
+        self.messages = error.response.json()["messages"] if error else None
+        self.body = error.response.text if error else None
+
+
+class ZosmfSoftwareInstanceNotFoundError(ZosmfSoftwareManagementError):
+    """Raised when a requested software instance does not exist."""
+
+    def __init__(self, response) -> None:
+        super().__init__(response)
+        self.messages = (
+            response.json().get("messages", [])
+            if response.headers.get("Content-Type").startswith("application/json")
+            else [response.text]
+        )
+
+    def __str__(self) -> str:
+        return ", ".join(self.messages) if self.messages else ""

zosmfrestapi-0.1.0/zosmfrestapi/exceptions/workflow.py

@@ -0,0 +1,30 @@
+import httpx2
+
+from . import ZosmfError
+
+
+class ZosmfWorkflowBaseError(ZosmfError):
+    """Base exception for z/OSMF workflow operations."""
+
+    pass
+
+
+class ZosmfWorkflowError(ZosmfWorkflowBaseError):
+    """Raised when a workflow REST request fails with an HTTP status.
+
+    When present in the response, ``status_code``, ``message_id``, ``message``,
+    and ``body`` expose the z/OSMF error details.
+    """
+
+    def __init__(self, error: httpx2.HTTPStatusError | None = None) -> None:
+        self.exc = error
+        self.status_code = error.response.status_code if error else None
+        self.message_id = error.response.json()["messageID"] if error else None
+        self.message = error.response.json()["messageText"] if error else None
+        self.body = error.response.text if error else None
+
+
+class ZosmfWorkflowCanceledError(ZosmfWorkflowBaseError):
+    """Reserved for workflow-specific cancellation failures."""
+
+    pass

zosmfrestapi-0.1.0/zosmfrestapi/models/__init__.py

@@ -0,0 +1 @@
+

zosmfrestapi-0.1.0/zosmfrestapi/models/authentication.py

@@ -0,0 +1,16 @@
+from dataclasses import dataclass
+
+
+@dataclass
+class LoginOk:
+    """Successful response from the z/OSMF authentication endpoint.
+
+    The endpoint return fields are preserved alongside any LTPA or JWT token
+    cookies returned by the server.
+    """
+
+    returnCode: int
+    reasonCode: int
+    message: str
+    ltpa_token: str | None = None
+    jwt_token: str | None = None