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

ptctools/portainer_client/openapi_client/models/__init__.py

@@ -0,0 +1,389 @@
+# coding: utf-8
+
+# flake8: noqa
+"""
+    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
+
+# import models into model package
+from openapi_client.models.auth_authenticate_payload import AuthAuthenticatePayload
+from openapi_client.models.auth_authenticate_response import AuthAuthenticateResponse
+from openapi_client.models.auth_oauth_payload import AuthOauthPayload
+from openapi_client.models.backup_backup_payload import BackupBackupPayload
+from openapi_client.models.backup_restore_payload import BackupRestorePayload
+from openapi_client.models.build_build_info import BuildBuildInfo
+from openapi_client.models.build_dependencies_info import BuildDependenciesInfo
+from openapi_client.models.build_runtime_info import BuildRuntimeInfo
+from openapi_client.models.containers_container_gpus_response import ContainersContainerGpusResponse
+from openapi_client.models.customtemplates_custom_template_from_file_content_payload import CustomtemplatesCustomTemplateFromFileContentPayload
+from openapi_client.models.customtemplates_custom_template_from_git_repository_payload import CustomtemplatesCustomTemplateFromGitRepositoryPayload
+from openapi_client.models.customtemplates_custom_template_update_payload import CustomtemplatesCustomTemplateUpdatePayload
+from openapi_client.models.customtemplates_file_response import CustomtemplatesFileResponse
+from openapi_client.models.docker_container_stats import DockerContainerStats
+from openapi_client.models.docker_dashboard_response import DockerDashboardResponse
+from openapi_client.models.docker_images_counters import DockerImagesCounters
+from openapi_client.models.edge_deployer_options_payload import EdgeDeployerOptionsPayload
+from openapi_client.models.edge_registry_credentials import EdgeRegistryCredentials
+from openapi_client.models.edge_stack_payload import EdgeStackPayload
+from openapi_client.models.edgegroups_decorated_edge_group import EdgegroupsDecoratedEdgeGroup
+from openapi_client.models.edgegroups_edge_group_create_payload import EdgegroupsEdgeGroupCreatePayload
+from openapi_client.models.edgegroups_edge_group_update_payload import EdgegroupsEdgeGroupUpdatePayload
+from openapi_client.models.edgejobs_edge_job_create_from_file_content_payload import EdgejobsEdgeJobCreateFromFileContentPayload
+from openapi_client.models.edgejobs_edge_job_file_response import EdgejobsEdgeJobFileResponse
+from openapi_client.models.edgejobs_edge_job_update_payload import EdgejobsEdgeJobUpdatePayload
+from openapi_client.models.edgejobs_file_response import EdgejobsFileResponse
+from openapi_client.models.edgejobs_task_container import EdgejobsTaskContainer
+from openapi_client.models.edgestacks_edge_stack_from_git_repository_payload import EdgestacksEdgeStackFromGitRepositoryPayload
+from openapi_client.models.edgestacks_edge_stack_from_string_payload import EdgestacksEdgeStackFromStringPayload
+from openapi_client.models.edgestacks_stack_file_response import EdgestacksStackFileResponse
+from openapi_client.models.edgestacks_update_edge_stack_payload import EdgestacksUpdateEdgeStackPayload
+from openapi_client.models.edgestacks_update_status_payload import EdgestacksUpdateStatusPayload
+from openapi_client.models.endpointedge_edge_job_response import EndpointedgeEdgeJobResponse
+from openapi_client.models.endpointedge_endpoint_edge_status_inspect_response import EndpointedgeEndpointEdgeStatusInspectResponse
+from openapi_client.models.endpointedge_stack_status_response import EndpointedgeStackStatusResponse
+from openapi_client.models.endpointgroups_endpoint_group_create_payload import EndpointgroupsEndpointGroupCreatePayload
+from openapi_client.models.endpointgroups_endpoint_group_update_payload import EndpointgroupsEndpointGroupUpdatePayload
+from openapi_client.models.endpoints_dockerhub_status_response import EndpointsDockerhubStatusResponse
+from openapi_client.models.endpoints_endpoint_create_global_key_response import EndpointsEndpointCreateGlobalKeyResponse
+from openapi_client.models.endpoints_endpoint_delete_batch_partial_response import EndpointsEndpointDeleteBatchPartialResponse
+from openapi_client.models.endpoints_endpoint_delete_batch_payload import EndpointsEndpointDeleteBatchPayload
+from openapi_client.models.endpoints_endpoint_delete_request import EndpointsEndpointDeleteRequest
+from openapi_client.models.endpoints_endpoint_settings_update_payload import EndpointsEndpointSettingsUpdatePayload
+from openapi_client.models.endpoints_endpoint_update_payload import EndpointsEndpointUpdatePayload
+from openapi_client.models.endpoints_endpoint_update_relations_payload import EndpointsEndpointUpdateRelationsPayload
+from openapi_client.models.endpoints_endpoint_update_relations_payload_relations_value import EndpointsEndpointUpdateRelationsPayloadRelationsValue
+from openapi_client.models.endpoints_force_update_service_payload import EndpointsForceUpdateServicePayload
+from openapi_client.models.endpoints_registry_access_payload import EndpointsRegistryAccessPayload
+from openapi_client.models.filesystem_dir_entry import FilesystemDirEntry
+from openapi_client.models.github_com_portainer_portainer_pkg_libhelm_release_hook import GithubComPortainerPortainerPkgLibhelmReleaseHook
+from openapi_client.models.github_com_portainer_portainer_pkg_libhelm_release_hook_execution import GithubComPortainerPortainerPkgLibhelmReleaseHookExecution
+from openapi_client.models.github_com_portainer_portainer_pkg_libhelm_release_info import GithubComPortainerPortainerPkgLibhelmReleaseInfo
+from openapi_client.models.github_com_portainer_portainer_pkg_libhelm_release_release import GithubComPortainerPortainerPkgLibhelmReleaseRelease
+from openapi_client.models.gitops_file_response import GitopsFileResponse
+from openapi_client.models.gitops_repository_file_preview_payload import GitopsRepositoryFilePreviewPayload
+from openapi_client.models.gittypes_git_authentication import GittypesGitAuthentication
+from openapi_client.models.gittypes_git_credential_auth_type import GittypesGitCredentialAuthType
+from openapi_client.models.gittypes_repo_config import GittypesRepoConfig
+from openapi_client.models.helm_install_chart_payload import HelmInstallChartPayload
+from openapi_client.models.images_image_response import ImagesImageResponse
+from openapi_client.models.intstr_int_or_string import IntstrIntOrString
+from openapi_client.models.intstr_type import IntstrType
+from openapi_client.models.k8s_io_api_core_v1_condition_status import K8sIoApiCoreV1ConditionStatus
+from openapi_client.models.k8s_io_api_rbac_v1_subject import K8sIoApiRbacV1Subject
+from openapi_client.models.k8s_io_apimachinery_pkg_apis_meta_v1_condition_status import K8sIoApimachineryPkgApisMetaV1ConditionStatus
+from openapi_client.models.kubernetes_configuration import KubernetesConfiguration
+from openapi_client.models.kubernetes_custom_resource_metadata import KubernetesCustomResourceMetadata
+from openapi_client.models.kubernetes_describe_resource_response import KubernetesDescribeResourceResponse
+from openapi_client.models.kubernetes_ingress_rule import KubernetesIngressRule
+from openapi_client.models.kubernetes_k8s_application import KubernetesK8sApplication
+from openapi_client.models.kubernetes_k8s_application_resource import KubernetesK8sApplicationResource
+from openapi_client.models.kubernetes_k8s_cluster_role import KubernetesK8sClusterRole
+from openapi_client.models.kubernetes_k8s_cluster_role_binding import KubernetesK8sClusterRoleBinding
+from openapi_client.models.kubernetes_k8s_config_map import KubernetesK8sConfigMap
+from openapi_client.models.kubernetes_k8s_configuration_owner_resource import KubernetesK8sConfigurationOwnerResource
+from openapi_client.models.kubernetes_k8s_cron_job import KubernetesK8sCronJob
+from openapi_client.models.kubernetes_k8s_dashboard import KubernetesK8sDashboard
+from openapi_client.models.kubernetes_k8s_event import KubernetesK8sEvent
+from openapi_client.models.kubernetes_k8s_event_involved_object import KubernetesK8sEventInvolvedObject
+from openapi_client.models.kubernetes_k8s_ingress_controller import KubernetesK8sIngressController
+from openapi_client.models.kubernetes_k8s_ingress_info import KubernetesK8sIngressInfo
+from openapi_client.models.kubernetes_k8s_ingress_path import KubernetesK8sIngressPath
+from openapi_client.models.kubernetes_k8s_ingress_tls import KubernetesK8sIngressTLS
+from openapi_client.models.kubernetes_k8s_job import KubernetesK8sJob
+from openapi_client.models.kubernetes_k8s_namespace_details import KubernetesK8sNamespaceDetails
+from openapi_client.models.kubernetes_k8s_persistent_volume import KubernetesK8sPersistentVolume
+from openapi_client.models.kubernetes_k8s_persistent_volume_claim import KubernetesK8sPersistentVolumeClaim
+from openapi_client.models.kubernetes_k8s_resource_quota import KubernetesK8sResourceQuota
+from openapi_client.models.kubernetes_k8s_role import KubernetesK8sRole
+from openapi_client.models.kubernetes_k8s_role_binding import KubernetesK8sRoleBinding
+from openapi_client.models.kubernetes_k8s_secret import KubernetesK8sSecret
+from openapi_client.models.kubernetes_k8s_service_account import KubernetesK8sServiceAccount
+from openapi_client.models.kubernetes_k8s_service_info import KubernetesK8sServiceInfo
+from openapi_client.models.kubernetes_k8s_service_ingress import KubernetesK8sServiceIngress
+from openapi_client.models.kubernetes_k8s_service_port import KubernetesK8sServicePort
+from openapi_client.models.kubernetes_k8s_storage_class import KubernetesK8sStorageClass
+from openapi_client.models.kubernetes_k8s_volume_info import KubernetesK8sVolumeInfo
+from openapi_client.models.kubernetes_metadata import KubernetesMetadata
+from openapi_client.models.kubernetes_namespaces_toggle_system_payload import KubernetesNamespacesToggleSystemPayload
+from openapi_client.models.kubernetes_pod import KubernetesPod
+from openapi_client.models.kubernetes_published_port import KubernetesPublishedPort
+from openapi_client.models.kubernetes_tls_info import KubernetesTLSInfo
+from openapi_client.models.ldap_check_payload import LdapCheckPayload
+from openapi_client.models.motd_motd_response import MotdMotdResponse
+from openapi_client.models.oauth2_auth_style import Oauth2AuthStyle
+from openapi_client.models.openamt_device_action_payload import OpenamtDeviceActionPayload
+from openapi_client.models.openamt_device_features_payload import OpenamtDeviceFeaturesPayload
+from openapi_client.models.openamt_open_amt_configure_payload import OpenamtOpenAMTConfigurePayload
+from openapi_client.models.os_file_mode import OsFileMode
+from openapi_client.models.platform_container_platform import PlatformContainerPlatform
+from openapi_client.models.portainer_api_key import PortainerAPIKey
+from openapi_client.models.portainer_access_policy import PortainerAccessPolicy
+from openapi_client.models.portainer_authentication_method import PortainerAuthenticationMethod
+from openapi_client.models.portainer_auto_update_settings import PortainerAutoUpdateSettings
+from openapi_client.models.portainer_azure_credentials import PortainerAzureCredentials
+from openapi_client.models.portainer_custom_template import PortainerCustomTemplate
+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_diagnostics_data import PortainerDiagnosticsData
+from openapi_client.models.portainer_docker_snapshot import PortainerDockerSnapshot
+from openapi_client.models.portainer_ecr_data import PortainerEcrData
+from openapi_client.models.portainer_edge import PortainerEdge
+from openapi_client.models.portainer_edge_group import PortainerEdgeGroup
+from openapi_client.models.portainer_edge_job import PortainerEdgeJob
+from openapi_client.models.portainer_edge_job_endpoint_meta import PortainerEdgeJobEndpointMeta
+from openapi_client.models.portainer_edge_job_logs_status import PortainerEdgeJobLogsStatus
+from openapi_client.models.portainer_edge_stack import PortainerEdgeStack
+from openapi_client.models.portainer_edge_stack_deployment_status import PortainerEdgeStackDeploymentStatus
+from openapi_client.models.portainer_edge_stack_deployment_type import PortainerEdgeStackDeploymentType
+from openapi_client.models.portainer_edge_stack_status import PortainerEdgeStackStatus
+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_endpoint import PortainerEndpoint
+from openapi_client.models.portainer_endpoint_agent import PortainerEndpointAgent
+from openapi_client.models.portainer_endpoint_group import PortainerEndpointGroup
+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_github_registry_data import PortainerGithubRegistryData
+from openapi_client.models.portainer_gitlab_registry_data import PortainerGitlabRegistryData
+from openapi_client.models.portainer_global_deployment_options import PortainerGlobalDeploymentOptions
+from openapi_client.models.portainer_helm_user_repository import PortainerHelmUserRepository
+from openapi_client.models.portainer_internal_auth_settings import PortainerInternalAuthSettings
+from openapi_client.models.portainer_k8s_namespace_info import PortainerK8sNamespaceInfo
+from openapi_client.models.portainer_k8s_node_limits import PortainerK8sNodeLimits
+from openapi_client.models.portainer_kubernetes_configuration import PortainerKubernetesConfiguration
+from openapi_client.models.portainer_kubernetes_data import PortainerKubernetesData
+from openapi_client.models.portainer_kubernetes_flags import PortainerKubernetesFlags
+from openapi_client.models.portainer_kubernetes_ingress_class_config import PortainerKubernetesIngressClassConfig
+from openapi_client.models.portainer_kubernetes_snapshot import PortainerKubernetesSnapshot
+from openapi_client.models.portainer_kubernetes_storage_class_config import PortainerKubernetesStorageClassConfig
+from openapi_client.models.portainer_ldap_group_search_settings import PortainerLDAPGroupSearchSettings
+from openapi_client.models.portainer_ldap_search_settings import PortainerLDAPSearchSettings
+from openapi_client.models.portainer_ldap_settings import PortainerLDAPSettings
+from openapi_client.models.portainer_membership_role import PortainerMembershipRole
+from openapi_client.models.portainer_o_auth_settings import PortainerOAuthSettings
+from openapi_client.models.portainer_open_amt_configuration import PortainerOpenAMTConfiguration
+from openapi_client.models.portainer_open_amt_device_enabled_features import PortainerOpenAMTDeviceEnabledFeatures
+from openapi_client.models.portainer_pair import PortainerPair
+from openapi_client.models.portainer_performance_metrics import PortainerPerformanceMetrics
+from openapi_client.models.portainer_quay_registry_data import PortainerQuayRegistryData
+from openapi_client.models.portainer_registry import PortainerRegistry
+from openapi_client.models.portainer_registry_access_policies import PortainerRegistryAccessPolicies
+from openapi_client.models.portainer_registry_management_configuration import PortainerRegistryManagementConfiguration
+from openapi_client.models.portainer_registry_type import PortainerRegistryType
+from openapi_client.models.portainer_resource_access_level import PortainerResourceAccessLevel
+from openapi_client.models.portainer_resource_control import PortainerResourceControl
+from openapi_client.models.portainer_resource_control_type import PortainerResourceControlType
+from openapi_client.models.portainer_role import PortainerRole
+from openapi_client.models.portainer_ssl_settings import PortainerSSLSettings
+from openapi_client.models.portainer_settings import PortainerSettings
+from openapi_client.models.portainer_stack import PortainerStack
+from openapi_client.models.portainer_stack_deployment_info import PortainerStackDeploymentInfo
+from openapi_client.models.portainer_stack_option import PortainerStackOption
+from openapi_client.models.portainer_stack_status import PortainerStackStatus
+from openapi_client.models.portainer_stack_type import PortainerStackType
+from openapi_client.models.portainer_tls_configuration import PortainerTLSConfiguration
+from openapi_client.models.portainer_tag import PortainerTag
+from openapi_client.models.portainer_team import PortainerTeam
+from openapi_client.models.portainer_team_membership import PortainerTeamMembership
+from openapi_client.models.portainer_team_resource_access import PortainerTeamResourceAccess
+from openapi_client.models.portainer_template import PortainerTemplate
+from openapi_client.models.portainer_template_env import PortainerTemplateEnv
+from openapi_client.models.portainer_template_env_select import PortainerTemplateEnvSelect
+from openapi_client.models.portainer_template_repository import PortainerTemplateRepository
+from openapi_client.models.portainer_template_type import PortainerTemplateType
+from openapi_client.models.portainer_template_volume import PortainerTemplateVolume
+from openapi_client.models.portainer_user import PortainerUser
+from openapi_client.models.portainer_user_resource_access import PortainerUserResourceAccess
+from openapi_client.models.portainer_user_role import PortainerUserRole
+from openapi_client.models.portainer_user_theme_settings import PortainerUserThemeSettings
+from openapi_client.models.portainer_webhook import PortainerWebhook
+from openapi_client.models.portainer_webhook_type import PortainerWebhookType
+from openapi_client.models.registries_registry_configure_payload import RegistriesRegistryConfigurePayload
+from openapi_client.models.registries_registry_create_payload import RegistriesRegistryCreatePayload
+from openapi_client.models.registries_registry_update_payload import RegistriesRegistryUpdatePayload
+from openapi_client.models.release_chart import ReleaseChart
+from openapi_client.models.release_chart_reference import ReleaseChartReference
+from openapi_client.models.release_dependency import ReleaseDependency
+from openapi_client.models.release_file import ReleaseFile
+from openapi_client.models.release_lock import ReleaseLock
+from openapi_client.models.release_maintainer import ReleaseMaintainer
+from openapi_client.models.release_metadata import ReleaseMetadata
+from openapi_client.models.release_release_element import ReleaseReleaseElement
+from openapi_client.models.release_values import ReleaseValues
+from openapi_client.models.resource_quantity import ResourceQuantity
+from openapi_client.models.resourcecontrols_resource_control_create_payload import ResourcecontrolsResourceControlCreatePayload
+from openapi_client.models.resourcecontrols_resource_control_update_payload import ResourcecontrolsResourceControlUpdatePayload
+from openapi_client.models.settings_public_settings_response import SettingsPublicSettingsResponse
+from openapi_client.models.settings_public_settings_response_edge import SettingsPublicSettingsResponseEdge
+from openapi_client.models.settings_settings_update_payload import SettingsSettingsUpdatePayload
+from openapi_client.models.ssl_ssl_update_payload import SslSslUpdatePayload
+from openapi_client.models.stacks_compose_stack_from_file_content_payload import StacksComposeStackFromFileContentPayload
+from openapi_client.models.stacks_compose_stack_from_git_repository_payload import StacksComposeStackFromGitRepositoryPayload
+from openapi_client.models.stacks_kubernetes_git_deployment_payload import StacksKubernetesGitDeploymentPayload
+from openapi_client.models.stacks_kubernetes_manifest_url_deployment_payload import StacksKubernetesManifestURLDeploymentPayload
+from openapi_client.models.stacks_kubernetes_string_deployment_payload import StacksKubernetesStringDeploymentPayload
+from openapi_client.models.stacks_stack_file_response import StacksStackFileResponse
+from openapi_client.models.stacks_stack_git_redploy_payload import StacksStackGitRedployPayload
+from openapi_client.models.stacks_stack_git_update_payload import StacksStackGitUpdatePayload
+from openapi_client.models.stacks_stack_migrate_payload import StacksStackMigratePayload
+from openapi_client.models.stacks_swarm_stack_from_file_content_payload import StacksSwarmStackFromFileContentPayload
+from openapi_client.models.stacks_swarm_stack_from_git_repository_payload import StacksSwarmStackFromGitRepositoryPayload
+from openapi_client.models.stacks_update_swarm_stack_payload import StacksUpdateSwarmStackPayload
+from openapi_client.models.swarm_service_update_response import SwarmServiceUpdateResponse
+from openapi_client.models.system_nodes_count_response import SystemNodesCountResponse
+from openapi_client.models.system_status import SystemStatus
+from openapi_client.models.system_system_info_response import SystemSystemInfoResponse
+from openapi_client.models.system_version_response import SystemVersionResponse
+from openapi_client.models.tags_tag_create_payload import TagsTagCreatePayload
+from openapi_client.models.teammemberships_team_membership_create_payload import TeammembershipsTeamMembershipCreatePayload
+from openapi_client.models.teammemberships_team_membership_update_payload import TeammembershipsTeamMembershipUpdatePayload
+from openapi_client.models.teams_team_create_payload import TeamsTeamCreatePayload
+from openapi_client.models.teams_team_update_payload import TeamsTeamUpdatePayload
+from openapi_client.models.templates_file_response import TemplatesFileResponse
+from openapi_client.models.templates_list_response import TemplatesListResponse
+from openapi_client.models.unstructured_unstructured import UnstructuredUnstructured
+from openapi_client.models.users_access_token_response import UsersAccessTokenResponse
+from openapi_client.models.users_add_helm_repo_url_payload import UsersAddHelmRepoUrlPayload
+from openapi_client.models.users_admin_init_payload import UsersAdminInitPayload
+from openapi_client.models.users_helm_user_repository_response import UsersHelmUserRepositoryResponse
+from openapi_client.models.users_theme_payload import UsersThemePayload
+from openapi_client.models.users_user_access_token_create_payload import UsersUserAccessTokenCreatePayload
+from openapi_client.models.users_user_create_payload import UsersUserCreatePayload
+from openapi_client.models.users_user_update_password_payload import UsersUserUpdatePasswordPayload
+from openapi_client.models.users_user_update_payload import UsersUserUpdatePayload
+from openapi_client.models.v1_app_armor_profile import V1AppArmorProfile
+from openapi_client.models.v1_app_armor_profile_type import V1AppArmorProfileType
+from openapi_client.models.v1_csi_persistent_volume_source import V1CSIPersistentVolumeSource
+from openapi_client.models.v1_capabilities import V1Capabilities
+from openapi_client.models.v1_client_ip_config import V1ClientIPConfig
+from openapi_client.models.v1_condition import V1Condition
+from openapi_client.models.v1_config_map_env_source import V1ConfigMapEnvSource
+from openapi_client.models.v1_config_map_key_selector import V1ConfigMapKeySelector
+from openapi_client.models.v1_container import V1Container
+from openapi_client.models.v1_container_port import V1ContainerPort
+from openapi_client.models.v1_container_resize_policy import V1ContainerResizePolicy
+from openapi_client.models.v1_container_restart_policy import V1ContainerRestartPolicy
+from openapi_client.models.v1_duration import V1Duration
+from openapi_client.models.v1_env_from_source import V1EnvFromSource
+from openapi_client.models.v1_env_var import V1EnvVar
+from openapi_client.models.v1_env_var_source import V1EnvVarSource
+from openapi_client.models.v1_exec_action import V1ExecAction
+from openapi_client.models.v1_grpc_action import V1GRPCAction
+from openapi_client.models.v1_http_get_action import V1HTTPGetAction
+from openapi_client.models.v1_http_header import V1HTTPHeader
+from openapi_client.models.v1_ip_family import V1IPFamily
+from openapi_client.models.v1_ip_family_policy import V1IPFamilyPolicy
+from openapi_client.models.v1_label_selector import V1LabelSelector
+from openapi_client.models.v1_label_selector_operator import V1LabelSelectorOperator
+from openapi_client.models.v1_label_selector_requirement import V1LabelSelectorRequirement
+from openapi_client.models.v1_lifecycle import V1Lifecycle
+from openapi_client.models.v1_lifecycle_handler import V1LifecycleHandler
+from openapi_client.models.v1_list_meta import V1ListMeta
+from openapi_client.models.v1_load_balancer_ip_mode import V1LoadBalancerIPMode
+from openapi_client.models.v1_load_balancer_ingress import V1LoadBalancerIngress
+from openapi_client.models.v1_load_balancer_status import V1LoadBalancerStatus
+from openapi_client.models.v1_managed_fields_entry import V1ManagedFieldsEntry
+from openapi_client.models.v1_managed_fields_operation_type import V1ManagedFieldsOperationType
+from openapi_client.models.v1_mount_propagation_mode import V1MountPropagationMode
+from openapi_client.models.v1_namespace_condition import V1NamespaceCondition
+from openapi_client.models.v1_namespace_condition_type import V1NamespaceConditionType
+from openapi_client.models.v1_namespace_phase import V1NamespacePhase
+from openapi_client.models.v1_namespace_status import V1NamespaceStatus
+from openapi_client.models.v1_object_field_selector import V1ObjectFieldSelector
+from openapi_client.models.v1_object_meta import V1ObjectMeta
+from openapi_client.models.v1_object_reference import V1ObjectReference
+from openapi_client.models.v1_owner_reference import V1OwnerReference
+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 openapi_client.models.v1_persistent_volume_reclaim_policy import V1PersistentVolumeReclaimPolicy
+from openapi_client.models.v1_port_status import V1PortStatus
+from openapi_client.models.v1_probe import V1Probe
+from openapi_client.models.v1_proc_mount_type import V1ProcMountType
+from openapi_client.models.v1_protocol import V1Protocol
+from openapi_client.models.v1_pull_policy import V1PullPolicy
+from openapi_client.models.v1_recursive_read_only_mode import V1RecursiveReadOnlyMode
+from openapi_client.models.v1_resource_claim import V1ResourceClaim
+from openapi_client.models.v1_resource_field_selector import V1ResourceFieldSelector
+from openapi_client.models.v1_resource_name import V1ResourceName
+from openapi_client.models.v1_resource_quota import V1ResourceQuota
+from openapi_client.models.v1_resource_quota_scope import V1ResourceQuotaScope
+from openapi_client.models.v1_resource_quota_spec import V1ResourceQuotaSpec
+from openapi_client.models.v1_resource_quota_status import V1ResourceQuotaStatus
+from openapi_client.models.v1_resource_requirements import V1ResourceRequirements
+from openapi_client.models.v1_resource_resize_restart_policy import V1ResourceResizeRestartPolicy
+from openapi_client.models.v1_role_ref import V1RoleRef
+from openapi_client.models.v1_se_linux_options import V1SELinuxOptions
+from openapi_client.models.v1_scope_selector import V1ScopeSelector
+from openapi_client.models.v1_scope_selector_operator import V1ScopeSelectorOperator
+from openapi_client.models.v1_scoped_resource_selector_requirement import V1ScopedResourceSelectorRequirement
+from openapi_client.models.v1_seccomp_profile import V1SeccompProfile
+from openapi_client.models.v1_seccomp_profile_type import V1SeccompProfileType
+from openapi_client.models.v1_secret_env_source import V1SecretEnvSource
+from openapi_client.models.v1_secret_key_selector import V1SecretKeySelector
+from openapi_client.models.v1_secret_reference import V1SecretReference
+from openapi_client.models.v1_security_context import V1SecurityContext
+from openapi_client.models.v1_service import V1Service
+from openapi_client.models.v1_service_affinity import V1ServiceAffinity
+from openapi_client.models.v1_service_external_traffic_policy import V1ServiceExternalTrafficPolicy
+from openapi_client.models.v1_service_internal_traffic_policy import V1ServiceInternalTrafficPolicy
+from openapi_client.models.v1_service_port import V1ServicePort
+from openapi_client.models.v1_service_spec import V1ServiceSpec
+from openapi_client.models.v1_service_status import V1ServiceStatus
+from openapi_client.models.v1_service_type import V1ServiceType
+from openapi_client.models.v1_session_affinity_config import V1SessionAffinityConfig
+from openapi_client.models.v1_signal import V1Signal
+from openapi_client.models.v1_sleep_action import V1SleepAction
+from openapi_client.models.v1_tcp_socket_action import V1TCPSocketAction
+from openapi_client.models.v1_termination_message_policy import V1TerminationMessagePolicy
+from openapi_client.models.v1_uri_scheme import V1URIScheme
+from openapi_client.models.v1_volume_device import V1VolumeDevice
+from openapi_client.models.v1_volume_mount import V1VolumeMount
+from openapi_client.models.v1_windows_security_context_options import V1WindowsSecurityContextOptions
+from openapi_client.models.v1beta1_container_metrics import V1beta1ContainerMetrics
+from openapi_client.models.v1beta1_node_metrics import V1beta1NodeMetrics
+from openapi_client.models.v1beta1_node_metrics_list import V1beta1NodeMetricsList
+from openapi_client.models.v1beta1_pod_metrics import V1beta1PodMetrics
+from openapi_client.models.v1beta1_pod_metrics_list import V1beta1PodMetricsList
+from openapi_client.models.v2_container_resource_metric_source import V2ContainerResourceMetricSource
+from openapi_client.models.v2_container_resource_metric_status import V2ContainerResourceMetricStatus
+from openapi_client.models.v2_cross_version_object_reference import V2CrossVersionObjectReference
+from openapi_client.models.v2_external_metric_source import V2ExternalMetricSource
+from openapi_client.models.v2_external_metric_status import V2ExternalMetricStatus
+from openapi_client.models.v2_hpa_scaling_policy import V2HPAScalingPolicy
+from openapi_client.models.v2_hpa_scaling_policy_type import V2HPAScalingPolicyType
+from openapi_client.models.v2_hpa_scaling_rules import V2HPAScalingRules
+from openapi_client.models.v2_horizontal_pod_autoscaler import V2HorizontalPodAutoscaler
+from openapi_client.models.v2_horizontal_pod_autoscaler_behavior import V2HorizontalPodAutoscalerBehavior
+from openapi_client.models.v2_horizontal_pod_autoscaler_condition import V2HorizontalPodAutoscalerCondition
+from openapi_client.models.v2_horizontal_pod_autoscaler_condition_type import V2HorizontalPodAutoscalerConditionType
+from openapi_client.models.v2_horizontal_pod_autoscaler_spec import V2HorizontalPodAutoscalerSpec
+from openapi_client.models.v2_horizontal_pod_autoscaler_status import V2HorizontalPodAutoscalerStatus
+from openapi_client.models.v2_metric_identifier import V2MetricIdentifier
+from openapi_client.models.v2_metric_source_type import V2MetricSourceType
+from openapi_client.models.v2_metric_spec import V2MetricSpec
+from openapi_client.models.v2_metric_status import V2MetricStatus
+from openapi_client.models.v2_metric_target import V2MetricTarget
+from openapi_client.models.v2_metric_target_type import V2MetricTargetType
+from openapi_client.models.v2_metric_value_status import V2MetricValueStatus
+from openapi_client.models.v2_object_metric_source import V2ObjectMetricSource
+from openapi_client.models.v2_object_metric_status import V2ObjectMetricStatus
+from openapi_client.models.v2_pods_metric_source import V2PodsMetricSource
+from openapi_client.models.v2_pods_metric_status import V2PodsMetricStatus
+from openapi_client.models.v2_resource_metric_source import V2ResourceMetricSource
+from openapi_client.models.v2_resource_metric_status import V2ResourceMetricStatus
+from openapi_client.models.v2_scaling_policy_select import V2ScalingPolicySelect
+from openapi_client.models.webhooks_webhook_create_payload import WebhooksWebhookCreatePayload
+from openapi_client.models.webhooks_webhook_update_payload import WebhooksWebhookUpdatePayload
+

ptctools/portainer_client/openapi_client/models/auth_authenticate_payload.py

@@ -0,0 +1,90 @@
+# 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
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AuthAuthenticatePayload(BaseModel):
+    """
+    AuthAuthenticatePayload
+    """ # noqa: E501
+    password: StrictStr = Field(description="Password")
+    username: StrictStr = Field(description="Username")
+    __properties: ClassVar[List[str]] = ["password", "username"]
+
+    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 AuthAuthenticatePayload 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 AuthAuthenticatePayload from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "password": obj.get("password"),
+            "username": obj.get("username")
+        })
+        return _obj
+
+

ptctools/portainer_client/openapi_client/models/auth_authenticate_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 AuthAuthenticateResponse(BaseModel):
+    """
+    AuthAuthenticateResponse
+    """ # noqa: E501
+    jwt: Optional[StrictStr] = Field(default=None, description="JWT token used to authenticate against the API")
+    __properties: ClassVar[List[str]] = ["jwt"]
+
+    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 AuthAuthenticateResponse 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 AuthAuthenticateResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "jwt": obj.get("jwt")
+        })
+        return _obj
+
+