linode-api4 5.41.0__tar.gz → 5.43.0__tar.gz

{linode_api4-5.41.0/linode_api4.egg-info → linode_api4-5.43.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: linode_api4
-Version: 5.41.0
+Version: 5.43.0
 Summary: The official Python SDK for Linode API v4
 Author-email: Linode <devs@linode.com>
 License: BSD-3-Clause
@@ -14,11 +14,12 @@ Classifier: Topic :: Software Development :: Libraries
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Python: >=3.9
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.10
 Description-Content-Type: text/x-rst
 License-File: LICENSE
 Requires-Dist: requests

{linode_api4-5.41.0 → linode_api4-5.43.0}/linode_api4/groups/linode.py

@@ -322,7 +322,6 @@ class LinodeGroup(Group):
         :param firewall: The firewall to attach this Linode to.
         :type firewall: int or Firewall
         :param disk_encryption: The disk encryption policy for this Linode.
-                                NOTE: Disk encryption may not currently be available to all users.
         :type disk_encryption: InstanceDiskEncryptionType or str
         :param interfaces: An array of Network Interfaces to add to this Linode’s Configuration Profile.
                            At least one and up to three Interface objects can exist in this array.

{linode_api4-5.41.0 → linode_api4-5.43.0}/linode_api4/groups/monitor.py

@@ -1,4 +1,4 @@
-from typing import Any, Optional
+from typing import Any, Optional, Union
 
 from linode_api4 import PaginatedList
 from linode_api4.errors import UnexpectedResponseError
@@ -6,6 +6,8 @@ from linode_api4.groups import Group
 from linode_api4.objects import (
     AlertChannel,
     AlertDefinition,
+    AlertDefinitionEntity,
+    AlertScope,
     MonitorDashboard,
     MonitorMetricsDefinition,
     MonitorService,
@@ -202,7 +204,7 @@ class MonitorGroup(Group):
 
         .. note:: This endpoint is in beta and requires using the v4beta base URL.
 
-        API Documentation: https://techdocs.akamai.com/linode-api/reference/get-alert-channels
+        API Documentation: https://techdocs.akamai.com/linode-api/reference/get-notification-channels
 
         :param filters: Optional filter expressions to apply to the collection.
                         See :doc:`Filtering Collections</linode_api4/objects/filtering>` for details.
@@ -221,6 +223,8 @@ class MonitorGroup(Group):
         trigger_conditions: dict,
         entity_ids: Optional[list[str]] = None,
         description: Optional[str] = None,
+        scope: Optional[Union[AlertScope, str]] = None,
+        regions: Optional[list[str]] = None,
     ) -> AlertDefinition:
         """
         Create a new alert definition for a given service type.
@@ -252,6 +256,10 @@ class MonitorGroup(Group):
         :type entity_ids: Optional[list[str]]
         :param description: (Optional) Longer description for the alert definition.
         :type description: Optional[str]
+        :param scope: (Optional) Alert scope (for example: `account`, `entity`, or `region`). Defaults to `entity`.
+        :type scope: Optional[Union[AlertScope, str]]
+        :param regions: (Optional) Regions to monitor.
+        :type regions: Optional[list[str]]
 
         :returns: The newly created :class:`AlertDefinition`.
         :rtype: AlertDefinition
@@ -267,10 +275,15 @@ class MonitorGroup(Group):
             "rule_criteria": rule_criteria,
             "trigger_conditions": trigger_conditions,
         }
-        if description is not None:
-            params["description"] = description
+
         if entity_ids is not None:
             params["entity_ids"] = entity_ids
+        if description is not None:
+            params["description"] = description
+        if scope is not None:
+            params["scope"] = scope
+        if regions is not None:
+            params["regions"] = regions
 
         # API will validate service_type and return an error if missing
         result = self.client.post(
@@ -284,3 +297,38 @@ class MonitorGroup(Group):
             )
 
         return AlertDefinition(self.client, result["id"], service_type, result)
+
+    def alert_definition_entities(
+        self,
+        service_type: str,
+        id: int,
+        *filters,
+    ) -> PaginatedList:
+        """
+        List entities associated with a specific alert definition.
+
+        This endpoint supports pagination fields (`page`, `page_size`) in the API.
+
+        .. note:: This endpoint is in beta and requires using the v4beta base URL.
+
+        API Documentation: TODO
+
+        :param service_type: Service type for the alert definition (e.g. `dbaas`).
+        :type service_type: str
+        :param id: Alert definition identifier.
+        :type id: int
+        :param filters: Optional filter expressions to apply to the collection.
+                        See :doc:`Filtering Collections</linode_api4/objects/filtering>`.
+
+        :returns: A paginated list of entities associated with the alert definition.
+        :rtype: PaginatedList[AlertDefinitionEntity]
+        """
+
+        endpoint = (
+            f"/monitor/services/{service_type}/alert-definitions/{id}/entities"
+        )
+        return self.client._get_and_filter(
+            AlertDefinitionEntity,
+            *filters,
+            endpoint=endpoint,
+        )

{linode_api4-5.41.0 → linode_api4-5.43.0}/linode_api4/groups/volume.py

@@ -48,7 +48,6 @@ class VolumeGroup(Group):
         :type tags: list[str]
         :param encryption: Whether the new Volume should opt in or out of disk encryption.
         :type encryption: str
-            Note: Block Storage Disk Encryption is not currently available to all users.
         :returns: The new Volume.
         :rtype: Volume
         """

{linode_api4-5.41.0 → linode_api4-5.43.0}/linode_api4/objects/linode.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import copy
 import string
 import sys
@@ -40,7 +42,11 @@ from linode_api4.objects.region import Region
 from linode_api4.objects.serializable import JSONObject, StrEnum
 from linode_api4.objects.vpc import VPC, VPCSubnet
 from linode_api4.paginated_list import PaginatedList
-from linode_api4.util import drop_null_keys, generate_device_suffixes
+from linode_api4.util import (
+    drop_null_keys,
+    generate_device_suffixes,
+    normalize_as_list,
+)
 
 PASSWORD_CHARS = string.ascii_letters + string.digits + string.punctuation
 MIN_DEVICE_LIMIT = 8
@@ -1246,14 +1252,14 @@ class Instance(Base):
     # create derived objects
     def config_create(
         self,
-        kernel=None,
-        label=None,
-        devices=[],
-        disks=[],
-        volumes=[],
-        interfaces=[],
+        kernel: Kernel | str | None = None,
+        label: str | None = None,
+        devices: "Disk | Volume | dict[str, Any] | list[Disk | Volume | dict[str, Any]] | None" = None,
+        disks: Disk | int | list[Disk | int] | None = None,
+        volumes: "Volume | int | list[Volume | int] | None" = None,
+        interfaces: list[ConfigInterface | dict[str, Any]] | None = None,
         **kwargs,
-    ):
+    ) -> Config:
         """
         Creates a Linode Config with the given attributes.
 
@@ -1263,10 +1269,13 @@ class Instance(Base):
         :param label: The config label
         :param disks: The list of disks, starting at sda, to map to this config.
         :param volumes: The volumes, starting after the last disk, to map to this
-            config
+                        config.
         :param devices: A list of devices to assign to this config, in device
-            index order.  Values must be of type Disk or Volume. If this is
-            given, you may not include disks or volumes.
+                        index order, a raw device mapping dict to pass directly to the API
+                        (e.g. ``{"sda": {"disk_id": 123}, "sdb": Volume(...)}``), or
+                        a single Disk or Volume.
+                        If this is given, you may not include disks or volumes.
+        :param interfaces: A list of ConfigInterface objects or dicts to assign to this config.
         :param **kwargs: Any other arguments accepted by the api.
 
         :returns: A new Linode Config
@@ -1274,6 +1283,8 @@ class Instance(Base):
         # needed here to avoid circular imports
         from .volume import Volume  # pylint: disable=import-outside-toplevel
 
+        interfaces = [] if interfaces is None else interfaces
+
         hypervisor_prefix = "sd" if self.hypervisor == "kvm" else "xvd"
 
         device_limit = int(
@@ -1288,52 +1299,83 @@ class Instance(Base):
             for suffix in generate_device_suffixes(device_limit)
         ]
 
-        device_map = {
-            device_names[i]: None for i in range(0, len(device_names))
-        }
+        def _flatten_device(device: Disk | Volume | dict | None):
+            if device is None:
+                return None
+            elif isinstance(device, Disk):
+                return {"disk_id": device.id}
+            elif isinstance(device, Volume):
+                return {"volume_id": device.id}
+            elif isinstance(device, dict):
+                return device
+
+            raise TypeError("Disk, Volume, or dict expected!")
+
+        def _device_entry(device: Disk | Volume | int, key: str):
+            if isinstance(device, (Disk, Volume)):
+                return _flatten_device(device)
+
+            try:
+                device_id = int(device)
+            except (TypeError, ValueError):
+                raise TypeError(
+                    "Disk, Volume, or integer ID expected!"
+                ) from None
+
+            return {key: device_id}
+
+        def _build_devices():
+            # Devices is a dict, flatten and pass through
+            if isinstance(devices, dict):
+                return {
+                    k: (
+                        _flatten_device(v)
+                        if isinstance(v, (Disk, Volume))
+                        else v
+                    )
+                    for k, v in devices.items()
+                }
 
+            device_list = []
+
+            if devices:
+                device_list += [
+                    _flatten_device(device)
+                    for device in normalize_as_list(devices)
+                ]
+
+            if disks:
+                device_list += [
+                    _device_entry(disk, "disk_id") if disk is not None else None
+                    for disk in normalize_as_list(disks)
+                ]
+
+            if volumes:
+                device_list += [
+                    (
+                        _device_entry(volume, "volume_id")
+                        if volume is not None
+                        else None
+                    )
+                    for volume in normalize_as_list(volumes)
+                ]
+
+            return {
+                device_names[i]: device for i, device in enumerate(device_list)
+            }
+
+        # This validation is enforced for backwards compatibility but isn't
+        # technically needed anymore
         if devices and (disks or volumes):
             raise ValueError(
                 'You may not call config_create with "devices" and '
                 'either of "disks" or "volumes" specified!'
             )
 
-        if not devices:
-            if not isinstance(disks, list):
-                disks = [disks]
-            if not isinstance(volumes, list):
-                volumes = [volumes]
-
-            devices = []
-
-            for d in disks:
-                if d is None:
-                    devices.append(None)
-                elif isinstance(d, Disk):
-                    devices.append(d)
-                else:
-                    devices.append(Disk(self._client, int(d), self.id))
-
-            for v in volumes:
-                if v is None:
-                    devices.append(None)
-                elif isinstance(v, Volume):
-                    devices.append(v)
-                else:
-                    devices.append(Volume(self._client, int(v)))
-
-        if not devices:
-            raise ValueError("Must include at least one disk or volume!")
+        device_map = _build_devices()
 
-        for i, d in enumerate(devices):
-            if d is None:
-                pass
-            elif isinstance(d, Disk):
-                device_map[device_names[i]] = {"disk_id": d.id}
-            elif isinstance(d, Volume):
-                device_map[device_names[i]] = {"volume_id": d.id}
-            else:
-                raise TypeError("Disk or Volume expected!")
+        if len(device_map) < 1:
+            raise ValueError("Must include at least one disk or volume!")
 
         param_interfaces = []
         for interface in interfaces:
@@ -1406,7 +1448,6 @@ class Instance(Base):
                                  should already be set up, see :any:`ProfileGroup.ssh_keys`
                                  for details.
         :param disk_encryption: The disk encryption policy for this Linode.
-                                NOTE: Disk encryption may not currently be available to all users.
         :type disk_encryption: InstanceDiskEncryptionType or str
         :param stackscript: A StackScript object, or the ID of one, to deploy to this
                             disk.  Requires deploying a compatible image.
@@ -1600,7 +1641,6 @@ class Instance(Base):
                                 the key.
         :type authorized_keys: list or str
         :param disk_encryption: The disk encryption policy for this Linode.
-                                NOTE: Disk encryption may not currently be available to all users.
         :type disk_encryption: InstanceDiskEncryptionType or str
 
         :returns: The newly generated password, if one was not provided
@@ -1845,8 +1885,8 @@ class Instance(Base):
         to_linode=None,
         region=None,
         instance_type=None,
-        configs=[],
-        disks=[],
+        configs=None,
+        disks=None,
         label=None,
         group=None,
         with_backups=None,
@@ -1902,7 +1942,10 @@ class Instance(Base):
                 'You may only specify one of "to_linode" and "region"'
             )
 
-        if region and not type:
+        configs = [] if configs is None else configs
+        disks = [] if disks is None else disks
+
+        if region and not instance_type:
             raise ValueError('Specifying a region requires a "service" as well')
 
         if not isinstance(configs, list) and not isinstance(

{linode_api4-5.41.0 → linode_api4-5.43.0}/linode_api4/objects/lke.py

@@ -8,6 +8,7 @@ from linode_api4.objects import (
     Base,
     DerivedBase,
     Instance,
+    InstanceDiskEncryptionType,
     JSONObject,
     MappedObject,
     Property,
@@ -422,6 +423,9 @@ class LKECluster(Base):
         ] = None,
         update_strategy: Optional[str] = None,
         label: str = None,
+        disk_encryption: Optional[
+            Union[str, InstanceDiskEncryptionType]
+        ] = None,
         **kwargs,
     ):
         """
@@ -443,6 +447,9 @@ class LKECluster(Base):
         :param update_strategy: The strategy to use when updating this node pool.
                                 NOTE: This field is specific to enterprise clusters.
         :type update_strategy: str
+        :param disk_encryption: Local disk encryption setting for this LKE node pool.
+                                One of 'enabled' or 'disabled'. Defaults to 'disabled'.
+        :type disk_encryption: str or InstanceDiskEncryptionType
         :param kwargs: Any other arguments to pass to the API.  See the API docs
                        for possible values.
 
@@ -459,6 +466,7 @@ class LKECluster(Base):
             "taints": taints,
             "k8s_version": k8s_version,
             "update_strategy": update_strategy,
+            "disk_encryption": disk_encryption,
         }
         params.update(kwargs)
 

{linode_api4-5.41.0 → linode_api4-5.43.0}/linode_api4/objects/monitor.py

@@ -7,11 +7,13 @@ from linode_api4.objects.serializable import JSONObject, StrEnum
 
 __all__ = [
     "AggregateFunction",
-    "Alert",
     "AlertChannel",
     "AlertDefinition",
+    "AlertDefinitionChannel",
+    "AlertDefinitionEntity",
+    "AlertEntities",
+    "AlertScope",
     "AlertType",
-    "Alerts",
     "MonitorDashboard",
     "MonitorMetricsDefinition",
     "MonitorService",
@@ -341,15 +343,15 @@ class RuleCriteria(JSONObject):
 
 
 @dataclass
-class Alert(JSONObject):
+class AlertDefinitionChannel(JSONObject):
     """
-    Represents an alert definition reference within an AlertChannel.
+    Represents the notification channel set up for use with an alert.
 
     Fields:
-      - id: int - Unique identifier of the alert definition.
-      - label: str - Human-readable name for the alert definition.
-      - type: str - Type of the alert (e.g., 'alerts-definitions').
-      - url: str - API URL for the alert definition.
+      - id: int - Unique identifier for this notification channel.
+      - label: str - Human-readable name for the alert channel.
+      - type: str - Type of notification used with the channel. For a user alert definition, only `email` is supported.
+      - url: str - URL for the channel that ends in the channel's id.
     """
 
     id: int = 0
@@ -358,18 +360,6 @@ class Alert(JSONObject):
     url: str = ""
 
 
-@dataclass
-class Alerts(JSONObject):
-    """
-    Represents a collection of alert definitions within an AlertChannel.
-
-    Fields:
-      - items: List[Alert] - List of alert definitions.
-    """
-
-    items: List[Alert] = field(default_factory=list)
-
-
 class AlertType(StrEnum):
     """
     Enumeration of alert origin types used by alert definitions.
@@ -387,6 +377,43 @@ class AlertType(StrEnum):
     user = "user"
 
 
+class AlertScope(StrEnum):
+    """
+    Scope values supported for alert definitions.
+    """
+
+    entity = "entity"
+    region = "region"
+    account = "account"
+
+
+@dataclass
+class AlertEntities(JSONObject):
+    """
+    Represents entity metadata for an alert definition.
+
+    For entity scoped alerts, `entities` envelope contains the URL to list entities,
+    a count, and a has_more_resources flag.
+    For region/account scoped alerts, the `entities` are returned as an empty object.
+    """
+
+    url: str = ""
+    count: int = 0
+    has_more_resources: bool = False
+
+
+@dataclass
+class AlertDefinitionEntity(JSONObject):
+    """
+    Represents an entity associated with an alert definition.
+    """
+
+    id: str = ""
+    label: str = ""
+    url: str = ""
+    _type: str = field(default="", metadata={"json_key": "type"})
+
+
 class AlertDefinition(DerivedBase):
     """
     Represents an alert definition for a monitor service.
@@ -406,12 +433,12 @@ class AlertDefinition(DerivedBase):
         "severity": Property(mutable=True),
         "type": Property(mutable=True),
         "status": Property(mutable=True),
-        "has_more_resources": Property(mutable=True),
+        "has_more_resources": Property(),  # Deprecated; use entities.has_more_resources.
         "rule_criteria": Property(mutable=True, json_object=RuleCriteria),
         "trigger_conditions": Property(
             mutable=True, json_object=TriggerConditions
         ),
-        "alert_channels": Property(mutable=True, json_object=Alerts),
+        "alert_channels": Property(json_object=AlertDefinitionChannel),
         "created": Property(is_datetime=True),
         "updated": Property(is_datetime=True),
         "updated_by": Property(),
@@ -419,28 +446,12 @@ class AlertDefinition(DerivedBase):
         "entity_ids": Property(mutable=True),
         "description": Property(mutable=True),
         "service_class": Property(alias_of="class"),
+        "scope": Property(AlertScope),
+        "regions": Property(mutable=True),
+        "entities": Property(json_object=AlertEntities),
     }
 
 
-@dataclass
-class EmailChannelContent(JSONObject):
-    """
-    Represents the content for an email alert channel.
-    """
-
-    email_addresses: Optional[List[str]] = None
-
-
-@dataclass
-class ChannelContent(JSONObject):
-    """
-    Represents the content block for an AlertChannel, which varies by channel type.
-    """
-
-    email: Optional[EmailChannelContent] = None
-    # Other channel types like 'webhook', 'slack' could be added here as Optional fields.
-
-
 @dataclass
 class EmailDetails(JSONObject):
     """
@@ -481,7 +492,7 @@ class AlertChannel(Base):
     fire. Alert channels define a destination and configuration for
     notifications (for example: email lists, webhooks, PagerDuty, Slack, etc.).
 
-    API Documentation: https://techdocs.akamai.com/linode-api/reference/get-alert-channels
+    API Documentation: https://techdocs.akamai.com/linode-api/reference/get-notification-channels
 
     This class maps to the Monitor API's `/monitor/alert-channels` resource
     and is used by the SDK to list, load, and inspect channels.
@@ -499,7 +510,6 @@ class AlertChannel(Base):
         "channel_type": Property(),
         "details": Property(mutable=False, json_object=ChannelDetails),
         "alerts": Property(mutable=False, json_object=AlertInfo),
-        "content": Property(mutable=False, json_object=ChannelContent),
         "created": Property(is_datetime=True),
         "updated": Property(is_datetime=True),
         "created_by": Property(),

{linode_api4-5.41.0 → linode_api4-5.43.0}/linode_api4/util.py

@@ -3,7 +3,7 @@ Contains various utility functions.
 """
 
 import string
-from typing import Any, Dict
+from typing import Any, Dict, List, Tuple, Union
 
 
 def drop_null_keys(data: Dict[Any, Any], recursive=True) -> Dict[Any, Any]:
@@ -30,6 +30,13 @@ def drop_null_keys(data: Dict[Any, Any], recursive=True) -> Dict[Any, Any]:
     return recursive_helper(data)
 
 
+def normalize_as_list(value: Any) -> Union[List, Tuple]:
+    """
+    Returns the value wrapped in a list if it isn't already a list or tuple.
+    """
+    return value if isinstance(value, (list, tuple)) else [value]
+
+
 def generate_device_suffixes(n: int) -> list[str]:
     """
     Generate n alphabetical suffixes starting with a, b, c, etc.

{linode_api4-5.41.0 → linode_api4-5.43.0}/linode_api4/version.py

@@ -2,4 +2,4 @@
 The version of this linode_api4 package.
 """
 
-__version__ = "v5.41.0"
+__version__ = "v5.43.0"

{linode_api4-5.41.0 → linode_api4-5.43.0/linode_api4.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: linode_api4
-Version: 5.41.0
+Version: 5.43.0
 Summary: The official Python SDK for Linode API v4
 Author-email: Linode <devs@linode.com>
 License: BSD-3-Clause
@@ -14,11 +14,12 @@ Classifier: Topic :: Software Development :: Libraries
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Python: >=3.9
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.10
 Description-Content-Type: text/x-rst
 License-File: LICENSE
 Requires-Dist: requests

{linode_api4-5.41.0 → linode_api4-5.43.0}/linode_api4.egg-info/SOURCES.txt

@@ -188,6 +188,7 @@ test/fixtures/longview_plan.json
 test/fixtures/longview_subscriptions.json
 test/fixtures/maintenance_policies.json
 test/fixtures/mongodb.json
+test/fixtures/monitor_alert-channels.json
 test/fixtures/monitor_alert-definitions.json
 test/fixtures/monitor_dashboards.json
 test/fixtures/monitor_dashboards_1.json
@@ -195,6 +196,7 @@ test/fixtures/monitor_services.json
 test/fixtures/monitor_services_dbaas.json
 test/fixtures/monitor_services_dbaas_alert-definitions.json
 test/fixtures/monitor_services_dbaas_alert-definitions_12345.json
+test/fixtures/monitor_services_dbaas_alert-definitions_12345_entities.json
 test/fixtures/monitor_services_dbaas_dashboards.json
 test/fixtures/monitor_services_dbaas_metric-definitions.json
 test/fixtures/monitor_services_dbaas_metrics.json

{linode_api4-5.41.0 → linode_api4-5.43.0}/pyproject.toml

@@ -8,7 +8,7 @@ name = "linode_api4"
 authors = [{ name = "Linode", email = "devs@linode.com" }]
 description = "The official Python SDK for Linode API v4"
 readme = "README.rst"
-requires-python = ">=3.9"
+requires-python = ">=3.10"
 keywords = [
     "akamai",
     "Akamai Connected Cloud",
@@ -25,10 +25,11 @@ classifiers = [
     "License :: OSI Approved :: BSD License",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
 ]
 dependencies = ["requests", "polling", "deprecated"]
 dynamic = ["version"]
@@ -78,7 +79,7 @@ line_length = 80
 
 [tool.black]
 line-length = 80
-target-version = ["py38", "py39", "py310", "py311", "py312"]
+target-version = ["py310", "py311", "py312", "py313", "py314"]
 
 [tool.autoflake]
 expand-star-imports = true