Update clients to latest platform release (4.6.0) (#68)

c-fteixeira · centml-machine-user · web-flow · commit 20ca5efc2ad4 · 2026-02-10T14:26:06.000-05:00
Co-authored-by: platform CI &lt;automation@centml.ai&gt;
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@ No description provided (generated by Openapi Generator https://github.com/opena
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 0.1.0
-- Package version: 4.5.1
+- Package version: 4.6.0
 - Generator version: 7.9.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 
@@ -211,6 +211,7 @@ Class | Method | HTTP request | Description
  - [UserVaultType](docs/UserVaultType.md)
  - [ValidationError](docs/ValidationError.md)
  - [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
+ - [VaultScope](docs/VaultScope.md)
 
 
 <a id="documentation-for-authorization"></a>
diff --git a/docs/EXTERNALApi.md b/docs/EXTERNALApi.md
@@ -913,7 +913,7 @@ Name | Type | Description  | Notes
 
 Get All User Vault Items Endpoint
 
-Retrieve all items of a specific type for the user.
+Retrieve all items the user has access to (both USER and ORG scoped).
 
 ### Example
 
@@ -3441,7 +3441,7 @@ Name | Type | Description  | Notes
 
 Update User Vault Item Endpoint
 
-Update or add multiple items of a specific type for the user.
+Update or add an item of a specific type for the user.
 
 ### Example
 
diff --git a/docs/GetClusterResponse.md b/docs/GetClusterResponse.md
@@ -6,6 +6,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **int** |  | 
+**cluster_name** | **str** |  | 
 **display_name** | **str** |  | 
 **region** | **str** |  | [optional] 
 
diff --git a/docs/UserVaultItem.md b/docs/UserVaultItem.md
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **type** | [**UserVaultType**](UserVaultType.md) |  | 
 **key** | **str** |  | 
 **value** | **str** |  | [optional] 
+**visibility** | [**VaultScope**](VaultScope.md) |  | [optional] 
 
 ## Example
 
diff --git a/docs/VaultScope.md b/docs/VaultScope.md
@@ -0,0 +1,12 @@
+# VaultScope
+
+
+## Enum
+
+* `USER` (value: `'USER'`)
+
+* `ORG` (value: `'ORG'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/platform_api_python_client/__init__.py b/platform_api_python_client/__init__.py
@@ -14,7 +14,7 @@
 """  # noqa: E501
 
 
-__version__ = "4.5.1"
+__version__ = "4.6.0"
 
 # import apis into sdk package
 from platform_api_python_client.api.external_api import EXTERNALApi
@@ -99,3 +99,4 @@
 from platform_api_python_client.models.user_vault_type import UserVaultType
 from platform_api_python_client.models.validation_error import ValidationError
 from platform_api_python_client.models.validation_error_loc_inner import ValidationErrorLocInner
+from platform_api_python_client.models.vault_scope import VaultScope
diff --git a/platform_api_python_client/api/external_api.py b/platform_api_python_client/api/external_api.py
@@ -3108,7 +3108,7 @@ def get_all_user_vault_items_endpoint_user_vault_get(
     ) -> ListUserVaultItemsResponse:
         """Get All User Vault Items Endpoint
 
-        Retrieve all items of a specific type for the user.
+        Retrieve all items the user has access to (both USER and ORG scoped).
 
         :param type:
         :type type: UserVaultType
@@ -3180,7 +3180,7 @@ def get_all_user_vault_items_endpoint_user_vault_get_with_http_info(
     ) -> ApiResponse[ListUserVaultItemsResponse]:
         """Get All User Vault Items Endpoint
 
-        Retrieve all items of a specific type for the user.
+        Retrieve all items the user has access to (both USER and ORG scoped).
 
         :param type:
         :type type: UserVaultType
@@ -3252,7 +3252,7 @@ def get_all_user_vault_items_endpoint_user_vault_get_without_preload_content(
     ) -> RESTResponseType:
         """Get All User Vault Items Endpoint
 
-        Retrieve all items of a specific type for the user.
+        Retrieve all items the user has access to (both USER and ORG scoped).
 
         :param type:
         :type type: UserVaultType
@@ -12078,7 +12078,7 @@ def update_user_vault_item_endpoint_user_vault_put(
     ) -> object:
         """Update User Vault Item Endpoint
 
-        Update or add multiple items of a specific type for the user.
+        Update or add an item of a specific type for the user.
 
         :param user_vault_item: (required)
         :type user_vault_item: UserVaultItem
@@ -12146,7 +12146,7 @@ def update_user_vault_item_endpoint_user_vault_put_with_http_info(
     ) -> ApiResponse[object]:
         """Update User Vault Item Endpoint
 
-        Update or add multiple items of a specific type for the user.
+        Update or add an item of a specific type for the user.
 
         :param user_vault_item: (required)
         :type user_vault_item: UserVaultItem
@@ -12214,7 +12214,7 @@ def update_user_vault_item_endpoint_user_vault_put_without_preload_content(
     ) -> RESTResponseType:
         """Update User Vault Item Endpoint
 
-        Update or add multiple items of a specific type for the user.
+        Update or add an item of a specific type for the user.
 
         :param user_vault_item: (required)
         :type user_vault_item: UserVaultItem
diff --git a/platform_api_python_client/api_client.py b/platform_api_python_client/api_client.py
@@ -90,7 +90,7 @@ def __init__(
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'OpenAPI-Generator/4.5.1/python'
+        self.user_agent = 'OpenAPI-Generator/4.6.0/python'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):
diff --git a/platform_api_python_client/configuration.py b/platform_api_python_client/configuration.py
@@ -392,7 +392,7 @@ def to_debug_report(self):
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 0.1.0\n"\
-               "SDK Package Version: 4.5.1".\
+               "SDK Package Version: 4.6.0".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):
diff --git a/platform_api_python_client/models/__init__.py b/platform_api_python_client/models/__init__.py
@@ -82,3 +82,4 @@
 from platform_api_python_client.models.user_vault_type import UserVaultType
 from platform_api_python_client.models.validation_error import ValidationError
 from platform_api_python_client.models.validation_error_loc_inner import ValidationErrorLocInner
+from platform_api_python_client.models.vault_scope import VaultScope
diff --git a/platform_api_python_client/models/get_cluster_response.py b/platform_api_python_client/models/get_cluster_response.py
@@ -27,9 +27,10 @@ class GetClusterResponse(BaseModel):
     GetClusterResponse
     """ # noqa: E501
     id: StrictInt
+    cluster_name: StrictStr
     display_name: StrictStr
     region: Optional[StrictStr] = None
-    __properties: ClassVar[List[str]] = ["id", "display_name", "region"]
+    __properties: ClassVar[List[str]] = ["id", "cluster_name", "display_name", "region"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -88,6 +89,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
 
         _obj = cls.model_validate({
             "id": obj.get("id"),
+            "cluster_name": obj.get("cluster_name"),
             "display_name": obj.get("display_name"),
             "region": obj.get("region")
         })
diff --git a/platform_api_python_client/models/user_vault_item.py b/platform_api_python_client/models/user_vault_item.py
@@ -20,6 +20,7 @@
 from pydantic import BaseModel, ConfigDict, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
 from platform_api_python_client.models.user_vault_type import UserVaultType
+from platform_api_python_client.models.vault_scope import VaultScope
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -30,7 +31,8 @@ class UserVaultItem(BaseModel):
     type: UserVaultType
     key: StrictStr
     value: Optional[StrictStr] = None
-    __properties: ClassVar[List[str]] = ["type", "key", "value"]
+    visibility: Optional[VaultScope] = None
+    __properties: ClassVar[List[str]] = ["type", "key", "value", "visibility"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -90,7 +92,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
         _obj = cls.model_validate({
             "type": obj.get("type"),
             "key": obj.get("key"),
-            "value": obj.get("value")
+            "value": obj.get("value"),
+            "visibility": obj.get("visibility")
         })
         return _obj
 
diff --git a/platform_api_python_client/models/vault_scope.py b/platform_api_python_client/models/vault_scope.py
@@ -0,0 +1,37 @@
+# coding: utf-8
+
+"""
+    Platform External API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class VaultScope(str, Enum):
+    """
+    VaultScope
+    """
+
+    """
+    allowed enum values
+    """
+    USER = 'USER'
+    ORG = 'ORG'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of VaultScope from a JSON string"""
+        return cls(json.loads(json_str))
+
+
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "platform_api_python_client"
-version = "4.5.1"
+version = "4.6.0"
 description = "Platform External API"
 authors = ["OpenAPI Generator Community <team@openapitools.org>"]
 license = "NoLicense"
diff --git a/setup.py b/setup.py
@@ -21,7 +21,7 @@
 # prerequisite: setuptools
 # http://pypi.python.org/pypi/setuptools
 NAME = "platform-api-python-client"
-VERSION = "4.5.1"
+VERSION = "4.6.0"
 PYTHON_REQUIRES = ">= 3.8"
 REQUIRES = [
     "urllib3 >= 1.25.3, < 3.0.0",
diff --git a/test/test_get_cluster_response.py b/test/test_get_cluster_response.py
@@ -36,12 +36,14 @@ def make_instance(self, include_optional) -> GetClusterResponse:
         if include_optional:
             return GetClusterResponse(
                 id = 56,
+                cluster_name = '',
                 display_name = '',
                 region = ''
             )
         else:
             return GetClusterResponse(
                 id = 56,
+                cluster_name = '',
                 display_name = '',
         )
         """
diff --git a/test/test_list_get_cluster_response.py b/test/test_list_get_cluster_response.py
@@ -38,6 +38,7 @@ def make_instance(self, include_optional) -> ListGetClusterResponse:
                 results = [
                     platform_api_python_client.models.get_cluster_response.GetClusterResponse(
                         id = 56, 
+                        cluster_name = '', 
                         display_name = '', 
                         region = '', )
                     ]
@@ -47,6 +48,7 @@ def make_instance(self, include_optional) -> ListGetClusterResponse:
                 results = [
                     platform_api_python_client.models.get_cluster_response.GetClusterResponse(
                         id = 56, 
+                        cluster_name = '', 
                         display_name = '', 
                         region = '', )
                     ],
diff --git a/test/test_list_user_vault_items_response.py b/test/test_list_user_vault_items_response.py
@@ -39,7 +39,8 @@ def make_instance(self, include_optional) -> ListUserVaultItemsResponse:
                     platform_api_python_client.models.user_vault_item.UserVaultItem(
                         type = 'env_vars', 
                         key = '', 
-                        value = '', )
+                        value = '', 
+                        visibility = 'USER', )
                     ]
             )
         else:
@@ -48,7 +49,8 @@ def make_instance(self, include_optional) -> ListUserVaultItemsResponse:
                     platform_api_python_client.models.user_vault_item.UserVaultItem(
                         type = 'env_vars', 
                         key = '', 
-                        value = '', )
+                        value = '', 
+                        visibility = 'USER', )
                     ],
         )
         """
diff --git a/test/test_user_vault_item.py b/test/test_user_vault_item.py
@@ -37,7 +37,8 @@ def make_instance(self, include_optional) -> UserVaultItem:
             return UserVaultItem(
                 type = 'env_vars',
                 key = '',
-                value = ''
+                value = '',
+                visibility = 'USER'
             )
         else:
             return UserVaultItem(
diff --git a/test/test_vault_scope.py b/test/test_vault_scope.py
@@ -0,0 +1,33 @@
+# coding: utf-8
+
+"""
+    Platform External API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from platform_api_python_client.models.vault_scope import VaultScope
+
+class TestVaultScope(unittest.TestCase):
+    """VaultScope unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def testVaultScope(self):
+        """Test VaultScope"""
+        # inst = VaultScope()
+
+if __name__ == '__main__':
+    unittest.main()
