mtn-cloud 0.2.2__tar.gz → 0.2.6__tar.gz

{mtn_cloud-0.2.2 → mtn_cloud-0.2.6}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: mtn-cloud
-Version: 0.2.2
-Summary: Community Python SDK for MTN Cloud (Morpheus) - Deploy and manage cloud resources with ease
+Version: 0.2.6
+Summary: Community Python SDK for MTN Cloud - Deploy and manage cloud resources with ease
 Project-URL: Homepage, https://github.com/mahveotm/mtn-cloud-python
 Project-URL: Documentation, https://github.com/mahveotm/mtn-cloud-python#readme
 Project-URL: Repository, https://github.com/mahveotm/mtn-cloud-python
@@ -10,7 +10,7 @@ Author-email: Marvellous Osuolale <m@rvellous.com>
 Maintainer-email: Marvellous Osuolale <m@rvellous.com>
 License: MIT
 License-File: LICENSE
-Keywords: api,cloud,devops,infrastructure,morpheus,mtn,sdk
+Keywords: api,cloud,devops,infrastructure,mtn,mtn-cloud,sdk
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
@@ -50,7 +50,7 @@ Description-Content-Type: text/markdown
 [![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-A Modern Python SDK for [MTN Cloud](https://console.cloud.mtn.ng) (Morpheus) with typed models, clear resource managers, and practical workflows for compute, networking, storage, and archives.
+A Modern Python SDK for [MTN Cloud](https://console.cloud.mtn.ng) with typed models, clear resource managers, and practical workflows for compute, networking, storage, and archives.
 
 Docs: [mtn-cloud-python](https://mahveotm.github.io/mtn-cloud-python/)
 
@@ -80,6 +80,7 @@ pip install mtn-cloud
 - [Storage](https://mahveotm.github.io/mtn-cloud-python/storage/)
 - [Advanced Cookbook](https://mahveotm.github.io/mtn-cloud-python/advanced-cookbook/)
 - [API Overview](https://mahveotm.github.io/mtn-cloud-python/api-overview/)
+- [API Reference](https://mahveotm.github.io/mtn-cloud-python/api-reference/)
 - [Docstring Style Standard](https://mahveotm.github.io/mtn-cloud-python/docstring-style/)
 
 ## Quick Start
@@ -348,6 +349,6 @@ MIT License. See [LICENSE](LICENSE) for details.
 
 - [MTN Cloud Console](https://console.cloud.mtn.ng)
 - [MTN Cloud Guide](https://cloud.mtn.ng/documentation)
-- [Morpheus API Documentation](https://apidocs.morpheusdata.com/)
+- [Morpheus API Documentation (supplementary)](https://apidocs.morpheusdata.com/)
 - [GitHub Repository](https://github.com/mahveotm/mtn-cloud-python)
 - [PyPI Package](https://pypi.org/project/mtn-cloud/)

{mtn_cloud-0.2.2 → mtn_cloud-0.2.6}/README.md

@@ -6,7 +6,7 @@
 [![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-A Modern Python SDK for [MTN Cloud](https://console.cloud.mtn.ng) (Morpheus) with typed models, clear resource managers, and practical workflows for compute, networking, storage, and archives.
+A Modern Python SDK for [MTN Cloud](https://console.cloud.mtn.ng) with typed models, clear resource managers, and practical workflows for compute, networking, storage, and archives.
 
 Docs: [mtn-cloud-python](https://mahveotm.github.io/mtn-cloud-python/)
 
@@ -36,6 +36,7 @@ pip install mtn-cloud
 - [Storage](https://mahveotm.github.io/mtn-cloud-python/storage/)
 - [Advanced Cookbook](https://mahveotm.github.io/mtn-cloud-python/advanced-cookbook/)
 - [API Overview](https://mahveotm.github.io/mtn-cloud-python/api-overview/)
+- [API Reference](https://mahveotm.github.io/mtn-cloud-python/api-reference/)
 - [Docstring Style Standard](https://mahveotm.github.io/mtn-cloud-python/docstring-style/)
 
 ## Quick Start
@@ -304,6 +305,6 @@ MIT License. See [LICENSE](LICENSE) for details.
 
 - [MTN Cloud Console](https://console.cloud.mtn.ng)
 - [MTN Cloud Guide](https://cloud.mtn.ng/documentation)
-- [Morpheus API Documentation](https://apidocs.morpheusdata.com/)
+- [Morpheus API Documentation (supplementary)](https://apidocs.morpheusdata.com/)
 - [GitHub Repository](https://github.com/mahveotm/mtn-cloud-python)
 - [PyPI Package](https://pypi.org/project/mtn-cloud/)

{mtn_cloud-0.2.2 → mtn_cloud-0.2.6}/docs/api-overview.md

@@ -2,6 +2,8 @@
 
 This page summarizes the public SDK surface.
 
+For endpoint-by-endpoint signatures, parameters, return types, and raised exceptions, see [API Reference](./api-reference/index.md).
+
 ## Entry Point
 
 ```python
@@ -79,8 +81,7 @@ Resource methods return typed Pydantic models, for example:
 
 ## Naming Conventions
 
-- `*_id` means numeric Morpheus resource ID.
+- `*_id` means numeric MTN Cloud resource ID.
 - `bucket_name` in archive methods means archive bucket name.
 - `remote_path` means path inside archive storage.
 - `local_path` / `local_directory` refer to local filesystem paths.
-

mtn_cloud-0.2.6/docs/api-reference/archive-buckets.md

@@ -0,0 +1,134 @@
+# Resource: `cloud.archive_buckets` (`ArchiveBucketsResource`)
+
+### `list(max_results=None, offset=0, sort=None, direction=None, phrase=None, name=None, **filters) -> list[ArchiveBucket]`
+
+- Endpoint: `GET /api/archives/buckets`
+- Parameters:
+    - Shared list args
+    - `name`: archive bucket name filter
+- Returns: `list[ArchiveBucket]`
+- Raises: common API exceptions
+
+### `get(archive_bucket_id: int) -> ArchiveBucket`
+
+- Endpoint: `GET /api/archives/buckets/{archive_bucket_id}`
+- Returns: `ArchiveBucket`
+- Raises: common API exceptions
+
+### `get_by_name(name: str) -> ArchiveBucket`
+
+- Endpoint sequence:
+    - `GET /api/archives/buckets?name=<name>&max=1`
+- Returns: `ArchiveBucket`
+- Raises:
+    - common API exceptions
+    - `NotFoundError` when no match
+
+### `create(name: str, *, storage_provider_id: int, description=None, visibility="private", is_public=False, account_id=None) -> ArchiveBucket`
+
+- Endpoint: `POST /api/archives/buckets`
+- Parameters:
+    - `name`: globally unique archive bucket name
+    - `storage_provider_id`: linked storage bucket/provider ID
+    - `description`: optional description
+    - `visibility`: `private` or `public`
+    - `is_public`: enable anonymous public URL support
+    - `account_id`: optional tenant account override
+- Returns: `ArchiveBucket`
+- Raises: common API exceptions
+
+### `update(archive_bucket_id: int, *, name=None, description=None, visibility=None, is_public=None, account_id=None) -> ArchiveBucket`
+
+- Endpoint: `PUT /api/archives/buckets/{archive_bucket_id}`
+- Returns: `ArchiveBucket`
+- Raises: common API exceptions
+
+### `delete(archive_bucket_id: int) -> bool`
+
+- Endpoint: `DELETE /api/archives/buckets/{archive_bucket_id}`
+- Returns: `True`
+- Raises: common API exceptions
+
+### `list_files(*, bucket_name: str, remote_path: str | None = None, name: str | None = None, phrase: str | None = None, full_tree: bool | None = None) -> list[ArchiveFile]`
+
+- Endpoint: `GET /api/archives/buckets/{bucket_name}/files/{remote_path}`
+- Parameters:
+    - `bucket_name`: archive bucket name (not storage provider name)
+    - `remote_path`: archive path to list (defaults to `/`)
+    - `name`: exact file name filter
+    - `phrase`: wildcard phrase filter
+    - `full_tree`: include nested paths
+- Returns: `list[ArchiveFile]`
+- Raises: common API exceptions
+
+### `upload_file(*, bucket_name: str, remote_path: str, local_path: str | Path, filename: str | None = None) -> ArchiveFile`
+
+- Endpoint: `POST /api/archives/buckets/{bucket_name}/files/{remote_path}` (multipart)
+- Parameters:
+    - `bucket_name`: destination archive bucket name
+    - `remote_path`: destination directory path
+    - `local_path`: local file path to upload
+    - `filename`: optional destination filename override
+- Returns: `ArchiveFile`
+- Raises:
+    - common API exceptions
+    - `FileNotFoundError` if `local_path` does not exist
+    - `ValueError` for invalid filename (empty, hidden name, spaces, unsupported chars)
+    - `NotFoundError` with enriched message when destination bucket/path does not exist
+
+### `upload_directory(*, bucket_name: str, remote_path: str, local_directory: str | Path, recursive: bool = True, dry_run: bool = False, strict: bool = False) -> ArchiveDirectoryUploadResult`
+
+Bulk upload helper with preflight classification.
+
+- Endpoint behavior:
+    - Local preflight scan/validation
+    - Multiple `POST /api/archives/buckets/{bucket_name}/files/{destination_remote_path}` calls for eligible files
+- Parameters:
+    - `bucket_name`: destination archive bucket
+    - `remote_path`: base destination directory
+    - `local_directory`: source directory
+    - `recursive`: include nested files
+    - `dry_run`: only preflight, no uploads
+    - `strict`: abort upload phase if preflight has skipped files
+- Returns: `ArchiveDirectoryUploadResult` with `scanned`, `eligible`, `skipped`, `uploaded`, `failed`, plus per-file details
+- Raises:
+    - `FileNotFoundError` if `local_directory` does not exist
+    - `NotADirectoryError` if `local_directory` is not a directory
+    - Other exceptions are generally captured into `failed_files`/`skipped_files` entries instead of being raised
+
+### `download_file(*, bucket_name: str, remote_path: str, local_path: str | Path | None = None) -> bytes | Path`
+
+- Endpoint: `GET /api/archives/download/{bucket_name}/{remote_path}`
+- Parameters:
+    - `local_path`: optional save target; when omitted returns bytes in memory
+- Returns:
+    - `bytes` when `local_path` is `None`
+    - `Path` when written to disk
+- Raises:
+    - common API exceptions
+    - filesystem exceptions if writing to `local_path` fails
+
+### `copy_file(*, source_bucket_name: str, source_path: str, destination_bucket_name: str, destination_path: str | None = None, destination_filename: str | None = None) -> ArchiveFile`
+
+Copy helper implemented as download + upload.
+
+- Endpoint sequence:
+    - `GET /api/archives/download/{source_bucket_name}/{source_path}`
+    - `POST /api/archives/buckets/{destination_bucket_name}/files/{destination_path or "/"}`
+- Returns: copied `ArchiveFile`
+- Raises:
+    - common API exceptions
+    - any local/file validation exceptions from `download_file(...)` or `upload_file(...)`
+
+### `get_file(archive_file_id: int) -> ArchiveFile`
+
+- Endpoint: `GET /api/archives/files/{archive_file_id}`
+- Returns: `ArchiveFile`
+- Raises: common API exceptions
+
+### `delete_file(archive_file_id: int) -> bool`
+
+- Endpoint: `DELETE /api/archives/files/{archive_file_id}`
+- Returns: `True`
+- Raises: common API exceptions
+

mtn_cloud-0.2.6/docs/api-reference/client.md

@@ -0,0 +1,44 @@
+# Client: `MTNCloud`
+
+### `MTNCloud(token=None, username=None, password=None, url=None, timeout=None, verify_ssl=True, config=None)`
+
+Creates an SDK client and lazy-loads resource managers.
+
+- Endpoint: None (constructor does not make API calls)
+- Parameters:
+    - `token`: API bearer token (recommended)
+    - `username`, `password`: OAuth password-grant alternative
+    - `url`: MTN Cloud base console URL, no `/api` needed
+    - `timeout`: request timeout in seconds
+    - `verify_ssl`: enable/disable TLS certificate validation
+    - `config`: explicit `MTNCloudConfig` object (overrides other args)
+- Returns: `MTNCloud`
+- Raises:
+    - `pydantic.ValidationError` if config values violate `MTNCloudConfig` constraints
+
+### `whoami() -> User`
+
+- Endpoint: `GET /api/whoami`
+- Parameters: none
+- Returns: `User`
+- Raises: common API exceptions
+
+### `ping() -> bool`
+
+Connectivity/auth convenience check.
+
+- Endpoint sequence:
+    - `GET /api/whoami` (via `whoami()`)
+- Parameters: none
+- Returns:
+    - `True` if request succeeds
+    - `False` for any exception
+- Raises: none (exceptions are swallowed and converted to `False`)
+
+### `close() -> None`
+
+- Endpoint: None
+- Parameters: none
+- Returns: `None`
+- Raises: none
+

mtn_cloud-0.2.6/docs/api-reference/clouds.md

@@ -0,0 +1,40 @@
+# Resource: `cloud.clouds` (`CloudsResource`)
+
+### `list(max_results=None, offset=0, sort=None, direction=None, phrase=None, name=None, group_id=None, type_code=None, **filters) -> list[Cloud]`
+
+- Endpoint: `GET /api/zones`
+- Parameters:
+    - Shared list args
+    - `name`: cloud/zone name filter
+    - `group_id`: mapped to `groupId`
+    - `type_code`: mapped to `type` (example: `openstack`)
+- Returns: `list[Cloud]`
+- Raises: common API exceptions
+
+### `list_openstack(max_results=None, offset=0, sort=None, direction=None, phrase=None, name=None, group_id=None, **filters) -> list[Cloud]`
+
+- Endpoint: `GET /api/zones?type=openstack`
+- Returns: OpenStack-only clouds
+- Raises: common API exceptions
+
+### `get(cloud_id: int) -> Cloud`
+
+- Endpoint: `GET /api/zones/{cloud_id}`
+- Returns: `Cloud`
+- Raises: common API exceptions
+
+### `get_by_name(name: str) -> Cloud`
+
+- Endpoint sequence:
+    - `GET /api/zones?name=<name>&max=1`
+- Returns: `Cloud`
+- Raises:
+    - common API exceptions
+    - `NotFoundError` when no match
+
+### `list_by_group(group_id: int) -> list[Cloud]`
+
+- Endpoint: `GET /api/zones?groupId=<group_id>`
+- Returns: `list[Cloud]`
+- Raises: common API exceptions
+

mtn_cloud-0.2.6/docs/api-reference/groups.md

@@ -0,0 +1,26 @@
+# Resource: `cloud.groups` (`GroupsResource`)
+
+### `list(max_results=None, offset=0, sort=None, direction=None, phrase=None, name=None, **filters) -> list[Group]`
+
+- Endpoint: `GET /api/groups`
+- Parameters:
+    - Shared list args
+    - `name`: group name filter
+- Returns: `list[Group]`
+- Raises: common API exceptions
+
+### `get(group_id: int) -> Group`
+
+- Endpoint: `GET /api/groups/{group_id}`
+- Returns: `Group`
+- Raises: common API exceptions
+
+### `get_by_name(name: str) -> Group`
+
+- Endpoint sequence:
+    - `GET /api/groups?name=<name>&max=1`
+- Returns: `Group`
+- Raises:
+    - common API exceptions
+    - `NotFoundError` when no match
+

mtn_cloud-0.2.6/docs/api-reference/index.md

@@ -0,0 +1,80 @@
+# API Reference
+
+This section documents the public SDK surface in endpoint-first format.
+
+## Sections
+
+- [Client (`MTNCloud`)](./client.md)
+- [Instances (`cloud.instances`)](./instances.md)
+- [Instance Types (`cloud.instance_types`)](./instance-types.md)
+- [Networks (`cloud.networks`)](./networks.md)
+- [Clouds (`cloud.clouds`)](./clouds.md)
+- [Groups (`cloud.groups`)](./groups.md)
+- [Plans (`cloud.plans`)](./plans.md)
+- [Storage Buckets (`cloud.storage_buckets`)](./storage-buckets.md)
+- [Archive Buckets (`cloud.archive_buckets`)](./archive-buckets.md)
+
+## Conventions
+
+- Base URL: `https://console.cloud.mtn.ng` by default (configurable via `MTN_CLOUD_URL`).
+- API prefix: the SDK automatically appends `/api`.
+- Endpoint examples below are shown as relative API paths, e.g. `GET /api/instances`.
+- All resource managers are accessed from a client instance:
+
+```python
+from mtn_cloud import MTNCloud
+
+cloud = MTNCloud(token="...")
+```
+
+## Common Exceptions
+
+All HTTP-backed methods may raise these exceptions based on API response or transport errors:
+
+| Exception | When it is raised |
+|---|---|
+| `AuthenticationError` | `401` or missing/invalid credentials |
+| `ForbiddenError` | `403` insufficient permission |
+| `NotFoundError` | `404` resource not found |
+| `ValidationError` | `400` invalid input/payload |
+| `RateLimitError` | `429` too many requests |
+| `ServerError` | `5xx` backend failure |
+| `TimeoutError` | request timeout |
+| `MTNCloudError` | connection errors, unknown status codes, generic request failures |
+
+Method-specific local exceptions (for example `FileNotFoundError`) are documented per method.
+
+## Shared `list(...)` Query Arguments
+
+Most resource managers implement a `list(...)` variant with these common query controls:
+
+| Argument | API Query Key | Notes |
+|---|---|---|
+| `max_results` | `max` | Maximum returned rows |
+| `offset` | `offset` | Pagination offset |
+| `sort` | `sort` | Sort field |
+| `direction` | `direction` | `asc` or `desc` |
+| `phrase` | `phrase` | API-side search phrase |
+| `**filters` | passthrough | Extra endpoint-specific filters |
+
+## Shared Inherited Helper
+
+Every resource manager (`instances`, `networks`, `plans`, etc.) inherits:
+
+### `resource.exists(resource_id: int) -> bool`
+
+- Endpoint sequence:
+    - `GET /api/<resource-path>/{resource_id}`
+- Returns:
+    - `True` if found
+    - `False` only when `NotFoundError` occurs
+- Raises:
+    - Any non-`NotFoundError` common API exception
+
+
+## References
+
+- MTN Cloud Console: <https://console.cloud.mtn.ng>
+- MTN Cloud Guide: <https://cloud.mtn.ng/documentation>
+- Morpheus API Documentation (supplementary): <https://apidocs.morpheusdata.com/>
+- SDK Source: <https://github.com/mahveotm/mtn-cloud-python>

mtn_cloud-0.2.6/docs/api-reference/instance-types.md

@@ -0,0 +1,62 @@
+# Resource: `cloud.instance_types` (`InstanceTypesResource`)
+
+### `list(max_results=None, offset=0, sort="name", direction="asc", phrase=None, name=None, code=None, category=None, featured=None, **filters) -> list[InstanceType]`
+
+- Endpoint: `GET /api/instance-types`
+- Parameters:
+    - Shared list args
+    - `name`: name filter
+    - `code`: code filter
+    - `category`: category filter (`os`, `sql`, `web`, `apps`, etc.)
+    - `featured`: feature flag filter
+- Returns: `list[InstanceType]`
+- Raises: common API exceptions
+
+### `get(instance_type_id: int) -> InstanceType`
+
+- Endpoint: `GET /api/instance-types/{instance_type_id}`
+- Returns: `InstanceType`
+- Raises: common API exceptions
+
+### `get_by_code(code: str) -> InstanceType`
+
+- Endpoint sequence:
+    - `GET /api/instance-types?code=<code>&max=1`
+- Returns: `InstanceType`
+- Raises:
+    - common API exceptions
+    - `NotFoundError` when no match
+
+### `get_by_name(name: str) -> InstanceType`
+
+- Endpoint sequence:
+    - `GET /api/instance-types?name=<name>&max=1`
+- Returns: `InstanceType`
+- Raises:
+    - common API exceptions
+    - `NotFoundError` when no match
+
+### `list_os() -> list[InstanceType]`
+
+- Endpoint: `GET /api/instance-types?category=os`
+- Returns: OS instance types
+- Raises: common API exceptions
+
+### `list_databases() -> list[InstanceType]`
+
+- Endpoint: `GET /api/instance-types?category=sql`
+- Returns: database instance types
+- Raises: common API exceptions
+
+### `list_web() -> list[InstanceType]`
+
+- Endpoint: `GET /api/instance-types?category=web`
+- Returns: web instance types
+- Raises: common API exceptions
+
+### `list_apps() -> list[InstanceType]`
+
+- Endpoint: `GET /api/instance-types?category=apps`
+- Returns: app instance types
+- Raises: common API exceptions
+

mtn_cloud-0.2.6/docs/api-reference/instances.md

@@ -0,0 +1,167 @@
+# Resource: `cloud.instances` (`InstancesResource`)
+
+### `list(max_results=None, offset=0, sort=None, direction=None, phrase=None, name=None, status=None, cloud_id=None, group_id=None, labels=None, **filters) -> list[Instance]`
+
+- Endpoint: `GET /api/instances`
+- Parameters:
+    - Shared list args (see [API Reference](./index.md#shared-list-query-arguments))
+    - `name`: exact name filter
+    - `status`: status filter
+    - `cloud_id`: mapped to query `zoneId`
+    - `group_id`: mapped to query `siteId`
+    - `labels`: list mapped to comma-delimited query `labels`
+- Returns: `list[Instance]`
+- Raises: common API exceptions
+
+### `get(instance_id: int) -> Instance`
+
+- Endpoint: `GET /api/instances/{instance_id}`
+- Parameters:
+    - `instance_id`: instance numeric ID
+- Returns: `Instance`
+- Raises: common API exceptions
+
+### `get_by_name(name: str) -> Instance`
+
+- Endpoint sequence:
+    - `GET /api/instances?name=<name>&max=1`
+- Parameters:
+    - `name`: instance name
+- Returns: `Instance`
+- Raises:
+    - common API exceptions
+    - `NotFoundError` when no instance matches
+
+### `create(name: str, *, cloud: str, type: str, group: str, layout: int, plan: int, description=None, environment=None, labels=None, tags=None, copies=1, layout_size=1, resource_pool_id=None, availability_zone=None, security_group="default", os_external_network_id=None, create_user=True, workflow_id=None, shutdown_days=None, expire_days=None, create_backup=None, security_groups=None, ports=None, volumes=None, network_interfaces=None, options=None) -> Instance`
+
+- Endpoint sequence:
+    - `GET /api/groups?name=<group>&max=1` (resolve group name to `group_id`)
+    - `POST /api/instances`
+- Parameters:
+    - Required core fields:
+        - `name`: new instance name
+        - `cloud`: cloud/zone name (example: `MTNNG_CLOUD_AZ_1`)
+        - `type`: instance type code (example: `MTN-CS10`)
+        - `group`: group/site name (resolved to ID)
+        - `layout`: layout ID
+        - `plan`: service plan ID
+    - Optional metadata:
+        - `description`, `environment`, `labels`, `tags`
+    - Optional sizing/provisioning:
+        - `copies`, `layout_size`
+    - Optional MTN/OpenStack-specific provisioning:
+        - `resource_pool_id`, `availability_zone`, `security_group`, `os_external_network_id`, `create_user`
+    - Optional automation:
+        - `workflow_id`, `shutdown_days`, `expire_days`, `create_backup`
+    - Optional networking/storage details:
+        - `security_groups`, `ports`, `volumes`, `network_interfaces`, `options`
+- Returns: `Instance`
+- Raises:
+    - common API exceptions
+    - `NotFoundError` when `group` cannot be resolved
+
+### `update(instance_id: int, name=None, description=None, labels=None) -> Instance`
+
+- Endpoint: `PUT /api/instances/{instance_id}`
+- Parameters:
+    - `instance_id`: target instance ID
+    - `name`: replacement name
+    - `description`: replacement description
+    - `labels`: replacement labels list
+- Returns: `Instance`
+- Raises: common API exceptions
+
+### `delete(instance_id: int, preserve_volumes=False, force=False) -> bool`
+
+- Endpoint: `DELETE /api/instances/{instance_id}`
+- Parameters:
+    - `instance_id`: target instance ID
+    - `preserve_volumes`: adds query `preserveVolumes=on`
+    - `force`: adds query `force=on`
+- Returns: `True` on successful deletion request
+- Raises: common API exceptions
+
+### `start(instance_id: int) -> Instance`
+
+- Endpoint sequence:
+    - `PUT /api/instances/{instance_id}/start`
+    - `GET /api/instances/{instance_id}`
+- Returns: refreshed `Instance`
+- Raises: common API exceptions
+
+### `stop(instance_id: int) -> Instance`
+
+- Endpoint sequence:
+    - `PUT /api/instances/{instance_id}/stop`
+    - `GET /api/instances/{instance_id}`
+- Returns: refreshed `Instance`
+- Raises: common API exceptions
+
+### `restart(instance_id: int) -> Instance`
+
+- Endpoint sequence:
+    - `PUT /api/instances/{instance_id}/restart`
+    - `GET /api/instances/{instance_id}`
+- Returns: refreshed `Instance`
+- Raises: common API exceptions
+
+### `suspend(instance_id: int) -> Instance`
+
+- Endpoint sequence:
+    - `PUT /api/instances/{instance_id}/suspend`
+    - `GET /api/instances/{instance_id}`
+- Returns: refreshed `Instance`
+- Raises: common API exceptions
+
+### `resize(instance_id: int, plan_id: int) -> Instance`
+
+- Endpoint sequence:
+    - `PUT /api/instances/{instance_id}/resize`
+    - `GET /api/instances/{instance_id}`
+- Parameters:
+    - `plan_id`: new service plan ID
+- Returns: resized `Instance`
+- Raises: common API exceptions
+
+### `wait_for_status(instance_id: int, target_status: str, timeout: int = 300, poll_interval: int = 5) -> Instance`
+
+Client-side polling helper.
+
+- Endpoint sequence:
+    - repeated `GET /api/instances/{instance_id}` until target status or timeout
+- Parameters:
+    - `target_status`: desired status string (`running`, `stopped`, etc.)
+    - `timeout`: max wait in seconds
+    - `poll_interval`: sleep interval between polls
+- Returns: `Instance` once target status matches
+- Raises:
+    - common API exceptions from internal `get`
+    - `TimeoutError` when timeout is exceeded
+    - `RuntimeError` if instance enters `failed` state
+
+### `wait_until_running(instance_id: int, timeout: int = 300) -> Instance`
+
+- Endpoint behavior: same as `wait_for_status(..., target_status="running")`
+- Returns: `Instance`
+- Raises: same as `wait_for_status`
+
+### `wait_until_stopped(instance_id: int, timeout: int = 300) -> Instance`
+
+- Endpoint behavior: same as `wait_for_status(..., target_status="stopped")`
+- Returns: `Instance`
+- Raises: same as `wait_for_status`
+
+### `get_console(instance_id: int) -> dict[str, Any]`
+
+- Endpoint: `GET /api/instances/{instance_id}/console`
+- Returns: raw console payload (`url`, credentials, metadata)
+- Raises: common API exceptions
+
+### `get_history(instance_id: int, max_results: int | None = None) -> list[dict[str, Any]]`
+
+- Endpoint: `GET /api/instances/{instance_id}/history`
+- Parameters:
+    - `max_results`: maps to query `max`
+- Returns: list from response key `processes`
+- Raises: common API exceptions
+

mtn_cloud-0.2.6/docs/api-reference/networks.md

@@ -0,0 +1,123 @@
+# Resource: `cloud.networks` (`NetworksResource`)
+
+### `list(max_results=None, offset=0, sort=None, direction=None, phrase=None, name=None, cloud_id=None, **filters) -> list[Network]`
+
+- Endpoint: `GET /api/networks`
+- Parameters:
+    - Shared list args
+    - `name`: network name filter
+    - `cloud_id`: mapped to query `zoneId`
+- Returns: `list[Network]`
+- Raises: common API exceptions
+
+### `get(network_id: int) -> Network`
+
+- Endpoint: `GET /api/networks/{network_id}`
+- Returns: `Network`
+- Raises: common API exceptions
+
+### `get_by_name(name: str, cloud_id: int | None = None) -> Network`
+
+- Endpoint sequence:
+    - `GET /api/networks?name=<name>&max=1`
+    - Adds `zoneId=<cloud_id>` when provided
+- Returns: `Network`
+- Raises:
+    - common API exceptions
+    - `NotFoundError` when no match
+
+### `list_by_cloud(cloud_id: int) -> list[Network]`
+
+- Endpoint: `GET /api/networks?zoneId=<cloud_id>`
+- Returns: `list[Network]`
+- Raises: common API exceptions
+
+### `create(name: str, *, cloud_id: int, group_id: int, type_id=None, display_name=None, labels=None, description=None, cidr=None, gateway=None, dns_primary=None, dns_secondary=None, vlan_id=None, switch_id=None, pool_id=None, allow_static_override=None, assign_public_ip=None, active=None, dhcp_server=None, network_domain_id=None, search_domains=None, network_proxy_id=None, appliance_url_proxy_bypass=None, no_proxy=None, visibility=None, tenant_ids=None, resource_permission_all=None, resource_permission_site_ids=None) -> Network`
+
+- Endpoint: `POST /api/networks`
+- Parameters:
+    - Required:
+        - `name`: network name
+        - `cloud_id`: cloud/zone ID
+        - `group_id`: group/site ID
+    - Common optional network config:
+        - `type_id`, `display_name`, `labels`, `description`, `cidr`, `gateway`
+        - `dns_primary`, `dns_secondary`, `vlan_id`, `switch_id`, `pool_id`
+        - `allow_static_override`, `assign_public_ip`, `active`, `dhcp_server`
+        - `network_domain_id`, `search_domains`, `network_proxy_id`
+        - `appliance_url_proxy_bypass`, `no_proxy`, `visibility`
+        - `tenant_ids`, `resource_permission_all`, `resource_permission_site_ids`
+- Returns: `Network`
+- Raises: common API exceptions
+
+### `update(network_id: int, *, display_name=None, labels=None, description=None, cidr=None, gateway=None, dns_primary=None, dns_secondary=None, vlan_id=None, switch_id=None, pool_id=None, allow_static_override=None, assign_public_ip=None, active=None, dhcp_server=None, network_domain_id=None, search_domains=None, network_proxy_id=None, appliance_url_proxy_bypass=None, no_proxy=None, visibility=None, tenant_ids=None, resource_permission_all=None, resource_permission_site_ids=None) -> Network`
+
+- Endpoint: `PUT /api/networks/{network_id}`
+- Parameters:
+    - `network_id`: target network ID
+    - Optional fields mirror `create(...)` (except required create-only identifiers)
+- Returns: `Network`
+- Raises: common API exceptions
+
+### `delete(network_id: int) -> bool`
+
+- Endpoint: `DELETE /api/networks/{network_id}`
+- Returns: `True`
+- Raises: common API exceptions
+
+### `list_subnets(network_id: int) -> list[Subnet]`
+
+- Endpoint: `GET /api/networks/{network_id}/subnets`
+- Returns: `list[Subnet]`
+- Raises: common API exceptions
+
+### `list_types(name=None, code=None, phrase=None, openstack_only=False) -> list[NetworkTypeInfo]`
+
+- Endpoint: `GET /api/network-types`
+- Parameters:
+    - `name`: exact name filter
+    - `code`: exact code filter
+    - `phrase`: phrase filter
+    - `openstack_only`: client-side filter on returned `is_openstack`
+- Returns: `list[NetworkTypeInfo]`
+- Raises: common API exceptions
+
+### `get_type(type_id: int) -> NetworkTypeInfo`
+
+- Endpoint: `GET /api/network-types/{type_id}`
+- Returns: `NetworkTypeInfo`
+- Raises: common API exceptions
+
+### `list_floating_ips(*, phrase=None, ip_address=None, ip_status=None, cloud_id=None, server_id=None) -> list[NetworkFloatingIP]`
+
+- Endpoint: `GET /api/networks/floating-ips`
+- Parameters:
+    - `phrase`: search phrase
+    - `ip_address`: exact IP match
+    - `ip_status`: provider status value
+    - `cloud_id`: mapped to `zoneId`
+    - `server_id`: mapped to `serverId`
+- Returns: `list[NetworkFloatingIP]`
+- Raises: common API exceptions
+
+### `get_floating_ip(floating_ip_id: int) -> NetworkFloatingIP`
+
+- Endpoint: `GET /api/networks/floating-ips/{floating_ip_id}`
+- Returns: `NetworkFloatingIP`
+- Raises: common API exceptions
+
+### `allocate_floating_ip(*, network_server_id: int, floating_ip_pool_id: int) -> NetworkFloatingIP`
+
+- Endpoint: `POST /api/networks/floating-ips`
+- Parameters:
+    - `network_server_id`: backend network server ID
+    - `floating_ip_pool_id`: floating IP pool ID
+- Returns: `NetworkFloatingIP`
+- Raises: common API exceptions
+
+### `release_floating_ip(floating_ip_id: int) -> bool`
+
+- Endpoint: `PUT /api/networks/floating-ips/{floating_ip_id}/release`
+- Returns: `True`
+- Raises: common API exceptions
+

mtn_cloud-0.2.6/docs/api-reference/plans.md

@@ -0,0 +1,41 @@
+# Resource: `cloud.plans` (`PlansResource`)
+
+### `list(max_results=None, offset=0, sort=None, direction=None, phrase=None, name=None, **filters) -> list[ServicePlan]`
+
+- Endpoint: `GET /api/service-plans`
+- Parameters:
+    - Shared list args
+    - `name`: plan name filter
+- Returns: `list[ServicePlan]`
+- Raises: common API exceptions
+
+### `get(plan_id: int) -> ServicePlan`
+
+- Endpoint: `GET /api/service-plans/{plan_id}`
+- Returns: `ServicePlan`
+- Raises: common API exceptions
+
+### `get_by_name(name: str) -> ServicePlan`
+
+- Endpoint sequence:
+    - `GET /api/service-plans?name=<name>&max=1`
+- Returns: `ServicePlan`
+- Raises:
+    - common API exceptions
+    - `NotFoundError` when no match
+
+### `find(cores=None, memory_gb=None, storage_gb=None) -> ServicePlan | None`
+
+Client-side selector for first plan meeting minimum requirements.
+
+- Endpoint sequence:
+    - `GET /api/service-plans`
+- Parameters:
+    - `cores`: minimum CPU cores
+    - `memory_gb`: minimum memory in GB
+    - `storage_gb`: minimum storage in GB
+- Returns:
+    - `ServicePlan` first match
+    - `None` if no plan satisfies constraints
+- Raises: common API exceptions
+

mtn_cloud-0.2.6/docs/api-reference/storage-buckets.md

@@ -0,0 +1,69 @@
+# Resource: `cloud.storage_buckets` (`StorageBucketsResource`)
+
+### `list(max_results=None, offset=0, sort=None, direction=None, phrase=None, name=None, **filters) -> list[StorageBucket]`
+
+- Endpoint: `GET /api/storage-buckets`
+- Parameters:
+    - Shared list args
+    - `name`: storage bucket name filter
+- Returns: `list[StorageBucket]`
+- Raises: common API exceptions
+
+### `get(storage_bucket_id: int) -> StorageBucket`
+
+- Endpoint: `GET /api/storage-buckets/{storage_bucket_id}`
+- Returns: `StorageBucket`
+- Raises: common API exceptions
+
+### `get_by_name(name: str) -> StorageBucket`
+
+- Endpoint sequence:
+    - `GET /api/storage-buckets?name=<name>&max=1`
+- Returns: `StorageBucket`
+- Raises:
+    - common API exceptions
+    - `NotFoundError` when no match
+
+### `create(name: str, *, bucket_name: str, access_key: str, secret_key: str, endpoint: str, storage_server=None, default_backup_target=None, copy_to_store=None, default_deployment_target=None, default_virtual_image_target=None, retention_policy_type="none", retention_policy_days=None, retention_provider=None, create_bucket=True) -> StorageBucket`
+
+- Endpoint: `POST /api/storage-buckets`
+- Parameters:
+    - Required:
+        - `name`: storage bucket object name
+        - `bucket_name`: underlying S3 bucket/container name
+        - `access_key`, `secret_key`, `endpoint`: provider credentials/endpoint
+    - Optional target/default flags:
+        - `default_backup_target`, `copy_to_store`, `default_deployment_target`, `default_virtual_image_target`
+    - Optional retention behavior:
+        - `retention_policy_type`: `backup`, `delete`, or `none`
+        - `retention_policy_days`, `retention_provider`
+    - `storage_server`: optional storage server ID
+    - `create_bucket`: create target bucket when missing
+- Returns: `StorageBucket`
+- Raises: common API exceptions
+
+### `create_s3(name: str, *, bucket_name: str, access_key: str, secret_key: str, endpoint: str, storage_server=None, create_bucket=True, default_backup_target=None, copy_to_store=None, default_deployment_target=None, default_virtual_image_target=None) -> StorageBucket`
+
+Convenience wrapper for S3-backed create.
+
+- Endpoint behavior: forwards to `create(...)` then `POST /api/storage-buckets`
+- Returns: `StorageBucket`
+- Raises: same as `create`
+
+### `update(storage_bucket_id: int, *, name=None, bucket_name=None, config=None, default_backup_target=None, copy_to_store=None, default_deployment_target=None, default_virtual_image_target=None, retention_policy_type=None, retention_policy_days=None, retention_provider=None, create_bucket=None) -> StorageBucket`
+
+- Endpoint: `PUT /api/storage-buckets/{storage_bucket_id}`
+- Parameters:
+    - `storage_bucket_id`: target ID
+    - Optional updates for name/bucket/config/defaults/retention
+- Returns: `StorageBucket`
+- Raises: common API exceptions
+
+### `delete(storage_bucket_id: int, *, remove_resources: bool = False) -> bool`
+
+- Endpoint: `DELETE /api/storage-buckets/{storage_bucket_id}`
+- Parameters:
+    - `remove_resources`: when `True`, sends `removeResources=true`
+- Returns: `True`
+- Raises: common API exceptions
+

{mtn_cloud-0.2.2 → mtn_cloud-0.2.6}/docs/index.md

@@ -14,7 +14,8 @@ Use this guide in two ways:
 4. [Storage](./storage.md)
 5. [Advanced Cookbook](./advanced-cookbook.md)
 6. [API Overview](./api-overview.md)
-7. [Docstring Style Standard](./docstring-style.md)
+7. [API Reference](./api-reference/index.md)
+8. [Docstring Style Standard](./docstring-style.md)
 
 ## Who This Is For
 
@@ -25,7 +26,7 @@ Use this guide in two ways:
 ## Conventions Used
 
 - `cloud` means an initialized `MTNCloud` client.
-- `group` maps to Morpheus site.
+- `group` maps to MTN Cloud site.
 - `cloud` or `zone` may be used interchangeably based on Morpheus API naming.
 - Example IDs and codes are illustrative; query your account first before provisioning.
 
@@ -36,4 +37,5 @@ Use this guide in two ways:
 3. Networking
 4. Storage
 5. API Overview
-6. Advanced Cookbook
+6. API Reference
+7. Advanced Cookbook

mtn_cloud-0.2.6/docs/stylesheets/extra.css

@@ -0,0 +1,30 @@
+:root {
+  --md-primary-fg-color: #005f73;
+  --md-primary-fg-color--light: #0a9396;
+  --md-primary-fg-color--dark: #004a59;
+  --md-accent-fg-color: #ee9b00;
+}
+
+[data-md-color-scheme="default"] {
+  --md-code-bg-color: #f3f5f7;
+}
+
+[data-md-color-scheme="slate"] {
+  --md-default-bg-color: #0e1116;
+  --md-default-fg-color: #e6edf3;
+  --md-code-bg-color: #161b22;
+}
+
+.md-typeset h1 {
+  font-weight: 700;
+  letter-spacing: -0.01em;
+}
+
+.md-typeset h2 {
+  border-bottom: 1px solid var(--md-default-fg-color--lightest);
+  padding-bottom: 0.2rem;
+}
+
+.md-typeset code {
+  border-radius: 0.25rem;
+}

{mtn_cloud-0.2.2 → mtn_cloud-0.2.6}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
 [project]
 name = "mtn-cloud"
 dynamic = ["version"]
-description = "Community Python SDK for MTN Cloud (Morpheus) - Deploy and manage cloud resources with ease"
+description = "Community Python SDK for MTN Cloud - Deploy and manage cloud resources with ease"
 readme = "README.md"
 license = { text = "MIT" }
 authors = [
@@ -17,7 +17,7 @@ maintainers = [
 keywords = [
     "mtn",
     "cloud",
-    "morpheus",
+    "mtn-cloud",
     "sdk",
     "api",
     "infrastructure",

{mtn_cloud-0.2.2 → mtn_cloud-0.2.6}/src/mtn_cloud/_version.py

@@ -1,3 +1,3 @@
 """Package version metadata."""
 
-__version__ = "0.2.2"
+__version__ = "0.2.6"

{mtn_cloud-0.2.2 → mtn_cloud-0.2.6}/src/mtn_cloud/client.py

@@ -17,7 +17,7 @@ from mtn_cloud.resources.storage_buckets import StorageBucketsResource
 
 class MTNCloud:
     """
-    MTN Cloud client for interacting with the Morpheus API.
+    MTN Cloud client for interacting with the MTN Cloud API.
 
     This is the main entry point for the SDK. Initialize with your
     API token or credentials to start making API calls.

{mtn_cloud-0.2.2 → mtn_cloud-0.2.6}/src/mtn_cloud/models/storage_bucket.py

@@ -1,4 +1,4 @@
-"""Models for Morpheus storage buckets."""
+"""Models for MTN Cloud storage buckets."""
 
 from __future__ import annotations
 

{mtn_cloud-0.2.2 → mtn_cloud-0.2.6}/src/mtn_cloud/resources/archive_buckets.py

@@ -1,4 +1,4 @@
-"""Resource manager for Morpheus archive buckets and files."""
+"""Resource manager for MTN Cloud archive buckets and files."""
 
 from __future__ import annotations
 

{mtn_cloud-0.2.2 → mtn_cloud-0.2.6}/src/mtn_cloud/resources/storage_buckets.py

@@ -1,4 +1,4 @@
-"""Resource manager for Morpheus storage buckets."""
+"""Resource manager for MTN Cloud storage buckets."""
 
 from __future__ import annotations
 

{mtn_cloud-0.2.2 → mtn_cloud-0.2.6}/tests/test_archive_buckets.py

@@ -21,12 +21,12 @@ SAMPLE_ARCHIVE_BUCKET = {
     "name": "apitestmybucket",
     "description": "API Test: My Archive Bucket",
     "storageProvider": {"id": 113, "name": "Local Archives"},
-    "owner": {"id": 1, "name": "Morpheus QA"},
+    "owner": {"id": 1, "name": "MTN QA"},
     "createdBy": {"username": "apiuser"},
     "isPublic": False,
     "visibility": "private",
     "code": "64d94943f108",
-    "filePath": "morpheus-archives/64d94943f108/",
+    "filePath": "mtn-archives/64d94943f108/",
     "rawSize": 0,
     "fileCount": 0,
     "accounts": [],
@@ -35,7 +35,7 @@ SAMPLE_ARCHIVE_BUCKET = {
 SAMPLE_ARCHIVE_FILE = {
     "id": 5338,
     "name": "test.txt",
-    "filePath": "morpheus-archives/6f657af7bc7b/test.txt",
+    "filePath": "mtn-archives/6f657af7bc7b/test.txt",
     "archiveBucket": {"id": 1115, "name": "apitestmybucket", "isPublic": False},
     "createdBy": {"username": "apiuser"},
     "isDirectory": False,

{mtn_cloud-0.2.2 → mtn_cloud-0.2.6}/tests/test_instance_types.py

@@ -36,21 +36,21 @@ SAMPLE_INSTANCE_TYPE = {
 
 SAMPLE_INSTANCE_TYPE_MULTIPLE_LAYOUTS = {
     "id": 113,
-    "name": "Morpheus Builds",
-    "code": "morphbuilds",
+    "name": "MTN Builds",
+    "code": "mtnbuilds",
     "description": None,
     "labels": [],
     "provisionTypeCode": "mixed",
     "category": "web",
     "active": True,
-    "environmentPrefix": "MORPHEUS_BUILDS",
+    "environmentPrefix": "MTN_BUILDS",
     "visibility": "private",
     "featured": True,
     "versions": ["7.9-v1", "8.3-v1"],
     "instanceTypeLayouts": [
-        {"id": 1313, "name": "Morpheus Debian", "provisionTypeCode": "vmware"},
-        {"id": 1315, "name": "Morpheus Ubuntu", "provisionTypeCode": "vmware"},
-        {"id": 1312, "name": "Morpheus CentOS", "provisionTypeCode": "vmware"},
+        {"id": 1313, "name": "MTN Debian", "provisionTypeCode": "vmware"},
+        {"id": 1315, "name": "MTN Ubuntu", "provisionTypeCode": "vmware"},
+        {"id": 1312, "name": "MTN CentOS", "provisionTypeCode": "vmware"},
     ],
     "account": {"id": 1, "name": "mastertenant"},
 }
@@ -183,7 +183,7 @@ class TestInstanceTypeModel:
         """Test getting layout by name."""
         it = InstanceType.model_validate(SAMPLE_INSTANCE_TYPE_MULTIPLE_LAYOUTS)
 
-        layout = it.get_layout_by_name("Morpheus Ubuntu")
+        layout = it.get_layout_by_name("MTN Ubuntu")
         assert layout is not None
         assert layout.id == 1315
 
@@ -197,7 +197,7 @@ class TestInstanceTypeModel:
 
         layout = it.get_layout_by_id(1312)
         assert layout is not None
-        assert layout.name == "Morpheus CentOS"
+        assert layout.name == "MTN CentOS"
 
         # Test not found
         not_found = it.get_layout_by_id(99999)