python-backlog 0.6.0__py3-none-any.whl → 0.7.2__py3-none-any.whl

backlog/base.py

@@ -9,6 +9,7 @@ from backlog.issue import Issue
 from backlog.git import Git
 from backlog.user import User
 from backlog.category import Category
+from backlog.custom_field import CustomField
 
 BACKLOG_BASE_URL = "https://{space}.backlog.jp"
 BACKLOG_URI_PREFIX = "/api/v2/"
@@ -97,6 +98,7 @@ class BacklogAPI(BaseAPI):
         self.git = Git(self)
         self.user = User(self)
         self.category = Category(self)
+        self.custom_field = CustomField(self)
 
     def get(self, method, uri, query_param, request_param, headers, **kwargs):
         _url = self.base_url + uri

backlog/custom_field.py

@@ -0,0 +1,378 @@
+from enum import Enum
+from typing import List, TypedDict, NewType, Optional, Union
+
+
+class CustomFieldResponse(TypedDict):
+    id: int
+    projectId: int
+    typeId: int
+    version: str
+    name: str
+    description: str
+    required: bool
+    useIssueType: bool
+    applicableIssueTypes: List[int]
+    displayOrder: int
+
+
+class _InitialDate(TypedDict):
+    id: int
+    shift: Optional[int]
+    date: Optional[str]
+
+
+class NumberCustomFieldResponse(CustomFieldResponse):
+    min: int
+    max: int
+    initialValue: int
+    unit: str
+    initialDate: _InitialDate
+
+
+class DateCustomFieldResponse(CustomFieldResponse):
+    min: str
+    max: str
+    initialValueType: int
+    initialDate: str
+    initialShift: int
+
+
+class _ListCustomFieldResponseItem(TypedDict):
+    id: int
+    name: str
+    displayOrder: int
+
+
+class ListCustomFieldResponse(CustomFieldResponse):
+    items: List[_ListCustomFieldResponseItem]
+    allowInput: bool
+    allowAddItem: bool
+
+
+AddTextCustomFieldResponse = NewType("AddTextCustomFieldResponse", CustomFieldResponse)
+AddSentenceCustomFieldResponse = NewType("AddSentenceCustomFieldResponse", CustomFieldResponse)
+AddNumberCustomFieldResponse = NewType("AddNumberCustomFieldResponse", NumberCustomFieldResponse)
+AddDateCustomFieldResponse = NewType("AddDateCustomFieldResponse", DateCustomFieldResponse)
+AddSingleListCustomFieldResponse = NewType("AddSingleListCustomFieldResponse", ListCustomFieldResponse)
+AddMultipleListCustomFieldResponse = NewType("AddMultipleListCustomFieldResponse", ListCustomFieldResponse)
+AddCheckboxCustomFieldResponse = NewType("AddCheckboxCustomFieldResponse", ListCustomFieldResponse)
+AddRadioCustomFieldResponse = NewType("AddRadioCustomFieldResponse", ListCustomFieldResponse)
+AddCustomFiledResponse = Union[
+    AddTextCustomFieldResponse, AddSentenceCustomFieldResponse,
+    AddNumberCustomFieldResponse, AddDateCustomFieldResponse,
+    AddSingleListCustomFieldResponse, AddMultipleListCustomFieldResponse,
+    AddCheckboxCustomFieldResponse, AddRadioCustomFieldResponse,
+]
+
+DeleteTextCustomFieldResponse = NewType("DeleteTextCustomFieldResponse", CustomFieldResponse)
+DeleteSentenceCustomFieldResponse = NewType("DeleteSentenceCustomFieldResponse", CustomFieldResponse)
+DeleteNumberCustomFieldResponse = NewType("DeleteNumberCustomFieldResponse", NumberCustomFieldResponse)
+DeleteDateCustomFieldResponse = NewType("DeleteDateCustomFieldResponse", DateCustomFieldResponse)
+DeleteSingleListCustomFieldResponse = NewType("DeleteSingleListCustomFieldResponse", ListCustomFieldResponse)
+DeleteMultipleListCustomFieldResponse = NewType("DeleteMultipleListCustomFieldResponse", ListCustomFieldResponse)
+DeleteCheckboxCustomFieldResponse = NewType("DeleteCheckboxCustomFieldResponse", ListCustomFieldResponse)
+DeleteRadioCustomFieldResponse = NewType("DeleteRadioCustomFieldResponse", ListCustomFieldResponse)
+DeleteCustomFiledResponse = Union[
+    DeleteTextCustomFieldResponse, DeleteSentenceCustomFieldResponse,
+    DeleteNumberCustomFieldResponse, DeleteDateCustomFieldResponse,
+    DeleteSingleListCustomFieldResponse, DeleteMultipleListCustomFieldResponse,
+    DeleteCheckboxCustomFieldResponse, DeleteRadioCustomFieldResponse,
+]
+
+
+class CustomField(object):
+    class TypeId(Enum):
+        TEXT = 1
+        SENTENCE = 2
+        NUMBER = 3
+        DATE = 4
+        SINGLE_LIST = 5
+        MULTIPLE_LIST = 6
+        CHECKBOX = 7
+        RADIO = 8
+
+    class DateInitialValueType(Enum):
+        TODAY = 1
+        TODAY_PLUS_INITIAL_SHIFT = 2
+        SPECIFIED_DAY = 3
+
+    def __init__(self, api) -> None:
+        self.api = api
+
+    def list(self, projectIdOrKey: str):
+        """List custom fields
+        https://developer.nulab.com/docs/backlog/api/2/get-custom-field-list/
+
+        :param projectIdOrKey: project id or key
+        :type projectIdOrKey: str
+        """
+        _url = f"projects/{projectIdOrKey}/customFields"
+        _method = "GET"
+
+        resp = self.api.invoke_method(_method, _url)
+
+        return resp.json()
+
+    def add(
+        self,
+        projectIdOrKey: str,
+        typeId: Union[TypeId, int],
+        name: str,
+        applicableIssueTypes: Optional[List[int]] = None,
+        description: Optional[str] = None,
+        required: Optional[bool] = None,
+        **kwargs,
+    ) -> AddCustomFiledResponse:
+        """Add custom field
+        https://developer.nulab.com/docs/backlog/api/2/add-custom-field/#
+        """
+        _url = f"projects/{projectIdOrKey}/customFields"
+        _method = "POST"
+        tid = typeId
+        if isinstance(typeId, Enum):
+            tid = typeId.value
+        elif isinstance(typeId, int):
+            tid = typeId
+        else:
+            raise ValueError(f"invalid typeId: {typeId}")
+        request_param = {
+            "typeId": tid,
+            "name": name,
+            "applicableIssueTypes": applicableIssueTypes,
+            "description": description,
+            "required": required,
+            **kwargs,
+        }
+        for k, v in request_param.copy().items():
+            if v is None:
+                del request_param[k]
+            if type(v) is bool:
+                request_param[k] = "true" if v else "false"
+
+        # for backlog parameter key spec
+        if "applicableIssueTypes" in request_param:
+            request_param["applicableIssueTypes[]"] = request_param["applicableIssueTypes"]
+            del request_param["applicableIssueTypes"]
+        if "items" in request_param:
+            request_param["items[]"] = request_param["items"]
+            del request_param["items"]
+
+        resp = self.api.invoke_method(_method, _url, request_param=request_param)
+
+        return resp.json()
+
+    def add_text_custom_field(
+        self,
+        projectIdOrKey: str,
+        name: str,
+        applicableIssueTypes: Optional[List[int]] = None,
+        description: Optional[str] = None,
+        required: Optional[bool] = None,
+    ) -> AddTextCustomFieldResponse:
+        return self.add(
+            projectIdOrKey,
+            1,
+            name,
+            applicableIssueTypes,
+            description,
+            required,
+        )
+
+    def add_sentence_custom_field(
+        self,
+        projectIdOrKey: str,
+        name: str,
+        applicableIssueTypes: Optional[List[int]] = None,
+        description: Optional[str] = None,
+        required: Optional[bool] = None,
+    ) -> AddSentenceCustomFieldResponse:
+        return self.add(
+            projectIdOrKey,
+            2,
+            name,
+            applicableIssueTypes,
+            description,
+            required,
+        )
+
+    def add_number_custom_field(
+        self,
+        projectIdOrKey: str,
+        name: str,
+        applicableIssueTypes: Optional[List[int]] = None,
+        description: Optional[str] = None,
+        required: Optional[bool] = None,
+        min: Optional[int] = None,
+        max: Optional[int] = None,
+        initialValue: Optional[int] = None,
+        unit: Optional[str] = None,
+    ) -> AddNumberCustomFieldResponse:
+        return self.add(
+            projectIdOrKey,
+            3,
+            name,
+            applicableIssueTypes,
+            description,
+            required,
+            min=min,
+            max=max,
+            initialValue=initialValue,
+            unit=unit,
+        )
+
+    def add_date_custom_field(
+        self,
+        projectIdOrKey: str,
+        name: str,
+        applicableIssueTypes: Optional[List[int]] = None,
+        description: Optional[str] = None,
+        required: Optional[bool] = None,
+        min: Optional[str] = None,  # yyyy-MM-dd
+        max: Optional[str] = None,  # yyyy-MM-dd
+        initialValueType: Optional[DateInitialValueType] = None,
+        initialDate: Optional[str] = None,  # yyyy-MM-dd
+        initialShift: Optional[int] = None,
+    ) -> AddDateCustomFieldResponse:
+        if isinstance(initialValueType, Enum):
+            initialValueType = initialValueType.value
+
+        if (
+            (initialValueType == self.DateInitialValueType.SPECIFIED_DAY.value)
+            and (initialDate is None)
+        ):
+            raise ValueError("initialDate is required when initialValueType is SPECIFIED_DAY")
+
+        return self.add(
+            projectIdOrKey,
+            4,
+            name,
+            applicableIssueTypes,
+            description,
+            required,
+            min=min,
+            max=max,
+            initialValueType=initialValueType,
+            initialDate=initialDate,
+            initialShift=initialShift,
+        )
+
+    def add_single_list_custom_field(
+        self,
+        projectIdOrKey: str,
+        name: str,
+        applicableIssueTypes: Optional[List[int]] = None,
+        description: Optional[str] = None,
+        required: Optional[bool] = None,
+        items: Optional[List[str]] = None,
+        allowInput: Optional[bool] = None,
+        allowAddItem: Optional[bool] = None,
+    ) -> AddSingleListCustomFieldResponse:
+        return self.add(
+            projectIdOrKey,
+            5,
+            name,
+            applicableIssueTypes,
+            description,
+            required,
+            items=items,
+            allowInput=allowInput,
+            allowAddItem=allowAddItem,
+        )
+
+    def add_multiple_list_custom_field(
+        self,
+        projectIdOrKey: str,
+        name: str,
+        applicableIssueTypes: Optional[List[int]] = None,
+        description: Optional[str] = None,
+        required: Optional[bool] = None,
+        items: Optional[List[str]] = None,
+        allowInput: Optional[bool] = None,
+        allowAddItem: Optional[bool] = None,
+    ) -> AddMultipleListCustomFieldResponse:
+        return self.add(
+            projectIdOrKey,
+            6,
+            name,
+            applicableIssueTypes,
+            description,
+            required,
+            items=items,
+            allowInput=allowInput,
+            allowAddItem=allowAddItem,
+        )
+
+    def add_checkbox_custom_field(
+        self,
+        projectIdOrKey: str,
+        name: str,
+        applicableIssueTypes: Optional[List[int]] = None,
+        description: Optional[str] = None,
+        required: Optional[bool] = None,
+        items: Optional[List[str]] = None,
+        allowInput: Optional[bool] = None,
+        allowAddItem: Optional[bool] = None,
+    ) -> AddCheckboxCustomFieldResponse:
+        return self.add(
+            projectIdOrKey,
+            7,
+            name,
+            applicableIssueTypes,
+            description,
+            required,
+            items=items,
+            allowInput=allowInput,
+            allowAddItem=allowAddItem,
+        )
+
+    def add_radio_custom_field(
+        self,
+        projectIdOrKey: str,
+        name: str,
+        applicableIssueTypes: Optional[List[int]] = None,
+        description: Optional[str] = None,
+        required: Optional[bool] = None,
+        items: Optional[List[str]] = None,
+        allowInput: Optional[bool] = None,
+        allowAddItem: Optional[bool] = None,
+    ) -> AddRadioCustomFieldResponse:
+        return self.add(
+            projectIdOrKey,
+            8,
+            name,
+            applicableIssueTypes,
+            description,
+            required,
+            items=items,
+            allowInput=allowInput,
+            allowAddItem=allowAddItem,
+        )
+
+    # def update(self, projectIdOrKey: str, id: int, name: str):
+    #     """Update category
+    #     https://developer.nulab.com/docs/backlog/api/2/update-category/#
+
+    #     :param projectIdOrKey: project id or key
+    #     :type projectIdOrKey: str
+    #     :param id: category id
+    #     :type id: int
+    #     :param name: category name
+    #     :type name: str
+    #     """
+    #     _url = f"projects/{projectIdOrKey}/categories/{id}"
+    #     _method = "PATCH"
+
+    #     resp = self.api.invoke_method(_method, _url, request_param={"name": name})
+
+    #     return resp.json()
+
+    def delete(self, projectIdOrKey: str, id: int) -> DeleteCustomFiledResponse:
+        """Delete custom field
+        https://developer.nulab.com/docs/backlog/api/2/delete-custom-field/#delete-custom-field
+        """
+        _url = f"projects/{projectIdOrKey}/customFields/{id}"
+        _method = "DELETE"
+
+        resp = self.api.invoke_method(_method, _url)
+
+        return resp.json()

{python_backlog-0.6.0.dist-info → python_backlog-0.7.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-backlog
-Version: 0.6.0
+Version: 0.7.2
 Summary: Backlog API v2 wrapper
 Home-page: https://github.com/hassaku63/pbl
 Author: hassaku63
@@ -8,7 +8,6 @@ Author-email: hassaku63@gmail.com
 License: MIT
 Project-URL: Source, https://github.com/hassaku63/pbl
 Keywords: nulab backlog
-Platform: UNKNOWN
 Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3.8
@@ -18,7 +17,8 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Natural Language :: Japanese
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
-Requires-Dist: requests ~=2.31.0
+License-File: LICENSE
+Requires-Dist: requests ~=2.32.2
 
 # pbl
 
@@ -87,5 +87,3 @@ Qiita https://qiita.com/hassaku_63/items/b9eb2a1c7ecd3c19507d
 ## Contact
 
 Twitter: [hassaku_63](https://twitter.com/hassaku_63)
-
-

{python_backlog-0.6.0.dist-info → python_backlog-0.7.2.dist-info}/RECORD

@@ -1,14 +1,15 @@
 backlog/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 backlog/attachment.py,sha256=RpaAcTnr_2CsJUDeeJHT1YSH0TwPImH5C0uwUOpDlHs,764
-backlog/base.py,sha256=m5sArzWDNL5ZBd8HtKZMPg-PW8DXHqfqWOyEm7XCNq8,5541
+backlog/base.py,sha256=-EUjAZr20vq3i8ekPe9LwbGvwJZ6PGhGCV8TsqZqIrs,5632
 backlog/category.py,sha256=DQ06yhOCXxtDbPMZ1Ig1QD8n7Ht_ZFrp8PJzO18IeZk,2530
+backlog/custom_field.py,sha256=dJ-XnrYv0rlpLvPhIkZEgcyNjZB8GR3352Or8HUPKlc,12243
 backlog/git.py,sha256=mazfvwn1Ekga0eeigk22Xf3vhXEo-P5Irfyq6r_QbaA,3056
 backlog/issue.py,sha256=of0DQ_1fsBPJ2aU6TS7IWlw0DzZIJRzo4fCGuKv2JY8,6636
 backlog/project.py,sha256=TOBDLV6eSpeQRxcjZ1ArrEE8lHRE7JIyaCJUQALSdSg,13839
 backlog/user.py,sha256=fgd1X1fom1mTPKDU6DFqBspPauq6UuhxrbFd9CCrptU,2829
 backlog/wiki.py,sha256=NjMkHopNb-9oic1yziiypzzpIHSdXcRfePZhOBKtDok,5431
-python_backlog-0.6.0.dist-info/LICENSE,sha256=1teWq4411yGkUz_9lD1V74mcHFRix2IqOAoFaghKYwo,1073
-python_backlog-0.6.0.dist-info/METADATA,sha256=NEFTIvy8HT4XYHbpYbiCctdWt6qDXtB7yDMicdjLRVI,2164
-python_backlog-0.6.0.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
-python_backlog-0.6.0.dist-info/top_level.txt,sha256=qzHRU2P6F24ntkXGiIBl4Qf_AlV0BRebSc5tuLlcOIE,8
-python_backlog-0.6.0.dist-info/RECORD,,
+python_backlog-0.7.2.dist-info/LICENSE,sha256=1teWq4411yGkUz_9lD1V74mcHFRix2IqOAoFaghKYwo,1073
+python_backlog-0.7.2.dist-info/METADATA,sha256=t_HkpWuFHIQUfbOrhIvWjkPGkq5lWsX4Y4PPb4EqcK8,2166
+python_backlog-0.7.2.dist-info/WHEEL,sha256=cVxcB9AmuTcXqmwrtPhNK88dr7IR_b6qagTj0UvIEbY,91
+python_backlog-0.7.2.dist-info/top_level.txt,sha256=qzHRU2P6F24ntkXGiIBl4Qf_AlV0BRebSc5tuLlcOIE,8
+python_backlog-0.7.2.dist-info/RECORD,,

{python_backlog-0.6.0.dist-info → python_backlog-0.7.2.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.41.2)
+Generator: setuptools (74.1.2)
 Root-Is-Purelib: true
 Tag: py3-none-any