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

ptctools/portainer_client/openapi_client/models/customtemplates_custom_template_from_file_content_payload.py

@@ -0,0 +1,114 @@
+# 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 openapi_client.models.portainer_custom_template_platform import PortainerCustomTemplatePlatform
+from openapi_client.models.portainer_custom_template_variable_definition import PortainerCustomTemplateVariableDefinition
+from openapi_client.models.portainer_stack_type import PortainerStackType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CustomtemplatesCustomTemplateFromFileContentPayload(BaseModel):
+    """
+    CustomtemplatesCustomTemplateFromFileContentPayload
+    """ # noqa: E501
+    description: StrictStr = Field(description="Description of the template")
+    edge_template: Optional[StrictBool] = Field(default=None, description="EdgeTemplate indicates if this template purpose for Edge Stack", alias="edgeTemplate")
+    file_content: StrictStr = Field(description="Content of stack file", alias="fileContent")
+    logo: Optional[StrictStr] = Field(default=None, description="URL of the template's logo")
+    note: Optional[StrictStr] = Field(default=None, description="A note that will be displayed in the UI. Supports HTML content")
+    platform: Optional[PortainerCustomTemplatePlatform] = Field(default=None, description="Platform associated to the template. Valid values are: 1 - 'linux', 2 - 'windows' Required for Docker stacks")
+    title: StrictStr = Field(description="Title of the template")
+    type: PortainerStackType = Field(description="Type of created stack: * 1 - swarm * 2 - compose * 3 - kubernetes")
+    variables: Optional[List[PortainerCustomTemplateVariableDefinition]] = Field(default=None, description="Definitions of variables in the stack file")
+    __properties: ClassVar[List[str]] = ["description", "edgeTemplate", "fileContent", "logo", "note", "platform", "title", "type", "variables"]
+
+    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 CustomtemplatesCustomTemplateFromFileContentPayload 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 variables (list)
+        _items = []
+        if self.variables:
+            for _item_variables in self.variables:
+                if _item_variables:
+                    _items.append(_item_variables.to_dict())
+            _dict['variables'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CustomtemplatesCustomTemplateFromFileContentPayload from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "description": obj.get("description"),
+            "edgeTemplate": obj.get("edgeTemplate"),
+            "fileContent": obj.get("fileContent"),
+            "logo": obj.get("logo"),
+            "note": obj.get("note"),
+            "platform": obj.get("platform"),
+            "title": obj.get("title"),
+            "type": obj.get("type"),
+            "variables": [PortainerCustomTemplateVariableDefinition.from_dict(_item) for _item in obj["variables"]] if obj.get("variables") is not None else None
+        })
+        return _obj
+
+

ptctools/portainer_client/openapi_client/models/customtemplates_custom_template_from_git_repository_payload.py

@@ -0,0 +1,128 @@
+# 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 openapi_client.models.portainer_custom_template_platform import PortainerCustomTemplatePlatform
+from openapi_client.models.portainer_custom_template_variable_definition import PortainerCustomTemplateVariableDefinition
+from openapi_client.models.portainer_stack_type import PortainerStackType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CustomtemplatesCustomTemplateFromGitRepositoryPayload(BaseModel):
+    """
+    CustomtemplatesCustomTemplateFromGitRepositoryPayload
+    """ # noqa: E501
+    compose_file_path_in_repository: Optional[StrictStr] = Field(default='docker-compose.yml', description="Path to the Stack file inside the Git repository", alias="composeFilePathInRepository")
+    description: StrictStr = Field(description="Description of the template")
+    edge_template: Optional[StrictBool] = Field(default=None, description="EdgeTemplate indicates if this template purpose for Edge Stack", alias="edgeTemplate")
+    is_compose_format: Optional[StrictBool] = Field(default=None, description="IsComposeFormat indicates if the Kubernetes template is created from a Docker Compose file", alias="isComposeFormat")
+    logo: Optional[StrictStr] = Field(default=None, description="URL of the template's logo")
+    note: Optional[StrictStr] = Field(default=None, description="A note that will be displayed in the UI. Supports HTML content")
+    platform: Optional[PortainerCustomTemplatePlatform] = Field(default=None, description="Platform associated to the template. Valid values are: 1 - 'linux', 2 - 'windows' Required for Docker stacks")
+    repository_authentication: Optional[StrictBool] = Field(default=None, description="Use basic authentication to clone the Git repository", alias="repositoryAuthentication")
+    repository_password: Optional[StrictStr] = Field(default=None, description="Password used in basic authentication. Required when RepositoryAuthentication is true.", alias="repositoryPassword")
+    repository_reference_name: Optional[StrictStr] = Field(default=None, description="Reference name of a Git repository hosting the Stack file", alias="repositoryReferenceName")
+    repository_url: StrictStr = Field(description="URL of a Git repository hosting the Stack file", alias="repositoryURL")
+    repository_username: Optional[StrictStr] = Field(default=None, description="Username used in basic authentication. Required when RepositoryAuthentication is true.", alias="repositoryUsername")
+    title: StrictStr = Field(description="Title of the template")
+    tlsskip_verify: Optional[StrictBool] = Field(default=None, description="TLSSkipVerify skips SSL verification when cloning the Git repository", alias="tlsskipVerify")
+    type: PortainerStackType = Field(description="Type of created stack: * 1 - swarm * 2 - compose * 3 - kubernetes")
+    variables: Optional[List[PortainerCustomTemplateVariableDefinition]] = Field(default=None, description="Definitions of variables in the stack file")
+    __properties: ClassVar[List[str]] = ["composeFilePathInRepository", "description", "edgeTemplate", "isComposeFormat", "logo", "note", "platform", "repositoryAuthentication", "repositoryPassword", "repositoryReferenceName", "repositoryURL", "repositoryUsername", "title", "tlsskipVerify", "type", "variables"]
+
+    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 CustomtemplatesCustomTemplateFromGitRepositoryPayload 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 variables (list)
+        _items = []
+        if self.variables:
+            for _item_variables in self.variables:
+                if _item_variables:
+                    _items.append(_item_variables.to_dict())
+            _dict['variables'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CustomtemplatesCustomTemplateFromGitRepositoryPayload from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "composeFilePathInRepository": obj.get("composeFilePathInRepository") if obj.get("composeFilePathInRepository") is not None else 'docker-compose.yml',
+            "description": obj.get("description"),
+            "edgeTemplate": obj.get("edgeTemplate"),
+            "isComposeFormat": obj.get("isComposeFormat"),
+            "logo": obj.get("logo"),
+            "note": obj.get("note"),
+            "platform": obj.get("platform"),
+            "repositoryAuthentication": obj.get("repositoryAuthentication"),
+            "repositoryPassword": obj.get("repositoryPassword"),
+            "repositoryReferenceName": obj.get("repositoryReferenceName"),
+            "repositoryURL": obj.get("repositoryURL"),
+            "repositoryUsername": obj.get("repositoryUsername"),
+            "title": obj.get("title"),
+            "tlsskipVerify": obj.get("tlsskipVerify"),
+            "type": obj.get("type"),
+            "variables": [PortainerCustomTemplateVariableDefinition.from_dict(_item) for _item in obj["variables"]] if obj.get("variables") is not None else None
+        })
+        return _obj
+
+

ptctools/portainer_client/openapi_client/models/customtemplates_custom_template_update_payload.py

@@ -0,0 +1,135 @@
+# 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_git_credential_auth_type import GittypesGitCredentialAuthType
+from openapi_client.models.portainer_custom_template_platform import PortainerCustomTemplatePlatform
+from openapi_client.models.portainer_custom_template_variable_definition import PortainerCustomTemplateVariableDefinition
+from openapi_client.models.portainer_stack_type import PortainerStackType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CustomtemplatesCustomTemplateUpdatePayload(BaseModel):
+    """
+    CustomtemplatesCustomTemplateUpdatePayload
+    """ # noqa: E501
+    compose_file_path_in_repository: Optional[StrictStr] = Field(default='docker-compose.yml', description="Path to the Stack file inside the Git repository", alias="composeFilePathInRepository")
+    description: StrictStr = Field(description="Description of the template")
+    edge_template: Optional[StrictBool] = Field(default=None, description="EdgeTemplate indicates if this template purpose for Edge Stack", alias="edgeTemplate")
+    file_content: StrictStr = Field(description="Content of stack file", alias="fileContent")
+    is_compose_format: Optional[StrictBool] = Field(default=None, description="IsComposeFormat indicates if the Kubernetes template is created from a Docker Compose file", alias="isComposeFormat")
+    logo: Optional[StrictStr] = Field(default=None, description="URL of the template's logo")
+    note: Optional[StrictStr] = Field(default=None, description="A note that will be displayed in the UI. Supports HTML content")
+    platform: Optional[PortainerCustomTemplatePlatform] = Field(default=None, description="Platform associated to the template. Valid values are: 1 - 'linux', 2 - 'windows' Required for Docker stacks")
+    repository_authentication: Optional[StrictBool] = Field(default=None, description="Use authentication to clone the Git repository", alias="repositoryAuthentication")
+    repository_authorization_type: Optional[GittypesGitCredentialAuthType] = Field(default=None, description="RepositoryAuthorizationType is the authorization type to use", alias="repositoryAuthorizationType")
+    repository_git_credential_id: Optional[StrictInt] = Field(default=None, description="GitCredentialID used to identify the bound git credential. Required when RepositoryAuthentication is true and RepositoryUsername/RepositoryPassword are not provided", alias="repositoryGitCredentialID")
+    repository_password: Optional[StrictStr] = Field(default=None, description="Password used in basic authentication or token used in token authentication. Required when RepositoryAuthentication is true and RepositoryGitCredentialID is 0", alias="repositoryPassword")
+    repository_reference_name: Optional[StrictStr] = Field(default=None, description="Reference name of a Git repository hosting the Stack file", alias="repositoryReferenceName")
+    repository_url: StrictStr = Field(description="URL of a Git repository hosting the Stack file", alias="repositoryURL")
+    repository_username: Optional[StrictStr] = Field(default=None, description="Username used in basic authentication. Required when RepositoryAuthentication is true and RepositoryGitCredentialID is 0. Ignored if RepositoryAuthType is token", alias="repositoryUsername")
+    title: StrictStr = Field(description="Title of the template")
+    tlsskip_verify: Optional[StrictBool] = Field(default=None, description="TLSSkipVerify skips SSL verification when cloning the Git repository", alias="tlsskipVerify")
+    type: PortainerStackType = Field(description="Type of created stack (1 - swarm, 2 - compose, 3 - kubernetes)")
+    variables: Optional[List[PortainerCustomTemplateVariableDefinition]] = Field(default=None, description="Definitions of variables in the stack file")
+    __properties: ClassVar[List[str]] = ["composeFilePathInRepository", "description", "edgeTemplate", "fileContent", "isComposeFormat", "logo", "note", "platform", "repositoryAuthentication", "repositoryAuthorizationType", "repositoryGitCredentialID", "repositoryPassword", "repositoryReferenceName", "repositoryURL", "repositoryUsername", "title", "tlsskipVerify", "type", "variables"]
+
+    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 CustomtemplatesCustomTemplateUpdatePayload 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 variables (list)
+        _items = []
+        if self.variables:
+            for _item_variables in self.variables:
+                if _item_variables:
+                    _items.append(_item_variables.to_dict())
+            _dict['variables'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CustomtemplatesCustomTemplateUpdatePayload from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "composeFilePathInRepository": obj.get("composeFilePathInRepository") if obj.get("composeFilePathInRepository") is not None else 'docker-compose.yml',
+            "description": obj.get("description"),
+            "edgeTemplate": obj.get("edgeTemplate"),
+            "fileContent": obj.get("fileContent"),
+            "isComposeFormat": obj.get("isComposeFormat"),
+            "logo": obj.get("logo"),
+            "note": obj.get("note"),
+            "platform": obj.get("platform"),
+            "repositoryAuthentication": obj.get("repositoryAuthentication"),
+            "repositoryAuthorizationType": obj.get("repositoryAuthorizationType"),
+            "repositoryGitCredentialID": obj.get("repositoryGitCredentialID"),
+            "repositoryPassword": obj.get("repositoryPassword"),
+            "repositoryReferenceName": obj.get("repositoryReferenceName"),
+            "repositoryURL": obj.get("repositoryURL"),
+            "repositoryUsername": obj.get("repositoryUsername"),
+            "title": obj.get("title"),
+            "tlsskipVerify": obj.get("tlsskipVerify"),
+            "type": obj.get("type"),
+            "variables": [PortainerCustomTemplateVariableDefinition.from_dict(_item) for _item in obj["variables"]] if obj.get("variables") is not None else None
+        })
+        return _obj
+
+

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

ptctools/portainer_client/openapi_client/models/docker_container_stats.py

@@ -0,0 +1,96 @@
+# 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, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DockerContainerStats(BaseModel):
+    """
+    DockerContainerStats
+    """ # noqa: E501
+    healthy: Optional[StrictInt] = None
+    running: Optional[StrictInt] = None
+    stopped: Optional[StrictInt] = None
+    total: Optional[StrictInt] = None
+    unhealthy: Optional[StrictInt] = None
+    __properties: ClassVar[List[str]] = ["healthy", "running", "stopped", "total", "unhealthy"]
+
+    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 DockerContainerStats 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 DockerContainerStats from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "healthy": obj.get("healthy"),
+            "running": obj.get("running"),
+            "stopped": obj.get("stopped"),
+            "total": obj.get("total"),
+            "unhealthy": obj.get("unhealthy")
+        })
+        return _obj
+
+