linode-api4 5.26.0__tar.gz → 5.28.0__tar.gz

{linode_api4-5.26.0/linode_api4.egg-info → linode_api4-5.28.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: linode_api4
-Version: 5.26.0
+Version: 5.28.0
 Summary: The official Python SDK for Linode API v4
 Author-email: Linode <devs@linode.com>
 License: BSD-3-Clause
@@ -198,16 +198,16 @@ Running the tests
 ^^^^^^^^^^^^^^^^^
 Run the tests locally using the make command. Run the entire test suite using command below::
 
-    make testint
+    make test-int
 
 To run a specific package/suite, use the environment variable `TEST_SUITE` using directory names in `integration/...` folder ::
 
-    make TEST_SUITE="account" testint          // Runs tests in `integration/models/account` directory
-    make TEST_SUITE="linode_client" testint    // Runs tests in `integration/linode_client` directory
+    make TEST_SUITE="account" test-int          // Runs tests in `integration/models/account` directory
+    make TEST_SUITE="linode_client" test-int    // Runs tests in `integration/linode_client` directory
 
-Lastly to run a specific test case use environment variable `TEST_CASE` with `testint` command::
+Lastly to run a specific test case use environment variable `TEST_CASE` with `test-int` command::
 
-    make TEST_CASE=test_get_domain_record testint
+    make TEST_CASE=test_get_domain_record test-int
 
 Documentation
 -------------

{linode_api4-5.26.0 → linode_api4-5.28.0}/README.rst

@@ -148,16 +148,16 @@ Running the tests
 ^^^^^^^^^^^^^^^^^
 Run the tests locally using the make command. Run the entire test suite using command below::
 
-    make testint
+    make test-int
 
 To run a specific package/suite, use the environment variable `TEST_SUITE` using directory names in `integration/...` folder ::
 
-    make TEST_SUITE="account" testint          // Runs tests in `integration/models/account` directory
-    make TEST_SUITE="linode_client" testint    // Runs tests in `integration/linode_client` directory
+    make TEST_SUITE="account" test-int          // Runs tests in `integration/models/account` directory
+    make TEST_SUITE="linode_client" test-int    // Runs tests in `integration/linode_client` directory
 
-Lastly to run a specific test case use environment variable `TEST_CASE` with `testint` command::
+Lastly to run a specific test case use environment variable `TEST_CASE` with `test-int` command::
 
-    make TEST_CASE=test_get_domain_record testint
+    make TEST_CASE=test_get_domain_record test-int
 
 Documentation
 -------------

{linode_api4-5.26.0 → linode_api4-5.28.0}/linode_api4/groups/account.py

@@ -101,7 +101,7 @@ class AccountGroup(Group):
         s = AccountSettings(self.client, result["managed"], result)
         return s
 
-    def invoices(self):
+    def invoices(self, *filters):
         """
         Returns Invoices issued to this account.
 
@@ -112,9 +112,9 @@ class AccountGroup(Group):
         :returns: Invoices issued to this account.
         :rtype: PaginatedList of Invoice
         """
-        return self.client._get_and_filter(Invoice)
+        return self.client._get_and_filter(Invoice, *filters)
 
-    def payments(self):
+    def payments(self, *filters):
         """
         Returns a list of Payments made on this account.
 
@@ -123,7 +123,7 @@ class AccountGroup(Group):
         :returns: A list of payments made on this account.
         :rtype: PaginatedList of Payment
         """
-        return self.client._get_and_filter(Payment)
+        return self.client._get_and_filter(Payment, *filters)
 
     def oauth_clients(self, *filters):
         """
@@ -337,7 +337,7 @@ class AccountGroup(Group):
                 json=resp,
             )
 
-    def service_transfers(self):
+    def service_transfers(self, *filters):
         """
         Returns a collection of all created and accepted Service Transfers for this account, regardless of the user that created or accepted the transfer.
 
@@ -347,7 +347,7 @@ class AccountGroup(Group):
         :rtype: PaginatedList of ServiceTransfer
         """
 
-        return self.client._get_and_filter(ServiceTransfer)
+        return self.client._get_and_filter(ServiceTransfer, *filters)
 
     def service_transfer_create(self, entities):
         """

{linode_api4-5.26.0 → linode_api4-5.28.0}/linode_api4/groups/database.py

@@ -1,13 +1,14 @@
 from linode_api4.errors import UnexpectedResponseError
 from linode_api4.groups import Group
 from linode_api4.objects import (
-    Base,
     Database,
     DatabaseEngine,
     DatabaseType,
     MySQLDatabase,
     PostgreSQLDatabase,
+    drop_null_keys,
 )
+from linode_api4.objects.base import _flatten_request_body_recursive
 
 
 class DatabaseGroup(Group):
@@ -126,13 +127,71 @@ class DatabaseGroup(Group):
 
         params = {
             "label": label,
-            "region": region.id if issubclass(type(region), Base) else region,
-            "engine": engine.id if issubclass(type(engine), Base) else engine,
-            "type": ltype.id if issubclass(type(ltype), Base) else ltype,
+            "region": region,
+            "engine": engine,
+            "type": ltype,
         }
         params.update(kwargs)
 
-        result = self.client.post("/databases/mysql/instances", data=params)
+        result = self.client.post(
+            "/databases/mysql/instances",
+            data=_flatten_request_body_recursive(drop_null_keys(params)),
+        )
+
+        if "id" not in result:
+            raise UnexpectedResponseError(
+                "Unexpected response when creating MySQL Database", json=result
+            )
+
+        d = MySQLDatabase(self.client, result["id"], result)
+        return d
+
+    def mysql_fork(self, source, restore_time, **kwargs):
+        """
+        Forks an :any:`MySQLDatabase` on this account with
+        the given restore_time. label, region, engine, and ltype are optional.
+        For example::
+
+           client = LinodeClient(TOKEN)
+
+           db_to_fork = client.database.mysql_instances()[0]
+
+           new_fork = client.database.mysql_fork(
+                db_to_fork.id,
+                db_to_fork.updated,
+                label="new-fresh-label"
+           )
+
+        API Documentation: https://techdocs.akamai.com/linode-api/reference/post-databases-mysql-instances
+
+        :param source: The id of the source database
+        :type source: int
+        :param restore_time: The timestamp for the fork
+        :type restore_time: datetime
+        :param label: The name for this cluster
+        :type label: str
+        :param region: The region to deploy this cluster in
+        :type region: str | Region
+        :param engine: The engine to deploy this cluster with
+        :type engine: str | Engine
+        :param ltype: The Linode Type to use for this cluster
+        :type ltype: str | Type
+        """
+
+        params = {
+            "fork": {
+                "source": source,
+                "restore_time": restore_time.strftime("%Y-%m-%dT%H:%M:%S"),
+            }
+        }
+        if "ltype" in kwargs:
+            params["type"] = kwargs["ltype"]
+        params.update(kwargs)
+
+        result = self.client.post(
+            "/databases/mysql/instances",
+            data=_flatten_request_body_recursive(drop_null_keys(params)),
+        )
 
         if "id" not in result:
             raise UnexpectedResponseError(
@@ -191,14 +250,71 @@ class DatabaseGroup(Group):
 
         params = {
             "label": label,
-            "region": region.id if issubclass(type(region), Base) else region,
-            "engine": engine.id if issubclass(type(engine), Base) else engine,
-            "type": ltype.id if issubclass(type(ltype), Base) else ltype,
+            "region": region,
+            "engine": engine,
+            "type": ltype,
+        }
+        params.update(kwargs)
+
+        result = self.client.post(
+            "/databases/postgresql/instances",
+            data=_flatten_request_body_recursive(drop_null_keys(params)),
+        )
+
+        if "id" not in result:
+            raise UnexpectedResponseError(
+                "Unexpected response when creating PostgreSQL Database",
+                json=result,
+            )
+
+        d = PostgreSQLDatabase(self.client, result["id"], result)
+        return d
+
+    def postgresql_fork(self, source, restore_time, **kwargs):
+        """
+        Forks an :any:`PostgreSQLDatabase` on this account with
+        the given restore_time. label, region, engine, and ltype are optional.
+        For example::
+
+           client = LinodeClient(TOKEN)
+
+           db_to_fork = client.database.postgresql_instances()[0]
+
+           new_fork = client.database.postgresql_fork(
+                db_to_fork.id,
+                db_to_fork.updated,
+                label="new-fresh-label"
+           )
+
+        API Documentation: https://techdocs.akamai.com/linode-api/reference/post-databases-postgresql-instances
+
+        :param source: The id of the source database
+        :type source: int
+        :param restore_time: The timestamp for the fork
+        :type restore_time: datetime
+        :param label: The name for this cluster
+        :type label: str
+        :param region: The region to deploy this cluster in
+        :type region: str | Region
+        :param engine: The engine to deploy this cluster with
+        :type engine: str | Engine
+        :param ltype: The Linode Type to use for this cluster
+        :type ltype: str | Type
+        """
+
+        params = {
+            "fork": {
+                "source": source,
+                "restore_time": restore_time.strftime("%Y-%m-%dT%H:%M:%S"),
+            }
         }
+        if "ltype" in kwargs:
+            params["type"] = kwargs["ltype"]
         params.update(kwargs)
 
         result = self.client.post(
-            "/databases/postgresql/instances", data=params
+            "/databases/postgresql/instances",
+            data=_flatten_request_body_recursive(drop_null_keys(params)),
         )
 
         if "id" not in result:

{linode_api4-5.26.0 → linode_api4-5.28.0}/linode_api4/groups/lke.py

@@ -66,6 +66,7 @@ class LKEGroup(Group):
         control_plane: Union[
             LKEClusterControlPlaneOptions, Dict[str, Any]
         ] = None,
+        apl_enabled: bool = False,
         **kwargs,
     ):
         """
@@ -100,8 +101,12 @@ class LKEGroup(Group):
                           formatted dicts.
         :param kube_version: The version of Kubernetes to use
         :type kube_version: KubeVersion or str
-        :param control_plane: Dict[str, Any] or LKEClusterControlPlaneRequest
-        :type control_plane: The control plane configuration of this LKE cluster.
+        :param control_plane: The control plane configuration of this LKE cluster.
+        :type control_plane: Dict[str, Any] or LKEClusterControlPlaneRequest
+        :param apl_enabled: Whether this cluster should use APL.
+                            NOTE: This endpoint is in beta and may only
+                            function if base_url is set to `https://api.linode.com/v4beta`.
+        :type apl_enabled: bool
         :param kwargs: Any other arguments to pass along to the API.  See the API
                        docs for possible values.
 
@@ -120,9 +125,13 @@ class LKEGroup(Group):
         }
         params.update(kwargs)
 
+        # Prevent errors for users without access to APL
+        if apl_enabled:
+            params["apl_enabled"] = apl_enabled
+
         result = self.client.post(
             "/lke/clusters",
-            data=_flatten_request_body_recursive(drop_null_keys(params)),
+            data=drop_null_keys(_flatten_request_body_recursive(params)),
         )
 
         if "id" not in result:

{linode_api4-5.26.0 → linode_api4-5.28.0}/linode_api4/groups/networking.py

@@ -367,3 +367,30 @@ class NetworkingGroup(Group):
         return self.client._get_and_filter(
             NetworkTransferPrice, *filters, endpoint="/network-transfer/prices"
         )
+
+    def delete_vlan(self, vlan, region):
+        """
+        This operation deletes a VLAN.
+        You can't delete a VLAN if it's still attached to a Linode.
+
+        API Documentation: https://techdocs.akamai.com/linode-api/reference/delete-vlan
+
+        :param vlan: The label of the VLAN to be deleted.
+        :type vlan: str or VLAN
+        :param region: The VLAN's region.
+        :type region: str or Region
+        """
+        if isinstance(region, Region):
+            region = region.id
+
+        if isinstance(vlan, VLAN):
+            vlan = vlan.label
+        resp = self.client.delete(
+            "/networking/vlans/{}/{}".format(region, vlan),
+            model=self,
+        )
+
+        if "error" in resp:
+            return False
+
+        return True

{linode_api4-5.26.0 → linode_api4-5.28.0}/linode_api4/groups/object_storage.py

@@ -5,6 +5,11 @@ from urllib import parse
 
 from deprecated import deprecated
 
+from linode_api4 import (
+    ObjectStorageEndpoint,
+    ObjectStorageEndpointType,
+    PaginatedList,
+)
 from linode_api4.errors import UnexpectedResponseError
 from linode_api4.groups import Group
 from linode_api4.objects import (
@@ -272,6 +277,30 @@ class ObjectStorageGroup(Group):
 
         return MappedObject(**result)
 
+    def endpoints(self, *filters) -> PaginatedList:
+        """
+        Returns a paginated list of all Object Storage endpoints available in your account.
+
+        This is intended to be called from the :any:`LinodeClient`
+        class, like this::
+
+           endpoints = client.object_storage.endpoints()
+
+        API Documentation: https://techdocs.akamai.com/linode-api/reference/get-object-storage-endpoints
+
+        :param filters: Any number of filters to apply to this query.
+                        See :doc:`Filtering Collections</linode_api4/objects/filtering>`
+                        for more details on filtering.
+
+        :returns: A list of Object Storage Endpoints that matched the query.
+        :rtype: PaginatedList of ObjectStorageEndpoint
+        """
+        return self.client._get_and_filter(
+            ObjectStorageEndpoint,
+            *filters,
+            endpoint="/object-storage/endpoints",
+        )
+
     def buckets(self, *filters):
         """
         Returns a paginated list of all Object Storage Buckets that you own.
@@ -299,6 +328,8 @@ class ObjectStorageGroup(Group):
         label: str,
         acl: ObjectStorageACL = ObjectStorageACL.PRIVATE,
         cors_enabled=False,
+        s3_endpoint: Optional[str] = None,
+        endpoint_type: Optional[ObjectStorageEndpointType] = None,
     ):
         """
         Creates an Object Storage Bucket in the specified cluster. Accounts with
@@ -320,6 +351,13 @@ class ObjectStorageGroup(Group):
                         should be created.
         :type cluster: str
 
+        :param endpoint_type: The type of s3_endpoint available to the active user in this region.
+        :type endpoint_type: str
+                   Enum: E0,E1,E2,E3
+
+        :param s3_endpoint: The active user's s3 endpoint URL, based on the endpoint_type and region.
+        :type s3_endpoint: str
+
         :param cors_enabled: If true, the bucket will be created with CORS enabled for
                              all origins. For more fine-grained controls of CORS, use
                              the S3 API directly.
@@ -346,6 +384,8 @@ class ObjectStorageGroup(Group):
             "label": label,
             "acl": acl,
             "cors_enabled": cors_enabled,
+            "s3_endpoint": s3_endpoint,
+            "endpoint_type": endpoint_type,
         }
 
         if self.is_cluster(cluster_or_region_id):

{linode_api4-5.26.0 → linode_api4-5.28.0}/linode_api4/objects/database.py

@@ -1,3 +1,5 @@
+from deprecated import deprecated
+
 from linode_api4.objects import Base, DerivedBase, MappedObject, Property
 
 
@@ -63,6 +65,9 @@ class DatabaseEngine(Base):
         Base.invalidate(self)
 
 
+@deprecated(
+    reason="Backups are not supported for non-legacy database clusters."
+)
 class DatabaseBackup(DerivedBase):
     """
     A generic Managed Database backup.
@@ -97,6 +102,9 @@ class DatabaseBackup(DerivedBase):
         )
 
 
+@deprecated(
+    reason="Backups are not supported for non-legacy database clusters."
+)
 class MySQLDatabaseBackup(DatabaseBackup):
     """
     A backup for an accessible Managed MySQL Database.
@@ -107,6 +115,9 @@ class MySQLDatabaseBackup(DatabaseBackup):
     api_endpoint = "/databases/mysql/instances/{database_id}/backups/{id}"
 
 
+@deprecated(
+    reason="Backups are not supported for non-legacy database clusters."
+)
 class PostgreSQLDatabaseBackup(DatabaseBackup):
     """
     A backup for an accessible Managed PostgreSQL Database.
@@ -131,7 +142,7 @@ class MySQLDatabase(Base):
         "label": Property(mutable=True),
         "allow_list": Property(mutable=True, unordered=True),
         "backups": Property(derived_class=MySQLDatabaseBackup),
-        "cluster_size": Property(),
+        "cluster_size": Property(mutable=True),
         "created": Property(is_datetime=True),
         "encrypted": Property(),
         "engine": Property(),
@@ -141,7 +152,9 @@ class MySQLDatabase(Base):
         "replication_type": Property(),
         "ssl_connection": Property(),
         "status": Property(volatile=True),
-        "type": Property(),
+        "type": Property(mutable=True),
+        "fork": Property(),
+        "oldest_restore_time": Property(is_datetime=True),
         "updated": Property(volatile=True, is_datetime=True),
         "updates": Property(mutable=True),
         "version": Property(),
@@ -219,6 +232,9 @@ class MySQLDatabase(Base):
             "{}/patch".format(MySQLDatabase.api_endpoint), model=self
         )
 
+    @deprecated(
+        reason="Backups are not supported for non-legacy database clusters."
+    )
     def backup_create(self, label, **kwargs):
         """
         Creates a snapshot backup of a Managed MySQL Database.
@@ -264,7 +280,7 @@ class PostgreSQLDatabase(Base):
         "label": Property(mutable=True),
         "allow_list": Property(mutable=True, unordered=True),
         "backups": Property(derived_class=PostgreSQLDatabaseBackup),
-        "cluster_size": Property(),
+        "cluster_size": Property(mutable=True),
         "created": Property(is_datetime=True),
         "encrypted": Property(),
         "engine": Property(),
@@ -275,7 +291,9 @@ class PostgreSQLDatabase(Base):
         "replication_type": Property(),
         "ssl_connection": Property(),
         "status": Property(volatile=True),
-        "type": Property(),
+        "type": Property(mutable=True),
+        "fork": Property(),
+        "oldest_restore_time": Property(is_datetime=True),
         "updated": Property(volatile=True, is_datetime=True),
         "updates": Property(mutable=True),
         "version": Property(),
@@ -354,6 +372,9 @@ class PostgreSQLDatabase(Base):
             "{}/patch".format(PostgreSQLDatabase.api_endpoint), model=self
         )
 
+    @deprecated(
+        reason="Backups are not supported for non-legacy database clusters."
+    )
     def backup_create(self, label, **kwargs):
         """
         Creates a snapshot backup of a Managed PostgreSQL Database.
@@ -414,6 +435,7 @@ class Database(Base):
         "region": Property(),
         "status": Property(),
         "type": Property(),
+        "fork": Property(),
         "updated": Property(),
         "updates": Property(),
         "version": Property(),

{linode_api4-5.26.0 → linode_api4-5.28.0}/linode_api4/objects/linode.py

@@ -269,6 +269,7 @@ class Type(Base):
         "vcpus": Property(),
         "gpus": Property(),
         "successor": Property(),
+        "accelerated_devices": Property(),
         # type_class is populated from the 'class' attribute of the returned JSON
     }
 
@@ -1638,6 +1639,22 @@ class Instance(Base):
             for firewall in result["data"]
         ]
 
+    def apply_firewalls(self):
+        """
+        Reapply assigned firewalls to a Linode in case they were not applied successfully.
+
+        API Documentation: https://techdocs.akamai.com/linode-api/reference/post-apply-firewalls
+
+        :returns: Returns True if the operation was successful
+        :rtype: bool
+        """
+
+        self._client.post(
+            "{}/firewalls/apply".format(Instance.api_endpoint), model=self
+        )
+
+        return True
+
     def nodebalancers(self):
         """
         View a list of NodeBalancers that are assigned to this Linode and readable by the requesting User.
@@ -1919,7 +1936,7 @@ class StackScript(Base):
 def _expand_placement_group_assignment(
     pg: Union[
         InstancePlacementGroupAssignment, "PlacementGroup", Dict[str, Any], int
-    ]
+    ],
 ) -> Optional[Dict[str, Any]]:
     """
     Expands the placement group argument into a dict for use in an API request body.

{linode_api4-5.26.0 → linode_api4-5.28.0}/linode_api4/objects/lke.py

@@ -14,6 +14,7 @@ from linode_api4.objects import (
     Region,
     Type,
 )
+from linode_api4.util import drop_null_keys
 
 
 class LKEType(Base):
@@ -79,8 +80,6 @@ class LKEClusterControlPlaneACLOptions(JSONObject):
     """
     LKEClusterControlPlaneACLOptions is used to set
     the ACL configuration of an LKE cluster's control plane.
-
-    NOTE: Control Plane ACLs may not currently be available to all users.
     """
 
     enabled: Optional[bool] = None
@@ -116,8 +115,6 @@ class LKEClusterControlPlaneACL(JSONObject):
     """
     LKEClusterControlPlaneACL describes the ACL configuration of an LKE cluster's
     control plane.
-
-    NOTE: Control Plane ACLs may not currently be available to all users.
     """
 
     include_none_values = True
@@ -257,6 +254,7 @@ class LKECluster(Base):
         "k8s_version": Property(slug_relationship=KubeVersion, mutable=True),
         "pools": Property(derived_class=LKENodePool),
         "control_plane": Property(mutable=True),
+        "apl_enabled": Property(),
     }
 
     def invalidate(self):
@@ -336,8 +334,6 @@ class LKECluster(Base):
         """
         Gets the ACL configuration of this cluster's control plane.
 
-        NOTE: Control Plane ACLs may not currently be available to all users.
-
         API Documentation: https://techdocs.akamai.com/linode-api/reference/get-lke-cluster-acl
 
         :returns: The cluster's control plane ACL configuration.
@@ -353,6 +349,36 @@ class LKECluster(Base):
 
         return LKEClusterControlPlaneACL.from_json(self._control_plane_acl)
 
+    @property
+    def apl_console_url(self) -> Optional[str]:
+        """
+        Returns the URL of this cluster's APL installation if this cluster
+        is APL-enabled, else None.
+
+        :returns: The URL of the APL console for this cluster.
+        :rtype: str or None
+        """
+
+        if not self.apl_enabled:
+            return None
+
+        return f"https://console.lke{self.id}.akamai-apl.net"
+
+    @property
+    def apl_health_check_url(self) -> Optional[str]:
+        """
+        Returns the URL of this cluster's APL health check endpoint if this cluster
+        is APL-enabled, else None.
+
+        :returns: The URL of the APL console for this cluster.
+        :rtype: str or None
+        """
+
+        if not self.apl_enabled:
+            return None
+
+        return f"https://auth.lke{self.id}.akamai-apl.net/ready"
+
     def node_pool_create(
         self,
         node_type: Union[Type, str],
@@ -527,8 +553,6 @@ class LKECluster(Base):
         """
         Updates the ACL configuration for this cluster's control plane.
 
-        NOTE: Control Plane ACLs may not currently be available to all users.
-
         API Documentation: https://techdocs.akamai.com/linode-api/reference/put-lke-cluster-acl
 
         :param acl: The ACL configuration to apply to this cluster.
@@ -543,7 +567,7 @@ class LKECluster(Base):
         result = self._client.put(
             f"{LKECluster.api_endpoint}/control_plane_acl",
             model=self,
-            data={"acl": acl},
+            data={"acl": drop_null_keys(acl)},
         )
 
         acl = result.get("acl")
@@ -558,8 +582,6 @@ class LKECluster(Base):
         This has the same effect as calling control_plane_acl_update with the `enabled` field
         set to False. Access controls are disabled and all rules are deleted.
 
-        NOTE: Control Plane ACLs may not currently be available to all users.
-
         API Documentation: https://techdocs.akamai.com/linode-api/reference/delete-lke-cluster-acl
         """
         self._client.delete(

{linode_api4-5.26.0 → linode_api4-5.28.0}/linode_api4/objects/networking.py

@@ -112,6 +112,20 @@ class IPAddress(Base):
 
         return {"address": self.address, "linode_id": linode.id}
 
+    def delete(self):
+        """
+        Override the delete() function from Base to use the correct endpoint.
+        """
+        resp = self._client.delete(
+            "/linode/instances/{}/ips/{}".format(self.linode_id, self.address),
+            model=self,
+        )
+
+        if "error" in resp:
+            return False
+        self.invalidate()
+        return True
+
 
 @dataclass
 class VPCIPAddress(JSONObject):