plane-sdk

Name	plane-sdk JSON
Version	0.1.3 JSON
	download
home_page	None
Summary	The Plane REST API
upload_time	2025-07-08 13:30:57
maintainer	None
docs_url	None
author	Plane
requires_python	None
license	GNU AGPLv3
keywords	the plane rest api
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # plane-sdk
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
- Generator version: 7.13.0
- Build package: org.openapitools.codegen.languages.PythonPydanticV1ClientCodegen
For more information, please visit [https://plane.so](https://plane.so)

## Requirements.

Python 3.7+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install plane-sdk
```
(you may need to run `pip` with root permission: `sudo pip install plane-sdk`)

Then import the package:
```python
import plane
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import plane
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python
from plane.configuration import Configuration
from plane.api_client import ApiClient
from plane.api.users_api import UsersApi
from plane.api.projects_api import ProjectsApi
from plane.exceptions import ApiException

def test_api():

    # Configure API Key authentication
    configuration = Configuration(
        api_key={'ApiKeyAuthentication': <API_KEY>}
    )

    # Configure Access Token authentication
    # configuration = Configuration(
    #    access_token='<PLANE_ACCESS_TOKEN>'
    # )

    # Create API client instance
    api_client = ApiClient(configuration)

    # Create Users API instance
    users_api = UsersApi(api_client)

    # Call get_current_user endpoint
    print("Fetching current user information...")
    user = users_api.get_current_user()
    print(user.email)

    projects_api = ProjectsApi(api_client)
    projects_response = projects_api.list_projects(slug="<workspace_slug>")
    for project in projects_response.results:
        print(f"{project.id} - {project.name}")
```

## Documentation for API Endpoints

All URIs are relative to *https://api.plane.so*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AssetsApi* | [**create_generic_asset_upload**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/AssetsApi.md#create_generic_asset_upload) | **POST** /api/v1/workspaces/{slug}/assets/ | Generate presigned URL for generic asset upload
*AssetsApi* | [**create_user_asset_upload**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/AssetsApi.md#create_user_asset_upload) | **POST** /api/v1/assets/user-assets/ | Generate presigned URL for user asset upload
*AssetsApi* | [**delete_user_asset**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/AssetsApi.md#delete_user_asset) | **DELETE** /api/v1/assets/user-assets/{asset_id}/ | Delete user asset
*AssetsApi* | [**get_generic_asset**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/AssetsApi.md#get_generic_asset) | **GET** /api/v1/workspaces/{slug}/assets/{asset_id}/ | Get presigned URL for asset download
*AssetsApi* | [**update_generic_asset**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/AssetsApi.md#update_generic_asset) | **PATCH** /api/v1/workspaces/{slug}/assets/{asset_id}/ | Update generic asset after upload completion
*AssetsApi* | [**update_user_asset**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/AssetsApi.md#update_user_asset) | **PATCH** /api/v1/assets/user-assets/{asset_id}/ | Mark user asset as uploaded
*CyclesApi* | [**add_cycle_work_items**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/CyclesApi.md#add_cycle_work_items) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/ | Add Work Items to Cycle
*CyclesApi* | [**archive_cycle**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/CyclesApi.md#archive_cycle) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/archive/ | Archive cycle
*CyclesApi* | [**create_cycle**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/CyclesApi.md#create_cycle) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/ | Create cycle
*CyclesApi* | [**delete_cycle**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/CyclesApi.md#delete_cycle) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{pk}/ | Delete cycle
*CyclesApi* | [**delete_cycle_work_item**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/CyclesApi.md#delete_cycle_work_item) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/{issue_id}/ | Delete cycle work item
*CyclesApi* | [**list_archived_cycles**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/CyclesApi.md#list_archived_cycles) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/archived-cycles/ | List archived cycles
*CyclesApi* | [**list_cycle_work_items**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/CyclesApi.md#list_cycle_work_items) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/ | List cycle work items
*CyclesApi* | [**list_cycles**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/CyclesApi.md#list_cycles) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/ | List cycles
*CyclesApi* | [**retrieve_cycle**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/CyclesApi.md#retrieve_cycle) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{pk}/ | Retrieve cycle
*CyclesApi* | [**retrieve_cycle_work_item**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/CyclesApi.md#retrieve_cycle_work_item) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/{issue_id}/ | Retrieve cycle work item
*CyclesApi* | [**transfer_cycle_work_items**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/CyclesApi.md#transfer_cycle_work_items) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/transfer-issues/ | Transfer cycle work items
*CyclesApi* | [**unarchive_cycle**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/CyclesApi.md#unarchive_cycle) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/archived-cycles/{pk}/unarchive/ | Unarchive cycle
*CyclesApi* | [**update_cycle**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/CyclesApi.md#update_cycle) | **PATCH** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{pk}/ | Update cycle
*IntakeApi* | [**create_intake_work_item**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IntakeApi.md#create_intake_work_item) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/intake-issues/ | Create intake work item
*IntakeApi* | [**delete_intake_work_item**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IntakeApi.md#delete_intake_work_item) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/intake-issues/{issue_id}/ | Delete intake work item
*IntakeApi* | [**get_intake_work_items_list**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IntakeApi.md#get_intake_work_items_list) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/intake-issues/ | List intake work items
*IntakeApi* | [**retrieve_intake_work_item**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IntakeApi.md#retrieve_intake_work_item) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/intake-issues/{issue_id}/ | Retrieve intake work item
*IntakeApi* | [**update_intake_work_item**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IntakeApi.md#update_intake_work_item) | **PATCH** /api/v1/workspaces/{slug}/projects/{project_id}/intake-issues/{issue_id}/ | Update intake work item
*LabelsApi* | [**create_label**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/LabelsApi.md#create_label) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/labels/ | Endpoints for label create/update/delete and fetch label details
*LabelsApi* | [**delete_label**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/LabelsApi.md#delete_label) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/labels/{pk}/ | Delete a label
*LabelsApi* | [**get_labels**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/LabelsApi.md#get_labels) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/labels/{pk}/ | Endpoints for label create/update/delete and fetch label details
*LabelsApi* | [**list_labels**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/LabelsApi.md#list_labels) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/labels/ | Endpoints for label create/update/delete and fetch label details
*LabelsApi* | [**update_label**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/LabelsApi.md#update_label) | **PATCH** /api/v1/workspaces/{slug}/projects/{project_id}/labels/{pk}/ | Update a label
*MembersApi* | [**get_project_members**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/MembersApi.md#get_project_members) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/members/ | List project members
*MembersApi* | [**get_workspace_members**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/MembersApi.md#get_workspace_members) | **GET** /api/v1/workspaces/{slug}/members/ | List workspace members
*ModulesApi* | [**add_module_work_items**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ModulesApi.md#add_module_work_items) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/modules/{module_id}/module-issues/ | Add Work Items to Module
*ModulesApi* | [**archive_module**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ModulesApi.md#archive_module) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/modules/{pk}/archive/ | Archive module
*ModulesApi* | [**create_module**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ModulesApi.md#create_module) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/modules/ | Create module
*ModulesApi* | [**delete_module**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ModulesApi.md#delete_module) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/modules/{pk}/ | Delete module
*ModulesApi* | [**delete_module_work_item**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ModulesApi.md#delete_module_work_item) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/modules/{module_id}/module-issues/{issue_id}/ | Delete module work item
*ModulesApi* | [**list_archived_modules**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ModulesApi.md#list_archived_modules) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/archived-modules/ | List archived modules
*ModulesApi* | [**list_module_work_items**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ModulesApi.md#list_module_work_items) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/modules/{module_id}/module-issues/ | List module work items
*ModulesApi* | [**list_modules**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ModulesApi.md#list_modules) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/modules/ | List modules
*ModulesApi* | [**retrieve_module**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ModulesApi.md#retrieve_module) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/modules/{pk}/ | Retrieve module
*ModulesApi* | [**unarchive_module**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ModulesApi.md#unarchive_module) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/archived-modules/{pk}/unarchive/ | Unarchive module
*ModulesApi* | [**update_module**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ModulesApi.md#update_module) | **PATCH** /api/v1/workspaces/{slug}/projects/{project_id}/modules/{pk}/ | Update module
*ProjectsApi* | [**archive_project**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ProjectsApi.md#archive_project) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/archive/ | Archive project
*ProjectsApi* | [**create_project**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ProjectsApi.md#create_project) | **POST** /api/v1/workspaces/{slug}/projects/ | Create project
*ProjectsApi* | [**delete_project**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ProjectsApi.md#delete_project) | **DELETE** /api/v1/workspaces/{slug}/projects/{pk}/ | Delete project
*ProjectsApi* | [**list_projects**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ProjectsApi.md#list_projects) | **GET** /api/v1/workspaces/{slug}/projects/ | List or retrieve projects
*ProjectsApi* | [**retrieve_project**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ProjectsApi.md#retrieve_project) | **GET** /api/v1/workspaces/{slug}/projects/{pk}/ | Retrieve project
*ProjectsApi* | [**unarchive_project**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ProjectsApi.md#unarchive_project) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/archive/ | Unarchive project
*ProjectsApi* | [**update_project**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ProjectsApi.md#update_project) | **PATCH** /api/v1/workspaces/{slug}/projects/{pk}/ | Update project
*StatesApi* | [**create_state**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/StatesApi.md#create_state) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/states/ | Create state
*StatesApi* | [**delete_state**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/StatesApi.md#delete_state) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/states/{state_id}/ | Delete state
*StatesApi* | [**list_states**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/StatesApi.md#list_states) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/states/ | List states
*StatesApi* | [**retrieve_state**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/StatesApi.md#retrieve_state) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/states/{state_id}/ | Retrieve state
*StatesApi* | [**update_state**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/StatesApi.md#update_state) | **PATCH** /api/v1/workspaces/{slug}/projects/{project_id}/states/{state_id}/ | Update state
*UsersApi* | [**get_current_user**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/UsersApi.md#get_current_user) | **GET** /api/v1/users/me/ | Get current user
*WorkItemActivityApi* | [**list_work_item_activities**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemActivityApi.md#list_work_item_activities) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/activities/ | Endpoints for issue activity/search and fetch issue activity details
*WorkItemActivityApi* | [**retrieve_work_item_activity**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemActivityApi.md#retrieve_work_item_activity) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/activities/{pk}/ | Endpoints for issue activity/search and fetch issue activity details
*WorkItemAttachmentsApi* | [**create_work_item_attachment**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemAttachmentsApi.md#create_work_item_attachment) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/issue-attachments/ | Endpoints for issue attachment create/update/delete and fetch issue attachment details
*WorkItemAttachmentsApi* | [**delete_work_item_attachment**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemAttachmentsApi.md#delete_work_item_attachment) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/issue-attachments/{pk}/ | Endpoints for issue attachment create/update/delete and fetch issue attachment details
*WorkItemAttachmentsApi* | [**list_work_item_attachments**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemAttachmentsApi.md#list_work_item_attachments) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/issue-attachments/ | Endpoints for issue attachment create/update/delete and fetch issue attachment details
*WorkItemAttachmentsApi* | [**retrieve_work_item_attachment**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemAttachmentsApi.md#retrieve_work_item_attachment) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/issue-attachments/{pk}/ | Endpoints for issue attachment create/update/delete and fetch issue attachment details
*WorkItemCommentsApi* | [**create_work_item_comment**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemCommentsApi.md#create_work_item_comment) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/comments/ | Endpoints for issue comment create/update/delete and fetch issue comment details
*WorkItemCommentsApi* | [**delete_work_item_comment**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemCommentsApi.md#delete_work_item_comment) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/comments/{pk}/ | Endpoints for issue comment create/update/delete and fetch issue comment details
*WorkItemCommentsApi* | [**list_work_item_comments**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemCommentsApi.md#list_work_item_comments) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/comments/ | Endpoints for issue comment create/update/delete and fetch issue comment details
*WorkItemCommentsApi* | [**retrieve_work_item_comment**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemCommentsApi.md#retrieve_work_item_comment) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/comments/{pk}/ | Endpoints for issue comment create/update/delete and fetch issue comment details
*WorkItemCommentsApi* | [**update_work_item_comment**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemCommentsApi.md#update_work_item_comment) | **PATCH** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/comments/{pk}/ | Endpoints for issue comment create/update/delete and fetch issue comment details
*WorkItemLinksApi* | [**create_work_item_link**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemLinksApi.md#create_work_item_link) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/links/ | Endpoints for issue link create/update/delete and fetch issue link details
*WorkItemLinksApi* | [**delete_work_item_link**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemLinksApi.md#delete_work_item_link) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/links/{pk}/ | Endpoints for issue link create/update/delete and fetch issue link details
*WorkItemLinksApi* | [**list_work_item_links**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemLinksApi.md#list_work_item_links) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/links/ | Endpoints for issue link create/update/delete and fetch issue link details
*WorkItemLinksApi* | [**retrieve_work_item_link**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemLinksApi.md#retrieve_work_item_link) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/links/{pk}/ | Endpoints for issue link create/update/delete and fetch issue link details
*WorkItemLinksApi* | [**update_issue_link**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemLinksApi.md#update_issue_link) | **PATCH** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/links/{pk}/ | Update an issue link
*WorkItemPropertiesApi* | [**create_issue_property**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemPropertiesApi.md#create_issue_property) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/issue-types/{type_id}/issue-properties/ | Create a new issue property
*WorkItemPropertiesApi* | [**create_issue_property_option**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemPropertiesApi.md#create_issue_property_option) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/issue-properties/{property_id}/options/ | Create a new issue property option
*WorkItemPropertiesApi* | [**create_issue_property_value**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemPropertiesApi.md#create_issue_property_value) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/issue-properties/{property_id}/values/ | Create/update an issue property value
*WorkItemPropertiesApi* | [**delete_issue_property**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemPropertiesApi.md#delete_issue_property) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/issue-types/{type_id}/issue-properties/{property_id}/ | Delete an issue property
*WorkItemPropertiesApi* | [**delete_issue_property_option**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemPropertiesApi.md#delete_issue_property_option) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/issue-properties/{property_id}/options/{option_id}/ | Delete an issue property option
*WorkItemPropertiesApi* | [**list_issue_properties**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemPropertiesApi.md#list_issue_properties) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issue-types/{type_id}/issue-properties/ | List issue properties
*WorkItemPropertiesApi* | [**list_issue_property_options**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemPropertiesApi.md#list_issue_property_options) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issue-properties/{property_id}/options/ | List issue property options
*WorkItemPropertiesApi* | [**list_issue_property_values**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemPropertiesApi.md#list_issue_property_values) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/issue-properties/{property_id}/values/ | List issue property values
*WorkItemPropertiesApi* | [**retrieve_issue_property**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemPropertiesApi.md#retrieve_issue_property) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issue-types/{type_id}/issue-properties/{property_id}/ | Get issue property by id
*WorkItemPropertiesApi* | [**retrieve_issue_property_option**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemPropertiesApi.md#retrieve_issue_property_option) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issue-properties/{property_id}/options/{option_id}/ | Get issue property option by id
*WorkItemPropertiesApi* | [**update_issue_property**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemPropertiesApi.md#update_issue_property) | **PATCH** /api/v1/workspaces/{slug}/projects/{project_id}/issue-types/{type_id}/issue-properties/{property_id}/ | Update an issue property
*WorkItemPropertiesApi* | [**update_issue_property_option**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemPropertiesApi.md#update_issue_property_option) | **PATCH** /api/v1/workspaces/{slug}/projects/{project_id}/issue-properties/{property_id}/options/{option_id}/ | Update an issue property option
*WorkItemTypesApi* | [**create_issue_type**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemTypesApi.md#create_issue_type) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/issue-types/ | Create a new issue type
*WorkItemTypesApi* | [**delete_issue_type**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemTypesApi.md#delete_issue_type) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/issue-types/{type_id}/ | Delete an issue type
*WorkItemTypesApi* | [**list_issue_types**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemTypesApi.md#list_issue_types) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issue-types/ | List issue types
*WorkItemTypesApi* | [**retrieve_issue_type**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemTypesApi.md#retrieve_issue_type) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issue-types/{type_id}/ | Retrieve an issue type by id
*WorkItemTypesApi* | [**update_issue_type**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemTypesApi.md#update_issue_type) | **PATCH** /api/v1/workspaces/{slug}/projects/{project_id}/issue-types/{type_id}/ | Update an issue type
*WorkItemWorklogsApi* | [**create_issue_worklog**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemWorklogsApi.md#create_issue_worklog) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/worklogs/ | Create a new worklog entry
*WorkItemWorklogsApi* | [**delete_issue_worklog**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemWorklogsApi.md#delete_issue_worklog) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/worklogs/{pk}/ | Delete a worklog entry
*WorkItemWorklogsApi* | [**get_project_worklog_summary**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemWorklogsApi.md#get_project_worklog_summary) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/total-worklogs/ | Get project worklog summary
*WorkItemWorklogsApi* | [**list_issue_worklogs**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemWorklogsApi.md#list_issue_worklogs) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/worklogs/ | List worklog entries
*WorkItemWorklogsApi* | [**update_issue_worklog**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemWorklogsApi.md#update_issue_worklog) | **PATCH** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/worklogs/{pk}/ | Update a worklog entry
*WorkItemsApi* | [**create_work_item**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemsApi.md#create_work_item) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/issues/ | Create work item
*WorkItemsApi* | [**delete_work_item**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemsApi.md#delete_work_item) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{pk}/ | Delete work item
*WorkItemsApi* | [**get_workspace_work_item**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemsApi.md#get_workspace_work_item) | **GET** /api/v1/workspaces/{slug}/issues/{project_identifier}-{issue_identifier}/ | Retrieve work item by identifiers
*WorkItemsApi* | [**list_work_items**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemsApi.md#list_work_items) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issues/ | List work items
*WorkItemsApi* | [**retrieve_work_item**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemsApi.md#retrieve_work_item) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{pk}/ | Retrieve work item
*WorkItemsApi* | [**search_work_items**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemsApi.md#search_work_items) | **GET** /api/v1/workspaces/{slug}/issues/search/ | 
*WorkItemsApi* | [**update_work_item**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemsApi.md#update_work_item) | **PATCH** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{pk}/ | Partially update work item


## Documentation For Models

 - [AccessEnum](https://github.com/makeplane/plane-python-sdk/blob/main/docs/AccessEnum.md)
 - [Cycle](https://github.com/makeplane/plane-python-sdk/blob/main/docs/Cycle.md)
 - [CycleCreateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/CycleCreateRequest.md)
 - [CycleIssue](https://github.com/makeplane/plane-python-sdk/blob/main/docs/CycleIssue.md)
 - [CycleIssueRequestRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/CycleIssueRequestRequest.md)
 - [CycleLite](https://github.com/makeplane/plane-python-sdk/blob/main/docs/CycleLite.md)
 - [EntityTypeEnum](https://github.com/makeplane/plane-python-sdk/blob/main/docs/EntityTypeEnum.md)
 - [GenericAssetUploadRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/GenericAssetUploadRequest.md)
 - [GetWorkspaceMembers200ResponseInner](https://github.com/makeplane/plane-python-sdk/blob/main/docs/GetWorkspaceMembers200ResponseInner.md)
 - [GroupEnum](https://github.com/makeplane/plane-python-sdk/blob/main/docs/GroupEnum.md)
 - [IntakeIssue](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IntakeIssue.md)
 - [IntakeIssueCreateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IntakeIssueCreateRequest.md)
 - [IntakeWorkItemStatusEnum](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IntakeWorkItemStatusEnum.md)
 - [Issue](https://github.com/makeplane/plane-python-sdk/blob/main/docs/Issue.md)
 - [IssueActivity](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueActivity.md)
 - [IssueAttachment](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueAttachment.md)
 - [IssueAttachmentUploadRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueAttachmentUploadRequest.md)
 - [IssueComment](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueComment.md)
 - [IssueCommentCreateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueCommentCreateRequest.md)
 - [IssueExpand](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueExpand.md)
 - [IssueForIntakeRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueForIntakeRequest.md)
 - [IssueLink](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueLink.md)
 - [IssueLinkCreateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueLinkCreateRequest.md)
 - [IssuePropertyAPI](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssuePropertyAPI.md)
 - [IssuePropertyAPIRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssuePropertyAPIRequest.md)
 - [IssuePropertyOptionAPI](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssuePropertyOptionAPI.md)
 - [IssuePropertyOptionAPIRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssuePropertyOptionAPIRequest.md)
 - [IssuePropertyValueAPI](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssuePropertyValueAPI.md)
 - [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)
 - [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)
 - [IssueWorkLogAPIRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueWorkLogAPIRequest.md)
 - [Label](https://github.com/makeplane/plane-python-sdk/blob/main/docs/Label.md)
 - [LabelCreateUpdateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/LabelCreateUpdateRequest.md)
 - [LabelLite](https://github.com/makeplane/plane-python-sdk/blob/main/docs/LabelLite.md)
 - [Module](https://github.com/makeplane/plane-python-sdk/blob/main/docs/Module.md)
 - [ModuleCreateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ModuleCreateRequest.md)
 - [ModuleIssue](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ModuleIssue.md)
 - [ModuleIssueRequestRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ModuleIssueRequestRequest.md)
 - [ModuleLite](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ModuleLite.md)
 - [ModuleStatusEnum](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ModuleStatusEnum.md)
 - [NetworkEnum](https://github.com/makeplane/plane-python-sdk/blob/main/docs/NetworkEnum.md)
 - [PaginatedArchivedCycleResponse](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PaginatedArchivedCycleResponse.md)
 - [PaginatedArchivedModuleResponse](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PaginatedArchivedModuleResponse.md)
 - [PaginatedCycleIssueResponse](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PaginatedCycleIssueResponse.md)
 - [PaginatedCycleResponse](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PaginatedCycleResponse.md)
 - [PaginatedIntakeIssueResponse](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PaginatedIntakeIssueResponse.md)
 - [PaginatedIssueActivityDetailResponse](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PaginatedIssueActivityDetailResponse.md)
 - [PaginatedIssueActivityResponse](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PaginatedIssueActivityResponse.md)
 - [PaginatedIssueCommentResponse](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PaginatedIssueCommentResponse.md)
 - [PaginatedIssueLinkDetailResponse](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PaginatedIssueLinkDetailResponse.md)
 - [PaginatedIssueLinkResponse](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PaginatedIssueLinkResponse.md)
 - [PaginatedLabelResponse](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PaginatedLabelResponse.md)
 - [PaginatedModuleIssueResponse](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PaginatedModuleIssueResponse.md)
 - [PaginatedModuleResponse](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PaginatedModuleResponse.md)
 - [PaginatedProjectResponse](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PaginatedProjectResponse.md)
 - [PaginatedStateResponse](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PaginatedStateResponse.md)
 - [PaginatedWorkItemResponse](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PaginatedWorkItemResponse.md)
 - [PatchedAssetUpdateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PatchedAssetUpdateRequest.md)
 - [PatchedCycleUpdateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PatchedCycleUpdateRequest.md)
 - [PatchedGenericAssetUpdateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PatchedGenericAssetUpdateRequest.md)
 - [PatchedIntakeIssueUpdateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PatchedIntakeIssueUpdateRequest.md)
 - [PatchedIssueCommentCreateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PatchedIssueCommentCreateRequest.md)
 - [PatchedIssueLinkUpdateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PatchedIssueLinkUpdateRequest.md)
 - [PatchedIssuePropertyAPIRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PatchedIssuePropertyAPIRequest.md)
 - [PatchedIssuePropertyOptionAPIRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PatchedIssuePropertyOptionAPIRequest.md)
 - [PatchedIssueRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PatchedIssueRequest.md)
 - [PatchedIssueTypeAPIRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PatchedIssueTypeAPIRequest.md)
 - [PatchedIssueWorkLogAPIRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PatchedIssueWorkLogAPIRequest.md)
 - [PatchedLabelCreateUpdateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PatchedLabelCreateUpdateRequest.md)
 - [PatchedModuleUpdateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PatchedModuleUpdateRequest.md)
 - [PatchedProjectUpdateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PatchedProjectUpdateRequest.md)
 - [PatchedStateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PatchedStateRequest.md)
 - [PriorityEnum](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PriorityEnum.md)
 - [Project](https://github.com/makeplane/plane-python-sdk/blob/main/docs/Project.md)
 - [ProjectCreateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ProjectCreateRequest.md)
 - [ProjectWorklogSummary](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ProjectWorklogSummary.md)
 - [PropertyTypeEnum](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PropertyTypeEnum.md)
 - [RelationTypeEnum](https://github.com/makeplane/plane-python-sdk/blob/main/docs/RelationTypeEnum.md)
 - [RetrieveWorkItemAttachment400Response](https://github.com/makeplane/plane-python-sdk/blob/main/docs/RetrieveWorkItemAttachment400Response.md)
 - [State](https://github.com/makeplane/plane-python-sdk/blob/main/docs/State.md)
 - [StateLite](https://github.com/makeplane/plane-python-sdk/blob/main/docs/StateLite.md)
 - [StateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/StateRequest.md)
 - [TimezoneEnum](https://github.com/makeplane/plane-python-sdk/blob/main/docs/TimezoneEnum.md)
 - [TransferCycleIssueRequestRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/TransferCycleIssueRequestRequest.md)
 - [TransferCycleWorkItems200Response](https://github.com/makeplane/plane-python-sdk/blob/main/docs/TransferCycleWorkItems200Response.md)
 - [TransferCycleWorkItems400Response](https://github.com/makeplane/plane-python-sdk/blob/main/docs/TransferCycleWorkItems400Response.md)
 - [TypeEnum](https://github.com/makeplane/plane-python-sdk/blob/main/docs/TypeEnum.md)
 - [UserAssetUploadRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/UserAssetUploadRequest.md)
 - [UserLite](https://github.com/makeplane/plane-python-sdk/blob/main/docs/UserLite.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="ApiKeyAuthentication"></a>
### ApiKeyAuthentication

- **Type**: API key
- **API key parameter name**: X-API-Key
- **Location**: HTTP header

<a id="OAuth2Authentication"></a>
### OAuth2Authentication

- **Type**: OAuth
- **Flow**: application
- **Authorization URL**: 
- **Scopes**: 
 - **read**: Read access to resources
 - **write**: Write access to resources

<a id="OAuth2Authentication"></a>
### OAuth2Authentication

- **Type**: OAuth
- **Flow**: accessCode
- **Authorization URL**: /auth/o/authorize-app/
- **Scopes**: 
 - **read**: Read access to resources
 - **write**: Write access to resources


## Author

support@plane.so



            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "plane-sdk",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "The Plane REST API",
    "author": "Plane",
    "author_email": "support@plane.so",
    "download_url": "https://files.pythonhosted.org/packages/e2/ce/870ab32f7fc2377fdb8017a4b8a0296f9f592643819338d14fd5234ff2a0/plane_sdk-0.1.3.tar.gz",
    "platform": null,
    "description": "# plane-sdk\nThe Plane REST API\n\nVisit our quick start guide and full API documentation at [developers.plane.so](https://developers.plane.so/api-reference/introduction).\n\n- API version: 0.0.1\n- Package version: 0.1.3\n- Generator version: 7.13.0\n- Build package: org.openapitools.codegen.languages.PythonPydanticV1ClientCodegen\nFor more information, please visit [https://plane.so](https://plane.so)\n\n## Requirements.\n\nPython 3.7+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install plane-sdk\n```\n(you may need to run `pip` with root permission: `sudo pip install plane-sdk`)\n\nThen import the package:\n```python\nimport plane\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport plane\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\nfrom plane.configuration import Configuration\nfrom plane.api_client import ApiClient\nfrom plane.api.users_api import UsersApi\nfrom plane.api.projects_api import ProjectsApi\nfrom plane.exceptions import ApiException\n\ndef test_api():\n\n    # Configure API Key authentication\n    configuration = Configuration(\n        api_key={'ApiKeyAuthentication': <API_KEY>}\n    )\n\n    # Configure Access Token authentication\n    # configuration = Configuration(\n    #    access_token='<PLANE_ACCESS_TOKEN>'\n    # )\n\n    # Create API client instance\n    api_client = ApiClient(configuration)\n\n    # Create Users API instance\n    users_api = UsersApi(api_client)\n\n    # Call get_current_user endpoint\n    print(\"Fetching current user information...\")\n    user = users_api.get_current_user()\n    print(user.email)\n\n    projects_api = ProjectsApi(api_client)\n    projects_response = projects_api.list_projects(slug=\"<workspace_slug>\")\n    for project in projects_response.results:\n        print(f\"{project.id} - {project.name}\")\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.plane.so*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*AssetsApi* | [**create_generic_asset_upload**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/AssetsApi.md#create_generic_asset_upload) | **POST** /api/v1/workspaces/{slug}/assets/ | Generate presigned URL for generic asset upload\n*AssetsApi* | [**create_user_asset_upload**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/AssetsApi.md#create_user_asset_upload) | **POST** /api/v1/assets/user-assets/ | Generate presigned URL for user asset upload\n*AssetsApi* | [**delete_user_asset**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/AssetsApi.md#delete_user_asset) | **DELETE** /api/v1/assets/user-assets/{asset_id}/ | Delete user asset\n*AssetsApi* | [**get_generic_asset**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/AssetsApi.md#get_generic_asset) | **GET** /api/v1/workspaces/{slug}/assets/{asset_id}/ | Get presigned URL for asset download\n*AssetsApi* | [**update_generic_asset**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/AssetsApi.md#update_generic_asset) | **PATCH** /api/v1/workspaces/{slug}/assets/{asset_id}/ | Update generic asset after upload completion\n*AssetsApi* | [**update_user_asset**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/AssetsApi.md#update_user_asset) | **PATCH** /api/v1/assets/user-assets/{asset_id}/ | Mark user asset as uploaded\n*CyclesApi* | [**add_cycle_work_items**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/CyclesApi.md#add_cycle_work_items) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/ | Add Work Items to Cycle\n*CyclesApi* | [**archive_cycle**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/CyclesApi.md#archive_cycle) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/archive/ | Archive cycle\n*CyclesApi* | [**create_cycle**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/CyclesApi.md#create_cycle) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/ | Create cycle\n*CyclesApi* | [**delete_cycle**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/CyclesApi.md#delete_cycle) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{pk}/ | Delete cycle\n*CyclesApi* | [**delete_cycle_work_item**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/CyclesApi.md#delete_cycle_work_item) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/{issue_id}/ | Delete cycle work item\n*CyclesApi* | [**list_archived_cycles**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/CyclesApi.md#list_archived_cycles) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/archived-cycles/ | List archived cycles\n*CyclesApi* | [**list_cycle_work_items**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/CyclesApi.md#list_cycle_work_items) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/ | List cycle work items\n*CyclesApi* | [**list_cycles**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/CyclesApi.md#list_cycles) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/ | List cycles\n*CyclesApi* | [**retrieve_cycle**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/CyclesApi.md#retrieve_cycle) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{pk}/ | Retrieve cycle\n*CyclesApi* | [**retrieve_cycle_work_item**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/CyclesApi.md#retrieve_cycle_work_item) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/{issue_id}/ | Retrieve cycle work item\n*CyclesApi* | [**transfer_cycle_work_items**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/CyclesApi.md#transfer_cycle_work_items) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/transfer-issues/ | Transfer cycle work items\n*CyclesApi* | [**unarchive_cycle**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/CyclesApi.md#unarchive_cycle) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/archived-cycles/{pk}/unarchive/ | Unarchive cycle\n*CyclesApi* | [**update_cycle**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/CyclesApi.md#update_cycle) | **PATCH** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{pk}/ | Update cycle\n*IntakeApi* | [**create_intake_work_item**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IntakeApi.md#create_intake_work_item) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/intake-issues/ | Create intake work item\n*IntakeApi* | [**delete_intake_work_item**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IntakeApi.md#delete_intake_work_item) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/intake-issues/{issue_id}/ | Delete intake work item\n*IntakeApi* | [**get_intake_work_items_list**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IntakeApi.md#get_intake_work_items_list) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/intake-issues/ | List intake work items\n*IntakeApi* | [**retrieve_intake_work_item**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IntakeApi.md#retrieve_intake_work_item) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/intake-issues/{issue_id}/ | Retrieve intake work item\n*IntakeApi* | [**update_intake_work_item**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IntakeApi.md#update_intake_work_item) | **PATCH** /api/v1/workspaces/{slug}/projects/{project_id}/intake-issues/{issue_id}/ | Update intake work item\n*LabelsApi* | [**create_label**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/LabelsApi.md#create_label) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/labels/ | Endpoints for label create/update/delete and fetch label details\n*LabelsApi* | [**delete_label**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/LabelsApi.md#delete_label) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/labels/{pk}/ | Delete a label\n*LabelsApi* | [**get_labels**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/LabelsApi.md#get_labels) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/labels/{pk}/ | Endpoints for label create/update/delete and fetch label details\n*LabelsApi* | [**list_labels**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/LabelsApi.md#list_labels) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/labels/ | Endpoints for label create/update/delete and fetch label details\n*LabelsApi* | [**update_label**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/LabelsApi.md#update_label) | **PATCH** /api/v1/workspaces/{slug}/projects/{project_id}/labels/{pk}/ | Update a label\n*MembersApi* | [**get_project_members**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/MembersApi.md#get_project_members) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/members/ | List project members\n*MembersApi* | [**get_workspace_members**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/MembersApi.md#get_workspace_members) | **GET** /api/v1/workspaces/{slug}/members/ | List workspace members\n*ModulesApi* | [**add_module_work_items**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ModulesApi.md#add_module_work_items) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/modules/{module_id}/module-issues/ | Add Work Items to Module\n*ModulesApi* | [**archive_module**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ModulesApi.md#archive_module) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/modules/{pk}/archive/ | Archive module\n*ModulesApi* | [**create_module**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ModulesApi.md#create_module) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/modules/ | Create module\n*ModulesApi* | [**delete_module**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ModulesApi.md#delete_module) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/modules/{pk}/ | Delete module\n*ModulesApi* | [**delete_module_work_item**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ModulesApi.md#delete_module_work_item) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/modules/{module_id}/module-issues/{issue_id}/ | Delete module work item\n*ModulesApi* | [**list_archived_modules**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ModulesApi.md#list_archived_modules) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/archived-modules/ | List archived modules\n*ModulesApi* | [**list_module_work_items**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ModulesApi.md#list_module_work_items) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/modules/{module_id}/module-issues/ | List module work items\n*ModulesApi* | [**list_modules**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ModulesApi.md#list_modules) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/modules/ | List modules\n*ModulesApi* | [**retrieve_module**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ModulesApi.md#retrieve_module) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/modules/{pk}/ | Retrieve module\n*ModulesApi* | [**unarchive_module**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ModulesApi.md#unarchive_module) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/archived-modules/{pk}/unarchive/ | Unarchive module\n*ModulesApi* | [**update_module**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ModulesApi.md#update_module) | **PATCH** /api/v1/workspaces/{slug}/projects/{project_id}/modules/{pk}/ | Update module\n*ProjectsApi* | [**archive_project**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ProjectsApi.md#archive_project) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/archive/ | Archive project\n*ProjectsApi* | [**create_project**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ProjectsApi.md#create_project) | **POST** /api/v1/workspaces/{slug}/projects/ | Create project\n*ProjectsApi* | [**delete_project**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ProjectsApi.md#delete_project) | **DELETE** /api/v1/workspaces/{slug}/projects/{pk}/ | Delete project\n*ProjectsApi* | [**list_projects**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ProjectsApi.md#list_projects) | **GET** /api/v1/workspaces/{slug}/projects/ | List or retrieve projects\n*ProjectsApi* | [**retrieve_project**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ProjectsApi.md#retrieve_project) | **GET** /api/v1/workspaces/{slug}/projects/{pk}/ | Retrieve project\n*ProjectsApi* | [**unarchive_project**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ProjectsApi.md#unarchive_project) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/archive/ | Unarchive project\n*ProjectsApi* | [**update_project**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ProjectsApi.md#update_project) | **PATCH** /api/v1/workspaces/{slug}/projects/{pk}/ | Update project\n*StatesApi* | [**create_state**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/StatesApi.md#create_state) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/states/ | Create state\n*StatesApi* | [**delete_state**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/StatesApi.md#delete_state) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/states/{state_id}/ | Delete state\n*StatesApi* | [**list_states**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/StatesApi.md#list_states) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/states/ | List states\n*StatesApi* | [**retrieve_state**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/StatesApi.md#retrieve_state) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/states/{state_id}/ | Retrieve state\n*StatesApi* | [**update_state**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/StatesApi.md#update_state) | **PATCH** /api/v1/workspaces/{slug}/projects/{project_id}/states/{state_id}/ | Update state\n*UsersApi* | [**get_current_user**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/UsersApi.md#get_current_user) | **GET** /api/v1/users/me/ | Get current user\n*WorkItemActivityApi* | [**list_work_item_activities**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemActivityApi.md#list_work_item_activities) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/activities/ | Endpoints for issue activity/search and fetch issue activity details\n*WorkItemActivityApi* | [**retrieve_work_item_activity**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemActivityApi.md#retrieve_work_item_activity) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/activities/{pk}/ | Endpoints for issue activity/search and fetch issue activity details\n*WorkItemAttachmentsApi* | [**create_work_item_attachment**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemAttachmentsApi.md#create_work_item_attachment) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/issue-attachments/ | Endpoints for issue attachment create/update/delete and fetch issue attachment details\n*WorkItemAttachmentsApi* | [**delete_work_item_attachment**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemAttachmentsApi.md#delete_work_item_attachment) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/issue-attachments/{pk}/ | Endpoints for issue attachment create/update/delete and fetch issue attachment details\n*WorkItemAttachmentsApi* | [**list_work_item_attachments**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemAttachmentsApi.md#list_work_item_attachments) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/issue-attachments/ | Endpoints for issue attachment create/update/delete and fetch issue attachment details\n*WorkItemAttachmentsApi* | [**retrieve_work_item_attachment**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemAttachmentsApi.md#retrieve_work_item_attachment) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/issue-attachments/{pk}/ | Endpoints for issue attachment create/update/delete and fetch issue attachment details\n*WorkItemCommentsApi* | [**create_work_item_comment**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemCommentsApi.md#create_work_item_comment) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/comments/ | Endpoints for issue comment create/update/delete and fetch issue comment details\n*WorkItemCommentsApi* | [**delete_work_item_comment**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemCommentsApi.md#delete_work_item_comment) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/comments/{pk}/ | Endpoints for issue comment create/update/delete and fetch issue comment details\n*WorkItemCommentsApi* | [**list_work_item_comments**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemCommentsApi.md#list_work_item_comments) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/comments/ | Endpoints for issue comment create/update/delete and fetch issue comment details\n*WorkItemCommentsApi* | [**retrieve_work_item_comment**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemCommentsApi.md#retrieve_work_item_comment) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/comments/{pk}/ | Endpoints for issue comment create/update/delete and fetch issue comment details\n*WorkItemCommentsApi* | [**update_work_item_comment**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemCommentsApi.md#update_work_item_comment) | **PATCH** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/comments/{pk}/ | Endpoints for issue comment create/update/delete and fetch issue comment details\n*WorkItemLinksApi* | [**create_work_item_link**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemLinksApi.md#create_work_item_link) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/links/ | Endpoints for issue link create/update/delete and fetch issue link details\n*WorkItemLinksApi* | [**delete_work_item_link**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemLinksApi.md#delete_work_item_link) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/links/{pk}/ | Endpoints for issue link create/update/delete and fetch issue link details\n*WorkItemLinksApi* | [**list_work_item_links**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemLinksApi.md#list_work_item_links) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/links/ | Endpoints for issue link create/update/delete and fetch issue link details\n*WorkItemLinksApi* | [**retrieve_work_item_link**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemLinksApi.md#retrieve_work_item_link) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/links/{pk}/ | Endpoints for issue link create/update/delete and fetch issue link details\n*WorkItemLinksApi* | [**update_issue_link**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemLinksApi.md#update_issue_link) | **PATCH** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/links/{pk}/ | Update an issue link\n*WorkItemPropertiesApi* | [**create_issue_property**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemPropertiesApi.md#create_issue_property) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/issue-types/{type_id}/issue-properties/ | Create a new issue property\n*WorkItemPropertiesApi* | [**create_issue_property_option**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemPropertiesApi.md#create_issue_property_option) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/issue-properties/{property_id}/options/ | Create a new issue property option\n*WorkItemPropertiesApi* | [**create_issue_property_value**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemPropertiesApi.md#create_issue_property_value) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/issue-properties/{property_id}/values/ | Create/update an issue property value\n*WorkItemPropertiesApi* | [**delete_issue_property**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemPropertiesApi.md#delete_issue_property) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/issue-types/{type_id}/issue-properties/{property_id}/ | Delete an issue property\n*WorkItemPropertiesApi* | [**delete_issue_property_option**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemPropertiesApi.md#delete_issue_property_option) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/issue-properties/{property_id}/options/{option_id}/ | Delete an issue property option\n*WorkItemPropertiesApi* | [**list_issue_properties**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemPropertiesApi.md#list_issue_properties) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issue-types/{type_id}/issue-properties/ | List issue properties\n*WorkItemPropertiesApi* | [**list_issue_property_options**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemPropertiesApi.md#list_issue_property_options) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issue-properties/{property_id}/options/ | List issue property options\n*WorkItemPropertiesApi* | [**list_issue_property_values**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemPropertiesApi.md#list_issue_property_values) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/issue-properties/{property_id}/values/ | List issue property values\n*WorkItemPropertiesApi* | [**retrieve_issue_property**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemPropertiesApi.md#retrieve_issue_property) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issue-types/{type_id}/issue-properties/{property_id}/ | Get issue property by id\n*WorkItemPropertiesApi* | [**retrieve_issue_property_option**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemPropertiesApi.md#retrieve_issue_property_option) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issue-properties/{property_id}/options/{option_id}/ | Get issue property option by id\n*WorkItemPropertiesApi* | [**update_issue_property**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemPropertiesApi.md#update_issue_property) | **PATCH** /api/v1/workspaces/{slug}/projects/{project_id}/issue-types/{type_id}/issue-properties/{property_id}/ | Update an issue property\n*WorkItemPropertiesApi* | [**update_issue_property_option**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemPropertiesApi.md#update_issue_property_option) | **PATCH** /api/v1/workspaces/{slug}/projects/{project_id}/issue-properties/{property_id}/options/{option_id}/ | Update an issue property option\n*WorkItemTypesApi* | [**create_issue_type**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemTypesApi.md#create_issue_type) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/issue-types/ | Create a new issue type\n*WorkItemTypesApi* | [**delete_issue_type**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemTypesApi.md#delete_issue_type) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/issue-types/{type_id}/ | Delete an issue type\n*WorkItemTypesApi* | [**list_issue_types**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemTypesApi.md#list_issue_types) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issue-types/ | List issue types\n*WorkItemTypesApi* | [**retrieve_issue_type**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemTypesApi.md#retrieve_issue_type) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issue-types/{type_id}/ | Retrieve an issue type by id\n*WorkItemTypesApi* | [**update_issue_type**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemTypesApi.md#update_issue_type) | **PATCH** /api/v1/workspaces/{slug}/projects/{project_id}/issue-types/{type_id}/ | Update an issue type\n*WorkItemWorklogsApi* | [**create_issue_worklog**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemWorklogsApi.md#create_issue_worklog) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/worklogs/ | Create a new worklog entry\n*WorkItemWorklogsApi* | [**delete_issue_worklog**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemWorklogsApi.md#delete_issue_worklog) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/worklogs/{pk}/ | Delete a worklog entry\n*WorkItemWorklogsApi* | [**get_project_worklog_summary**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemWorklogsApi.md#get_project_worklog_summary) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/total-worklogs/ | Get project worklog summary\n*WorkItemWorklogsApi* | [**list_issue_worklogs**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemWorklogsApi.md#list_issue_worklogs) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/worklogs/ | List worklog entries\n*WorkItemWorklogsApi* | [**update_issue_worklog**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemWorklogsApi.md#update_issue_worklog) | **PATCH** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/worklogs/{pk}/ | Update a worklog entry\n*WorkItemsApi* | [**create_work_item**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemsApi.md#create_work_item) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/issues/ | Create work item\n*WorkItemsApi* | [**delete_work_item**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemsApi.md#delete_work_item) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{pk}/ | Delete work item\n*WorkItemsApi* | [**get_workspace_work_item**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemsApi.md#get_workspace_work_item) | **GET** /api/v1/workspaces/{slug}/issues/{project_identifier}-{issue_identifier}/ | Retrieve work item by identifiers\n*WorkItemsApi* | [**list_work_items**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemsApi.md#list_work_items) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issues/ | List work items\n*WorkItemsApi* | [**retrieve_work_item**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemsApi.md#retrieve_work_item) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{pk}/ | Retrieve work item\n*WorkItemsApi* | [**search_work_items**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemsApi.md#search_work_items) | **GET** /api/v1/workspaces/{slug}/issues/search/ | \n*WorkItemsApi* | [**update_work_item**](https://github.com/makeplane/plane-python-sdk/blob/main/docs/WorkItemsApi.md#update_work_item) | **PATCH** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{pk}/ | Partially update work item\n\n\n## Documentation For Models\n\n - [AccessEnum](https://github.com/makeplane/plane-python-sdk/blob/main/docs/AccessEnum.md)\n - [Cycle](https://github.com/makeplane/plane-python-sdk/blob/main/docs/Cycle.md)\n - [CycleCreateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/CycleCreateRequest.md)\n - [CycleIssue](https://github.com/makeplane/plane-python-sdk/blob/main/docs/CycleIssue.md)\n - [CycleIssueRequestRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/CycleIssueRequestRequest.md)\n - [CycleLite](https://github.com/makeplane/plane-python-sdk/blob/main/docs/CycleLite.md)\n - [EntityTypeEnum](https://github.com/makeplane/plane-python-sdk/blob/main/docs/EntityTypeEnum.md)\n - [GenericAssetUploadRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/GenericAssetUploadRequest.md)\n - [GetWorkspaceMembers200ResponseInner](https://github.com/makeplane/plane-python-sdk/blob/main/docs/GetWorkspaceMembers200ResponseInner.md)\n - [GroupEnum](https://github.com/makeplane/plane-python-sdk/blob/main/docs/GroupEnum.md)\n - [IntakeIssue](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IntakeIssue.md)\n - [IntakeIssueCreateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IntakeIssueCreateRequest.md)\n - [IntakeWorkItemStatusEnum](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IntakeWorkItemStatusEnum.md)\n - [Issue](https://github.com/makeplane/plane-python-sdk/blob/main/docs/Issue.md)\n - [IssueActivity](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueActivity.md)\n - [IssueAttachment](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueAttachment.md)\n - [IssueAttachmentUploadRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueAttachmentUploadRequest.md)\n - [IssueComment](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueComment.md)\n - [IssueCommentCreateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueCommentCreateRequest.md)\n - [IssueExpand](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueExpand.md)\n - [IssueForIntakeRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueForIntakeRequest.md)\n - [IssueLink](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueLink.md)\n - [IssueLinkCreateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueLinkCreateRequest.md)\n - [IssuePropertyAPI](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssuePropertyAPI.md)\n - [IssuePropertyAPIRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssuePropertyAPIRequest.md)\n - [IssuePropertyOptionAPI](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssuePropertyOptionAPI.md)\n - [IssuePropertyOptionAPIRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssuePropertyOptionAPIRequest.md)\n - [IssuePropertyValueAPI](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssuePropertyValueAPI.md)\n - [IssuePropertyValueAPIRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssuePropertyValueAPIRequest.md)\n - [IssueRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueRequest.md)\n - [IssueSearch](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueSearch.md)\n - [IssueTypeAPI](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueTypeAPI.md)\n - [IssueTypeAPIRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueTypeAPIRequest.md)\n - [IssueWorkLogAPI](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueWorkLogAPI.md)\n - [IssueWorkLogAPIRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueWorkLogAPIRequest.md)\n - [Label](https://github.com/makeplane/plane-python-sdk/blob/main/docs/Label.md)\n - [LabelCreateUpdateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/LabelCreateUpdateRequest.md)\n - [LabelLite](https://github.com/makeplane/plane-python-sdk/blob/main/docs/LabelLite.md)\n - [Module](https://github.com/makeplane/plane-python-sdk/blob/main/docs/Module.md)\n - [ModuleCreateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ModuleCreateRequest.md)\n - [ModuleIssue](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ModuleIssue.md)\n - [ModuleIssueRequestRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ModuleIssueRequestRequest.md)\n - [ModuleLite](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ModuleLite.md)\n - [ModuleStatusEnum](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ModuleStatusEnum.md)\n - [NetworkEnum](https://github.com/makeplane/plane-python-sdk/blob/main/docs/NetworkEnum.md)\n - [PaginatedArchivedCycleResponse](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PaginatedArchivedCycleResponse.md)\n - [PaginatedArchivedModuleResponse](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PaginatedArchivedModuleResponse.md)\n - [PaginatedCycleIssueResponse](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PaginatedCycleIssueResponse.md)\n - [PaginatedCycleResponse](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PaginatedCycleResponse.md)\n - [PaginatedIntakeIssueResponse](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PaginatedIntakeIssueResponse.md)\n - [PaginatedIssueActivityDetailResponse](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PaginatedIssueActivityDetailResponse.md)\n - [PaginatedIssueActivityResponse](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PaginatedIssueActivityResponse.md)\n - [PaginatedIssueCommentResponse](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PaginatedIssueCommentResponse.md)\n - [PaginatedIssueLinkDetailResponse](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PaginatedIssueLinkDetailResponse.md)\n - [PaginatedIssueLinkResponse](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PaginatedIssueLinkResponse.md)\n - [PaginatedLabelResponse](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PaginatedLabelResponse.md)\n - [PaginatedModuleIssueResponse](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PaginatedModuleIssueResponse.md)\n - [PaginatedModuleResponse](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PaginatedModuleResponse.md)\n - [PaginatedProjectResponse](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PaginatedProjectResponse.md)\n - [PaginatedStateResponse](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PaginatedStateResponse.md)\n - [PaginatedWorkItemResponse](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PaginatedWorkItemResponse.md)\n - [PatchedAssetUpdateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PatchedAssetUpdateRequest.md)\n - [PatchedCycleUpdateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PatchedCycleUpdateRequest.md)\n - [PatchedGenericAssetUpdateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PatchedGenericAssetUpdateRequest.md)\n - [PatchedIntakeIssueUpdateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PatchedIntakeIssueUpdateRequest.md)\n - [PatchedIssueCommentCreateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PatchedIssueCommentCreateRequest.md)\n - [PatchedIssueLinkUpdateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PatchedIssueLinkUpdateRequest.md)\n - [PatchedIssuePropertyAPIRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PatchedIssuePropertyAPIRequest.md)\n - [PatchedIssuePropertyOptionAPIRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PatchedIssuePropertyOptionAPIRequest.md)\n - [PatchedIssueRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PatchedIssueRequest.md)\n - [PatchedIssueTypeAPIRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PatchedIssueTypeAPIRequest.md)\n - [PatchedIssueWorkLogAPIRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PatchedIssueWorkLogAPIRequest.md)\n - [PatchedLabelCreateUpdateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PatchedLabelCreateUpdateRequest.md)\n - [PatchedModuleUpdateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PatchedModuleUpdateRequest.md)\n - [PatchedProjectUpdateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PatchedProjectUpdateRequest.md)\n - [PatchedStateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PatchedStateRequest.md)\n - [PriorityEnum](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PriorityEnum.md)\n - [Project](https://github.com/makeplane/plane-python-sdk/blob/main/docs/Project.md)\n - [ProjectCreateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ProjectCreateRequest.md)\n - [ProjectWorklogSummary](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ProjectWorklogSummary.md)\n - [PropertyTypeEnum](https://github.com/makeplane/plane-python-sdk/blob/main/docs/PropertyTypeEnum.md)\n - [RelationTypeEnum](https://github.com/makeplane/plane-python-sdk/blob/main/docs/RelationTypeEnum.md)\n - [RetrieveWorkItemAttachment400Response](https://github.com/makeplane/plane-python-sdk/blob/main/docs/RetrieveWorkItemAttachment400Response.md)\n - [State](https://github.com/makeplane/plane-python-sdk/blob/main/docs/State.md)\n - [StateLite](https://github.com/makeplane/plane-python-sdk/blob/main/docs/StateLite.md)\n - [StateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/StateRequest.md)\n - [TimezoneEnum](https://github.com/makeplane/plane-python-sdk/blob/main/docs/TimezoneEnum.md)\n - [TransferCycleIssueRequestRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/TransferCycleIssueRequestRequest.md)\n - [TransferCycleWorkItems200Response](https://github.com/makeplane/plane-python-sdk/blob/main/docs/TransferCycleWorkItems200Response.md)\n - [TransferCycleWorkItems400Response](https://github.com/makeplane/plane-python-sdk/blob/main/docs/TransferCycleWorkItems400Response.md)\n - [TypeEnum](https://github.com/makeplane/plane-python-sdk/blob/main/docs/TypeEnum.md)\n - [UserAssetUploadRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/UserAssetUploadRequest.md)\n - [UserLite](https://github.com/makeplane/plane-python-sdk/blob/main/docs/UserLite.md)\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\n\nAuthentication schemes defined for the API:\n<a id=\"ApiKeyAuthentication\"></a>\n### ApiKeyAuthentication\n\n- **Type**: API key\n- **API key parameter name**: X-API-Key\n- **Location**: HTTP header\n\n<a id=\"OAuth2Authentication\"></a>\n### OAuth2Authentication\n\n- **Type**: OAuth\n- **Flow**: application\n- **Authorization URL**: \n- **Scopes**: \n - **read**: Read access to resources\n - **write**: Write access to resources\n\n<a id=\"OAuth2Authentication\"></a>\n### OAuth2Authentication\n\n- **Type**: OAuth\n- **Flow**: accessCode\n- **Authorization URL**: /auth/o/authorize-app/\n- **Scopes**: \n - **read**: Read access to resources\n - **write**: Write access to resources\n\n\n## Author\n\nsupport@plane.so\n\n\n",
    "bugtrack_url": null,
    "license": "GNU AGPLv3",
    "summary": "The Plane REST API",
    "version": "0.1.3",
    "project_urls": null,
    "split_keywords": [
        "the",
        "plane",
        "rest",
        "api"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "64504f55cff8436866c6f2d1221cbd552fef2ada56f57d83ddca7f0b7046c373",
                "md5": "3b1ec4880150244b1e166062a1d19758",
                "sha256": "a0bdf138bcb8747b6efda16f5e2b12f9f22de2790a4436ec8f8934d5ce6874d6"
            },
            "downloads": -1,
            "filename": "plane_sdk-0.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3b1ec4880150244b1e166062a1d19758",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 229433,
            "upload_time": "2025-07-08T13:30:55",
            "upload_time_iso_8601": "2025-07-08T13:30:55.948692Z",
            "url": "https://files.pythonhosted.org/packages/64/50/4f55cff8436866c6f2d1221cbd552fef2ada56f57d83ddca7f0b7046c373/plane_sdk-0.1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "e2ce870ab32f7fc2377fdb8017a4b8a0296f9f592643819338d14fd5234ff2a0",
                "md5": "424e7ed4035703c052781fb3bfc8496b",
                "sha256": "8e91e23fb507a6144cf36c21757e36f7c887d655ec99629761236b92bee28aef"
            },
            "downloads": -1,
            "filename": "plane_sdk-0.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "424e7ed4035703c052781fb3bfc8496b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 107984,
            "upload_time": "2025-07-08T13:30:57",
            "upload_time_iso_8601": "2025-07-08T13:30:57.039342Z",
            "url": "https://files.pythonhosted.org/packages/e2/ce/870ab32f7fc2377fdb8017a4b8a0296f9f592643819338d14fd5234ff2a0/plane_sdk-0.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-08 13:30:57",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "plane-sdk"
}