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

ptctools/portainer_client/openapi_client/models/portainer_edge_stack_status.py

@@ -0,0 +1,117 @@
+# 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_edge_stack_deployment_status import PortainerEdgeStackDeploymentStatus
+from openapi_client.models.portainer_edge_stack_status_details import PortainerEdgeStackStatusDetails
+from openapi_client.models.portainer_edge_stack_status_type import PortainerEdgeStackStatusType
+from openapi_client.models.portainer_stack_deployment_info import PortainerStackDeploymentInfo
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PortainerEdgeStackStatus(BaseModel):
+    """
+    PortainerEdgeStackStatus
+    """ # noqa: E501
+    details: Optional[PortainerEdgeStackStatusDetails] = Field(default=None, description="Deprecated", alias="Details")
+    error: Optional[StrictStr] = Field(default=None, description="Deprecated", alias="Error")
+    ready_re_pull_image: Optional[StrictBool] = Field(default=None, description="ReadyRePullImage is a flag to indicate whether the auto update is trigger to re-pull image", alias="ReadyRePullImage")
+    type: Optional[PortainerEdgeStackStatusType] = Field(default=None, description="Deprecated", alias="Type")
+    deployment_info: Optional[PortainerStackDeploymentInfo] = Field(default=None, description="EE only feature", alias="deploymentInfo")
+    endpoint_id: Optional[StrictInt] = Field(default=None, alias="endpointID")
+    status: Optional[List[PortainerEdgeStackDeploymentStatus]] = None
+    __properties: ClassVar[List[str]] = ["Details", "Error", "ReadyRePullImage", "Type", "deploymentInfo", "endpointID", "status"]
+
+    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 PortainerEdgeStackStatus 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 details
+        if self.details:
+            _dict['Details'] = self.details.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of deployment_info
+        if self.deployment_info:
+            _dict['deploymentInfo'] = self.deployment_info.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in status (list)
+        _items = []
+        if self.status:
+            for _item_status in self.status:
+                if _item_status:
+                    _items.append(_item_status.to_dict())
+            _dict['status'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PortainerEdgeStackStatus from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "Details": PortainerEdgeStackStatusDetails.from_dict(obj["Details"]) if obj.get("Details") is not None else None,
+            "Error": obj.get("Error"),
+            "ReadyRePullImage": obj.get("ReadyRePullImage"),
+            "Type": obj.get("Type"),
+            "deploymentInfo": PortainerStackDeploymentInfo.from_dict(obj["deploymentInfo"]) if obj.get("deploymentInfo") is not None else None,
+            "endpointID": obj.get("endpointID"),
+            "status": [PortainerEdgeStackDeploymentStatus.from_dict(_item) for _item in obj["status"]] if obj.get("status") is not None else None
+        })
+        return _obj
+
+

ptctools/portainer_client/openapi_client/models/portainer_edge_stack_status_details.py

@@ -0,0 +1,100 @@
+# 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 PortainerEdgeStackStatusDetails(BaseModel):
+    """
+    PortainerEdgeStackStatusDetails
+    """ # noqa: E501
+    acknowledged: Optional[StrictBool] = None
+    error: Optional[StrictBool] = None
+    images_pulled: Optional[StrictBool] = Field(default=None, alias="imagesPulled")
+    ok: Optional[StrictBool] = None
+    pending: Optional[StrictBool] = None
+    remote_update_success: Optional[StrictBool] = Field(default=None, alias="remoteUpdateSuccess")
+    remove: Optional[StrictBool] = None
+    __properties: ClassVar[List[str]] = ["acknowledged", "error", "imagesPulled", "ok", "pending", "remoteUpdateSuccess", "remove"]
+
+    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 PortainerEdgeStackStatusDetails 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 PortainerEdgeStackStatusDetails from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "acknowledged": obj.get("acknowledged"),
+            "error": obj.get("error"),
+            "imagesPulled": obj.get("imagesPulled"),
+            "ok": obj.get("ok"),
+            "pending": obj.get("pending"),
+            "remoteUpdateSuccess": obj.get("remoteUpdateSuccess"),
+            "remove": obj.get("remove")
+        })
+        return _obj
+
+

ptctools/portainer_client/openapi_client/models/portainer_edge_stack_status_type.py

@@ -0,0 +1,50 @@
+# 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 json
+from enum import Enum
+from typing_extensions import Self
+
+
+class PortainerEdgeStackStatusType(int, Enum):
+    """
+    PortainerEdgeStackStatusType
+    """
+
+    """
+    allowed enum values
+    """
+    EdgeStackStatusPending = 0
+    EdgeStackStatusDeploymentReceived = 1
+    EdgeStackStatusError = 2
+    EdgeStackStatusAcknowledged = 3
+    EdgeStackStatusRemoved = 4
+    EdgeStackStatusRemoteUpdateSuccess = 5
+    EdgeStackStatusImagesPulled = 6
+    EdgeStackStatusRunning = 7
+    EdgeStackStatusDeploying = 8
+    EdgeStackStatusRemoving = 9
+    EdgeStackStatusPausedDeploying = 10
+    EdgeStackStatusRollingBack = 11
+    EdgeStackStatusRolledBack = 12
+    EdgeStackStatusCompleted = 13
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of PortainerEdgeStackStatusType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

ptctools/portainer_client/openapi_client/models/portainer_endpoint.py

@@ -0,0 +1,233 @@
+# 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_access_policy import PortainerAccessPolicy
+from openapi_client.models.portainer_azure_credentials import PortainerAzureCredentials
+from openapi_client.models.portainer_docker_snapshot import PortainerDockerSnapshot
+from openapi_client.models.portainer_endpoint_agent import PortainerEndpointAgent
+from openapi_client.models.portainer_endpoint_post_init_migrations import PortainerEndpointPostInitMigrations
+from openapi_client.models.portainer_endpoint_security_settings import PortainerEndpointSecuritySettings
+from openapi_client.models.portainer_endpoint_status import PortainerEndpointStatus
+from openapi_client.models.portainer_endpoint_type import PortainerEndpointType
+from openapi_client.models.portainer_environment_edge_settings import PortainerEnvironmentEdgeSettings
+from openapi_client.models.portainer_kubernetes_data import PortainerKubernetesData
+from openapi_client.models.portainer_pair import PortainerPair
+from openapi_client.models.portainer_tls_configuration import PortainerTLSConfiguration
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PortainerEndpoint(BaseModel):
+    """
+    PortainerEndpoint
+    """ # noqa: E501
+    amt_device_guid: Optional[StrictStr] = Field(default=None, description="The identifier of the AMT Device associated with this environment(endpoint)", alias="AMTDeviceGUID")
+    authorized_teams: Optional[List[StrictInt]] = Field(default=None, alias="AuthorizedTeams")
+    authorized_users: Optional[List[StrictInt]] = Field(default=None, description="Deprecated in DBVersion == 18", alias="AuthorizedUsers")
+    azure_credentials: Optional[PortainerAzureCredentials] = Field(default=None, alias="AzureCredentials")
+    compose_syntax_max_version: Optional[StrictStr] = Field(default=None, description="Maximum version of docker-compose", alias="ComposeSyntaxMaxVersion")
+    container_engine: Optional[StrictStr] = Field(default=None, description="ContainerEngine represents the container engine type. This can be 'docker' or 'podman' when interacting directly with these environmentes, otherwise '' for kubernetes environments.", alias="ContainerEngine")
+    edge_checkin_interval: Optional[StrictInt] = Field(default=None, description="The check in interval for edge agent (in seconds)", alias="EdgeCheckinInterval")
+    edge_id: Optional[StrictStr] = Field(default=None, description="The identifier of the edge agent associated with this environment(endpoint)", alias="EdgeID")
+    edge_key: Optional[StrictStr] = Field(default=None, description="The key which is used to map the agent to Portainer", alias="EdgeKey")
+    enable_gpu_management: Optional[StrictBool] = Field(default=None, alias="EnableGPUManagement")
+    gpus: Optional[List[PortainerPair]] = Field(default=None, alias="Gpus")
+    group_id: Optional[StrictInt] = Field(default=None, description="Environment(Endpoint) group identifier", alias="GroupId")
+    heartbeat: Optional[StrictBool] = Field(default=None, description="Heartbeat indicates the heartbeat status of an edge environment", alias="Heartbeat")
+    id: Optional[StrictInt] = Field(default=None, description="Environment(Endpoint) Identifier", alias="Id")
+    is_edge_device: Optional[StrictBool] = Field(default=None, description="Deprecated v2.18", alias="IsEdgeDevice")
+    kubernetes: Optional[PortainerKubernetesData] = Field(default=None, description="Associated Kubernetes data", alias="Kubernetes")
+    name: Optional[StrictStr] = Field(default=None, description="Environment(Endpoint) name", alias="Name")
+    post_init_migrations: Optional[PortainerEndpointPostInitMigrations] = Field(default=None, description="Whether we need to run any \"post init migrations\".", alias="PostInitMigrations")
+    public_url: Optional[StrictStr] = Field(default=None, description="URL or IP address where exposed containers will be reachable", alias="PublicURL")
+    snapshots: Optional[List[PortainerDockerSnapshot]] = Field(default=None, description="List of snapshots", alias="Snapshots")
+    status: Optional[PortainerEndpointStatus] = Field(default=None, description="The status of the environment(endpoint) (1 - up, 2 - down)", alias="Status")
+    tls: Optional[StrictBool] = Field(default=None, description="Deprecated fields Deprecated in DBVersion == 4", alias="TLS")
+    tlsca_cert: Optional[StrictStr] = Field(default=None, alias="TLSCACert")
+    tls_cert: Optional[StrictStr] = Field(default=None, alias="TLSCert")
+    tls_config: Optional[PortainerTLSConfiguration] = Field(default=None, alias="TLSConfig")
+    tls_key: Optional[StrictStr] = Field(default=None, alias="TLSKey")
+    tag_ids: Optional[List[StrictInt]] = Field(default=None, description="List of tag identifiers to which this environment(endpoint) is associated", alias="TagIds")
+    tags: Optional[List[StrictStr]] = Field(default=None, description="Deprecated in DBVersion == 22", alias="Tags")
+    team_access_policies: Optional[Dict[str, PortainerAccessPolicy]] = Field(default=None, description="List of team identifiers authorized to connect to this environment(endpoint)", alias="TeamAccessPolicies")
+    type: Optional[PortainerEndpointType] = Field(default=None, description="Environment(Endpoint) environment(endpoint) type. 1 for a Docker environment(endpoint), 2 for an agent on Docker environment(endpoint) or 3 for an Azure environment(endpoint).", alias="Type")
+    url: Optional[StrictStr] = Field(default=None, description="URL or IP address of the Docker host associated to this environment(endpoint)", alias="URL")
+    user_access_policies: Optional[Dict[str, PortainerAccessPolicy]] = Field(default=None, description="List of user identifiers authorized to connect to this environment(endpoint)", alias="UserAccessPolicies")
+    user_trusted: Optional[StrictBool] = Field(default=None, description="Whether the device has been trusted or not by the user", alias="UserTrusted")
+    agent: Optional[PortainerEndpointAgent] = None
+    edge: Optional[PortainerEnvironmentEdgeSettings] = None
+    last_check_in_date: Optional[StrictInt] = Field(default=None, description="LastCheckInDate mark last check-in date on checkin", alias="lastCheckInDate")
+    query_date: Optional[StrictInt] = Field(default=None, description="QueryDate of each query with the endpoints list", alias="queryDate")
+    security_settings: Optional[PortainerEndpointSecuritySettings] = Field(default=None, description="Environment(Endpoint) specific security settings", alias="securitySettings")
+    __properties: ClassVar[List[str]] = ["AMTDeviceGUID", "AuthorizedTeams", "AuthorizedUsers", "AzureCredentials", "ComposeSyntaxMaxVersion", "ContainerEngine", "EdgeCheckinInterval", "EdgeID", "EdgeKey", "EnableGPUManagement", "Gpus", "GroupId", "Heartbeat", "Id", "IsEdgeDevice", "Kubernetes", "Name", "PostInitMigrations", "PublicURL", "Snapshots", "Status", "TLS", "TLSCACert", "TLSCert", "TLSConfig", "TLSKey", "TagIds", "Tags", "TeamAccessPolicies", "Type", "URL", "UserAccessPolicies", "UserTrusted", "agent", "edge", "lastCheckInDate", "queryDate", "securitySettings"]
+
+    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 PortainerEndpoint 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 azure_credentials
+        if self.azure_credentials:
+            _dict['AzureCredentials'] = self.azure_credentials.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in gpus (list)
+        _items = []
+        if self.gpus:
+            for _item_gpus in self.gpus:
+                if _item_gpus:
+                    _items.append(_item_gpus.to_dict())
+            _dict['Gpus'] = _items
+        # override the default output from pydantic by calling `to_dict()` of kubernetes
+        if self.kubernetes:
+            _dict['Kubernetes'] = self.kubernetes.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of post_init_migrations
+        if self.post_init_migrations:
+            _dict['PostInitMigrations'] = self.post_init_migrations.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in snapshots (list)
+        _items = []
+        if self.snapshots:
+            for _item_snapshots in self.snapshots:
+                if _item_snapshots:
+                    _items.append(_item_snapshots.to_dict())
+            _dict['Snapshots'] = _items
+        # override the default output from pydantic by calling `to_dict()` of tls_config
+        if self.tls_config:
+            _dict['TLSConfig'] = self.tls_config.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each value in team_access_policies (dict)
+        _field_dict = {}
+        if self.team_access_policies:
+            for _key_team_access_policies in self.team_access_policies:
+                if self.team_access_policies[_key_team_access_policies]:
+                    _field_dict[_key_team_access_policies] = self.team_access_policies[_key_team_access_policies].to_dict()
+            _dict['TeamAccessPolicies'] = _field_dict
+        # override the default output from pydantic by calling `to_dict()` of each value in user_access_policies (dict)
+        _field_dict = {}
+        if self.user_access_policies:
+            for _key_user_access_policies in self.user_access_policies:
+                if self.user_access_policies[_key_user_access_policies]:
+                    _field_dict[_key_user_access_policies] = self.user_access_policies[_key_user_access_policies].to_dict()
+            _dict['UserAccessPolicies'] = _field_dict
+        # override the default output from pydantic by calling `to_dict()` of agent
+        if self.agent:
+            _dict['agent'] = self.agent.to_dict()
+        # 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 security_settings
+        if self.security_settings:
+            _dict['securitySettings'] = self.security_settings.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PortainerEndpoint from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "AMTDeviceGUID": obj.get("AMTDeviceGUID"),
+            "AuthorizedTeams": obj.get("AuthorizedTeams"),
+            "AuthorizedUsers": obj.get("AuthorizedUsers"),
+            "AzureCredentials": PortainerAzureCredentials.from_dict(obj["AzureCredentials"]) if obj.get("AzureCredentials") is not None else None,
+            "ComposeSyntaxMaxVersion": obj.get("ComposeSyntaxMaxVersion"),
+            "ContainerEngine": obj.get("ContainerEngine"),
+            "EdgeCheckinInterval": obj.get("EdgeCheckinInterval"),
+            "EdgeID": obj.get("EdgeID"),
+            "EdgeKey": obj.get("EdgeKey"),
+            "EnableGPUManagement": obj.get("EnableGPUManagement"),
+            "Gpus": [PortainerPair.from_dict(_item) for _item in obj["Gpus"]] if obj.get("Gpus") is not None else None,
+            "GroupId": obj.get("GroupId"),
+            "Heartbeat": obj.get("Heartbeat"),
+            "Id": obj.get("Id"),
+            "IsEdgeDevice": obj.get("IsEdgeDevice"),
+            "Kubernetes": PortainerKubernetesData.from_dict(obj["Kubernetes"]) if obj.get("Kubernetes") is not None else None,
+            "Name": obj.get("Name"),
+            "PostInitMigrations": PortainerEndpointPostInitMigrations.from_dict(obj["PostInitMigrations"]) if obj.get("PostInitMigrations") is not None else None,
+            "PublicURL": obj.get("PublicURL"),
+            "Snapshots": [PortainerDockerSnapshot.from_dict(_item) for _item in obj["Snapshots"]] if obj.get("Snapshots") is not None else None,
+            "Status": obj.get("Status"),
+            "TLS": obj.get("TLS"),
+            "TLSCACert": obj.get("TLSCACert"),
+            "TLSCert": obj.get("TLSCert"),
+            "TLSConfig": PortainerTLSConfiguration.from_dict(obj["TLSConfig"]) if obj.get("TLSConfig") is not None else None,
+            "TLSKey": obj.get("TLSKey"),
+            "TagIds": obj.get("TagIds"),
+            "Tags": obj.get("Tags"),
+            "TeamAccessPolicies": dict(
+                (_k, PortainerAccessPolicy.from_dict(_v))
+                for _k, _v in obj["TeamAccessPolicies"].items()
+            )
+            if obj.get("TeamAccessPolicies") is not None
+            else None,
+            "Type": obj.get("Type"),
+            "URL": obj.get("URL"),
+            "UserAccessPolicies": dict(
+                (_k, PortainerAccessPolicy.from_dict(_v))
+                for _k, _v in obj["UserAccessPolicies"].items()
+            )
+            if obj.get("UserAccessPolicies") is not None
+            else None,
+            "UserTrusted": obj.get("UserTrusted"),
+            "agent": PortainerEndpointAgent.from_dict(obj["agent"]) if obj.get("agent") is not None else None,
+            "edge": PortainerEnvironmentEdgeSettings.from_dict(obj["edge"]) if obj.get("edge") is not None else None,
+            "lastCheckInDate": obj.get("lastCheckInDate"),
+            "queryDate": obj.get("queryDate"),
+            "securitySettings": PortainerEndpointSecuritySettings.from_dict(obj["securitySettings"]) if obj.get("securitySettings") is not None else None
+        })
+        return _obj
+
+

ptctools/portainer_client/openapi_client/models/portainer_endpoint_agent.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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PortainerEndpointAgent(BaseModel):
+    """
+    PortainerEndpointAgent
+    """ # noqa: E501
+    version: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["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 PortainerEndpointAgent 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 PortainerEndpointAgent from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "version": obj.get("version")
+        })
+        return _obj
+
+