ptctools 0.1.0__py3-none-any.whl → 0.2.0__py3-none-any.whl

ptctools/portainer_client/openapi_client/models/portainer_settings.py

@@ -0,0 +1,187 @@
+# coding: utf-8
+
+"""
+    PortainerCE API
+
+    Portainer API is an HTTP API served by Portainer. It is used by the Portainer UI and everything you can do with the UI can be done using the HTTP API. Examples are available at https://documentation.portainer.io/api/api-examples/ You can find out more about Portainer at [http://portainer.io](http://portainer.io) and get some support on [Slack](http://portainer.io/slack/).  # Authentication  Most of the API environments(endpoints) require to be authenticated as well as some level of authorization to be used. Portainer API uses JSON Web Token to manage authentication and thus requires you to provide a token in the **Authorization** header of each request with the **Bearer** authentication mechanism.  Example:  ``` Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwidXNlcm5hbWUiOiJhZG1pbiIsInJvbGUiOjEsImV4cCI6MTQ5OTM3NjE1NH0.NJ6vE8FY1WG6jsRQzfMqeatJ4vh2TWAeeYfDhP71YEE ```  # Security  Each API environment(endpoint) has an associated access policy, it is documented in the description of each environment(endpoint).  Different access policies are available:  - Public access - Authenticated access - Restricted access - Administrator access  ### Public access  No authentication is required to access the environments(endpoints) with this access policy.  ### Authenticated access  Authentication is required to access the environments(endpoints) with this access policy.  ### Restricted access  Authentication is required to access the environments(endpoints) with this access policy. Extra-checks might be added to ensure access to the resource is granted. Returned data might also be filtered.  ### Administrator access  Authentication as well as an administrator role are required to access the environments(endpoints) with this access policy.  # Execute Docker requests  Portainer **DO NOT** expose specific environments(endpoints) to manage your Docker resources (create a container, remove a volume, etc...).  Instead, it acts as a reverse-proxy to the Docker HTTP API. This means that you can execute Docker requests **via** the Portainer HTTP API.  To do so, you can use the `/endpoints/{id}/docker` Portainer API environment(endpoint) (which is not documented below due to Swagger limitations). This environment(endpoint) has a restricted access policy so you still need to be authenticated to be able to query this environment(endpoint). Any query on this environment(endpoint) will be proxied to the Docker API of the associated environment(endpoint) (requests and responses objects are the same as documented in the Docker API).  # Private Registry  Using private registry, you will need to pass a based64 encoded JSON string ‘{\"registryId\":\\<registryID value\\>}’ inside the Request Header. The parameter name is \"X-Registry-Auth\". \\<registryID value\\> - The registry ID where the repository was created.  Example:  ``` eyJyZWdpc3RyeUlkIjoxfQ== ```  **NOTE**: You can find more information on how to query the Docker API in the [Docker official documentation](https://docs.docker.com/engine/api/v1.30/) as well as in [this Portainer example](https://documentation.portainer.io/api/api-examples/). 
+
+    The version of the OpenAPI document: 2.33.6
+    Contact: info@portainer.io
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from openapi_client.models.portainer_authentication_method import PortainerAuthenticationMethod
+from openapi_client.models.portainer_edge import PortainerEdge
+from openapi_client.models.portainer_global_deployment_options import PortainerGlobalDeploymentOptions
+from openapi_client.models.portainer_internal_auth_settings import PortainerInternalAuthSettings
+from openapi_client.models.portainer_ldap_settings import PortainerLDAPSettings
+from openapi_client.models.portainer_o_auth_settings import PortainerOAuthSettings
+from openapi_client.models.portainer_open_amt_configuration import PortainerOpenAMTConfiguration
+from openapi_client.models.portainer_pair import PortainerPair
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PortainerSettings(BaseModel):
+    """
+    PortainerSettings
+    """ # noqa: E501
+    agent_secret: Optional[StrictStr] = Field(default=None, description="Container environment parameter AGENT_SECRET", alias="AgentSecret")
+    allow_bind_mounts_for_regular_users: Optional[StrictBool] = Field(default=None, alias="AllowBindMountsForRegularUsers")
+    allow_container_capabilities_for_regular_users: Optional[StrictBool] = Field(default=None, alias="AllowContainerCapabilitiesForRegularUsers")
+    allow_device_mapping_for_regular_users: Optional[StrictBool] = Field(default=None, alias="AllowDeviceMappingForRegularUsers")
+    allow_host_namespace_for_regular_users: Optional[StrictBool] = Field(default=None, alias="AllowHostNamespaceForRegularUsers")
+    allow_privileged_mode_for_regular_users: Optional[StrictBool] = Field(default=None, alias="AllowPrivilegedModeForRegularUsers")
+    allow_stack_management_for_regular_users: Optional[StrictBool] = Field(default=None, alias="AllowStackManagementForRegularUsers")
+    allow_volume_browser_for_regular_users: Optional[StrictBool] = Field(default=None, alias="AllowVolumeBrowserForRegularUsers")
+    authentication_method: Optional[PortainerAuthenticationMethod] = Field(default=None, description="Active authentication method for the Portainer instance. Valid values are: 1 for internal, 2 for LDAP, or 3 for oauth", alias="AuthenticationMethod")
+    black_listed_labels: Optional[List[PortainerPair]] = Field(default=None, description="A list of label name & value that will be used to hide containers when querying containers", alias="BlackListedLabels")
+    display_donation_header: Optional[StrictBool] = Field(default=None, description="Deprecated fields", alias="DisplayDonationHeader")
+    display_external_contributors: Optional[StrictBool] = Field(default=None, alias="DisplayExternalContributors")
+    edge: Optional[PortainerEdge] = Field(default=None, alias="Edge")
+    edge_agent_checkin_interval: Optional[StrictInt] = Field(default=None, description="The default check in interval for edge agent (in seconds)", alias="EdgeAgentCheckinInterval")
+    edge_portainer_url: Optional[StrictStr] = Field(default=None, description="EdgePortainerURL is the URL that is exposed to edge agents", alias="EdgePortainerUrl")
+    enable_edge_compute_features: Optional[StrictBool] = Field(default=None, description="Whether edge compute features are enabled", alias="EnableEdgeComputeFeatures")
+    enable_host_management_features: Optional[StrictBool] = Field(default=None, description="Deprecated fields v26", alias="EnableHostManagementFeatures")
+    enable_telemetry: Optional[StrictBool] = Field(default=None, description="Whether telemetry is enabled", alias="EnableTelemetry")
+    enforce_edge_id: Optional[StrictBool] = Field(default=None, description="EnforceEdgeID makes Portainer store the Edge ID instead of accepting anyone", alias="EnforceEdgeID")
+    feature_flag_settings: Optional[Dict[str, StrictBool]] = Field(default=None, alias="FeatureFlagSettings")
+    global_deployment_options: Optional[PortainerGlobalDeploymentOptions] = Field(default=None, description="Deployment options for encouraging git ops workflows", alias="GlobalDeploymentOptions")
+    helm_repository_url: Optional[StrictStr] = Field(default=None, description="Helm repository URL, defaults to \"https://charts.bitnami.com/bitnami\"", alias="HelmRepositoryURL")
+    internal_auth_settings: Optional[PortainerInternalAuthSettings] = Field(default=None, alias="InternalAuthSettings")
+    is_docker_desktop_extension: Optional[StrictBool] = Field(default=None, alias="IsDockerDesktopExtension")
+    kubeconfig_expiry: Optional[StrictStr] = Field(default=None, description="The expiry of a Kubeconfig", alias="KubeconfigExpiry")
+    kubectl_shell_image: Optional[StrictStr] = Field(default=None, description="KubectlImage, defaults to portainer/kubectl-shell", alias="KubectlShellImage")
+    ldap_settings: Optional[PortainerLDAPSettings] = Field(default=None, alias="LDAPSettings")
+    logo_url: Optional[StrictStr] = Field(default=None, description="URL to a logo that will be displayed on the login page as well as on top of the sidebar. Will use default Portainer logo when value is empty string", alias="LogoURL")
+    o_auth_settings: Optional[PortainerOAuthSettings] = Field(default=None, alias="OAuthSettings")
+    snapshot_interval: Optional[StrictStr] = Field(default=None, description="The interval in which environment(endpoint) snapshots are created", alias="SnapshotInterval")
+    templates_url: Optional[StrictStr] = Field(default=None, description="URL to the templates that will be displayed in the UI when navigating to App Templates", alias="TemplatesURL")
+    trust_on_first_connect: Optional[StrictBool] = Field(default=None, description="TrustOnFirstConnect makes Portainer accepting edge agent connection by default", alias="TrustOnFirstConnect")
+    user_session_timeout: Optional[StrictStr] = Field(default=None, description="The duration of a user session", alias="UserSessionTimeout")
+    open_amt_configuration: Optional[PortainerOpenAMTConfiguration] = Field(default=None, alias="openAMTConfiguration")
+    __properties: ClassVar[List[str]] = ["AgentSecret", "AllowBindMountsForRegularUsers", "AllowContainerCapabilitiesForRegularUsers", "AllowDeviceMappingForRegularUsers", "AllowHostNamespaceForRegularUsers", "AllowPrivilegedModeForRegularUsers", "AllowStackManagementForRegularUsers", "AllowVolumeBrowserForRegularUsers", "AuthenticationMethod", "BlackListedLabels", "DisplayDonationHeader", "DisplayExternalContributors", "Edge", "EdgeAgentCheckinInterval", "EdgePortainerUrl", "EnableEdgeComputeFeatures", "EnableHostManagementFeatures", "EnableTelemetry", "EnforceEdgeID", "FeatureFlagSettings", "GlobalDeploymentOptions", "HelmRepositoryURL", "InternalAuthSettings", "IsDockerDesktopExtension", "KubeconfigExpiry", "KubectlShellImage", "LDAPSettings", "LogoURL", "OAuthSettings", "SnapshotInterval", "TemplatesURL", "TrustOnFirstConnect", "UserSessionTimeout", "openAMTConfiguration"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of PortainerSettings from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in black_listed_labels (list)
+        _items = []
+        if self.black_listed_labels:
+            for _item_black_listed_labels in self.black_listed_labels:
+                if _item_black_listed_labels:
+                    _items.append(_item_black_listed_labels.to_dict())
+            _dict['BlackListedLabels'] = _items
+        # override the default output from pydantic by calling `to_dict()` of edge
+        if self.edge:
+            _dict['Edge'] = self.edge.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of global_deployment_options
+        if self.global_deployment_options:
+            _dict['GlobalDeploymentOptions'] = self.global_deployment_options.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of internal_auth_settings
+        if self.internal_auth_settings:
+            _dict['InternalAuthSettings'] = self.internal_auth_settings.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of ldap_settings
+        if self.ldap_settings:
+            _dict['LDAPSettings'] = self.ldap_settings.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of o_auth_settings
+        if self.o_auth_settings:
+            _dict['OAuthSettings'] = self.o_auth_settings.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of open_amt_configuration
+        if self.open_amt_configuration:
+            _dict['openAMTConfiguration'] = self.open_amt_configuration.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PortainerSettings from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "AgentSecret": obj.get("AgentSecret"),
+            "AllowBindMountsForRegularUsers": obj.get("AllowBindMountsForRegularUsers"),
+            "AllowContainerCapabilitiesForRegularUsers": obj.get("AllowContainerCapabilitiesForRegularUsers"),
+            "AllowDeviceMappingForRegularUsers": obj.get("AllowDeviceMappingForRegularUsers"),
+            "AllowHostNamespaceForRegularUsers": obj.get("AllowHostNamespaceForRegularUsers"),
+            "AllowPrivilegedModeForRegularUsers": obj.get("AllowPrivilegedModeForRegularUsers"),
+            "AllowStackManagementForRegularUsers": obj.get("AllowStackManagementForRegularUsers"),
+            "AllowVolumeBrowserForRegularUsers": obj.get("AllowVolumeBrowserForRegularUsers"),
+            "AuthenticationMethod": obj.get("AuthenticationMethod"),
+            "BlackListedLabels": [PortainerPair.from_dict(_item) for _item in obj["BlackListedLabels"]] if obj.get("BlackListedLabels") is not None else None,
+            "DisplayDonationHeader": obj.get("DisplayDonationHeader"),
+            "DisplayExternalContributors": obj.get("DisplayExternalContributors"),
+            "Edge": PortainerEdge.from_dict(obj["Edge"]) if obj.get("Edge") is not None else None,
+            "EdgeAgentCheckinInterval": obj.get("EdgeAgentCheckinInterval"),
+            "EdgePortainerUrl": obj.get("EdgePortainerUrl"),
+            "EnableEdgeComputeFeatures": obj.get("EnableEdgeComputeFeatures"),
+            "EnableHostManagementFeatures": obj.get("EnableHostManagementFeatures"),
+            "EnableTelemetry": obj.get("EnableTelemetry"),
+            "EnforceEdgeID": obj.get("EnforceEdgeID"),
+            "FeatureFlagSettings": obj.get("FeatureFlagSettings"),
+            "GlobalDeploymentOptions": PortainerGlobalDeploymentOptions.from_dict(obj["GlobalDeploymentOptions"]) if obj.get("GlobalDeploymentOptions") is not None else None,
+            "HelmRepositoryURL": obj.get("HelmRepositoryURL"),
+            "InternalAuthSettings": PortainerInternalAuthSettings.from_dict(obj["InternalAuthSettings"]) if obj.get("InternalAuthSettings") is not None else None,
+            "IsDockerDesktopExtension": obj.get("IsDockerDesktopExtension"),
+            "KubeconfigExpiry": obj.get("KubeconfigExpiry"),
+            "KubectlShellImage": obj.get("KubectlShellImage"),
+            "LDAPSettings": PortainerLDAPSettings.from_dict(obj["LDAPSettings"]) if obj.get("LDAPSettings") is not None else None,
+            "LogoURL": obj.get("LogoURL"),
+            "OAuthSettings": PortainerOAuthSettings.from_dict(obj["OAuthSettings"]) if obj.get("OAuthSettings") is not None else None,
+            "SnapshotInterval": obj.get("SnapshotInterval"),
+            "TemplatesURL": obj.get("TemplatesURL"),
+            "TrustOnFirstConnect": obj.get("TrustOnFirstConnect"),
+            "UserSessionTimeout": obj.get("UserSessionTimeout"),
+            "openAMTConfiguration": PortainerOpenAMTConfiguration.from_dict(obj["openAMTConfiguration"]) if obj.get("openAMTConfiguration") is not None else None
+        })
+        return _obj
+
+

ptctools/portainer_client/openapi_client/models/portainer_ssl_settings.py

@@ -0,0 +1,94 @@
+# coding: utf-8
+
+"""
+    PortainerCE API
+
+    Portainer API is an HTTP API served by Portainer. It is used by the Portainer UI and everything you can do with the UI can be done using the HTTP API. Examples are available at https://documentation.portainer.io/api/api-examples/ You can find out more about Portainer at [http://portainer.io](http://portainer.io) and get some support on [Slack](http://portainer.io/slack/).  # Authentication  Most of the API environments(endpoints) require to be authenticated as well as some level of authorization to be used. Portainer API uses JSON Web Token to manage authentication and thus requires you to provide a token in the **Authorization** header of each request with the **Bearer** authentication mechanism.  Example:  ``` Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwidXNlcm5hbWUiOiJhZG1pbiIsInJvbGUiOjEsImV4cCI6MTQ5OTM3NjE1NH0.NJ6vE8FY1WG6jsRQzfMqeatJ4vh2TWAeeYfDhP71YEE ```  # Security  Each API environment(endpoint) has an associated access policy, it is documented in the description of each environment(endpoint).  Different access policies are available:  - Public access - Authenticated access - Restricted access - Administrator access  ### Public access  No authentication is required to access the environments(endpoints) with this access policy.  ### Authenticated access  Authentication is required to access the environments(endpoints) with this access policy.  ### Restricted access  Authentication is required to access the environments(endpoints) with this access policy. Extra-checks might be added to ensure access to the resource is granted. Returned data might also be filtered.  ### Administrator access  Authentication as well as an administrator role are required to access the environments(endpoints) with this access policy.  # Execute Docker requests  Portainer **DO NOT** expose specific environments(endpoints) to manage your Docker resources (create a container, remove a volume, etc...).  Instead, it acts as a reverse-proxy to the Docker HTTP API. This means that you can execute Docker requests **via** the Portainer HTTP API.  To do so, you can use the `/endpoints/{id}/docker` Portainer API environment(endpoint) (which is not documented below due to Swagger limitations). This environment(endpoint) has a restricted access policy so you still need to be authenticated to be able to query this environment(endpoint). Any query on this environment(endpoint) will be proxied to the Docker API of the associated environment(endpoint) (requests and responses objects are the same as documented in the Docker API).  # Private Registry  Using private registry, you will need to pass a based64 encoded JSON string ‘{\"registryId\":\\<registryID value\\>}’ inside the Request Header. The parameter name is \"X-Registry-Auth\". \\<registryID value\\> - The registry ID where the repository was created.  Example:  ``` eyJyZWdpc3RyeUlkIjoxfQ== ```  **NOTE**: You can find more information on how to query the Docker API in the [Docker official documentation](https://docs.docker.com/engine/api/v1.30/) as well as in [this Portainer example](https://documentation.portainer.io/api/api-examples/). 
+
+    The version of the OpenAPI document: 2.33.6
+    Contact: info@portainer.io
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PortainerSSLSettings(BaseModel):
+    """
+    PortainerSSLSettings
+    """ # noqa: E501
+    cert_path: Optional[StrictStr] = Field(default=None, alias="certPath")
+    http_enabled: Optional[StrictBool] = Field(default=None, alias="httpEnabled")
+    key_path: Optional[StrictStr] = Field(default=None, alias="keyPath")
+    self_signed: Optional[StrictBool] = Field(default=None, alias="selfSigned")
+    __properties: ClassVar[List[str]] = ["certPath", "httpEnabled", "keyPath", "selfSigned"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of PortainerSSLSettings from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PortainerSSLSettings from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "certPath": obj.get("certPath"),
+            "httpEnabled": obj.get("httpEnabled"),
+            "keyPath": obj.get("keyPath"),
+            "selfSigned": obj.get("selfSigned")
+        })
+        return _obj
+
+

ptctools/portainer_client/openapi_client/models/portainer_stack.py

@@ -0,0 +1,152 @@
+# coding: utf-8
+
+"""
+    PortainerCE API
+
+    Portainer API is an HTTP API served by Portainer. It is used by the Portainer UI and everything you can do with the UI can be done using the HTTP API. Examples are available at https://documentation.portainer.io/api/api-examples/ You can find out more about Portainer at [http://portainer.io](http://portainer.io) and get some support on [Slack](http://portainer.io/slack/).  # Authentication  Most of the API environments(endpoints) require to be authenticated as well as some level of authorization to be used. Portainer API uses JSON Web Token to manage authentication and thus requires you to provide a token in the **Authorization** header of each request with the **Bearer** authentication mechanism.  Example:  ``` Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwidXNlcm5hbWUiOiJhZG1pbiIsInJvbGUiOjEsImV4cCI6MTQ5OTM3NjE1NH0.NJ6vE8FY1WG6jsRQzfMqeatJ4vh2TWAeeYfDhP71YEE ```  # Security  Each API environment(endpoint) has an associated access policy, it is documented in the description of each environment(endpoint).  Different access policies are available:  - Public access - Authenticated access - Restricted access - Administrator access  ### Public access  No authentication is required to access the environments(endpoints) with this access policy.  ### Authenticated access  Authentication is required to access the environments(endpoints) with this access policy.  ### Restricted access  Authentication is required to access the environments(endpoints) with this access policy. Extra-checks might be added to ensure access to the resource is granted. Returned data might also be filtered.  ### Administrator access  Authentication as well as an administrator role are required to access the environments(endpoints) with this access policy.  # Execute Docker requests  Portainer **DO NOT** expose specific environments(endpoints) to manage your Docker resources (create a container, remove a volume, etc...).  Instead, it acts as a reverse-proxy to the Docker HTTP API. This means that you can execute Docker requests **via** the Portainer HTTP API.  To do so, you can use the `/endpoints/{id}/docker` Portainer API environment(endpoint) (which is not documented below due to Swagger limitations). This environment(endpoint) has a restricted access policy so you still need to be authenticated to be able to query this environment(endpoint). Any query on this environment(endpoint) will be proxied to the Docker API of the associated environment(endpoint) (requests and responses objects are the same as documented in the Docker API).  # Private Registry  Using private registry, you will need to pass a based64 encoded JSON string ‘{\"registryId\":\\<registryID value\\>}’ inside the Request Header. The parameter name is \"X-Registry-Auth\". \\<registryID value\\> - The registry ID where the repository was created.  Example:  ``` eyJyZWdpc3RyeUlkIjoxfQ== ```  **NOTE**: You can find more information on how to query the Docker API in the [Docker official documentation](https://docs.docker.com/engine/api/v1.30/) as well as in [this Portainer example](https://documentation.portainer.io/api/api-examples/). 
+
+    The version of the OpenAPI document: 2.33.6
+    Contact: info@portainer.io
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from openapi_client.models.gittypes_repo_config import GittypesRepoConfig
+from openapi_client.models.portainer_auto_update_settings import PortainerAutoUpdateSettings
+from openapi_client.models.portainer_pair import PortainerPair
+from openapi_client.models.portainer_resource_control import PortainerResourceControl
+from openapi_client.models.portainer_stack_option import PortainerStackOption
+from openapi_client.models.portainer_stack_status import PortainerStackStatus
+from openapi_client.models.portainer_stack_type import PortainerStackType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PortainerStack(BaseModel):
+    """
+    PortainerStack
+    """ # noqa: E501
+    additional_files: Optional[List[StrictStr]] = Field(default=None, description="Only applies when deploying stack with multiple files", alias="AdditionalFiles")
+    auto_update: Optional[PortainerAutoUpdateSettings] = Field(default=None, description="The GitOps update settings of a git stack", alias="AutoUpdate")
+    endpoint_id: Optional[StrictInt] = Field(default=None, description="Environment(Endpoint) identifier. Reference the environment(endpoint) that will be used for deployment", alias="EndpointId")
+    entry_point: Optional[StrictStr] = Field(default=None, description="Path to the Stack file", alias="EntryPoint")
+    env: Optional[List[PortainerPair]] = Field(default=None, description="A list of environment(endpoint) variables used during stack deployment", alias="Env")
+    id: Optional[StrictInt] = Field(default=None, description="Stack Identifier", alias="Id")
+    name: Optional[StrictStr] = Field(default=None, description="Stack name", alias="Name")
+    option: Optional[PortainerStackOption] = Field(default=None, description="The stack deployment option", alias="Option")
+    resource_control: Optional[PortainerResourceControl] = Field(default=None, alias="ResourceControl")
+    status: Optional[PortainerStackStatus] = Field(default=None, description="Stack status (1 - active, 2 - inactive)", alias="Status")
+    swarm_id: Optional[StrictStr] = Field(default=None, description="Cluster identifier of the Swarm cluster where the stack is deployed", alias="SwarmId")
+    type: Optional[PortainerStackType] = Field(default=None, description="Stack type. 1 for a Swarm stack, 2 for a Compose stack", alias="Type")
+    created_by: Optional[StrictStr] = Field(default=None, description="The username which created this stack", alias="createdBy")
+    creation_date: Optional[StrictInt] = Field(default=None, description="The date in unix time when stack was created", alias="creationDate")
+    from_app_template: Optional[StrictBool] = Field(default=None, description="Whether the stack is from a app template", alias="fromAppTemplate")
+    git_config: Optional[GittypesRepoConfig] = Field(default=None, description="The git config of this stack", alias="gitConfig")
+    namespace: Optional[StrictStr] = Field(default=None, description="Kubernetes namespace if stack is a kube application")
+    project_path: Optional[StrictStr] = Field(default=None, description="Path on disk to the repository hosting the Stack file", alias="projectPath")
+    update_date: Optional[StrictInt] = Field(default=None, description="The date in unix time when stack was last updated", alias="updateDate")
+    updated_by: Optional[StrictStr] = Field(default=None, description="The username which last updated this stack", alias="updatedBy")
+    __properties: ClassVar[List[str]] = ["AdditionalFiles", "AutoUpdate", "EndpointId", "EntryPoint", "Env", "Id", "Name", "Option", "ResourceControl", "Status", "SwarmId", "Type", "createdBy", "creationDate", "fromAppTemplate", "gitConfig", "namespace", "projectPath", "updateDate", "updatedBy"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of PortainerStack from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of auto_update
+        if self.auto_update:
+            _dict['AutoUpdate'] = self.auto_update.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in env (list)
+        _items = []
+        if self.env:
+            for _item_env in self.env:
+                if _item_env:
+                    _items.append(_item_env.to_dict())
+            _dict['Env'] = _items
+        # override the default output from pydantic by calling `to_dict()` of option
+        if self.option:
+            _dict['Option'] = self.option.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of resource_control
+        if self.resource_control:
+            _dict['ResourceControl'] = self.resource_control.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of git_config
+        if self.git_config:
+            _dict['gitConfig'] = self.git_config.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PortainerStack from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "AdditionalFiles": obj.get("AdditionalFiles"),
+            "AutoUpdate": PortainerAutoUpdateSettings.from_dict(obj["AutoUpdate"]) if obj.get("AutoUpdate") is not None else None,
+            "EndpointId": obj.get("EndpointId"),
+            "EntryPoint": obj.get("EntryPoint"),
+            "Env": [PortainerPair.from_dict(_item) for _item in obj["Env"]] if obj.get("Env") is not None else None,
+            "Id": obj.get("Id"),
+            "Name": obj.get("Name"),
+            "Option": PortainerStackOption.from_dict(obj["Option"]) if obj.get("Option") is not None else None,
+            "ResourceControl": PortainerResourceControl.from_dict(obj["ResourceControl"]) if obj.get("ResourceControl") is not None else None,
+            "Status": obj.get("Status"),
+            "SwarmId": obj.get("SwarmId"),
+            "Type": obj.get("Type"),
+            "createdBy": obj.get("createdBy"),
+            "creationDate": obj.get("creationDate"),
+            "fromAppTemplate": obj.get("fromAppTemplate"),
+            "gitConfig": GittypesRepoConfig.from_dict(obj["gitConfig"]) if obj.get("gitConfig") is not None else None,
+            "namespace": obj.get("namespace"),
+            "projectPath": obj.get("projectPath"),
+            "updateDate": obj.get("updateDate"),
+            "updatedBy": obj.get("updatedBy")
+        })
+        return _obj
+
+

ptctools/portainer_client/openapi_client/models/portainer_stack_deployment_info.py

@@ -0,0 +1,92 @@
+# coding: utf-8
+
+"""
+    PortainerCE API
+
+    Portainer API is an HTTP API served by Portainer. It is used by the Portainer UI and everything you can do with the UI can be done using the HTTP API. Examples are available at https://documentation.portainer.io/api/api-examples/ You can find out more about Portainer at [http://portainer.io](http://portainer.io) and get some support on [Slack](http://portainer.io/slack/).  # Authentication  Most of the API environments(endpoints) require to be authenticated as well as some level of authorization to be used. Portainer API uses JSON Web Token to manage authentication and thus requires you to provide a token in the **Authorization** header of each request with the **Bearer** authentication mechanism.  Example:  ``` Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwidXNlcm5hbWUiOiJhZG1pbiIsInJvbGUiOjEsImV4cCI6MTQ5OTM3NjE1NH0.NJ6vE8FY1WG6jsRQzfMqeatJ4vh2TWAeeYfDhP71YEE ```  # Security  Each API environment(endpoint) has an associated access policy, it is documented in the description of each environment(endpoint).  Different access policies are available:  - Public access - Authenticated access - Restricted access - Administrator access  ### Public access  No authentication is required to access the environments(endpoints) with this access policy.  ### Authenticated access  Authentication is required to access the environments(endpoints) with this access policy.  ### Restricted access  Authentication is required to access the environments(endpoints) with this access policy. Extra-checks might be added to ensure access to the resource is granted. Returned data might also be filtered.  ### Administrator access  Authentication as well as an administrator role are required to access the environments(endpoints) with this access policy.  # Execute Docker requests  Portainer **DO NOT** expose specific environments(endpoints) to manage your Docker resources (create a container, remove a volume, etc...).  Instead, it acts as a reverse-proxy to the Docker HTTP API. This means that you can execute Docker requests **via** the Portainer HTTP API.  To do so, you can use the `/endpoints/{id}/docker` Portainer API environment(endpoint) (which is not documented below due to Swagger limitations). This environment(endpoint) has a restricted access policy so you still need to be authenticated to be able to query this environment(endpoint). Any query on this environment(endpoint) will be proxied to the Docker API of the associated environment(endpoint) (requests and responses objects are the same as documented in the Docker API).  # Private Registry  Using private registry, you will need to pass a based64 encoded JSON string ‘{\"registryId\":\\<registryID value\\>}’ inside the Request Header. The parameter name is \"X-Registry-Auth\". \\<registryID value\\> - The registry ID where the repository was created.  Example:  ``` eyJyZWdpc3RyeUlkIjoxfQ== ```  **NOTE**: You can find more information on how to query the Docker API in the [Docker official documentation](https://docs.docker.com/engine/api/v1.30/) as well as in [this Portainer example](https://documentation.portainer.io/api/api-examples/). 
+
+    The version of the OpenAPI document: 2.33.6
+    Contact: info@portainer.io
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PortainerStackDeploymentInfo(BaseModel):
+    """
+    PortainerStackDeploymentInfo
+    """ # noqa: E501
+    config_hash: Optional[StrictStr] = Field(default=None, description="ConfigHash is the commit hash of the git repository used for deploying the stack", alias="ConfigHash")
+    file_version: Optional[StrictInt] = Field(default=None, description="FileVersion is the version of the stack file, used to detect changes", alias="FileVersion")
+    version: Optional[StrictInt] = Field(default=None, description="Version is the version of the stack and also is the deployed version in edge agent", alias="Version")
+    __properties: ClassVar[List[str]] = ["ConfigHash", "FileVersion", "Version"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of PortainerStackDeploymentInfo from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PortainerStackDeploymentInfo from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "ConfigHash": obj.get("ConfigHash"),
+            "FileVersion": obj.get("FileVersion"),
+            "Version": obj.get("Version")
+        })
+        return _obj
+
+

ptctools/portainer_client/openapi_client/models/portainer_stack_option.py

@@ -0,0 +1,88 @@
+# coding: utf-8
+
+"""
+    PortainerCE API
+
+    Portainer API is an HTTP API served by Portainer. It is used by the Portainer UI and everything you can do with the UI can be done using the HTTP API. Examples are available at https://documentation.portainer.io/api/api-examples/ You can find out more about Portainer at [http://portainer.io](http://portainer.io) and get some support on [Slack](http://portainer.io/slack/).  # Authentication  Most of the API environments(endpoints) require to be authenticated as well as some level of authorization to be used. Portainer API uses JSON Web Token to manage authentication and thus requires you to provide a token in the **Authorization** header of each request with the **Bearer** authentication mechanism.  Example:  ``` Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwidXNlcm5hbWUiOiJhZG1pbiIsInJvbGUiOjEsImV4cCI6MTQ5OTM3NjE1NH0.NJ6vE8FY1WG6jsRQzfMqeatJ4vh2TWAeeYfDhP71YEE ```  # Security  Each API environment(endpoint) has an associated access policy, it is documented in the description of each environment(endpoint).  Different access policies are available:  - Public access - Authenticated access - Restricted access - Administrator access  ### Public access  No authentication is required to access the environments(endpoints) with this access policy.  ### Authenticated access  Authentication is required to access the environments(endpoints) with this access policy.  ### Restricted access  Authentication is required to access the environments(endpoints) with this access policy. Extra-checks might be added to ensure access to the resource is granted. Returned data might also be filtered.  ### Administrator access  Authentication as well as an administrator role are required to access the environments(endpoints) with this access policy.  # Execute Docker requests  Portainer **DO NOT** expose specific environments(endpoints) to manage your Docker resources (create a container, remove a volume, etc...).  Instead, it acts as a reverse-proxy to the Docker HTTP API. This means that you can execute Docker requests **via** the Portainer HTTP API.  To do so, you can use the `/endpoints/{id}/docker` Portainer API environment(endpoint) (which is not documented below due to Swagger limitations). This environment(endpoint) has a restricted access policy so you still need to be authenticated to be able to query this environment(endpoint). Any query on this environment(endpoint) will be proxied to the Docker API of the associated environment(endpoint) (requests and responses objects are the same as documented in the Docker API).  # Private Registry  Using private registry, you will need to pass a based64 encoded JSON string ‘{\"registryId\":\\<registryID value\\>}’ inside the Request Header. The parameter name is \"X-Registry-Auth\". \\<registryID value\\> - The registry ID where the repository was created.  Example:  ``` eyJyZWdpc3RyeUlkIjoxfQ== ```  **NOTE**: You can find more information on how to query the Docker API in the [Docker official documentation](https://docs.docker.com/engine/api/v1.30/) as well as in [this Portainer example](https://documentation.portainer.io/api/api-examples/). 
+
+    The version of the OpenAPI document: 2.33.6
+    Contact: info@portainer.io
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PortainerStackOption(BaseModel):
+    """
+    PortainerStackOption
+    """ # noqa: E501
+    prune: Optional[StrictBool] = Field(default=None, description="Prune services that are no longer referenced")
+    __properties: ClassVar[List[str]] = ["prune"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of PortainerStackOption from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PortainerStackOption from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "prune": obj.get("prune")
+        })
+        return _obj
+
+