fix: response type definitions for APIs

Prashant-Surya · Prashant-Surya · commit 1b387e3a9017 · 2025-07-24T18:21:41.000+05:30
- WorkItemTypes Response
- GetProjectMembers Response
- IssueSearch Response
- State Response (without slug)

make appInstallationId optional in getAppInstallations endpoint

bump version to 0.1.4
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
@@ -37,6 +37,7 @@ docs/IssuePropertyValueAPI.md
 docs/IssuePropertyValueAPIRequest.md
 docs/IssueRequest.md
 docs/IssueSearch.md
+docs/IssueSearchItem.md
 docs/IssueTypeAPI.md
 docs/IssueTypeAPIRequest.md
 docs/IssueWorkLogAPI.md
@@ -169,6 +170,7 @@ plane/models/issue_property_value_api.py
 plane/models/issue_property_value_api_request.py
 plane/models/issue_request.py
 plane/models/issue_search.py
+plane/models/issue_search_item.py
 plane/models/issue_type_api.py
 plane/models/issue_type_api_request.py
 plane/models/issue_work_log_api.py
@@ -231,6 +233,9 @@ plane/models/transfer_cycle_work_items400_response.py
 plane/models/type_enum.py
 plane/models/user_asset_upload_request.py
 plane/models/user_lite.py
+plane/oauth/__init__.py
+plane/oauth/api.py
+plane/oauth/models.py
 plane/py.typed
 plane/rest.py
 pyproject.toml
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@ The Plane REST API
 Visit our quick start guide and full API documentation at [developers.plane.so](https://developers.plane.so/api-reference/introduction).
 
 - API version: 0.0.1
-- Package version: 0.1.3
+- Package version: 0.1.4
 - Generator version: 7.13.0
 - Build package: org.openapitools.codegen.languages.PythonPydanticV1ClientCodegen
 For more information, please visit [https://plane.so](https://plane.so)
@@ -227,6 +227,7 @@ Class | Method | HTTP request | Description
  - [IssuePropertyValueAPIRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssuePropertyValueAPIRequest.md)
  - [IssueRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueRequest.md)
  - [IssueSearch](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueSearch.md)
+ - [IssueSearchItem](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueSearchItem.md)
  - [IssueTypeAPI](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueTypeAPI.md)
  - [IssueTypeAPIRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueTypeAPIRequest.md)
  - [IssueWorkLogAPI](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueWorkLogAPI.md)
diff --git a/docs/IssueSearch.md b/docs/IssueSearch.md
@@ -5,12 +5,7 @@ Serializer for work item search result data formatting.  Provides standardized s
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **str** | Issue ID | 
-**name** | **str** | Issue name | 
-**sequence_id** | **str** | Issue sequence ID | 
-**project__identifier** | **str** | Project identifier | 
-**project_id** | **str** | Project ID | 
-**workspace__slug** | **str** | Workspace slug | 
+**issues** | [**List[IssueSearchItem]**](IssueSearchItem.md) | Array of search result issues | 
 
 ## Example
 
diff --git a/docs/IssueSearchItem.md b/docs/IssueSearchItem.md
@@ -0,0 +1,34 @@
+# IssueSearchItem
+
+Individual issue component for search results.  Provides standardized search result structure including work item identifiers, project context, and workspace information for search API responses.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** | Issue ID | 
+**name** | **str** | Issue name | 
+**sequence_id** | **str** | Issue sequence ID | 
+**project__identifier** | **str** | Project identifier | 
+**project_id** | **str** | Project ID | 
+**workspace__slug** | **str** | Workspace slug | 
+
+## Example
+
+```python
+from plane.models.issue_search_item import IssueSearchItem
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of IssueSearchItem from a JSON string
+issue_search_item_instance = IssueSearchItem.from_json(json)
+# print the JSON string representation of the object
+print IssueSearchItem.to_json()
+
+# convert the object into a dict
+issue_search_item_dict = issue_search_item_instance.to_dict()
+# create an instance of IssueSearchItem from a dict
+issue_search_item_from_dict = IssueSearchItem.from_dict(issue_search_item_dict)
+```
+[[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/docs/MembersApi.md b/docs/MembersApi.md
@@ -9,7 +9,7 @@ Method | HTTP request | Description
 
 
 # **get_project_members**
-> UserLite get_project_members(project_id, slug)
+> List[UserLite] get_project_members(project_id, slug)
 
 List project members
 
@@ -76,7 +76,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**UserLite**](UserLite.md)
+[**List[UserLite]**](UserLite.md)
 
 ### Authorization
 
diff --git a/docs/State.md b/docs/State.md
@@ -12,7 +12,6 @@ Name | Type | Description | Notes
 **name** | **str** |  | 
 **description** | **str** |  | [optional] 
 **color** | **str** |  | 
-**slug** | **str** |  | [optional] [readonly] 
 **sequence** | **float** |  | [optional] 
 **group** | [**GroupEnum**](GroupEnum.md) |  | [optional] 
 **is_triage** | **bool** |  | [optional] 
diff --git a/docs/WorkItemTypesApi.md b/docs/WorkItemTypesApi.md
@@ -194,7 +194,7 @@ void (empty response body)
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **list_issue_types**
-> IssueTypeAPI list_issue_types(project_id, slug)
+> List[IssueTypeAPI] list_issue_types(project_id, slug)
 
 List issue types
 
@@ -261,7 +261,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**IssueTypeAPI**](IssueTypeAPI.md)
+[**List[IssueTypeAPI]**](IssueTypeAPI.md)
 
 ### Authorization
 
diff --git a/plane/__init__.py b/plane/__init__.py
@@ -15,7 +15,7 @@
 """  # noqa: E501
 
 
-__version__ = "0.1.3"
+__version__ = "0.1.4"
 
 # import apis into sdk package
 from plane.api.assets_api import AssetsApi
@@ -79,6 +79,7 @@
 from plane.models.issue_property_value_api_request import IssuePropertyValueAPIRequest
 from plane.models.issue_request import IssueRequest
 from plane.models.issue_search import IssueSearch
+from plane.models.issue_search_item import IssueSearchItem
 from plane.models.issue_type_api import IssueTypeAPI
 from plane.models.issue_type_api_request import IssueTypeAPIRequest
 from plane.models.issue_work_log_api import IssueWorkLogAPI
diff --git a/plane/api/members_api.py b/plane/api/members_api.py
@@ -46,7 +46,7 @@ def __init__(self, api_client=None) -> None:
         self.api_client = api_client
 
     @validate_arguments
-    def get_project_members(self, project_id : Annotated[StrictStr, Field(..., description="Project ID")], slug : Annotated[StrictStr, Field(..., description="Workspace slug")], **kwargs) -> UserLite:  # noqa: E501
+    def get_project_members(self, project_id : Annotated[StrictStr, Field(..., description="Project ID")], slug : Annotated[StrictStr, Field(..., description="Workspace slug")], **kwargs) -> List[UserLite]:  # noqa: E501
         """List project members  # noqa: E501
 
         Retrieve all users who are members of the specified project.  # noqa: E501
@@ -69,7 +69,7 @@ def get_project_members(self, project_id : Annotated[StrictStr, Field(..., descr
         :return: Returns the result object.
                  If the method is called asynchronously,
                  returns the request thread.
-        :rtype: UserLite
+        :rtype: List[UserLite]
         """
         kwargs['_return_http_data_only'] = True
         if '_preload_content' in kwargs:
@@ -114,7 +114,7 @@ def get_project_members_with_http_info(self, project_id : Annotated[StrictStr, F
         :return: Returns the result object.
                  If the method is called asynchronously,
                  returns the request thread.
-        :rtype: tuple(UserLite, status_code(int), headers(HTTPHeaderDict))
+        :rtype: tuple(List[UserLite], status_code(int), headers(HTTPHeaderDict))
         """
 
         _params = locals()
@@ -173,7 +173,7 @@ def get_project_members_with_http_info(self, project_id : Annotated[StrictStr, F
         _auth_settings = ['ApiKeyAuthentication', 'OAuth2Authentication', 'OAuth2Authentication']  # noqa: E501
 
         _response_types_map = {
-            '200': "UserLite",
+            '200': "List[UserLite]",
             '401': None,
             '403': None,
             '404': None,
diff --git a/plane/api/work_item_types_api.py b/plane/api/work_item_types_api.py
@@ -20,7 +20,7 @@
 from typing_extensions import Annotated
 from pydantic import Field, StrictStr
 
-from typing import Optional
+from typing import List, Optional
 
 from plane.models.issue_type_api import IssueTypeAPI
 from plane.models.issue_type_api_request import IssueTypeAPIRequest
@@ -364,7 +364,7 @@ def delete_issue_type_with_http_info(self, project_id : Annotated[StrictStr, Fie
             _request_auth=_params.get('_request_auth'))
 
     @validate_arguments
-    def list_issue_types(self, project_id : Annotated[StrictStr, Field(..., description="Project ID")], slug : Annotated[StrictStr, Field(..., description="Workspace slug")], **kwargs) -> IssueTypeAPI:  # noqa: E501
+    def list_issue_types(self, project_id : Annotated[StrictStr, Field(..., description="Project ID")], slug : Annotated[StrictStr, Field(..., description="Workspace slug")], **kwargs) -> List[IssueTypeAPI]:  # noqa: E501
         """List issue types  # noqa: E501
 
         List all issue types for a project  # noqa: E501
@@ -387,7 +387,7 @@ def list_issue_types(self, project_id : Annotated[StrictStr, Field(..., descript
         :return: Returns the result object.
                  If the method is called asynchronously,
                  returns the request thread.
-        :rtype: IssueTypeAPI
+        :rtype: List[IssueTypeAPI]
         """
         kwargs['_return_http_data_only'] = True
         if '_preload_content' in kwargs:
@@ -432,7 +432,7 @@ def list_issue_types_with_http_info(self, project_id : Annotated[StrictStr, Fiel
         :return: Returns the result object.
                  If the method is called asynchronously,
                  returns the request thread.
-        :rtype: tuple(IssueTypeAPI, status_code(int), headers(HTTPHeaderDict))
+        :rtype: tuple(List[IssueTypeAPI], status_code(int), headers(HTTPHeaderDict))
         """
 
         _params = locals()
@@ -494,7 +494,7 @@ def list_issue_types_with_http_info(self, project_id : Annotated[StrictStr, Fiel
             '401': None,
             '403': None,
             '404': None,
-            '200': "IssueTypeAPI",
+            '200': "List[IssueTypeAPI]",
         }
 
         return self.api_client.call_api(
diff --git a/plane/api_client.py b/plane/api_client.py
@@ -78,7 +78,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None,
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'OpenAPI-Generator/0.1.3/python'
+        self.user_agent = 'OpenAPI-Generator/0.1.4/python'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):
diff --git a/plane/configuration.py b/plane/configuration.py
@@ -412,7 +412,7 @@ def to_debug_report(self):
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 0.0.1\n"\
-               "SDK Package Version: 0.1.3".\
+               "SDK Package Version: 0.1.4".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):
diff --git a/plane/models/__init__.py b/plane/models/__init__.py
@@ -46,6 +46,7 @@
 from plane.models.issue_property_value_api_request import IssuePropertyValueAPIRequest
 from plane.models.issue_request import IssueRequest
 from plane.models.issue_search import IssueSearch
+from plane.models.issue_search_item import IssueSearchItem
 from plane.models.issue_type_api import IssueTypeAPI
 from plane.models.issue_type_api_request import IssueTypeAPIRequest
 from plane.models.issue_work_log_api import IssueWorkLogAPI
diff --git a/plane/models/issue_search.py b/plane/models/issue_search.py
@@ -19,20 +19,15 @@
 import json
 
 
-
-from pydantic import BaseModel, Field, StrictStr
+from pydantic import BaseModel, Field, conlist
+from plane.models.issue_search_item import IssueSearchItem
 
 class IssueSearch(BaseModel):
     """
     Serializer for work item search result data formatting.  Provides standardized search result structure including work item identifiers, project context, and workspace information for search API responses.  # noqa: E501
     """
-    id: StrictStr = Field(default=..., description="Issue ID")
-    name: StrictStr = Field(default=..., description="Issue name")
-    sequence_id: StrictStr = Field(default=..., description="Issue sequence ID")
-    project__identifier: StrictStr = Field(default=..., description="Project identifier")
-    project_id: StrictStr = Field(default=..., description="Project ID")
-    workspace__slug: StrictStr = Field(default=..., description="Workspace slug")
-    __properties = ["id", "name", "sequence_id", "project__identifier", "project_id", "workspace__slug"]
+    issues: conlist(IssueSearchItem) = Field(default=..., description="Array of search result issues")
+    __properties = ["issues"]
 
     class Config:
         """Pydantic configuration"""
@@ -58,6 +53,13 @@ def to_dict(self):
                           exclude={
                           },
                           exclude_none=True)
+        # override the default output from pydantic by calling `to_dict()` of each item in issues (list)
+        _items = []
+        if self.issues:
+            for _item in self.issues:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['issues'] = _items
         return _dict
 
     @classmethod
@@ -70,12 +72,7 @@ def from_dict(cls, obj: dict) -> IssueSearch:
             return IssueSearch.parse_obj(obj)
 
         _obj = IssueSearch.parse_obj({
-            "id": obj.get("id"),
-            "name": obj.get("name"),
-            "sequence_id": obj.get("sequence_id"),
-            "project__identifier": obj.get("project__identifier"),
-            "project_id": obj.get("project_id"),
-            "workspace__slug": obj.get("workspace__slug")
+            "issues": [IssueSearchItem.from_dict(_item) for _item in obj.get("issues")] if obj.get("issues") is not None else None
         })
         return _obj
 
diff --git a/plane/models/issue_search_item.py b/plane/models/issue_search_item.py
@@ -0,0 +1,82 @@
+# coding: utf-8
+
+"""
+    The Plane REST API
+
+    The Plane REST API  Visit our quick start guide and full API documentation at [developers.plane.so](https://developers.plane.so/api-reference/introduction).
+
+    The version of the API Spec: 0.0.1
+    Contact: support@plane.so
+    This class is auto generated.
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+
+
+from pydantic import BaseModel, Field, StrictStr
+
+class IssueSearchItem(BaseModel):
+    """
+    Individual issue component for search results.  Provides standardized search result structure including work item identifiers, project context, and workspace information for search API responses.  # noqa: E501
+    """
+    id: StrictStr = Field(default=..., description="Issue ID")
+    name: StrictStr = Field(default=..., description="Issue name")
+    sequence_id: StrictStr = Field(default=..., description="Issue sequence ID")
+    project__identifier: StrictStr = Field(default=..., description="Project identifier")
+    project_id: StrictStr = Field(default=..., description="Project ID")
+    workspace__slug: StrictStr = Field(default=..., description="Workspace slug")
+    __properties = ["id", "name", "sequence_id", "project__identifier", "project_id", "workspace__slug"]
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> IssueSearchItem:
+        """Create an instance of IssueSearchItem from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> IssueSearchItem:
+        """Create an instance of IssueSearchItem from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return IssueSearchItem.parse_obj(obj)
+
+        _obj = IssueSearchItem.parse_obj({
+            "id": obj.get("id"),
+            "name": obj.get("name"),
+            "sequence_id": obj.get("sequence_id"),
+            "project__identifier": obj.get("project__identifier"),
+            "project_id": obj.get("project_id"),
+            "workspace__slug": obj.get("workspace__slug")
+        })
+        return _obj
+
+
diff --git a/plane/models/state.py b/plane/models/state.py
diff --git a/plane/oauth/api.py b/plane/oauth/api.py
diff --git a/plane/oauth/models.py b/plane/oauth/models.py
diff --git a/pyproject.toml b/pyproject.toml
diff --git a/setup.py b/setup.py
