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

ptctools/portainer_client/openapi_client/models/kubernetes_k8s_persistent_volume.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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from openapi_client.models.resource_quantity import ResourceQuantity
+from openapi_client.models.v1_csi_persistent_volume_source import V1CSIPersistentVolumeSource
+from openapi_client.models.v1_object_reference import V1ObjectReference
+from openapi_client.models.v1_persistent_volume_access_mode import V1PersistentVolumeAccessMode
+from openapi_client.models.v1_persistent_volume_mode import V1PersistentVolumeMode
+from openapi_client.models.v1_persistent_volume_reclaim_policy import V1PersistentVolumeReclaimPolicy
+from typing import Optional, Set
+from typing_extensions import Self
+
+class KubernetesK8sPersistentVolume(BaseModel):
+    """
+    KubernetesK8sPersistentVolume
+    """ # noqa: E501
+    access_modes: Optional[List[V1PersistentVolumeAccessMode]] = Field(default=None, alias="accessModes")
+    annotations: Optional[Dict[str, StrictStr]] = None
+    capacity: Optional[Dict[str, ResourceQuantity]] = None
+    claim_ref: Optional[V1ObjectReference] = Field(default=None, alias="claimRef")
+    csi: Optional[V1CSIPersistentVolumeSource] = None
+    name: Optional[StrictStr] = None
+    persistent_volume_reclaim_policy: Optional[V1PersistentVolumeReclaimPolicy] = Field(default=None, alias="persistentVolumeReclaimPolicy")
+    storage_class_name: Optional[StrictStr] = Field(default=None, alias="storageClassName")
+    volume_mode: Optional[V1PersistentVolumeMode] = Field(default=None, alias="volumeMode")
+    __properties: ClassVar[List[str]] = ["accessModes", "annotations", "capacity", "claimRef", "csi", "name", "persistentVolumeReclaimPolicy", "storageClassName", "volumeMode"]
+
+    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 KubernetesK8sPersistentVolume 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 value in capacity (dict)
+        _field_dict = {}
+        if self.capacity:
+            for _key_capacity in self.capacity:
+                if self.capacity[_key_capacity]:
+                    _field_dict[_key_capacity] = self.capacity[_key_capacity].to_dict()
+            _dict['capacity'] = _field_dict
+        # override the default output from pydantic by calling `to_dict()` of claim_ref
+        if self.claim_ref:
+            _dict['claimRef'] = self.claim_ref.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of csi
+        if self.csi:
+            _dict['csi'] = self.csi.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of KubernetesK8sPersistentVolume from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "accessModes": obj.get("accessModes"),
+            "annotations": obj.get("annotations"),
+            "capacity": dict(
+                (_k, ResourceQuantity.from_dict(_v))
+                for _k, _v in obj["capacity"].items()
+            )
+            if obj.get("capacity") is not None
+            else None,
+            "claimRef": V1ObjectReference.from_dict(obj["claimRef"]) if obj.get("claimRef") is not None else None,
+            "csi": V1CSIPersistentVolumeSource.from_dict(obj["csi"]) if obj.get("csi") is not None else None,
+            "name": obj.get("name"),
+            "persistentVolumeReclaimPolicy": obj.get("persistentVolumeReclaimPolicy"),
+            "storageClassName": obj.get("storageClassName"),
+            "volumeMode": obj.get("volumeMode")
+        })
+        return _obj
+
+

ptctools/portainer_client/openapi_client/models/kubernetes_k8s_persistent_volume_claim.py

@@ -0,0 +1,136 @@
+# 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 openapi_client.models.kubernetes_k8s_application import KubernetesK8sApplication
+from openapi_client.models.resource_quantity import ResourceQuantity
+from openapi_client.models.v1_persistent_volume_access_mode import V1PersistentVolumeAccessMode
+from openapi_client.models.v1_persistent_volume_claim_phase import V1PersistentVolumeClaimPhase
+from openapi_client.models.v1_persistent_volume_mode import V1PersistentVolumeMode
+from typing import Optional, Set
+from typing_extensions import Self
+
+class KubernetesK8sPersistentVolumeClaim(BaseModel):
+    """
+    KubernetesK8sPersistentVolumeClaim
+    """ # noqa: E501
+    access_modes: Optional[List[V1PersistentVolumeAccessMode]] = Field(default=None, alias="accessModes")
+    creation_date: Optional[StrictStr] = Field(default=None, alias="creationDate")
+    id: Optional[StrictStr] = None
+    labels: Optional[Dict[str, StrictStr]] = None
+    name: Optional[StrictStr] = None
+    namespace: Optional[StrictStr] = None
+    owning_applications: Optional[List[KubernetesK8sApplication]] = Field(default=None, alias="owningApplications")
+    phase: Optional[V1PersistentVolumeClaimPhase] = None
+    resources_requests: Optional[Dict[str, ResourceQuantity]] = Field(default=None, alias="resourcesRequests")
+    storage: Optional[StrictInt] = None
+    storage_class: Optional[StrictStr] = Field(default=None, alias="storageClass")
+    volume_mode: Optional[V1PersistentVolumeMode] = Field(default=None, alias="volumeMode")
+    volume_name: Optional[StrictStr] = Field(default=None, alias="volumeName")
+    __properties: ClassVar[List[str]] = ["accessModes", "creationDate", "id", "labels", "name", "namespace", "owningApplications", "phase", "resourcesRequests", "storage", "storageClass", "volumeMode", "volumeName"]
+
+    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 KubernetesK8sPersistentVolumeClaim 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 owning_applications (list)
+        _items = []
+        if self.owning_applications:
+            for _item_owning_applications in self.owning_applications:
+                if _item_owning_applications:
+                    _items.append(_item_owning_applications.to_dict())
+            _dict['owningApplications'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each value in resources_requests (dict)
+        _field_dict = {}
+        if self.resources_requests:
+            for _key_resources_requests in self.resources_requests:
+                if self.resources_requests[_key_resources_requests]:
+                    _field_dict[_key_resources_requests] = self.resources_requests[_key_resources_requests].to_dict()
+            _dict['resourcesRequests'] = _field_dict
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of KubernetesK8sPersistentVolumeClaim from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "accessModes": obj.get("accessModes"),
+            "creationDate": obj.get("creationDate"),
+            "id": obj.get("id"),
+            "labels": obj.get("labels"),
+            "name": obj.get("name"),
+            "namespace": obj.get("namespace"),
+            "owningApplications": [KubernetesK8sApplication.from_dict(_item) for _item in obj["owningApplications"]] if obj.get("owningApplications") is not None else None,
+            "phase": obj.get("phase"),
+            "resourcesRequests": dict(
+                (_k, ResourceQuantity.from_dict(_v))
+                for _k, _v in obj["resourcesRequests"].items()
+            )
+            if obj.get("resourcesRequests") is not None
+            else None,
+            "storage": obj.get("storage"),
+            "storageClass": obj.get("storageClass"),
+            "volumeMode": obj.get("volumeMode"),
+            "volumeName": obj.get("volumeName")
+        })
+        return _obj
+
+

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

ptctools/portainer_client/openapi_client/models/kubernetes_k8s_role.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, Field, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class KubernetesK8sRole(BaseModel):
+    """
+    KubernetesK8sRole
+    """ # noqa: E501
+    creation_date: Optional[StrictStr] = Field(default=None, alias="creationDate")
+    is_system: Optional[StrictBool] = Field(default=None, description="isSystem is true if prefixed with \"system:\" or exists in the kube-system namespace or is one of the portainer roles", alias="isSystem")
+    name: Optional[StrictStr] = None
+    namespace: Optional[StrictStr] = None
+    uid: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["creationDate", "isSystem", "name", "namespace", "uid"]
+
+    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 KubernetesK8sRole 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 KubernetesK8sRole from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "creationDate": obj.get("creationDate"),
+            "isSystem": obj.get("isSystem"),
+            "name": obj.get("name"),
+            "namespace": obj.get("namespace"),
+            "uid": obj.get("uid")
+        })
+        return _obj
+
+

ptctools/portainer_client/openapi_client/models/kubernetes_k8s_role_binding.py

@@ -0,0 +1,112 @@
+# 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.k8s_io_api_rbac_v1_subject import K8sIoApiRbacV1Subject
+from openapi_client.models.v1_role_ref import V1RoleRef
+from typing import Optional, Set
+from typing_extensions import Self
+
+class KubernetesK8sRoleBinding(BaseModel):
+    """
+    KubernetesK8sRoleBinding
+    """ # noqa: E501
+    creation_date: Optional[StrictStr] = Field(default=None, alias="creationDate")
+    is_system: Optional[StrictBool] = Field(default=None, alias="isSystem")
+    name: Optional[StrictStr] = None
+    namespace: Optional[StrictStr] = None
+    role_ref: Optional[V1RoleRef] = Field(default=None, alias="roleRef")
+    subjects: Optional[List[K8sIoApiRbacV1Subject]] = None
+    uid: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["creationDate", "isSystem", "name", "namespace", "roleRef", "subjects", "uid"]
+
+    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 KubernetesK8sRoleBinding 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 role_ref
+        if self.role_ref:
+            _dict['roleRef'] = self.role_ref.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in subjects (list)
+        _items = []
+        if self.subjects:
+            for _item_subjects in self.subjects:
+                if _item_subjects:
+                    _items.append(_item_subjects.to_dict())
+            _dict['subjects'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of KubernetesK8sRoleBinding from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "creationDate": obj.get("creationDate"),
+            "isSystem": obj.get("isSystem"),
+            "name": obj.get("name"),
+            "namespace": obj.get("namespace"),
+            "roleRef": V1RoleRef.from_dict(obj["roleRef"]) if obj.get("roleRef") is not None else None,
+            "subjects": [K8sIoApiRbacV1Subject.from_dict(_item) for _item in obj["subjects"]] if obj.get("subjects") is not None else None,
+            "uid": obj.get("uid")
+        })
+        return _obj
+
+