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

ptctools/portainer_client/openapi_client/test/test_portainer_endpoint.py

@@ -0,0 +1,222 @@
+# 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
+
+
+import unittest
+
+from openapi_client.models.portainer_endpoint import PortainerEndpoint
+
+class TestPortainerEndpoint(unittest.TestCase):
+    """PortainerEndpoint unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> PortainerEndpoint:
+        """Test PortainerEndpoint
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `PortainerEndpoint`
+        """
+        model = PortainerEndpoint()
+        if include_optional:
+            return PortainerEndpoint(
+                amt_device_guid = '4c4c4544-004b-3910-8037-b6c04f504633',
+                authorized_teams = [
+                    56
+                    ],
+                authorized_users = [
+                    56
+                    ],
+                azure_credentials = openapi_client.models.portainer/azure_credentials.portainer.AzureCredentials(
+                    application_id = 'eag7cdo9-o09l-9i83-9dO9-f0b23oe78db4', 
+                    authentication_key = 'cOrXoK/1D35w8YQ8nH1/8ZGwzz45JIYD5jxHKXEQknk=', 
+                    tenant_id = '34ddc78d-4fel-2358-8cc1-df84c8o839f5', ),
+                compose_syntax_max_version = '3.8',
+                container_engine = 'docker',
+                edge_checkin_interval = 5,
+                edge_id = '',
+                edge_key = '',
+                enable_gpu_management = True,
+                gpus = [
+                    openapi_client.models.portainer/pair.portainer.Pair(
+                        name = 'name', 
+                        value = 'value', )
+                    ],
+                group_id = 1,
+                heartbeat = True,
+                id = 1,
+                is_edge_device = True,
+                kubernetes = openapi_client.models.portainer/kubernetes_data.portainer.KubernetesData(
+                    configuration = openapi_client.models.portainer/kubernetes_configuration.portainer.KubernetesConfiguration(
+                        allow_none_ingress_class = True, 
+                        enable_resource_over_commit = True, 
+                        ingress_availability_per_namespace = True, 
+                        ingress_classes = [
+                            openapi_client.models.portainer/kubernetes_ingress_class_config.portainer.KubernetesIngressClassConfig(
+                                blocked = True, 
+                                blocked_namespaces = [
+                                    ''
+                                    ], 
+                                name = '', 
+                                type = '', )
+                            ], 
+                        resource_over_commit_percentage = 56, 
+                        restrict_default_namespace = True, 
+                        storage_classes = [
+                            openapi_client.models.portainer/kubernetes_storage_class_config.portainer.KubernetesStorageClassConfig(
+                                access_modes = [
+                                    ''
+                                    ], 
+                                allow_volume_expansion = True, 
+                                name = '', 
+                                provisioner = '', )
+                            ], 
+                        use_load_balancer = True, 
+                        use_server_metrics = True, ), 
+                    flags = openapi_client.models.portainer/kubernetes_flags.portainer.KubernetesFlags(
+                        is_server_ingress_class_detected = True, 
+                        is_server_metrics_detected = True, 
+                        is_server_storage_detected = True, ), 
+                    snapshots = [
+                        openapi_client.models.portainer/kubernetes_snapshot.portainer.KubernetesSnapshot(
+                            diagnostics_data = openapi_client.models.portainer/diagnostics_data.portainer.DiagnosticsData(
+                                dns = {
+                                    'key' : ''
+                                    }, 
+                                log = '', 
+                                proxy = {
+                                    'key' : ''
+                                    }, 
+                                telnet = {
+                                    'key' : ''
+                                    }, ), 
+                            kubernetes_version = '', 
+                            node_count = 56, 
+                            performance_metrics = openapi_client.models.portainer/performance_metrics.portainer.PerformanceMetrics(
+                                cpu_usage = 1.337, 
+                                memory_usage = 1.337, 
+                                network_usage = 1.337, ), 
+                            time = 56, 
+                            total_cpu = 56, 
+                            total_memory = 56, )
+                        ], ),
+                name = 'my-environment',
+                post_init_migrations = openapi_client.models.portainer/endpoint_post_init_migrations.portainer.EndpointPostInitMigrations(
+                    migrate_gpus = True, 
+                    migrate_ingresses = True, ),
+                public_url = 'docker.mydomain.tld:2375',
+                snapshots = [
+                    openapi_client.models.portainer/docker_snapshot.portainer.DockerSnapshot(
+                        container_count = 56, 
+                        diagnostics_data = openapi_client.models.portainer/diagnostics_data.portainer.DiagnosticsData(
+                            dns = {
+                                'key' : ''
+                                }, 
+                            log = '', 
+                            proxy = {
+                                'key' : ''
+                                }, 
+                            telnet = {
+                                'key' : ''
+                                }, ), 
+                        docker_snapshot_raw = openapi_client.models.docker_snapshot_raw.DockerSnapshotRaw(), 
+                        docker_version = '', 
+                        gpu_use_all = True, 
+                        gpu_use_list = [
+                            ''
+                            ], 
+                        healthy_container_count = 56, 
+                        image_count = 56, 
+                        is_podman = True, 
+                        node_count = 56, 
+                        performance_metrics = openapi_client.models.portainer/performance_metrics.portainer.PerformanceMetrics(
+                            cpu_usage = 1.337, 
+                            memory_usage = 1.337, 
+                            network_usage = 1.337, ), 
+                        running_container_count = 56, 
+                        service_count = 56, 
+                        stack_count = 56, 
+                        stopped_container_count = 56, 
+                        swarm = True, 
+                        time = 56, 
+                        total_cpu = 56, 
+                        total_memory = 56, 
+                        unhealthy_container_count = 56, 
+                        volume_count = 56, )
+                    ],
+                status = 0,
+                tls = True,
+                tlsca_cert = '',
+                tls_cert = '',
+                tls_config = openapi_client.models.portainer/tls_configuration.portainer.TLSConfiguration(
+                    tls = True, 
+                    tlsca_cert = '/data/tls/ca.pem', 
+                    tls_cert = '/data/tls/cert.pem', 
+                    tls_key = '/data/tls/key.pem', 
+                    tls_skip_verify = False, ),
+                tls_key = '',
+                tag_ids = [
+                    56
+                    ],
+                tags = [
+                    ''
+                    ],
+                team_access_policies = {
+                    'key' : openapi_client.models.portainer/access_policy.portainer.AccessPolicy(
+                        role_id = 1, )
+                    },
+                type = 0,
+                url = 'docker.mydomain.tld:2375',
+                user_access_policies = {
+                    'key' : openapi_client.models.portainer/access_policy.portainer.AccessPolicy(
+                        role_id = 1, )
+                    },
+                user_trusted = True,
+                agent = openapi_client.models.portainer_endpoint_agent.portainer_Endpoint_agent(
+                    version = '1.0.0', ),
+                edge = openapi_client.models.portainer/environment_edge_settings.portainer.EnvironmentEdgeSettings(
+                    command_interval = 60, 
+                    ping_interval = 60, 
+                    snapshot_interval = 60, 
+                    async_mode = True, ),
+                last_check_in_date = 56,
+                query_date = 56,
+                security_settings = openapi_client.models.portainer/endpoint_security_settings.portainer.EndpointSecuritySettings(
+                    allow_bind_mounts_for_regular_users = False, 
+                    allow_container_capabilities_for_regular_users = True, 
+                    allow_device_mapping_for_regular_users = True, 
+                    allow_host_namespace_for_regular_users = True, 
+                    allow_privileged_mode_for_regular_users = False, 
+                    allow_stack_management_for_regular_users = True, 
+                    allow_sysctl_setting_for_regular_users = True, 
+                    allow_volume_browser_for_regular_users = True, 
+                    enable_host_management_features = True, )
+            )
+        else:
+            return PortainerEndpoint(
+        )
+        """
+
+    def testPortainerEndpoint(self):
+        """Test PortainerEndpoint"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

ptctools/portainer_client/openapi_client/test/test_portainer_endpoint_agent.py

@@ -0,0 +1,52 @@
+# 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
+
+
+import unittest
+
+from openapi_client.models.portainer_endpoint_agent import PortainerEndpointAgent
+
+class TestPortainerEndpointAgent(unittest.TestCase):
+    """PortainerEndpointAgent unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> PortainerEndpointAgent:
+        """Test PortainerEndpointAgent
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `PortainerEndpointAgent`
+        """
+        model = PortainerEndpointAgent()
+        if include_optional:
+            return PortainerEndpointAgent(
+                version = '1.0.0'
+            )
+        else:
+            return PortainerEndpointAgent(
+        )
+        """
+
+    def testPortainerEndpointAgent(self):
+        """Test PortainerEndpointAgent"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

ptctools/portainer_client/openapi_client/test/test_portainer_endpoint_group.py

@@ -0,0 +1,79 @@
+# 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
+
+
+import unittest
+
+from openapi_client.models.portainer_endpoint_group import PortainerEndpointGroup
+
+class TestPortainerEndpointGroup(unittest.TestCase):
+    """PortainerEndpointGroup unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> PortainerEndpointGroup:
+        """Test PortainerEndpointGroup
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `PortainerEndpointGroup`
+        """
+        model = PortainerEndpointGroup()
+        if include_optional:
+            return PortainerEndpointGroup(
+                authorized_teams = [
+                    56
+                    ],
+                authorized_users = [
+                    56
+                    ],
+                description = 'Environment(Endpoint) group description',
+                id = 1,
+                labels = [
+                    openapi_client.models.portainer/pair.portainer.Pair(
+                        name = 'name', 
+                        value = 'value', )
+                    ],
+                name = 'my-environment-group',
+                tag_ids = [
+                    56
+                    ],
+                tags = [
+                    ''
+                    ],
+                team_access_policies = {
+                    'key' : openapi_client.models.portainer/access_policy.portainer.AccessPolicy(
+                        role_id = 1, )
+                    },
+                user_access_policies = {
+                    'key' : openapi_client.models.portainer/access_policy.portainer.AccessPolicy(
+                        role_id = 1, )
+                    }
+            )
+        else:
+            return PortainerEndpointGroup(
+        )
+        """
+
+    def testPortainerEndpointGroup(self):
+        """Test PortainerEndpointGroup"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

ptctools/portainer_client/openapi_client/test/test_portainer_endpoint_post_init_migrations.py

@@ -0,0 +1,53 @@
+# 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
+
+
+import unittest
+
+from openapi_client.models.portainer_endpoint_post_init_migrations import PortainerEndpointPostInitMigrations
+
+class TestPortainerEndpointPostInitMigrations(unittest.TestCase):
+    """PortainerEndpointPostInitMigrations unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> PortainerEndpointPostInitMigrations:
+        """Test PortainerEndpointPostInitMigrations
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `PortainerEndpointPostInitMigrations`
+        """
+        model = PortainerEndpointPostInitMigrations()
+        if include_optional:
+            return PortainerEndpointPostInitMigrations(
+                migrate_gpus = True,
+                migrate_ingresses = True
+            )
+        else:
+            return PortainerEndpointPostInitMigrations(
+        )
+        """
+
+    def testPortainerEndpointPostInitMigrations(self):
+        """Test PortainerEndpointPostInitMigrations"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

ptctools/portainer_client/openapi_client/test/test_portainer_endpoint_security_settings.py

@@ -0,0 +1,60 @@
+# 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
+
+
+import unittest
+
+from openapi_client.models.portainer_endpoint_security_settings import PortainerEndpointSecuritySettings
+
+class TestPortainerEndpointSecuritySettings(unittest.TestCase):
+    """PortainerEndpointSecuritySettings unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> PortainerEndpointSecuritySettings:
+        """Test PortainerEndpointSecuritySettings
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `PortainerEndpointSecuritySettings`
+        """
+        model = PortainerEndpointSecuritySettings()
+        if include_optional:
+            return PortainerEndpointSecuritySettings(
+                allow_bind_mounts_for_regular_users = False,
+                allow_container_capabilities_for_regular_users = True,
+                allow_device_mapping_for_regular_users = True,
+                allow_host_namespace_for_regular_users = True,
+                allow_privileged_mode_for_regular_users = False,
+                allow_stack_management_for_regular_users = True,
+                allow_sysctl_setting_for_regular_users = True,
+                allow_volume_browser_for_regular_users = True,
+                enable_host_management_features = True
+            )
+        else:
+            return PortainerEndpointSecuritySettings(
+        )
+        """
+
+    def testPortainerEndpointSecuritySettings(self):
+        """Test PortainerEndpointSecuritySettings"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

ptctools/portainer_client/openapi_client/test/test_portainer_endpoint_status.py

@@ -0,0 +1,34 @@
+# 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
+
+
+import unittest
+
+from openapi_client.models.portainer_endpoint_status import PortainerEndpointStatus
+
+class TestPortainerEndpointStatus(unittest.TestCase):
+    """PortainerEndpointStatus unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def testPortainerEndpointStatus(self):
+        """Test PortainerEndpointStatus"""
+        # inst = PortainerEndpointStatus()
+
+if __name__ == '__main__':
+    unittest.main()

ptctools/portainer_client/openapi_client/test/test_portainer_endpoint_type.py

@@ -0,0 +1,34 @@
+# 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
+
+
+import unittest
+
+from openapi_client.models.portainer_endpoint_type import PortainerEndpointType
+
+class TestPortainerEndpointType(unittest.TestCase):
+    """PortainerEndpointType unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def testPortainerEndpointType(self):
+        """Test PortainerEndpointType"""
+        # inst = PortainerEndpointType()
+
+if __name__ == '__main__':
+    unittest.main()

ptctools/portainer_client/openapi_client/test/test_portainer_environment_edge_settings.py

@@ -0,0 +1,55 @@
+# 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
+
+
+import unittest
+
+from openapi_client.models.portainer_environment_edge_settings import PortainerEnvironmentEdgeSettings
+
+class TestPortainerEnvironmentEdgeSettings(unittest.TestCase):
+    """PortainerEnvironmentEdgeSettings unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> PortainerEnvironmentEdgeSettings:
+        """Test PortainerEnvironmentEdgeSettings
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `PortainerEnvironmentEdgeSettings`
+        """
+        model = PortainerEnvironmentEdgeSettings()
+        if include_optional:
+            return PortainerEnvironmentEdgeSettings(
+                command_interval = 60,
+                ping_interval = 60,
+                snapshot_interval = 60,
+                async_mode = True
+            )
+        else:
+            return PortainerEnvironmentEdgeSettings(
+        )
+        """
+
+    def testPortainerEnvironmentEdgeSettings(self):
+        """Test PortainerEnvironmentEdgeSettings"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()