@makeplane/plane-node-sdk 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/publish-node-sdk.yml +24 -0
- package/.openapi-generator/FILES +119 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/README.md +95 -0
- package/dist/apis/AssetsApi.d.ts +100 -0
- package/dist/apis/AssetsApi.js +522 -0
- package/dist/apis/CyclesApi.d.ts +225 -0
- package/dist/apis/CyclesApi.js +1142 -0
- package/dist/apis/IntakeApi.d.ts +96 -0
- package/dist/apis/IntakeApi.js +485 -0
- package/dist/apis/LabelsApi.d.ts +97 -0
- package/dist/apis/LabelsApi.js +488 -0
- package/dist/apis/MembersApi.d.ts +44 -0
- package/dist/apis/MembersApi.js +228 -0
- package/dist/apis/ModulesApi.d.ts +198 -0
- package/dist/apis/ModulesApi.js +991 -0
- package/dist/apis/ProjectsApi.d.ts +120 -0
- package/dist/apis/ProjectsApi.js +621 -0
- package/dist/apis/StatesApi.d.ts +96 -0
- package/dist/apis/StatesApi.js +485 -0
- package/dist/apis/UsersApi.d.ts +27 -0
- package/dist/apis/UsersApi.js +149 -0
- package/dist/apis/WorkItemActivityApi.d.ts +58 -0
- package/dist/apis/WorkItemActivityApi.js +270 -0
- package/dist/apis/WorkItemAttachmentsApi.d.ts +80 -0
- package/dist/apis/WorkItemAttachmentsApi.js +400 -0
- package/dist/apis/WorkItemCommentsApi.d.ts +102 -0
- package/dist/apis/WorkItemCommentsApi.js +500 -0
- package/dist/apis/WorkItemLinksApi.d.ts +106 -0
- package/dist/apis/WorkItemLinksApi.js +515 -0
- package/dist/apis/WorkItemPropertiesApi.d.ts +210 -0
- package/dist/apis/WorkItemPropertiesApi.js +1066 -0
- package/dist/apis/WorkItemTypesApi.d.ts +92 -0
- package/dist/apis/WorkItemTypesApi.js +473 -0
- package/dist/apis/WorkItemWorklogsApi.d.ts +95 -0
- package/dist/apis/WorkItemWorklogsApi.js +479 -0
- package/dist/apis/WorkItemsApi.d.ts +134 -0
- package/dist/apis/WorkItemsApi.js +674 -0
- package/dist/apis/index.d.ts +17 -0
- package/dist/apis/index.js +34 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +20 -0
- package/dist/models/AccessEnum.d.ts +25 -0
- package/dist/models/AccessEnum.js +51 -0
- package/dist/models/Cycle.d.ts +215 -0
- package/dist/models/Cycle.js +93 -0
- package/dist/models/CycleCreateRequest.d.ts +77 -0
- package/dist/models/CycleCreateRequest.js +67 -0
- package/dist/models/CycleIssue.d.ts +94 -0
- package/dist/models/CycleIssue.js +65 -0
- package/dist/models/CycleIssueRequestRequest.d.ts +34 -0
- package/dist/models/CycleIssueRequestRequest.js +50 -0
- package/dist/models/CycleLite.d.ts +161 -0
- package/dist/models/CycleLite.js +96 -0
- package/dist/models/EntityTypeEnum.d.ts +25 -0
- package/dist/models/EntityTypeEnum.js +51 -0
- package/dist/models/GenericAssetUploadRequest.d.ts +65 -0
- package/dist/models/GenericAssetUploadRequest.js +62 -0
- package/dist/models/GetWorkspaceMembers200ResponseInner.d.ts +73 -0
- package/dist/models/GetWorkspaceMembers200ResponseInner.js +55 -0
- package/dist/models/GroupEnum.d.ts +33 -0
- package/dist/models/GroupEnum.js +59 -0
- package/dist/models/IntakeIssue.d.ts +150 -0
- package/dist/models/IntakeIssue.js +80 -0
- package/dist/models/IntakeIssueCreateRequest.d.ts +72 -0
- package/dist/models/IntakeIssueCreateRequest.js +66 -0
- package/dist/models/IntakeWorkItemStatusEnum.d.ts +31 -0
- package/dist/models/IntakeWorkItemStatusEnum.js +57 -0
- package/dist/models/Issue.d.ts +197 -0
- package/dist/models/Issue.js +98 -0
- package/dist/models/IssueActivity.d.ts +136 -0
- package/dist/models/IssueActivity.js +83 -0
- package/dist/models/IssueAttachment.d.ts +172 -0
- package/dist/models/IssueAttachment.js +89 -0
- package/dist/models/IssueAttachmentUploadRequest.d.ts +58 -0
- package/dist/models/IssueAttachmentUploadRequest.js +60 -0
- package/dist/models/IssueComment.d.ts +137 -0
- package/dist/models/IssueComment.js +74 -0
- package/dist/models/IssueCommentCreateRequest.d.ts +59 -0
- package/dist/models/IssueCommentCreateRequest.js +57 -0
- package/dist/models/IssueExpand.d.ts +226 -0
- package/dist/models/IssueExpand.js +105 -0
- package/dist/models/IssueForIntakeRequest.d.ts +53 -0
- package/dist/models/IssueForIntakeRequest.js +57 -0
- package/dist/models/IssueLink.d.ts +100 -0
- package/dist/models/IssueLink.js +64 -0
- package/dist/models/IssueLinkCreateRequest.d.ts +34 -0
- package/dist/models/IssueLinkCreateRequest.js +50 -0
- package/dist/models/IssuePropertyAPI.d.ts +171 -0
- package/dist/models/IssuePropertyAPI.js +88 -0
- package/dist/models/IssuePropertyAPIRequest.d.ts +99 -0
- package/dist/models/IssuePropertyAPIRequest.js +76 -0
- package/dist/models/IssuePropertyOptionAPI.d.ts +133 -0
- package/dist/models/IssuePropertyOptionAPI.js +73 -0
- package/dist/models/IssuePropertyOptionAPIRequest.d.ts +67 -0
- package/dist/models/IssuePropertyOptionAPIRequest.js +62 -0
- package/dist/models/IssuePropertyValueAPI.d.ts +133 -0
- package/dist/models/IssuePropertyValueAPI.js +78 -0
- package/dist/models/IssuePropertyValueAPIRequest.d.ts +85 -0
- package/dist/models/IssuePropertyValueAPIRequest.js +70 -0
- package/dist/models/IssueRequest.d.ts +167 -0
- package/dist/models/IssueRequest.js +95 -0
- package/dist/models/IssueSearch.d.ts +64 -0
- package/dist/models/IssueSearch.js +70 -0
- package/dist/models/IssueTypeAPI.d.ts +127 -0
- package/dist/models/IssueTypeAPI.js +72 -0
- package/dist/models/IssueTypeAPIRequest.d.ts +67 -0
- package/dist/models/IssueTypeAPIRequest.js +62 -0
- package/dist/models/IssueWorkLogAPI.d.ts +85 -0
- package/dist/models/IssueWorkLogAPI.js +60 -0
- package/dist/models/IssueWorkLogAPIRequest.d.ts +49 -0
- package/dist/models/IssueWorkLogAPIRequest.js +54 -0
- package/dist/models/Label.d.ts +118 -0
- package/dist/models/Label.js +70 -0
- package/dist/models/LabelCreateUpdateRequest.d.ts +70 -0
- package/dist/models/LabelCreateUpdateRequest.js +62 -0
- package/dist/models/LabelLite.d.ts +46 -0
- package/dist/models/LabelLite.js +53 -0
- package/dist/models/Module.d.ts +197 -0
- package/dist/models/Module.js +91 -0
- package/dist/models/ModuleCreateRequest.d.ts +83 -0
- package/dist/models/ModuleCreateRequest.js +67 -0
- package/dist/models/ModuleIssue.d.ts +94 -0
- package/dist/models/ModuleIssue.js +63 -0
- package/dist/models/ModuleIssueRequestRequest.d.ts +34 -0
- package/dist/models/ModuleIssueRequestRequest.js +50 -0
- package/dist/models/ModuleLite.d.ts +167 -0
- package/dist/models/ModuleLite.js +97 -0
- package/dist/models/ModuleStatusEnum.d.ts +33 -0
- package/dist/models/ModuleStatusEnum.js +59 -0
- package/dist/models/NetworkEnum.d.ts +25 -0
- package/dist/models/NetworkEnum.js +51 -0
- package/dist/models/PaginatedArchivedCycleResponse.d.ts +98 -0
- package/dist/models/PaginatedArchivedCycleResponse.js +95 -0
- package/dist/models/PaginatedArchivedModuleResponse.d.ts +98 -0
- package/dist/models/PaginatedArchivedModuleResponse.js +95 -0
- package/dist/models/PaginatedCycleIssueResponse.d.ts +98 -0
- package/dist/models/PaginatedCycleIssueResponse.js +95 -0
- package/dist/models/PaginatedCycleResponse.d.ts +98 -0
- package/dist/models/PaginatedCycleResponse.js +95 -0
- package/dist/models/PaginatedIntakeIssueResponse.d.ts +98 -0
- package/dist/models/PaginatedIntakeIssueResponse.js +95 -0
- package/dist/models/PaginatedIssueActivityDetailResponse.d.ts +98 -0
- package/dist/models/PaginatedIssueActivityDetailResponse.js +95 -0
- package/dist/models/PaginatedIssueActivityResponse.d.ts +98 -0
- package/dist/models/PaginatedIssueActivityResponse.js +95 -0
- package/dist/models/PaginatedIssueCommentResponse.d.ts +98 -0
- package/dist/models/PaginatedIssueCommentResponse.js +95 -0
- package/dist/models/PaginatedIssueLinkDetailResponse.d.ts +98 -0
- package/dist/models/PaginatedIssueLinkDetailResponse.js +95 -0
- package/dist/models/PaginatedIssueLinkResponse.d.ts +98 -0
- package/dist/models/PaginatedIssueLinkResponse.js +95 -0
- package/dist/models/PaginatedLabelResponse.d.ts +98 -0
- package/dist/models/PaginatedLabelResponse.js +95 -0
- package/dist/models/PaginatedModuleIssueResponse.d.ts +98 -0
- package/dist/models/PaginatedModuleIssueResponse.js +95 -0
- package/dist/models/PaginatedModuleResponse.d.ts +98 -0
- package/dist/models/PaginatedModuleResponse.js +95 -0
- package/dist/models/PaginatedProjectResponse.d.ts +98 -0
- package/dist/models/PaginatedProjectResponse.js +95 -0
- package/dist/models/PaginatedStateResponse.d.ts +98 -0
- package/dist/models/PaginatedStateResponse.js +95 -0
- package/dist/models/PaginatedWorkItemResponse.d.ts +98 -0
- package/dist/models/PaginatedWorkItemResponse.js +95 -0
- package/dist/models/PatchedAssetUpdateRequest.d.ts +34 -0
- package/dist/models/PatchedAssetUpdateRequest.js +48 -0
- package/dist/models/PatchedCycleUpdateRequest.d.ts +77 -0
- package/dist/models/PatchedCycleUpdateRequest.js +63 -0
- package/dist/models/PatchedGenericAssetUpdateRequest.d.ts +34 -0
- package/dist/models/PatchedGenericAssetUpdateRequest.js +48 -0
- package/dist/models/PatchedIntakeIssueUpdateRequest.d.ts +66 -0
- package/dist/models/PatchedIntakeIssueUpdateRequest.js +60 -0
- package/dist/models/PatchedIssueCommentCreateRequest.d.ts +59 -0
- package/dist/models/PatchedIssueCommentCreateRequest.js +57 -0
- package/dist/models/PatchedIssueLinkUpdateRequest.d.ts +34 -0
- package/dist/models/PatchedIssueLinkUpdateRequest.js +48 -0
- package/dist/models/PatchedIssuePropertyAPIRequest.d.ts +99 -0
- package/dist/models/PatchedIssuePropertyAPIRequest.js +72 -0
- package/dist/models/PatchedIssuePropertyOptionAPIRequest.d.ts +67 -0
- package/dist/models/PatchedIssuePropertyOptionAPIRequest.js +60 -0
- package/dist/models/PatchedIssueRequest.d.ts +167 -0
- package/dist/models/PatchedIssueRequest.js +93 -0
- package/dist/models/PatchedIssueTypeAPIRequest.d.ts +67 -0
- package/dist/models/PatchedIssueTypeAPIRequest.js +60 -0
- package/dist/models/PatchedIssueWorkLogAPIRequest.d.ts +49 -0
- package/dist/models/PatchedIssueWorkLogAPIRequest.js +54 -0
- package/dist/models/PatchedLabelCreateUpdateRequest.d.ts +70 -0
- package/dist/models/PatchedLabelCreateUpdateRequest.js +60 -0
- package/dist/models/PatchedModuleUpdateRequest.d.ts +83 -0
- package/dist/models/PatchedModuleUpdateRequest.js +65 -0
- package/dist/models/PatchedProjectUpdateRequest.d.ts +143 -0
- package/dist/models/PatchedProjectUpdateRequest.js +85 -0
- package/dist/models/PatchedStateRequest.d.ts +83 -0
- package/dist/models/PatchedStateRequest.js +65 -0
- package/dist/models/PriorityEnum.d.ts +31 -0
- package/dist/models/PriorityEnum.js +57 -0
- package/dist/models/Project.d.ts +294 -0
- package/dist/models/Project.js +124 -0
- package/dist/models/ProjectCreateRequest.d.ts +131 -0
- package/dist/models/ProjectCreateRequest.js +85 -0
- package/dist/models/ProjectWorklogSummary.d.ts +37 -0
- package/dist/models/ProjectWorklogSummary.js +54 -0
- package/dist/models/PropertyTypeEnum.d.ts +39 -0
- package/dist/models/PropertyTypeEnum.js +65 -0
- package/dist/models/RelationTypeEnum.d.ts +25 -0
- package/dist/models/RelationTypeEnum.js +51 -0
- package/dist/models/RetrieveWorkItemAttachment400Response.d.ts +37 -0
- package/dist/models/RetrieveWorkItemAttachment400Response.js +50 -0
- package/dist/models/State.d.ts +137 -0
- package/dist/models/State.js +78 -0
- package/dist/models/StateLite.d.ts +53 -0
- package/dist/models/StateLite.js +50 -0
- package/dist/models/StateRequest.d.ts +83 -0
- package/dist/models/StateRequest.js +69 -0
- package/dist/models/TimezoneEnum.d.ts +887 -0
- package/dist/models/TimezoneEnum.js +913 -0
- package/dist/models/TransferCycleIssueRequestRequest.d.ts +34 -0
- package/dist/models/TransferCycleIssueRequestRequest.js +50 -0
- package/dist/models/TransferCycleWorkItems200Response.d.ts +31 -0
- package/dist/models/TransferCycleWorkItems200Response.js +48 -0
- package/dist/models/TransferCycleWorkItems400Response.d.ts +31 -0
- package/dist/models/TransferCycleWorkItems400Response.js +48 -0
- package/dist/models/TypeEnum.d.ts +31 -0
- package/dist/models/TypeEnum.js +57 -0
- package/dist/models/UserAssetUploadRequest.d.ts +64 -0
- package/dist/models/UserAssetUploadRequest.js +62 -0
- package/dist/models/UserLite.d.ts +70 -0
- package/dist/models/UserLite.js +52 -0
- package/dist/models/index.d.ts +93 -0
- package/dist/models/index.js +110 -0
- package/dist/runtime.d.ts +183 -0
- package/dist/runtime.js +563 -0
- package/eslint.config.mjs +11 -0
- package/package.json +23 -0
- package/src/apis/AssetsApi.ts +388 -0
- package/src/apis/CyclesApi.ts +1031 -0
- package/src/apis/IntakeApi.ts +401 -0
- package/src/apis/LabelsApi.ts +406 -0
- package/src/apis/MembersApi.ts +146 -0
- package/src/apis/ModulesApi.ts +890 -0
- package/src/apis/ProjectsApi.ts +486 -0
- package/src/apis/StatesApi.ts +401 -0
- package/src/apis/UsersApi.ts +71 -0
- package/src/apis/WorkItemActivityApi.ts +228 -0
- package/src/apis/WorkItemAttachmentsApi.ts +335 -0
- package/src/apis/WorkItemCommentsApi.ts +439 -0
- package/src/apis/WorkItemLinksApi.ts +469 -0
- package/src/apis/WorkItemPropertiesApi.ts +981 -0
- package/src/apis/WorkItemTypesApi.ts +378 -0
- package/src/apis/WorkItemWorklogsApi.ts +398 -0
- package/src/apis/WorkItemsApi.ts +591 -0
- package/src/apis/index.ts +19 -0
- package/src/index.ts +5 -0
- package/src/models/AccessEnum.ts +53 -0
- package/src/models/Cycle.ts +300 -0
- package/src/models/CycleCreateRequest.ts +135 -0
- package/src/models/CycleIssue.ts +142 -0
- package/src/models/CycleIssueRequestRequest.ts +68 -0
- package/src/models/CycleLite.ts +246 -0
- package/src/models/EntityTypeEnum.ts +53 -0
- package/src/models/GenericAssetUploadRequest.ts +110 -0
- package/src/models/GetWorkspaceMembers200ResponseInner.ts +113 -0
- package/src/models/GroupEnum.ts +61 -0
- package/src/models/IntakeIssue.ts +227 -0
- package/src/models/IntakeIssueCreateRequest.ts +134 -0
- package/src/models/IntakeWorkItemStatusEnum.ts +59 -0
- package/src/models/Issue.ts +287 -0
- package/src/models/IssueActivity.ts +202 -0
- package/src/models/IssueAttachment.ts +245 -0
- package/src/models/IssueAttachmentUploadRequest.ts +101 -0
- package/src/models/IssueComment.ts +204 -0
- package/src/models/IssueCommentCreateRequest.ts +109 -0
- package/src/models/IssueExpand.ts +348 -0
- package/src/models/IssueForIntakeRequest.ts +102 -0
- package/src/models/IssueLink.ts +148 -0
- package/src/models/IssueLinkCreateRequest.ts +68 -0
- package/src/models/IssuePropertyAPI.ts +255 -0
- package/src/models/IssuePropertyAPIRequest.ts +171 -0
- package/src/models/IssuePropertyOptionAPI.ts +190 -0
- package/src/models/IssuePropertyOptionAPIRequest.ts +113 -0
- package/src/models/IssuePropertyValueAPI.ts +194 -0
- package/src/models/IssuePropertyValueAPIRequest.ts +138 -0
- package/src/models/IssueRequest.ts +254 -0
- package/src/models/IssueSearch.ts +113 -0
- package/src/models/IssueTypeAPI.ts +183 -0
- package/src/models/IssueTypeAPIRequest.ts +113 -0
- package/src/models/IssueWorkLogAPI.ts +130 -0
- package/src/models/IssueWorkLogAPIRequest.ts +88 -0
- package/src/models/Label.ts +172 -0
- package/src/models/LabelCreateUpdateRequest.ts +116 -0
- package/src/models/LabelLite.ts +83 -0
- package/src/models/Module.ts +280 -0
- package/src/models/ModuleCreateRequest.ts +142 -0
- package/src/models/ModuleIssue.ts +140 -0
- package/src/models/ModuleIssueRequestRequest.ts +68 -0
- package/src/models/ModuleLite.ts +253 -0
- package/src/models/ModuleStatusEnum.ts +61 -0
- package/src/models/NetworkEnum.ts +53 -0
- package/src/models/PaginatedArchivedCycleResponse.ts +172 -0
- package/src/models/PaginatedArchivedModuleResponse.ts +172 -0
- package/src/models/PaginatedCycleIssueResponse.ts +172 -0
- package/src/models/PaginatedCycleResponse.ts +172 -0
- package/src/models/PaginatedIntakeIssueResponse.ts +172 -0
- package/src/models/PaginatedIssueActivityDetailResponse.ts +172 -0
- package/src/models/PaginatedIssueActivityResponse.ts +172 -0
- package/src/models/PaginatedIssueCommentResponse.ts +172 -0
- package/src/models/PaginatedIssueLinkDetailResponse.ts +172 -0
- package/src/models/PaginatedIssueLinkResponse.ts +172 -0
- package/src/models/PaginatedLabelResponse.ts +172 -0
- package/src/models/PaginatedModuleIssueResponse.ts +172 -0
- package/src/models/PaginatedModuleResponse.ts +172 -0
- package/src/models/PaginatedProjectResponse.ts +172 -0
- package/src/models/PaginatedStateResponse.ts +172 -0
- package/src/models/PaginatedWorkItemResponse.ts +172 -0
- package/src/models/PatchedAssetUpdateRequest.ts +67 -0
- package/src/models/PatchedCycleUpdateRequest.ts +133 -0
- package/src/models/PatchedGenericAssetUpdateRequest.ts +67 -0
- package/src/models/PatchedIntakeIssueUpdateRequest.ts +124 -0
- package/src/models/PatchedIssueCommentCreateRequest.ts +109 -0
- package/src/models/PatchedIssueLinkUpdateRequest.ts +67 -0
- package/src/models/PatchedIssuePropertyAPIRequest.ts +169 -0
- package/src/models/PatchedIssuePropertyOptionAPIRequest.ts +112 -0
- package/src/models/PatchedIssueRequest.ts +253 -0
- package/src/models/PatchedIssueTypeAPIRequest.ts +112 -0
- package/src/models/PatchedIssueWorkLogAPIRequest.ts +88 -0
- package/src/models/PatchedLabelCreateUpdateRequest.ts +115 -0
- package/src/models/PatchedModuleUpdateRequest.ts +141 -0
- package/src/models/PatchedProjectUpdateRequest.ts +221 -0
- package/src/models/PatchedStateRequest.ts +141 -0
- package/src/models/PriorityEnum.ts +59 -0
- package/src/models/Project.ts +414 -0
- package/src/models/ProjectCreateRequest.ts +207 -0
- package/src/models/ProjectWorklogSummary.ts +74 -0
- package/src/models/PropertyTypeEnum.ts +67 -0
- package/src/models/RelationTypeEnum.ts +53 -0
- package/src/models/RetrieveWorkItemAttachment400Response.ts +72 -0
- package/src/models/State.ts +206 -0
- package/src/models/StateLite.ts +97 -0
- package/src/models/StateRequest.ts +143 -0
- package/src/models/TimezoneEnum.ts +915 -0
- package/src/models/TransferCycleIssueRequestRequest.ts +68 -0
- package/src/models/TransferCycleWorkItems200Response.ts +64 -0
- package/src/models/TransferCycleWorkItems400Response.ts +64 -0
- package/src/models/TypeEnum.ts +59 -0
- package/src/models/UserAssetUploadRequest.ts +121 -0
- package/src/models/UserLite.ts +108 -0
- package/src/models/index.ts +95 -0
- package/src/runtime.ts +431 -0
- package/tsconfig.json +20 -0
|
@@ -0,0 +1,591 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* The Plane REST API
|
|
5
|
+
* The Plane REST API Visit our quick start guide and full API documentation at [developers.plane.so](https://developers.plane.so/api-reference/introduction).
|
|
6
|
+
*
|
|
7
|
+
* The version of the API Spec: 0.0.1
|
|
8
|
+
* Contact: support@plane.so
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated.
|
|
11
|
+
* Do not edit the class manually.
|
|
12
|
+
*/
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
import * as runtime from '../runtime';
|
|
16
|
+
import type {
|
|
17
|
+
Issue,
|
|
18
|
+
IssueRequest,
|
|
19
|
+
IssueSearch,
|
|
20
|
+
PaginatedWorkItemResponse,
|
|
21
|
+
PatchedIssueRequest,
|
|
22
|
+
} from '../models/index';
|
|
23
|
+
import {
|
|
24
|
+
IssueFromJSON,
|
|
25
|
+
IssueToJSON,
|
|
26
|
+
IssueRequestFromJSON,
|
|
27
|
+
IssueRequestToJSON,
|
|
28
|
+
IssueSearchFromJSON,
|
|
29
|
+
IssueSearchToJSON,
|
|
30
|
+
PaginatedWorkItemResponseFromJSON,
|
|
31
|
+
PaginatedWorkItemResponseToJSON,
|
|
32
|
+
PatchedIssueRequestFromJSON,
|
|
33
|
+
PatchedIssueRequestToJSON,
|
|
34
|
+
} from '../models/index';
|
|
35
|
+
|
|
36
|
+
export interface CreateWorkItemRequest {
|
|
37
|
+
projectId: string;
|
|
38
|
+
slug: string;
|
|
39
|
+
issueRequest: IssueRequest;
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
export interface DeleteWorkItemRequest {
|
|
43
|
+
pk: string;
|
|
44
|
+
projectId: string;
|
|
45
|
+
slug: string;
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
export interface GetWorkspaceWorkItemRequest {
|
|
49
|
+
issueIdentifier: number;
|
|
50
|
+
projectIdentifier: string;
|
|
51
|
+
slug: string;
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
export interface ListWorkItemsRequest {
|
|
55
|
+
projectId: string;
|
|
56
|
+
slug: string;
|
|
57
|
+
cursor?: string;
|
|
58
|
+
expand?: string;
|
|
59
|
+
externalId?: string;
|
|
60
|
+
externalSource?: string;
|
|
61
|
+
fields?: string;
|
|
62
|
+
orderBy?: string;
|
|
63
|
+
perPage?: number;
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
export interface RetrieveWorkItemRequest {
|
|
67
|
+
pk: string;
|
|
68
|
+
projectId: string;
|
|
69
|
+
slug: string;
|
|
70
|
+
expand?: string;
|
|
71
|
+
externalId?: string;
|
|
72
|
+
externalSource?: string;
|
|
73
|
+
fields?: string;
|
|
74
|
+
orderBy?: string;
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
export interface SearchWorkItemsRequest {
|
|
78
|
+
search: string;
|
|
79
|
+
slug: string;
|
|
80
|
+
limit?: number;
|
|
81
|
+
projectId?: string;
|
|
82
|
+
workspaceSearch?: string;
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
export interface UpdateWorkItemRequest {
|
|
86
|
+
pk: string;
|
|
87
|
+
projectId: string;
|
|
88
|
+
slug: string;
|
|
89
|
+
patchedIssueRequest?: PatchedIssueRequest;
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
/**
|
|
93
|
+
*
|
|
94
|
+
*/
|
|
95
|
+
export class WorkItemsApi extends runtime.BaseAPI {
|
|
96
|
+
|
|
97
|
+
/**
|
|
98
|
+
* Create a new work item in the specified project with the provided details.
|
|
99
|
+
* Create work item
|
|
100
|
+
*/
|
|
101
|
+
async createWorkItemRaw(requestParameters: CreateWorkItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Issue>> {
|
|
102
|
+
if (requestParameters['projectId'] == null) {
|
|
103
|
+
throw new runtime.RequiredError(
|
|
104
|
+
'projectId',
|
|
105
|
+
'Required parameter "projectId" was null or undefined when calling createWorkItem().'
|
|
106
|
+
);
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
if (requestParameters['slug'] == null) {
|
|
110
|
+
throw new runtime.RequiredError(
|
|
111
|
+
'slug',
|
|
112
|
+
'Required parameter "slug" was null or undefined when calling createWorkItem().'
|
|
113
|
+
);
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
if (requestParameters['issueRequest'] == null) {
|
|
117
|
+
throw new runtime.RequiredError(
|
|
118
|
+
'issueRequest',
|
|
119
|
+
'Required parameter "issueRequest" was null or undefined when calling createWorkItem().'
|
|
120
|
+
);
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
const queryParameters: any = {};
|
|
124
|
+
|
|
125
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
126
|
+
|
|
127
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
128
|
+
|
|
129
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
130
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuthentication authentication
|
|
131
|
+
}
|
|
132
|
+
|
|
133
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
134
|
+
// oauth required
|
|
135
|
+
headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2Authentication", []);
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
139
|
+
// oauth required
|
|
140
|
+
headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2Authentication", []);
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
const response = await this.request({
|
|
144
|
+
path: `/api/v1/workspaces/{slug}/projects/{project_id}/issues/`.replace(`{${"project_id"}}`, encodeURIComponent(String(requestParameters['projectId']))).replace(`{${"slug"}}`, encodeURIComponent(String(requestParameters['slug']))),
|
|
145
|
+
method: 'POST',
|
|
146
|
+
headers: headerParameters,
|
|
147
|
+
query: queryParameters,
|
|
148
|
+
body: IssueRequestToJSON(requestParameters['issueRequest']),
|
|
149
|
+
}, initOverrides);
|
|
150
|
+
|
|
151
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => IssueFromJSON(jsonValue));
|
|
152
|
+
}
|
|
153
|
+
|
|
154
|
+
/**
|
|
155
|
+
* Create a new work item in the specified project with the provided details.
|
|
156
|
+
* Create work item
|
|
157
|
+
*/
|
|
158
|
+
async createWorkItem(requestParameters: CreateWorkItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Issue> {
|
|
159
|
+
const response = await this.createWorkItemRaw(requestParameters, initOverrides);
|
|
160
|
+
return await response.value();
|
|
161
|
+
}
|
|
162
|
+
|
|
163
|
+
/**
|
|
164
|
+
* Permanently delete an existing work item from the project. Only admins or the item creator can perform this action.
|
|
165
|
+
* Delete work item
|
|
166
|
+
*/
|
|
167
|
+
async deleteWorkItemRaw(requestParameters: DeleteWorkItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
|
|
168
|
+
if (requestParameters['pk'] == null) {
|
|
169
|
+
throw new runtime.RequiredError(
|
|
170
|
+
'pk',
|
|
171
|
+
'Required parameter "pk" was null or undefined when calling deleteWorkItem().'
|
|
172
|
+
);
|
|
173
|
+
}
|
|
174
|
+
|
|
175
|
+
if (requestParameters['projectId'] == null) {
|
|
176
|
+
throw new runtime.RequiredError(
|
|
177
|
+
'projectId',
|
|
178
|
+
'Required parameter "projectId" was null or undefined when calling deleteWorkItem().'
|
|
179
|
+
);
|
|
180
|
+
}
|
|
181
|
+
|
|
182
|
+
if (requestParameters['slug'] == null) {
|
|
183
|
+
throw new runtime.RequiredError(
|
|
184
|
+
'slug',
|
|
185
|
+
'Required parameter "slug" was null or undefined when calling deleteWorkItem().'
|
|
186
|
+
);
|
|
187
|
+
}
|
|
188
|
+
|
|
189
|
+
const queryParameters: any = {};
|
|
190
|
+
|
|
191
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
192
|
+
|
|
193
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
194
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuthentication authentication
|
|
195
|
+
}
|
|
196
|
+
|
|
197
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
198
|
+
// oauth required
|
|
199
|
+
headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2Authentication", []);
|
|
200
|
+
}
|
|
201
|
+
|
|
202
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
203
|
+
// oauth required
|
|
204
|
+
headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2Authentication", []);
|
|
205
|
+
}
|
|
206
|
+
|
|
207
|
+
const response = await this.request({
|
|
208
|
+
path: `/api/v1/workspaces/{slug}/projects/{project_id}/issues/{pk}/`.replace(`{${"pk"}}`, encodeURIComponent(String(requestParameters['pk']))).replace(`{${"project_id"}}`, encodeURIComponent(String(requestParameters['projectId']))).replace(`{${"slug"}}`, encodeURIComponent(String(requestParameters['slug']))),
|
|
209
|
+
method: 'DELETE',
|
|
210
|
+
headers: headerParameters,
|
|
211
|
+
query: queryParameters,
|
|
212
|
+
}, initOverrides);
|
|
213
|
+
|
|
214
|
+
return new runtime.VoidApiResponse(response);
|
|
215
|
+
}
|
|
216
|
+
|
|
217
|
+
/**
|
|
218
|
+
* Permanently delete an existing work item from the project. Only admins or the item creator can perform this action.
|
|
219
|
+
* Delete work item
|
|
220
|
+
*/
|
|
221
|
+
async deleteWorkItem(requestParameters: DeleteWorkItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
|
222
|
+
await this.deleteWorkItemRaw(requestParameters, initOverrides);
|
|
223
|
+
}
|
|
224
|
+
|
|
225
|
+
/**
|
|
226
|
+
* Retrieve a specific work item using workspace slug, project identifier, and issue identifier.
|
|
227
|
+
* Retrieve work item by identifiers
|
|
228
|
+
*/
|
|
229
|
+
async getWorkspaceWorkItemRaw(requestParameters: GetWorkspaceWorkItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Issue>> {
|
|
230
|
+
if (requestParameters['issueIdentifier'] == null) {
|
|
231
|
+
throw new runtime.RequiredError(
|
|
232
|
+
'issueIdentifier',
|
|
233
|
+
'Required parameter "issueIdentifier" was null or undefined when calling getWorkspaceWorkItem().'
|
|
234
|
+
);
|
|
235
|
+
}
|
|
236
|
+
|
|
237
|
+
if (requestParameters['projectIdentifier'] == null) {
|
|
238
|
+
throw new runtime.RequiredError(
|
|
239
|
+
'projectIdentifier',
|
|
240
|
+
'Required parameter "projectIdentifier" was null or undefined when calling getWorkspaceWorkItem().'
|
|
241
|
+
);
|
|
242
|
+
}
|
|
243
|
+
|
|
244
|
+
if (requestParameters['slug'] == null) {
|
|
245
|
+
throw new runtime.RequiredError(
|
|
246
|
+
'slug',
|
|
247
|
+
'Required parameter "slug" was null or undefined when calling getWorkspaceWorkItem().'
|
|
248
|
+
);
|
|
249
|
+
}
|
|
250
|
+
|
|
251
|
+
const queryParameters: any = {};
|
|
252
|
+
|
|
253
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
254
|
+
|
|
255
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
256
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuthentication authentication
|
|
257
|
+
}
|
|
258
|
+
|
|
259
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
260
|
+
// oauth required
|
|
261
|
+
headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2Authentication", []);
|
|
262
|
+
}
|
|
263
|
+
|
|
264
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
265
|
+
// oauth required
|
|
266
|
+
headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2Authentication", []);
|
|
267
|
+
}
|
|
268
|
+
|
|
269
|
+
const response = await this.request({
|
|
270
|
+
path: `/api/v1/workspaces/{slug}/issues/{project_identifier}-{issue_identifier}/`.replace(`{${"issue_identifier"}}`, encodeURIComponent(String(requestParameters['issueIdentifier']))).replace(`{${"project_identifier"}}`, encodeURIComponent(String(requestParameters['projectIdentifier']))).replace(`{${"slug"}}`, encodeURIComponent(String(requestParameters['slug']))),
|
|
271
|
+
method: 'GET',
|
|
272
|
+
headers: headerParameters,
|
|
273
|
+
query: queryParameters,
|
|
274
|
+
}, initOverrides);
|
|
275
|
+
|
|
276
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => IssueFromJSON(jsonValue));
|
|
277
|
+
}
|
|
278
|
+
|
|
279
|
+
/**
|
|
280
|
+
* Retrieve a specific work item using workspace slug, project identifier, and issue identifier.
|
|
281
|
+
* Retrieve work item by identifiers
|
|
282
|
+
*/
|
|
283
|
+
async getWorkspaceWorkItem(requestParameters: GetWorkspaceWorkItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Issue> {
|
|
284
|
+
const response = await this.getWorkspaceWorkItemRaw(requestParameters, initOverrides);
|
|
285
|
+
return await response.value();
|
|
286
|
+
}
|
|
287
|
+
|
|
288
|
+
/**
|
|
289
|
+
* Retrieve a paginated list of all work items in a project. Supports filtering, ordering, and field selection through query parameters.
|
|
290
|
+
* List work items
|
|
291
|
+
*/
|
|
292
|
+
async listWorkItemsRaw(requestParameters: ListWorkItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedWorkItemResponse>> {
|
|
293
|
+
if (requestParameters['projectId'] == null) {
|
|
294
|
+
throw new runtime.RequiredError(
|
|
295
|
+
'projectId',
|
|
296
|
+
'Required parameter "projectId" was null or undefined when calling listWorkItems().'
|
|
297
|
+
);
|
|
298
|
+
}
|
|
299
|
+
|
|
300
|
+
if (requestParameters['slug'] == null) {
|
|
301
|
+
throw new runtime.RequiredError(
|
|
302
|
+
'slug',
|
|
303
|
+
'Required parameter "slug" was null or undefined when calling listWorkItems().'
|
|
304
|
+
);
|
|
305
|
+
}
|
|
306
|
+
|
|
307
|
+
const queryParameters: any = {};
|
|
308
|
+
|
|
309
|
+
if (requestParameters['cursor'] != null) {
|
|
310
|
+
queryParameters['cursor'] = requestParameters['cursor'];
|
|
311
|
+
}
|
|
312
|
+
|
|
313
|
+
if (requestParameters['expand'] != null) {
|
|
314
|
+
queryParameters['expand'] = requestParameters['expand'];
|
|
315
|
+
}
|
|
316
|
+
|
|
317
|
+
if (requestParameters['externalId'] != null) {
|
|
318
|
+
queryParameters['external_id'] = requestParameters['externalId'];
|
|
319
|
+
}
|
|
320
|
+
|
|
321
|
+
if (requestParameters['externalSource'] != null) {
|
|
322
|
+
queryParameters['external_source'] = requestParameters['externalSource'];
|
|
323
|
+
}
|
|
324
|
+
|
|
325
|
+
if (requestParameters['fields'] != null) {
|
|
326
|
+
queryParameters['fields'] = requestParameters['fields'];
|
|
327
|
+
}
|
|
328
|
+
|
|
329
|
+
if (requestParameters['orderBy'] != null) {
|
|
330
|
+
queryParameters['order_by'] = requestParameters['orderBy'];
|
|
331
|
+
}
|
|
332
|
+
|
|
333
|
+
if (requestParameters['perPage'] != null) {
|
|
334
|
+
queryParameters['per_page'] = requestParameters['perPage'];
|
|
335
|
+
}
|
|
336
|
+
|
|
337
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
338
|
+
|
|
339
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
340
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuthentication authentication
|
|
341
|
+
}
|
|
342
|
+
|
|
343
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
344
|
+
// oauth required
|
|
345
|
+
headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2Authentication", []);
|
|
346
|
+
}
|
|
347
|
+
|
|
348
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
349
|
+
// oauth required
|
|
350
|
+
headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2Authentication", []);
|
|
351
|
+
}
|
|
352
|
+
|
|
353
|
+
const response = await this.request({
|
|
354
|
+
path: `/api/v1/workspaces/{slug}/projects/{project_id}/issues/`.replace(`{${"project_id"}}`, encodeURIComponent(String(requestParameters['projectId']))).replace(`{${"slug"}}`, encodeURIComponent(String(requestParameters['slug']))),
|
|
355
|
+
method: 'GET',
|
|
356
|
+
headers: headerParameters,
|
|
357
|
+
query: queryParameters,
|
|
358
|
+
}, initOverrides);
|
|
359
|
+
|
|
360
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedWorkItemResponseFromJSON(jsonValue));
|
|
361
|
+
}
|
|
362
|
+
|
|
363
|
+
/**
|
|
364
|
+
* Retrieve a paginated list of all work items in a project. Supports filtering, ordering, and field selection through query parameters.
|
|
365
|
+
* List work items
|
|
366
|
+
*/
|
|
367
|
+
async listWorkItems(requestParameters: ListWorkItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedWorkItemResponse> {
|
|
368
|
+
const response = await this.listWorkItemsRaw(requestParameters, initOverrides);
|
|
369
|
+
return await response.value();
|
|
370
|
+
}
|
|
371
|
+
|
|
372
|
+
/**
|
|
373
|
+
* Retrieve details of a specific work item.
|
|
374
|
+
* Retrieve work item
|
|
375
|
+
*/
|
|
376
|
+
async retrieveWorkItemRaw(requestParameters: RetrieveWorkItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Issue>> {
|
|
377
|
+
if (requestParameters['pk'] == null) {
|
|
378
|
+
throw new runtime.RequiredError(
|
|
379
|
+
'pk',
|
|
380
|
+
'Required parameter "pk" was null or undefined when calling retrieveWorkItem().'
|
|
381
|
+
);
|
|
382
|
+
}
|
|
383
|
+
|
|
384
|
+
if (requestParameters['projectId'] == null) {
|
|
385
|
+
throw new runtime.RequiredError(
|
|
386
|
+
'projectId',
|
|
387
|
+
'Required parameter "projectId" was null or undefined when calling retrieveWorkItem().'
|
|
388
|
+
);
|
|
389
|
+
}
|
|
390
|
+
|
|
391
|
+
if (requestParameters['slug'] == null) {
|
|
392
|
+
throw new runtime.RequiredError(
|
|
393
|
+
'slug',
|
|
394
|
+
'Required parameter "slug" was null or undefined when calling retrieveWorkItem().'
|
|
395
|
+
);
|
|
396
|
+
}
|
|
397
|
+
|
|
398
|
+
const queryParameters: any = {};
|
|
399
|
+
|
|
400
|
+
if (requestParameters['expand'] != null) {
|
|
401
|
+
queryParameters['expand'] = requestParameters['expand'];
|
|
402
|
+
}
|
|
403
|
+
|
|
404
|
+
if (requestParameters['externalId'] != null) {
|
|
405
|
+
queryParameters['external_id'] = requestParameters['externalId'];
|
|
406
|
+
}
|
|
407
|
+
|
|
408
|
+
if (requestParameters['externalSource'] != null) {
|
|
409
|
+
queryParameters['external_source'] = requestParameters['externalSource'];
|
|
410
|
+
}
|
|
411
|
+
|
|
412
|
+
if (requestParameters['fields'] != null) {
|
|
413
|
+
queryParameters['fields'] = requestParameters['fields'];
|
|
414
|
+
}
|
|
415
|
+
|
|
416
|
+
if (requestParameters['orderBy'] != null) {
|
|
417
|
+
queryParameters['order_by'] = requestParameters['orderBy'];
|
|
418
|
+
}
|
|
419
|
+
|
|
420
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
421
|
+
|
|
422
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
423
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuthentication authentication
|
|
424
|
+
}
|
|
425
|
+
|
|
426
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
427
|
+
// oauth required
|
|
428
|
+
headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2Authentication", []);
|
|
429
|
+
}
|
|
430
|
+
|
|
431
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
432
|
+
// oauth required
|
|
433
|
+
headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2Authentication", []);
|
|
434
|
+
}
|
|
435
|
+
|
|
436
|
+
const response = await this.request({
|
|
437
|
+
path: `/api/v1/workspaces/{slug}/projects/{project_id}/issues/{pk}/`.replace(`{${"pk"}}`, encodeURIComponent(String(requestParameters['pk']))).replace(`{${"project_id"}}`, encodeURIComponent(String(requestParameters['projectId']))).replace(`{${"slug"}}`, encodeURIComponent(String(requestParameters['slug']))),
|
|
438
|
+
method: 'GET',
|
|
439
|
+
headers: headerParameters,
|
|
440
|
+
query: queryParameters,
|
|
441
|
+
}, initOverrides);
|
|
442
|
+
|
|
443
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => IssueFromJSON(jsonValue));
|
|
444
|
+
}
|
|
445
|
+
|
|
446
|
+
/**
|
|
447
|
+
* Retrieve details of a specific work item.
|
|
448
|
+
* Retrieve work item
|
|
449
|
+
*/
|
|
450
|
+
async retrieveWorkItem(requestParameters: RetrieveWorkItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Issue> {
|
|
451
|
+
const response = await this.retrieveWorkItemRaw(requestParameters, initOverrides);
|
|
452
|
+
return await response.value();
|
|
453
|
+
}
|
|
454
|
+
|
|
455
|
+
/**
|
|
456
|
+
* Perform semantic search across issue names, sequence IDs, and project identifiers.
|
|
457
|
+
*/
|
|
458
|
+
async searchWorkItemsRaw(requestParameters: SearchWorkItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IssueSearch>> {
|
|
459
|
+
if (requestParameters['search'] == null) {
|
|
460
|
+
throw new runtime.RequiredError(
|
|
461
|
+
'search',
|
|
462
|
+
'Required parameter "search" was null or undefined when calling searchWorkItems().'
|
|
463
|
+
);
|
|
464
|
+
}
|
|
465
|
+
|
|
466
|
+
if (requestParameters['slug'] == null) {
|
|
467
|
+
throw new runtime.RequiredError(
|
|
468
|
+
'slug',
|
|
469
|
+
'Required parameter "slug" was null or undefined when calling searchWorkItems().'
|
|
470
|
+
);
|
|
471
|
+
}
|
|
472
|
+
|
|
473
|
+
const queryParameters: any = {};
|
|
474
|
+
|
|
475
|
+
if (requestParameters['limit'] != null) {
|
|
476
|
+
queryParameters['limit'] = requestParameters['limit'];
|
|
477
|
+
}
|
|
478
|
+
|
|
479
|
+
if (requestParameters['projectId'] != null) {
|
|
480
|
+
queryParameters['project_id'] = requestParameters['projectId'];
|
|
481
|
+
}
|
|
482
|
+
|
|
483
|
+
if (requestParameters['search'] != null) {
|
|
484
|
+
queryParameters['search'] = requestParameters['search'];
|
|
485
|
+
}
|
|
486
|
+
|
|
487
|
+
if (requestParameters['workspaceSearch'] != null) {
|
|
488
|
+
queryParameters['workspace_search'] = requestParameters['workspaceSearch'];
|
|
489
|
+
}
|
|
490
|
+
|
|
491
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
492
|
+
|
|
493
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
494
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuthentication authentication
|
|
495
|
+
}
|
|
496
|
+
|
|
497
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
498
|
+
// oauth required
|
|
499
|
+
headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2Authentication", []);
|
|
500
|
+
}
|
|
501
|
+
|
|
502
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
503
|
+
// oauth required
|
|
504
|
+
headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2Authentication", []);
|
|
505
|
+
}
|
|
506
|
+
|
|
507
|
+
const response = await this.request({
|
|
508
|
+
path: `/api/v1/workspaces/{slug}/issues/search/`.replace(`{${"slug"}}`, encodeURIComponent(String(requestParameters['slug']))),
|
|
509
|
+
method: 'GET',
|
|
510
|
+
headers: headerParameters,
|
|
511
|
+
query: queryParameters,
|
|
512
|
+
}, initOverrides);
|
|
513
|
+
|
|
514
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => IssueSearchFromJSON(jsonValue));
|
|
515
|
+
}
|
|
516
|
+
|
|
517
|
+
/**
|
|
518
|
+
* Perform semantic search across issue names, sequence IDs, and project identifiers.
|
|
519
|
+
*/
|
|
520
|
+
async searchWorkItems(requestParameters: SearchWorkItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IssueSearch> {
|
|
521
|
+
const response = await this.searchWorkItemsRaw(requestParameters, initOverrides);
|
|
522
|
+
return await response.value();
|
|
523
|
+
}
|
|
524
|
+
|
|
525
|
+
/**
|
|
526
|
+
* Partially update an existing work item with the provided fields. Supports external ID validation to prevent conflicts.
|
|
527
|
+
* Partially update work item
|
|
528
|
+
*/
|
|
529
|
+
async updateWorkItemRaw(requestParameters: UpdateWorkItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Issue>> {
|
|
530
|
+
if (requestParameters['pk'] == null) {
|
|
531
|
+
throw new runtime.RequiredError(
|
|
532
|
+
'pk',
|
|
533
|
+
'Required parameter "pk" was null or undefined when calling updateWorkItem().'
|
|
534
|
+
);
|
|
535
|
+
}
|
|
536
|
+
|
|
537
|
+
if (requestParameters['projectId'] == null) {
|
|
538
|
+
throw new runtime.RequiredError(
|
|
539
|
+
'projectId',
|
|
540
|
+
'Required parameter "projectId" was null or undefined when calling updateWorkItem().'
|
|
541
|
+
);
|
|
542
|
+
}
|
|
543
|
+
|
|
544
|
+
if (requestParameters['slug'] == null) {
|
|
545
|
+
throw new runtime.RequiredError(
|
|
546
|
+
'slug',
|
|
547
|
+
'Required parameter "slug" was null or undefined when calling updateWorkItem().'
|
|
548
|
+
);
|
|
549
|
+
}
|
|
550
|
+
|
|
551
|
+
const queryParameters: any = {};
|
|
552
|
+
|
|
553
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
554
|
+
|
|
555
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
556
|
+
|
|
557
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
558
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuthentication authentication
|
|
559
|
+
}
|
|
560
|
+
|
|
561
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
562
|
+
// oauth required
|
|
563
|
+
headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2Authentication", []);
|
|
564
|
+
}
|
|
565
|
+
|
|
566
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
567
|
+
// oauth required
|
|
568
|
+
headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2Authentication", []);
|
|
569
|
+
}
|
|
570
|
+
|
|
571
|
+
const response = await this.request({
|
|
572
|
+
path: `/api/v1/workspaces/{slug}/projects/{project_id}/issues/{pk}/`.replace(`{${"pk"}}`, encodeURIComponent(String(requestParameters['pk']))).replace(`{${"project_id"}}`, encodeURIComponent(String(requestParameters['projectId']))).replace(`{${"slug"}}`, encodeURIComponent(String(requestParameters['slug']))),
|
|
573
|
+
method: 'PATCH',
|
|
574
|
+
headers: headerParameters,
|
|
575
|
+
query: queryParameters,
|
|
576
|
+
body: PatchedIssueRequestToJSON(requestParameters['patchedIssueRequest']),
|
|
577
|
+
}, initOverrides);
|
|
578
|
+
|
|
579
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => IssueFromJSON(jsonValue));
|
|
580
|
+
}
|
|
581
|
+
|
|
582
|
+
/**
|
|
583
|
+
* Partially update an existing work item with the provided fields. Supports external ID validation to prevent conflicts.
|
|
584
|
+
* Partially update work item
|
|
585
|
+
*/
|
|
586
|
+
async updateWorkItem(requestParameters: UpdateWorkItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Issue> {
|
|
587
|
+
const response = await this.updateWorkItemRaw(requestParameters, initOverrides);
|
|
588
|
+
return await response.value();
|
|
589
|
+
}
|
|
590
|
+
|
|
591
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
|
|
3
|
+
export * from './AssetsApi';
|
|
4
|
+
export * from './CyclesApi';
|
|
5
|
+
export * from './IntakeApi';
|
|
6
|
+
export * from './LabelsApi';
|
|
7
|
+
export * from './MembersApi';
|
|
8
|
+
export * from './ModulesApi';
|
|
9
|
+
export * from './ProjectsApi';
|
|
10
|
+
export * from './StatesApi';
|
|
11
|
+
export * from './UsersApi';
|
|
12
|
+
export * from './WorkItemActivityApi';
|
|
13
|
+
export * from './WorkItemAttachmentsApi';
|
|
14
|
+
export * from './WorkItemCommentsApi';
|
|
15
|
+
export * from './WorkItemLinksApi';
|
|
16
|
+
export * from './WorkItemPropertiesApi';
|
|
17
|
+
export * from './WorkItemTypesApi';
|
|
18
|
+
export * from './WorkItemWorklogsApi';
|
|
19
|
+
export * from './WorkItemsApi';
|
package/src/index.ts
ADDED
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* The Plane REST API
|
|
5
|
+
* The Plane REST API Visit our quick start guide and full API documentation at [developers.plane.so](https://developers.plane.so/api-reference/introduction).
|
|
6
|
+
*
|
|
7
|
+
* The version of the API Spec: 0.0.1
|
|
8
|
+
* Contact: support@plane.so
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated.
|
|
11
|
+
* Do not edit the class manually.
|
|
12
|
+
*/
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* * `INTERNAL` - INTERNAL
|
|
17
|
+
* * `EXTERNAL` - EXTERNAL
|
|
18
|
+
* @export
|
|
19
|
+
*/
|
|
20
|
+
export const AccessEnum = {
|
|
21
|
+
Internal: 'INTERNAL',
|
|
22
|
+
External: 'EXTERNAL'
|
|
23
|
+
} as const;
|
|
24
|
+
export type AccessEnum = typeof AccessEnum[keyof typeof AccessEnum];
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
export function instanceOfAccessEnum(value: any): boolean {
|
|
28
|
+
for (const key in AccessEnum) {
|
|
29
|
+
if (Object.prototype.hasOwnProperty.call(AccessEnum, key)) {
|
|
30
|
+
if (AccessEnum[key as keyof typeof AccessEnum] === value) {
|
|
31
|
+
return true;
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
return false;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
export function AccessEnumFromJSON(json: any): AccessEnum {
|
|
39
|
+
return AccessEnumFromJSONTyped(json, false);
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
export function AccessEnumFromJSONTyped(json: any, ignoreDiscriminator: boolean): AccessEnum {
|
|
43
|
+
return json as AccessEnum;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
export function AccessEnumToJSON(value?: AccessEnum | null): any {
|
|
47
|
+
return value as any;
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
export function AccessEnumToJSONTyped(value: any, ignoreDiscriminator: boolean): AccessEnum {
|
|
51
|
+
return value as AccessEnum;
|
|
52
|
+
}
|
|
53
|
+
|