devopness 2.6.5__tar.gz → 2.7.0__tar.gz

{devopness-2.6.5 → devopness-2.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: devopness
-Version: 2.6.5
+Version: 2.7.0
 Summary: Devopness API Python SDK - Painless essential DevOps to everyone
 License-Expression: Apache-2.0
 Keywords: API Client,Cloud Engineering,Cloud Infrastructure,Cloud Platform,Cloud Resource Management,Configuration Management,Deployment Automation,Devopness,DevOps,Infrastructure as Code,Platform Engineering,Python SDK,Server Management,Server Provisioning,Zero Downtime Deployment

{devopness-2.6.5 → devopness-2.7.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [project]
 name = "devopness"
-version = "2.6.5"
+version = "2.7.0"
 description = "Devopness API Python SDK - Painless essential DevOps to everyone"
 license = "Apache-2.0"
 readme = "README.md"
@@ -68,7 +68,7 @@ exclude = ["src/devopness/generated/.openapi-generator-ignore"]
 
 [tool.poetry.group.dev.dependencies]
 openapi-generator-cli = { version = "7.24.0", markers = "python_version < '4.0'" }
-ruff = "^0.16.0"
+ruff = "^0.16.2"
 mypy = "^2.3.0"
 
 [tool.ruff]
@@ -107,6 +107,7 @@ ignore = [
 "src/devopness/generated/**/*" = [
   "line-too-long",                 # Line too long
   "non-pep604-annotation-union",   # Use `X | Y` for type annotations (auto-generated code uses Union)
+  "builtin-argument-shadowing",    # Shadowing builtin argument
 ]
 "src/devopness/generated/**/__init__.py" = [
   "unused-import", # Module imported but unused

{devopness-2.6.5 → devopness-2.7.0}/src/devopness/generated/api/actions_api.py

@@ -6,8 +6,16 @@ Note:
     https://openapi-generator.tech
 """
 
+from typing import Union
+
 from .. import DevopnessBaseService, DevopnessBaseServiceAsync, DevopnessResponse
-from ..models import Action, ActionRelation, ActionRetryResponse
+from ..models import (
+    Action,
+    ActionRelation,
+    ActionRetryResponse,
+    ListActionsFilterParameter,
+    ListActionsFilterParameterPlain,
+)
 from ..utils import parse_query_string
 
 
@@ -23,6 +31,9 @@ class ActionsApiService(DevopnessBaseService):
         """
         Get an action by ID
 
+        Attributes:
+            action_id (int): The ID of the action.
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -41,10 +52,17 @@ class ActionsApiService(DevopnessBaseService):
         self,
         page: int | None = None,
         per_page: int | None = None,
+        filter: Union[ListActionsFilterParameter, ListActionsFilterParameterPlain]
+        | None = None,
     ) -> DevopnessResponse[list[ActionRelation]]:
         """
         Return a list of all actions belonging to current user
 
+        Attributes:
+            page (Optional[int]): Number of the page to be retrieved
+            per_page (Optional[int]): Number of items returned per page
+            filter (Optional[Union[ListActionsFilterParameter, ListActionsFilterParameterPlain,]]): Filter the results using the available fields. Multiple filters can be combined.  Example: `?filter[resource_type]=application&filter[status]=active`
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -54,12 +72,13 @@ class ActionsApiService(DevopnessBaseService):
             {
                 "page": page,
                 "per_page": per_page,
+                "filter": filter,
             }
         )
 
         endpoint_parts = [
             "/actions",
-            f"?{query_string}",
+            f"?{query_string}" if query_string else "",
         ]
 
         endpoint: str = "".join(endpoint_parts)
@@ -77,6 +96,12 @@ class ActionsApiService(DevopnessBaseService):
         """
         List resource actions of an action type
 
+        Attributes:
+            resource_id (int): The resource ID.
+            resource_type (str): The resource type to get related actions.
+            page (Optional[int]): Number of the page to be retrieved
+            per_page (Optional[int]): Number of items returned per page
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -91,7 +116,7 @@ class ActionsApiService(DevopnessBaseService):
 
         endpoint_parts = [
             f"/actions/{resource_type}/{resource_id}",
-            f"?{query_string}",
+            f"?{query_string}" if query_string else "",
         ]
 
         endpoint: str = "".join(endpoint_parts)
@@ -109,6 +134,12 @@ class ActionsApiService(DevopnessBaseService):
         """
         List actions triggered to a given action target resource
 
+        Attributes:
+            target_resource_id (int): The resource ID of the action target.
+            target_resource_type (str): The resource type of the action target on which this action will be executed to perform operations on the action resource.
+            page (Optional[int]): Number of the page to be retrieved
+            per_page (Optional[int]): Number of items returned per page
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -123,7 +154,7 @@ class ActionsApiService(DevopnessBaseService):
 
         endpoint_parts = [
             f"/actions/targets/{target_resource_type}/{target_resource_id}",
-            f"?{query_string}",
+            f"?{query_string}" if query_string else "",
         ]
 
         endpoint: str = "".join(endpoint_parts)
@@ -138,6 +169,9 @@ class ActionsApiService(DevopnessBaseService):
         """
         Retry an action
 
+        Attributes:
+            action_id (int): The ID of the action.
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -165,6 +199,9 @@ class ActionsApiServiceAsync(DevopnessBaseServiceAsync):
         """
         Get an action by ID
 
+        Attributes:
+            action_id (int): The ID of the action.
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -183,10 +220,17 @@ class ActionsApiServiceAsync(DevopnessBaseServiceAsync):
         self,
         page: int | None = None,
         per_page: int | None = None,
+        filter: Union[ListActionsFilterParameter, ListActionsFilterParameterPlain]
+        | None = None,
     ) -> DevopnessResponse[list[ActionRelation]]:
         """
         Return a list of all actions belonging to current user
 
+        Attributes:
+            page (Optional[int]): Number of the page to be retrieved
+            per_page (Optional[int]): Number of items returned per page
+            filter (Optional[Union[ListActionsFilterParameter, ListActionsFilterParameterPlain,]]): Filter the results using the available fields. Multiple filters can be combined.  Example: `?filter[resource_type]=application&filter[status]=active`
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -196,12 +240,13 @@ class ActionsApiServiceAsync(DevopnessBaseServiceAsync):
             {
                 "page": page,
                 "per_page": per_page,
+                "filter": filter,
             }
         )
 
         endpoint_parts = [
             "/actions",
-            f"?{query_string}",
+            f"?{query_string}" if query_string else "",
         ]
 
         endpoint: str = "".join(endpoint_parts)
@@ -219,6 +264,12 @@ class ActionsApiServiceAsync(DevopnessBaseServiceAsync):
         """
         List resource actions of an action type
 
+        Attributes:
+            resource_id (int): The resource ID.
+            resource_type (str): The resource type to get related actions.
+            page (Optional[int]): Number of the page to be retrieved
+            per_page (Optional[int]): Number of items returned per page
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -233,7 +284,7 @@ class ActionsApiServiceAsync(DevopnessBaseServiceAsync):
 
         endpoint_parts = [
             f"/actions/{resource_type}/{resource_id}",
-            f"?{query_string}",
+            f"?{query_string}" if query_string else "",
         ]
 
         endpoint: str = "".join(endpoint_parts)
@@ -251,6 +302,12 @@ class ActionsApiServiceAsync(DevopnessBaseServiceAsync):
         """
         List actions triggered to a given action target resource
 
+        Attributes:
+            target_resource_id (int): The resource ID of the action target.
+            target_resource_type (str): The resource type of the action target on which this action will be executed to perform operations on the action resource.
+            page (Optional[int]): Number of the page to be retrieved
+            per_page (Optional[int]): Number of items returned per page
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -265,7 +322,7 @@ class ActionsApiServiceAsync(DevopnessBaseServiceAsync):
 
         endpoint_parts = [
             f"/actions/targets/{target_resource_type}/{target_resource_id}",
-            f"?{query_string}",
+            f"?{query_string}" if query_string else "",
         ]
 
         endpoint: str = "".join(endpoint_parts)
@@ -280,6 +337,9 @@ class ActionsApiServiceAsync(DevopnessBaseServiceAsync):
         """
         Retry an action
 
+        Attributes:
+            action_id (int): The ID of the action.
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.

{devopness-2.6.5 → devopness-2.7.0}/src/devopness/generated/api/actions_logs_api.py

@@ -24,6 +24,11 @@ class ActionsLogsApiService(DevopnessBaseService):
         """
         Get action target step log
 
+        Attributes:
+            action_id (int): The ID of the action.
+            action_step_order (int): The action step order.
+            action_target_id (int): The ID of the action target.
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -53,6 +58,11 @@ class ActionsLogsApiServiceAsync(DevopnessBaseServiceAsync):
         """
         Get action target step log
 
+        Attributes:
+            action_id (int): The ID of the action.
+            action_step_order (int): The action step order.
+            action_target_id (int): The ID of the action target.
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.

{devopness-2.6.5 → devopness-2.7.0}/src/devopness/generated/api/applications_api.py

@@ -41,6 +41,10 @@ class ApplicationsApiService(DevopnessBaseService):
         """
         Trigger a new deployment for current application
 
+        Attributes:
+            application_id (int): The ID of the application.
+            deployment_application_create (Union[DeploymentApplicationCreate, DeploymentApplicationCreatePlain,]): A JSON object containing the resource data
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -66,6 +70,10 @@ class ApplicationsApiService(DevopnessBaseService):
         """
         Create an application
 
+        Attributes:
+            environment_id (int): The ID of the environment.
+            application_environment_create (Union[ApplicationEnvironmentCreate, ApplicationEnvironmentCreatePlain,]): A JSON object containing the resource data
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -91,6 +99,10 @@ class ApplicationsApiService(DevopnessBaseService):
         """
         Create applications from a template
 
+        Attributes:
+            environment_id (int): The ID of the environment.
+            application_environment_apply_template (Union[ApplicationEnvironmentApplyTemplate, ApplicationEnvironmentApplyTemplatePlain,]): A JSON object containing the resource data
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -112,6 +124,9 @@ class ApplicationsApiService(DevopnessBaseService):
         """
         Delete a given application
 
+        Attributes:
+            application_id (int): The ID of the application.
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -133,6 +148,9 @@ class ApplicationsApiService(DevopnessBaseService):
         """
         Get an application by ID
 
+        Attributes:
+            application_id (int): The ID of the application.
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -156,6 +174,11 @@ class ApplicationsApiService(DevopnessBaseService):
         """
         List applications in an environment
 
+        Attributes:
+            environment_id (int): The ID of the environment.
+            page (Optional[int]): Number of the page to be retrieved
+            per_page (Optional[int]): Number of items returned per page
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -170,7 +193,7 @@ class ApplicationsApiService(DevopnessBaseService):
 
         endpoint_parts = [
             f"/environments/{environment_id}/applications",
-            f"?{query_string}",
+            f"?{query_string}" if query_string else "",
         ]
 
         endpoint: str = "".join(endpoint_parts)
@@ -189,6 +212,10 @@ class ApplicationsApiService(DevopnessBaseService):
         """
         Update an existing application
 
+        Attributes:
+            application_id (int): The ID of the application.
+            application_update (Union[ApplicationUpdate, ApplicationUpdatePlain,]): A JSON object containing the resource data
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -220,6 +247,10 @@ class ApplicationsApiServiceAsync(DevopnessBaseServiceAsync):
         """
         Trigger a new deployment for current application
 
+        Attributes:
+            application_id (int): The ID of the application.
+            deployment_application_create (Union[DeploymentApplicationCreate, DeploymentApplicationCreatePlain,]): A JSON object containing the resource data
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -245,6 +276,10 @@ class ApplicationsApiServiceAsync(DevopnessBaseServiceAsync):
         """
         Create an application
 
+        Attributes:
+            environment_id (int): The ID of the environment.
+            application_environment_create (Union[ApplicationEnvironmentCreate, ApplicationEnvironmentCreatePlain,]): A JSON object containing the resource data
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -270,6 +305,10 @@ class ApplicationsApiServiceAsync(DevopnessBaseServiceAsync):
         """
         Create applications from a template
 
+        Attributes:
+            environment_id (int): The ID of the environment.
+            application_environment_apply_template (Union[ApplicationEnvironmentApplyTemplate, ApplicationEnvironmentApplyTemplatePlain,]): A JSON object containing the resource data
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -293,6 +332,9 @@ class ApplicationsApiServiceAsync(DevopnessBaseServiceAsync):
         """
         Delete a given application
 
+        Attributes:
+            application_id (int): The ID of the application.
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -314,6 +356,9 @@ class ApplicationsApiServiceAsync(DevopnessBaseServiceAsync):
         """
         Get an application by ID
 
+        Attributes:
+            application_id (int): The ID of the application.
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -337,6 +382,11 @@ class ApplicationsApiServiceAsync(DevopnessBaseServiceAsync):
         """
         List applications in an environment
 
+        Attributes:
+            environment_id (int): The ID of the environment.
+            page (Optional[int]): Number of the page to be retrieved
+            per_page (Optional[int]): Number of items returned per page
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -351,7 +401,7 @@ class ApplicationsApiServiceAsync(DevopnessBaseServiceAsync):
 
         endpoint_parts = [
             f"/environments/{environment_id}/applications",
-            f"?{query_string}",
+            f"?{query_string}" if query_string else "",
         ]
 
         endpoint: str = "".join(endpoint_parts)
@@ -370,6 +420,10 @@ class ApplicationsApiServiceAsync(DevopnessBaseServiceAsync):
         """
         Update an existing application
 
+        Attributes:
+            application_id (int): The ID of the application.
+            application_update (Union[ApplicationUpdate, ApplicationUpdatePlain,]): A JSON object containing the resource data
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.

{devopness-2.6.5 → devopness-2.7.0}/src/devopness/generated/api/applications_hooks_api.py

@@ -25,6 +25,11 @@ class ApplicationsHooksApiService(DevopnessBaseService):
         """
         List all hooks in an application
 
+        Attributes:
+            application_id (int): The ID of the application.
+            page (Optional[int]): Number of the page to be retrieved
+            per_page (Optional[int]): Number of items returned per page
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -39,7 +44,7 @@ class ApplicationsHooksApiService(DevopnessBaseService):
 
         endpoint_parts = [
             f"/applications/{application_id}/hooks",
-            f"?{query_string}",
+            f"?{query_string}" if query_string else "",
         ]
 
         endpoint: str = "".join(endpoint_parts)
@@ -62,6 +67,11 @@ class ApplicationsHooksApiServiceAsync(DevopnessBaseServiceAsync):
         """
         List all hooks in an application
 
+        Attributes:
+            application_id (int): The ID of the application.
+            page (Optional[int]): Number of the page to be retrieved
+            per_page (Optional[int]): Number of items returned per page
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -76,7 +86,7 @@ class ApplicationsHooksApiServiceAsync(DevopnessBaseServiceAsync):
 
         endpoint_parts = [
             f"/applications/{application_id}/hooks",
-            f"?{query_string}",
+            f"?{query_string}" if query_string else "",
         ]
 
         endpoint: str = "".join(endpoint_parts)

{devopness-2.6.5 → devopness-2.7.0}/src/devopness/generated/api/applications_variables_api.py

@@ -35,6 +35,10 @@ class ApplicationsVariablesApiService(DevopnessBaseService):
         """
         Create a new variable linked to an application
 
+        Attributes:
+            application_id (int): The ID of the application.
+            variable_application_create (Union[VariableApplicationCreate, VariableApplicationCreatePlain,]): A JSON object containing the resource data
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -66,6 +70,11 @@ class ApplicationsVariablesApiService(DevopnessBaseService):
         """
         Return a list of variables belonging to an application
 
+        Attributes:
+            application_id (int): The ID of the application.
+            page (Optional[int]): Number of the page to be retrieved
+            per_page (Optional[int]): Number of items returned per page
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -88,7 +97,7 @@ class ApplicationsVariablesApiService(DevopnessBaseService):
 
         endpoint_parts = [
             f"/applications/{application_id}/variables",
-            f"?{query_string}",
+            f"?{query_string}" if query_string else "",
         ]
 
         endpoint: str = "".join(endpoint_parts)
@@ -113,6 +122,10 @@ class ApplicationsVariablesApiServiceAsync(DevopnessBaseServiceAsync):
         """
         Create a new variable linked to an application
 
+        Attributes:
+            application_id (int): The ID of the application.
+            variable_application_create (Union[VariableApplicationCreate, VariableApplicationCreatePlain,]): A JSON object containing the resource data
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -144,6 +157,11 @@ class ApplicationsVariablesApiServiceAsync(DevopnessBaseServiceAsync):
         """
         Return a list of variables belonging to an application
 
+        Attributes:
+            application_id (int): The ID of the application.
+            page (Optional[int]): Number of the page to be retrieved
+            per_page (Optional[int]): Number of items returned per page
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -166,7 +184,7 @@ class ApplicationsVariablesApiServiceAsync(DevopnessBaseServiceAsync):
 
         endpoint_parts = [
             f"/applications/{application_id}/variables",
-            f"?{query_string}",
+            f"?{query_string}" if query_string else "",
         ]
 
         endpoint: str = "".join(endpoint_parts)