@makeplane/plane-node-sdk 0.1.4 → 0.2.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.
Files changed (566) hide show
  1. package/LICENSE +7 -0
  2. package/README.md +117 -76
  3. package/dist/Configuration.d.ts +21 -0
  4. package/dist/Configuration.d.ts.map +1 -0
  5. package/dist/Configuration.js +28 -0
  6. package/dist/Configuration.js.map +1 -0
  7. package/dist/api/BaseResource.d.ts +55 -0
  8. package/dist/api/BaseResource.d.ts.map +1 -0
  9. package/dist/api/BaseResource.js +179 -0
  10. package/dist/api/BaseResource.js.map +1 -0
  11. package/dist/api/Customers/Properties.d.ts +44 -0
  12. package/dist/api/Customers/Properties.d.ts.map +1 -0
  13. package/dist/api/Customers/Properties.js +65 -0
  14. package/dist/api/Customers/Properties.js.map +1 -0
  15. package/dist/api/Customers/Requests.d.ts +32 -0
  16. package/dist/api/Customers/Requests.d.ts.map +1 -0
  17. package/dist/api/Customers/Requests.js +45 -0
  18. package/dist/api/Customers/Requests.js.map +1 -0
  19. package/dist/api/Customers/index.d.ts +49 -0
  20. package/dist/api/Customers/index.d.ts.map +1 -0
  21. package/dist/api/Customers/index.js +71 -0
  22. package/dist/api/Customers/index.js.map +1 -0
  23. package/dist/api/Cycles.d.ts +61 -0
  24. package/dist/api/Cycles.d.ts.map +1 -0
  25. package/dist/api/Cycles.js +89 -0
  26. package/dist/api/Cycles.js.map +1 -0
  27. package/dist/api/Epics.d.ts +20 -0
  28. package/dist/api/Epics.d.ts.map +1 -0
  29. package/dist/api/Epics.js +27 -0
  30. package/dist/api/Epics.js.map +1 -0
  31. package/dist/api/Intake.d.ts +32 -0
  32. package/dist/api/Intake.d.ts.map +1 -0
  33. package/dist/api/Intake.js +45 -0
  34. package/dist/api/Intake.js.map +1 -0
  35. package/dist/api/Labels.d.ts +58 -0
  36. package/dist/api/Labels.d.ts.map +1 -0
  37. package/dist/api/Labels.js +45 -0
  38. package/dist/api/Labels.js.map +1 -0
  39. package/dist/api/Links.d.ts +32 -0
  40. package/dist/api/Links.d.ts.map +1 -0
  41. package/dist/api/Links.js +45 -0
  42. package/dist/api/Links.js.map +1 -0
  43. package/dist/api/Members.d.ts +56 -0
  44. package/dist/api/Members.d.ts.map +1 -0
  45. package/dist/api/Members.js +45 -0
  46. package/dist/api/Members.js.map +1 -0
  47. package/dist/api/Modules.d.ts +57 -0
  48. package/dist/api/Modules.d.ts.map +1 -0
  49. package/dist/api/Modules.js +83 -0
  50. package/dist/api/Modules.js.map +1 -0
  51. package/dist/api/Pages.d.ts +35 -0
  52. package/dist/api/Pages.d.ts.map +1 -0
  53. package/dist/api/Pages.js +53 -0
  54. package/dist/api/Pages.js.map +1 -0
  55. package/dist/api/Projects.d.ts +41 -0
  56. package/dist/api/Projects.d.ts.map +1 -0
  57. package/dist/api/Projects.js +60 -0
  58. package/dist/api/Projects.js.map +1 -0
  59. package/dist/api/States.d.ts +32 -0
  60. package/dist/api/States.d.ts.map +1 -0
  61. package/dist/api/States.js +45 -0
  62. package/dist/api/States.js.map +1 -0
  63. package/dist/api/Users.d.ts +15 -0
  64. package/dist/api/Users.d.ts.map +1 -0
  65. package/dist/api/Users.js +21 -0
  66. package/dist/api/Users.js.map +1 -0
  67. package/dist/api/WorkItemProperties/Options.d.ts +31 -0
  68. package/dist/api/WorkItemProperties/Options.d.ts.map +1 -0
  69. package/dist/api/WorkItemProperties/Options.js +45 -0
  70. package/dist/api/WorkItemProperties/Options.js.map +1 -0
  71. package/dist/api/WorkItemProperties/Values.d.ts +23 -0
  72. package/dist/api/WorkItemProperties/Values.d.ts.map +1 -0
  73. package/dist/api/WorkItemProperties/Values.js +34 -0
  74. package/dist/api/WorkItemProperties/Values.js.map +1 -0
  75. package/dist/api/WorkItemProperties/index.d.ts +35 -0
  76. package/dist/api/WorkItemProperties/index.d.ts.map +1 -0
  77. package/dist/api/WorkItemProperties/index.js +49 -0
  78. package/dist/api/WorkItemProperties/index.js.map +1 -0
  79. package/dist/api/WorkItemTypes.d.ts +36 -0
  80. package/dist/api/WorkItemTypes.d.ts.map +1 -0
  81. package/dist/api/WorkItemTypes.js +45 -0
  82. package/dist/api/WorkItemTypes.js.map +1 -0
  83. package/dist/api/WorkItems/Activities.d.ts +20 -0
  84. package/dist/api/WorkItems/Activities.d.ts.map +1 -0
  85. package/dist/api/WorkItems/Activities.js +27 -0
  86. package/dist/api/WorkItems/Activities.js.map +1 -0
  87. package/dist/api/WorkItems/Attachments.d.ts +31 -0
  88. package/dist/api/WorkItems/Attachments.d.ts.map +1 -0
  89. package/dist/api/WorkItems/Attachments.js +45 -0
  90. package/dist/api/WorkItems/Attachments.js.map +1 -0
  91. package/dist/api/WorkItems/Comments.d.ts +32 -0
  92. package/dist/api/WorkItems/Comments.d.ts.map +1 -0
  93. package/dist/api/WorkItems/Comments.js +45 -0
  94. package/dist/api/WorkItems/Comments.js.map +1 -0
  95. package/dist/api/WorkItems/Relations.d.ts +23 -0
  96. package/dist/api/WorkItems/Relations.d.ts.map +1 -0
  97. package/dist/api/WorkItems/Relations.js +33 -0
  98. package/dist/api/WorkItems/Relations.js.map +1 -0
  99. package/dist/api/WorkItems/WorkLogs.d.ts +27 -0
  100. package/dist/api/WorkItems/WorkLogs.d.ts.map +1 -0
  101. package/dist/api/WorkItems/WorkLogs.js +39 -0
  102. package/dist/api/WorkItems/WorkLogs.js.map +1 -0
  103. package/dist/api/WorkItems/index.d.ts +48 -0
  104. package/dist/api/WorkItems/index.d.ts.map +1 -0
  105. package/dist/api/WorkItems/index.js +75 -0
  106. package/dist/api/WorkItems/index.js.map +1 -0
  107. package/dist/api/Workspace.d.ts +15 -0
  108. package/dist/api/Workspace.d.ts.map +1 -0
  109. package/dist/api/Workspace.js +21 -0
  110. package/dist/api/Workspace.js.map +1 -0
  111. package/dist/client/index.d.ts +4 -0
  112. package/dist/client/index.d.ts.map +1 -0
  113. package/dist/client/index.js +8 -0
  114. package/dist/client/index.js.map +1 -0
  115. package/dist/{oauth/api.d.ts → client/oauth-client.d.ts} +7 -5
  116. package/dist/client/oauth-client.d.ts.map +1 -0
  117. package/dist/client/oauth-client.js +129 -0
  118. package/dist/client/oauth-client.js.map +1 -0
  119. package/dist/client/plane-client.d.ts +47 -0
  120. package/dist/client/plane-client.d.ts.map +1 -0
  121. package/dist/client/plane-client.js +55 -0
  122. package/dist/client/plane-client.js.map +1 -0
  123. package/dist/errors/HttpError.d.ts +8 -0
  124. package/dist/errors/HttpError.d.ts.map +1 -0
  125. package/dist/errors/HttpError.js +15 -0
  126. package/dist/errors/HttpError.js.map +1 -0
  127. package/dist/errors/PlaneError.d.ts +9 -0
  128. package/dist/errors/PlaneError.d.ts.map +1 -0
  129. package/dist/errors/PlaneError.js +16 -0
  130. package/dist/errors/PlaneError.js.map +1 -0
  131. package/dist/errors/index.d.ts +3 -0
  132. package/dist/errors/index.d.ts.map +1 -0
  133. package/dist/errors/index.js +8 -0
  134. package/dist/errors/index.js.map +1 -0
  135. package/dist/index.d.ts +31 -4
  136. package/dist/index.d.ts.map +1 -0
  137. package/dist/index.js +67 -5
  138. package/dist/index.js.map +1 -0
  139. package/dist/models/Attachment.d.ts +46 -0
  140. package/dist/models/Attachment.d.ts.map +1 -0
  141. package/dist/models/Attachment.js +7 -0
  142. package/dist/models/Attachment.js.map +1 -0
  143. package/dist/models/Comment.d.ts +43 -0
  144. package/dist/models/Comment.d.ts.map +1 -0
  145. package/dist/models/Comment.js +3 -0
  146. package/dist/models/Comment.js.map +1 -0
  147. package/dist/models/Customer.d.ts +136 -0
  148. package/dist/models/Customer.d.ts.map +1 -0
  149. package/dist/models/Customer.js +3 -0
  150. package/dist/models/Customer.js.map +1 -0
  151. package/dist/models/Cycle.d.ts +59 -210
  152. package/dist/models/Cycle.d.ts.map +1 -0
  153. package/dist/models/Cycle.js +1 -91
  154. package/dist/models/Cycle.js.map +1 -0
  155. package/dist/models/Epic.d.ts +34 -0
  156. package/dist/models/Epic.d.ts.map +1 -0
  157. package/dist/{oauth/models.js → models/Epic.js} +1 -0
  158. package/dist/models/Epic.js.map +1 -0
  159. package/dist/models/Intake.d.ts +48 -0
  160. package/dist/models/Intake.d.ts.map +1 -0
  161. package/dist/models/Intake.js +3 -0
  162. package/dist/models/Intake.js.map +1 -0
  163. package/dist/models/Label.d.ts +13 -113
  164. package/dist/models/Label.d.ts.map +1 -0
  165. package/dist/models/Label.js +1 -68
  166. package/dist/models/Label.js.map +1 -0
  167. package/dist/models/Link.d.ts +25 -0
  168. package/dist/models/Link.d.ts.map +1 -0
  169. package/dist/models/Link.js +3 -0
  170. package/dist/models/Link.js.map +1 -0
  171. package/dist/models/Module.d.ts +55 -193
  172. package/dist/models/Module.d.ts.map +1 -0
  173. package/dist/models/Module.js +1 -89
  174. package/dist/models/Module.js.map +1 -0
  175. package/dist/{oauth/models.d.ts → models/OAuth.d.ts} +1 -0
  176. package/dist/models/OAuth.d.ts.map +1 -0
  177. package/dist/models/OAuth.js +3 -0
  178. package/dist/models/OAuth.js.map +1 -0
  179. package/dist/models/Page.d.ts +14 -0
  180. package/dist/models/Page.d.ts.map +1 -0
  181. package/dist/models/Page.js +3 -0
  182. package/dist/models/Page.js.map +1 -0
  183. package/dist/models/Project.d.ts +42 -290
  184. package/dist/models/Project.d.ts.map +1 -0
  185. package/dist/models/Project.js +1 -122
  186. package/dist/models/Project.js.map +1 -0
  187. package/dist/models/State.d.ts +34 -124
  188. package/dist/models/State.d.ts.map +1 -0
  189. package/dist/models/State.js +2 -73
  190. package/dist/models/State.js.map +1 -0
  191. package/dist/models/User.d.ts +10 -0
  192. package/dist/models/User.d.ts.map +1 -0
  193. package/dist/models/User.js +3 -0
  194. package/dist/models/User.js.map +1 -0
  195. package/dist/models/WorkItem.d.ts +111 -0
  196. package/dist/models/WorkItem.d.ts.map +1 -0
  197. package/dist/models/WorkItem.js +3 -0
  198. package/dist/models/WorkItem.js.map +1 -0
  199. package/dist/models/WorkItemProperty.d.ts +123 -0
  200. package/dist/models/WorkItemProperty.d.ts.map +1 -0
  201. package/dist/models/WorkItemProperty.js +3 -0
  202. package/dist/models/WorkItemProperty.js.map +1 -0
  203. package/dist/models/WorkItemRelation.d.ts +34 -0
  204. package/dist/models/WorkItemRelation.d.ts.map +1 -0
  205. package/dist/models/WorkItemRelation.js +3 -0
  206. package/dist/models/WorkItemRelation.js.map +1 -0
  207. package/dist/models/WorkItemType.d.ts +18 -0
  208. package/dist/models/WorkItemType.d.ts.map +1 -0
  209. package/dist/models/WorkItemType.js +3 -0
  210. package/dist/models/WorkItemType.js.map +1 -0
  211. package/dist/models/WorkLog.d.ts +23 -0
  212. package/dist/models/WorkLog.d.ts.map +1 -0
  213. package/dist/models/WorkLog.js +3 -0
  214. package/dist/models/WorkLog.js.map +1 -0
  215. package/dist/models/common.d.ts +63 -0
  216. package/dist/models/common.d.ts.map +1 -0
  217. package/dist/models/common.js +6 -0
  218. package/dist/models/common.js.map +1 -0
  219. package/dist/models/index.d.ts +11 -95
  220. package/dist/models/index.d.ts.map +1 -0
  221. package/dist/models/index.js +9 -94
  222. package/dist/models/index.js.map +1 -0
  223. package/package.json +49 -14
  224. package/.github/workflows/publish-node-sdk.yml +0 -43
  225. package/.openapi-generator/FILES +0 -124
  226. package/.openapi-generator/VERSION +0 -1
  227. package/.openapi-generator-ignore +0 -23
  228. package/dist/apis/AssetsApi.d.ts +0 -100
  229. package/dist/apis/AssetsApi.js +0 -522
  230. package/dist/apis/CyclesApi.d.ts +0 -225
  231. package/dist/apis/CyclesApi.js +0 -1142
  232. package/dist/apis/IntakeApi.d.ts +0 -96
  233. package/dist/apis/IntakeApi.js +0 -485
  234. package/dist/apis/LabelsApi.d.ts +0 -97
  235. package/dist/apis/LabelsApi.js +0 -488
  236. package/dist/apis/MembersApi.d.ts +0 -44
  237. package/dist/apis/MembersApi.js +0 -228
  238. package/dist/apis/ModulesApi.d.ts +0 -198
  239. package/dist/apis/ModulesApi.js +0 -991
  240. package/dist/apis/ProjectsApi.d.ts +0 -120
  241. package/dist/apis/ProjectsApi.js +0 -621
  242. package/dist/apis/StatesApi.d.ts +0 -96
  243. package/dist/apis/StatesApi.js +0 -485
  244. package/dist/apis/UsersApi.d.ts +0 -27
  245. package/dist/apis/UsersApi.js +0 -149
  246. package/dist/apis/WorkItemActivityApi.d.ts +0 -58
  247. package/dist/apis/WorkItemActivityApi.js +0 -270
  248. package/dist/apis/WorkItemAttachmentsApi.d.ts +0 -80
  249. package/dist/apis/WorkItemAttachmentsApi.js +0 -400
  250. package/dist/apis/WorkItemCommentsApi.d.ts +0 -102
  251. package/dist/apis/WorkItemCommentsApi.js +0 -500
  252. package/dist/apis/WorkItemLinksApi.d.ts +0 -106
  253. package/dist/apis/WorkItemLinksApi.js +0 -515
  254. package/dist/apis/WorkItemPropertiesApi.d.ts +0 -210
  255. package/dist/apis/WorkItemPropertiesApi.js +0 -1066
  256. package/dist/apis/WorkItemTypesApi.d.ts +0 -92
  257. package/dist/apis/WorkItemTypesApi.js +0 -473
  258. package/dist/apis/WorkItemWorklogsApi.d.ts +0 -95
  259. package/dist/apis/WorkItemWorklogsApi.js +0 -479
  260. package/dist/apis/WorkItemsApi.d.ts +0 -134
  261. package/dist/apis/WorkItemsApi.js +0 -674
  262. package/dist/apis/index.d.ts +0 -17
  263. package/dist/apis/index.js +0 -34
  264. package/dist/models/AccessEnum.d.ts +0 -25
  265. package/dist/models/AccessEnum.js +0 -51
  266. package/dist/models/CycleCreateRequest.d.ts +0 -77
  267. package/dist/models/CycleCreateRequest.js +0 -67
  268. package/dist/models/CycleIssue.d.ts +0 -94
  269. package/dist/models/CycleIssue.js +0 -65
  270. package/dist/models/CycleIssueRequestRequest.d.ts +0 -34
  271. package/dist/models/CycleIssueRequestRequest.js +0 -50
  272. package/dist/models/CycleLite.d.ts +0 -161
  273. package/dist/models/CycleLite.js +0 -96
  274. package/dist/models/EntityTypeEnum.d.ts +0 -25
  275. package/dist/models/EntityTypeEnum.js +0 -51
  276. package/dist/models/GenericAssetUploadRequest.d.ts +0 -65
  277. package/dist/models/GenericAssetUploadRequest.js +0 -62
  278. package/dist/models/GetWorkspaceMembers200ResponseInner.d.ts +0 -73
  279. package/dist/models/GetWorkspaceMembers200ResponseInner.js +0 -55
  280. package/dist/models/GroupEnum.d.ts +0 -33
  281. package/dist/models/GroupEnum.js +0 -59
  282. package/dist/models/IntakeIssue.d.ts +0 -150
  283. package/dist/models/IntakeIssue.js +0 -80
  284. package/dist/models/IntakeIssueCreateRequest.d.ts +0 -72
  285. package/dist/models/IntakeIssueCreateRequest.js +0 -66
  286. package/dist/models/IntakeWorkItemStatusEnum.d.ts +0 -31
  287. package/dist/models/IntakeWorkItemStatusEnum.js +0 -57
  288. package/dist/models/Issue.d.ts +0 -197
  289. package/dist/models/Issue.js +0 -98
  290. package/dist/models/IssueActivity.d.ts +0 -136
  291. package/dist/models/IssueActivity.js +0 -83
  292. package/dist/models/IssueAttachment.d.ts +0 -172
  293. package/dist/models/IssueAttachment.js +0 -89
  294. package/dist/models/IssueAttachmentUploadRequest.d.ts +0 -58
  295. package/dist/models/IssueAttachmentUploadRequest.js +0 -60
  296. package/dist/models/IssueComment.d.ts +0 -137
  297. package/dist/models/IssueComment.js +0 -74
  298. package/dist/models/IssueCommentCreateRequest.d.ts +0 -59
  299. package/dist/models/IssueCommentCreateRequest.js +0 -57
  300. package/dist/models/IssueDetail.d.ts +0 -211
  301. package/dist/models/IssueDetail.js +0 -108
  302. package/dist/models/IssueExpand.d.ts +0 -224
  303. package/dist/models/IssueExpand.js +0 -103
  304. package/dist/models/IssueForIntakeRequest.d.ts +0 -53
  305. package/dist/models/IssueForIntakeRequest.js +0 -57
  306. package/dist/models/IssueLink.d.ts +0 -100
  307. package/dist/models/IssueLink.js +0 -64
  308. package/dist/models/IssueLinkCreateRequest.d.ts +0 -34
  309. package/dist/models/IssueLinkCreateRequest.js +0 -50
  310. package/dist/models/IssuePropertyAPI.d.ts +0 -171
  311. package/dist/models/IssuePropertyAPI.js +0 -88
  312. package/dist/models/IssuePropertyAPIRequest.d.ts +0 -99
  313. package/dist/models/IssuePropertyAPIRequest.js +0 -76
  314. package/dist/models/IssuePropertyOptionAPI.d.ts +0 -133
  315. package/dist/models/IssuePropertyOptionAPI.js +0 -73
  316. package/dist/models/IssuePropertyOptionAPIRequest.d.ts +0 -67
  317. package/dist/models/IssuePropertyOptionAPIRequest.js +0 -62
  318. package/dist/models/IssuePropertyValueAPI.d.ts +0 -133
  319. package/dist/models/IssuePropertyValueAPI.js +0 -78
  320. package/dist/models/IssuePropertyValueAPIDetail.d.ts +0 -39
  321. package/dist/models/IssuePropertyValueAPIDetail.js +0 -54
  322. package/dist/models/IssuePropertyValueAPIRequest.d.ts +0 -85
  323. package/dist/models/IssuePropertyValueAPIRequest.js +0 -70
  324. package/dist/models/IssueRequest.d.ts +0 -167
  325. package/dist/models/IssueRequest.js +0 -95
  326. package/dist/models/IssueSearch.d.ts +0 -34
  327. package/dist/models/IssueSearch.js +0 -51
  328. package/dist/models/IssueSearchItem.d.ts +0 -64
  329. package/dist/models/IssueSearchItem.js +0 -70
  330. package/dist/models/IssueTypeAPI.d.ts +0 -127
  331. package/dist/models/IssueTypeAPI.js +0 -72
  332. package/dist/models/IssueTypeAPIRequest.d.ts +0 -67
  333. package/dist/models/IssueTypeAPIRequest.js +0 -62
  334. package/dist/models/IssueWorkLogAPI.d.ts +0 -85
  335. package/dist/models/IssueWorkLogAPI.js +0 -60
  336. package/dist/models/IssueWorkLogAPIRequest.d.ts +0 -49
  337. package/dist/models/IssueWorkLogAPIRequest.js +0 -54
  338. package/dist/models/LabelCreateUpdateRequest.d.ts +0 -70
  339. package/dist/models/LabelCreateUpdateRequest.js +0 -62
  340. package/dist/models/ModuleCreateRequest.d.ts +0 -83
  341. package/dist/models/ModuleCreateRequest.js +0 -67
  342. package/dist/models/ModuleIssue.d.ts +0 -94
  343. package/dist/models/ModuleIssue.js +0 -63
  344. package/dist/models/ModuleIssueRequestRequest.d.ts +0 -34
  345. package/dist/models/ModuleIssueRequestRequest.js +0 -50
  346. package/dist/models/ModuleLite.d.ts +0 -167
  347. package/dist/models/ModuleLite.js +0 -97
  348. package/dist/models/ModuleStatusEnum.d.ts +0 -33
  349. package/dist/models/ModuleStatusEnum.js +0 -59
  350. package/dist/models/NetworkEnum.d.ts +0 -25
  351. package/dist/models/NetworkEnum.js +0 -51
  352. package/dist/models/PaginatedArchivedCycleResponse.d.ts +0 -98
  353. package/dist/models/PaginatedArchivedCycleResponse.js +0 -95
  354. package/dist/models/PaginatedArchivedModuleResponse.d.ts +0 -98
  355. package/dist/models/PaginatedArchivedModuleResponse.js +0 -95
  356. package/dist/models/PaginatedCycleIssueResponse.d.ts +0 -98
  357. package/dist/models/PaginatedCycleIssueResponse.js +0 -95
  358. package/dist/models/PaginatedCycleResponse.d.ts +0 -98
  359. package/dist/models/PaginatedCycleResponse.js +0 -95
  360. package/dist/models/PaginatedIntakeIssueResponse.d.ts +0 -98
  361. package/dist/models/PaginatedIntakeIssueResponse.js +0 -95
  362. package/dist/models/PaginatedIssueActivityDetailResponse.d.ts +0 -98
  363. package/dist/models/PaginatedIssueActivityDetailResponse.js +0 -95
  364. package/dist/models/PaginatedIssueActivityResponse.d.ts +0 -98
  365. package/dist/models/PaginatedIssueActivityResponse.js +0 -95
  366. package/dist/models/PaginatedIssueCommentResponse.d.ts +0 -98
  367. package/dist/models/PaginatedIssueCommentResponse.js +0 -95
  368. package/dist/models/PaginatedIssueLinkDetailResponse.d.ts +0 -98
  369. package/dist/models/PaginatedIssueLinkDetailResponse.js +0 -95
  370. package/dist/models/PaginatedIssueLinkResponse.d.ts +0 -98
  371. package/dist/models/PaginatedIssueLinkResponse.js +0 -95
  372. package/dist/models/PaginatedLabelResponse.d.ts +0 -98
  373. package/dist/models/PaginatedLabelResponse.js +0 -95
  374. package/dist/models/PaginatedModuleIssueResponse.d.ts +0 -98
  375. package/dist/models/PaginatedModuleIssueResponse.js +0 -95
  376. package/dist/models/PaginatedModuleResponse.d.ts +0 -98
  377. package/dist/models/PaginatedModuleResponse.js +0 -95
  378. package/dist/models/PaginatedProjectResponse.d.ts +0 -98
  379. package/dist/models/PaginatedProjectResponse.js +0 -95
  380. package/dist/models/PaginatedStateResponse.d.ts +0 -98
  381. package/dist/models/PaginatedStateResponse.js +0 -95
  382. package/dist/models/PaginatedWorkItemResponse.d.ts +0 -98
  383. package/dist/models/PaginatedWorkItemResponse.js +0 -95
  384. package/dist/models/PatchedAssetUpdateRequest.d.ts +0 -34
  385. package/dist/models/PatchedAssetUpdateRequest.js +0 -48
  386. package/dist/models/PatchedCycleUpdateRequest.d.ts +0 -77
  387. package/dist/models/PatchedCycleUpdateRequest.js +0 -63
  388. package/dist/models/PatchedGenericAssetUpdateRequest.d.ts +0 -34
  389. package/dist/models/PatchedGenericAssetUpdateRequest.js +0 -48
  390. package/dist/models/PatchedIntakeIssueUpdateRequest.d.ts +0 -66
  391. package/dist/models/PatchedIntakeIssueUpdateRequest.js +0 -60
  392. package/dist/models/PatchedIssueCommentCreateRequest.d.ts +0 -59
  393. package/dist/models/PatchedIssueCommentCreateRequest.js +0 -57
  394. package/dist/models/PatchedIssueLinkUpdateRequest.d.ts +0 -34
  395. package/dist/models/PatchedIssueLinkUpdateRequest.js +0 -48
  396. package/dist/models/PatchedIssuePropertyAPIRequest.d.ts +0 -99
  397. package/dist/models/PatchedIssuePropertyAPIRequest.js +0 -72
  398. package/dist/models/PatchedIssuePropertyOptionAPIRequest.d.ts +0 -67
  399. package/dist/models/PatchedIssuePropertyOptionAPIRequest.js +0 -60
  400. package/dist/models/PatchedIssueRequest.d.ts +0 -167
  401. package/dist/models/PatchedIssueRequest.js +0 -93
  402. package/dist/models/PatchedIssueTypeAPIRequest.d.ts +0 -67
  403. package/dist/models/PatchedIssueTypeAPIRequest.js +0 -60
  404. package/dist/models/PatchedIssueWorkLogAPIRequest.d.ts +0 -49
  405. package/dist/models/PatchedIssueWorkLogAPIRequest.js +0 -54
  406. package/dist/models/PatchedLabelCreateUpdateRequest.d.ts +0 -70
  407. package/dist/models/PatchedLabelCreateUpdateRequest.js +0 -60
  408. package/dist/models/PatchedModuleUpdateRequest.d.ts +0 -83
  409. package/dist/models/PatchedModuleUpdateRequest.js +0 -65
  410. package/dist/models/PatchedProjectUpdateRequest.d.ts +0 -143
  411. package/dist/models/PatchedProjectUpdateRequest.js +0 -85
  412. package/dist/models/PatchedStateRequest.d.ts +0 -83
  413. package/dist/models/PatchedStateRequest.js +0 -65
  414. package/dist/models/PriorityEnum.d.ts +0 -31
  415. package/dist/models/PriorityEnum.js +0 -57
  416. package/dist/models/ProjectCreateRequest.d.ts +0 -131
  417. package/dist/models/ProjectCreateRequest.js +0 -85
  418. package/dist/models/ProjectWorklogSummary.d.ts +0 -37
  419. package/dist/models/ProjectWorklogSummary.js +0 -54
  420. package/dist/models/PropertyTypeEnum.d.ts +0 -39
  421. package/dist/models/PropertyTypeEnum.js +0 -65
  422. package/dist/models/RelationTypeEnum.d.ts +0 -25
  423. package/dist/models/RelationTypeEnum.js +0 -51
  424. package/dist/models/RetrieveWorkItemAttachment400Response.d.ts +0 -37
  425. package/dist/models/RetrieveWorkItemAttachment400Response.js +0 -50
  426. package/dist/models/StateLite.d.ts +0 -53
  427. package/dist/models/StateLite.js +0 -50
  428. package/dist/models/StateRequest.d.ts +0 -83
  429. package/dist/models/StateRequest.js +0 -69
  430. package/dist/models/TimezoneEnum.d.ts +0 -887
  431. package/dist/models/TimezoneEnum.js +0 -913
  432. package/dist/models/TransferCycleIssueRequestRequest.d.ts +0 -34
  433. package/dist/models/TransferCycleIssueRequestRequest.js +0 -50
  434. package/dist/models/TransferCycleWorkItems200Response.d.ts +0 -31
  435. package/dist/models/TransferCycleWorkItems200Response.js +0 -48
  436. package/dist/models/TransferCycleWorkItems400Response.d.ts +0 -31
  437. package/dist/models/TransferCycleWorkItems400Response.js +0 -48
  438. package/dist/models/TypeEnum.d.ts +0 -31
  439. package/dist/models/TypeEnum.js +0 -57
  440. package/dist/models/UserAssetUploadRequest.d.ts +0 -64
  441. package/dist/models/UserAssetUploadRequest.js +0 -62
  442. package/dist/models/UserLite.d.ts +0 -70
  443. package/dist/models/UserLite.js +0 -52
  444. package/dist/oauth/api.js +0 -243
  445. package/dist/runtime.d.ts +0 -183
  446. package/dist/runtime.js +0 -563
  447. package/eslint.config.mjs +0 -11
  448. package/src/apis/AssetsApi.ts +0 -388
  449. package/src/apis/CyclesApi.ts +0 -1031
  450. package/src/apis/IntakeApi.ts +0 -401
  451. package/src/apis/LabelsApi.ts +0 -406
  452. package/src/apis/MembersApi.ts +0 -146
  453. package/src/apis/ModulesApi.ts +0 -890
  454. package/src/apis/ProjectsApi.ts +0 -486
  455. package/src/apis/StatesApi.ts +0 -401
  456. package/src/apis/UsersApi.ts +0 -71
  457. package/src/apis/WorkItemActivityApi.ts +0 -228
  458. package/src/apis/WorkItemAttachmentsApi.ts +0 -335
  459. package/src/apis/WorkItemCommentsApi.ts +0 -439
  460. package/src/apis/WorkItemLinksApi.ts +0 -469
  461. package/src/apis/WorkItemPropertiesApi.ts +0 -984
  462. package/src/apis/WorkItemTypesApi.ts +0 -378
  463. package/src/apis/WorkItemWorklogsApi.ts +0 -398
  464. package/src/apis/WorkItemsApi.ts +0 -594
  465. package/src/apis/index.ts +0 -19
  466. package/src/index.ts +0 -6
  467. package/src/models/AccessEnum.ts +0 -53
  468. package/src/models/Cycle.ts +0 -300
  469. package/src/models/CycleCreateRequest.ts +0 -135
  470. package/src/models/CycleIssue.ts +0 -142
  471. package/src/models/CycleIssueRequestRequest.ts +0 -68
  472. package/src/models/CycleLite.ts +0 -246
  473. package/src/models/EntityTypeEnum.ts +0 -53
  474. package/src/models/GenericAssetUploadRequest.ts +0 -110
  475. package/src/models/GetWorkspaceMembers200ResponseInner.ts +0 -113
  476. package/src/models/GroupEnum.ts +0 -61
  477. package/src/models/IntakeIssue.ts +0 -227
  478. package/src/models/IntakeIssueCreateRequest.ts +0 -134
  479. package/src/models/IntakeWorkItemStatusEnum.ts +0 -59
  480. package/src/models/Issue.ts +0 -287
  481. package/src/models/IssueActivity.ts +0 -202
  482. package/src/models/IssueAttachment.ts +0 -245
  483. package/src/models/IssueAttachmentUploadRequest.ts +0 -101
  484. package/src/models/IssueComment.ts +0 -204
  485. package/src/models/IssueCommentCreateRequest.ts +0 -109
  486. package/src/models/IssueDetail.ts +0 -319
  487. package/src/models/IssueExpand.ts +0 -334
  488. package/src/models/IssueForIntakeRequest.ts +0 -102
  489. package/src/models/IssueLink.ts +0 -148
  490. package/src/models/IssueLinkCreateRequest.ts +0 -68
  491. package/src/models/IssuePropertyAPI.ts +0 -255
  492. package/src/models/IssuePropertyAPIRequest.ts +0 -171
  493. package/src/models/IssuePropertyOptionAPI.ts +0 -190
  494. package/src/models/IssuePropertyOptionAPIRequest.ts +0 -113
  495. package/src/models/IssuePropertyValueAPI.ts +0 -194
  496. package/src/models/IssuePropertyValueAPIDetail.ts +0 -76
  497. package/src/models/IssuePropertyValueAPIRequest.ts +0 -138
  498. package/src/models/IssueRequest.ts +0 -254
  499. package/src/models/IssueSearch.ts +0 -75
  500. package/src/models/IssueSearchItem.ts +0 -113
  501. package/src/models/IssueTypeAPI.ts +0 -183
  502. package/src/models/IssueTypeAPIRequest.ts +0 -113
  503. package/src/models/IssueWorkLogAPI.ts +0 -130
  504. package/src/models/IssueWorkLogAPIRequest.ts +0 -88
  505. package/src/models/Label.ts +0 -172
  506. package/src/models/LabelCreateUpdateRequest.ts +0 -116
  507. package/src/models/Module.ts +0 -280
  508. package/src/models/ModuleCreateRequest.ts +0 -142
  509. package/src/models/ModuleIssue.ts +0 -140
  510. package/src/models/ModuleIssueRequestRequest.ts +0 -68
  511. package/src/models/ModuleLite.ts +0 -253
  512. package/src/models/ModuleStatusEnum.ts +0 -61
  513. package/src/models/NetworkEnum.ts +0 -53
  514. package/src/models/PaginatedArchivedCycleResponse.ts +0 -172
  515. package/src/models/PaginatedArchivedModuleResponse.ts +0 -172
  516. package/src/models/PaginatedCycleIssueResponse.ts +0 -172
  517. package/src/models/PaginatedCycleResponse.ts +0 -172
  518. package/src/models/PaginatedIntakeIssueResponse.ts +0 -172
  519. package/src/models/PaginatedIssueActivityDetailResponse.ts +0 -172
  520. package/src/models/PaginatedIssueActivityResponse.ts +0 -172
  521. package/src/models/PaginatedIssueCommentResponse.ts +0 -172
  522. package/src/models/PaginatedIssueLinkDetailResponse.ts +0 -172
  523. package/src/models/PaginatedIssueLinkResponse.ts +0 -172
  524. package/src/models/PaginatedLabelResponse.ts +0 -172
  525. package/src/models/PaginatedModuleIssueResponse.ts +0 -172
  526. package/src/models/PaginatedModuleResponse.ts +0 -172
  527. package/src/models/PaginatedProjectResponse.ts +0 -172
  528. package/src/models/PaginatedStateResponse.ts +0 -172
  529. package/src/models/PaginatedWorkItemResponse.ts +0 -172
  530. package/src/models/PatchedAssetUpdateRequest.ts +0 -67
  531. package/src/models/PatchedCycleUpdateRequest.ts +0 -133
  532. package/src/models/PatchedGenericAssetUpdateRequest.ts +0 -67
  533. package/src/models/PatchedIntakeIssueUpdateRequest.ts +0 -124
  534. package/src/models/PatchedIssueCommentCreateRequest.ts +0 -109
  535. package/src/models/PatchedIssueLinkUpdateRequest.ts +0 -67
  536. package/src/models/PatchedIssuePropertyAPIRequest.ts +0 -169
  537. package/src/models/PatchedIssuePropertyOptionAPIRequest.ts +0 -112
  538. package/src/models/PatchedIssueRequest.ts +0 -253
  539. package/src/models/PatchedIssueTypeAPIRequest.ts +0 -112
  540. package/src/models/PatchedIssueWorkLogAPIRequest.ts +0 -88
  541. package/src/models/PatchedLabelCreateUpdateRequest.ts +0 -115
  542. package/src/models/PatchedModuleUpdateRequest.ts +0 -141
  543. package/src/models/PatchedProjectUpdateRequest.ts +0 -221
  544. package/src/models/PatchedStateRequest.ts +0 -141
  545. package/src/models/PriorityEnum.ts +0 -59
  546. package/src/models/Project.ts +0 -414
  547. package/src/models/ProjectCreateRequest.ts +0 -207
  548. package/src/models/ProjectWorklogSummary.ts +0 -74
  549. package/src/models/PropertyTypeEnum.ts +0 -67
  550. package/src/models/RelationTypeEnum.ts +0 -53
  551. package/src/models/RetrieveWorkItemAttachment400Response.ts +0 -72
  552. package/src/models/State.ts +0 -199
  553. package/src/models/StateLite.ts +0 -97
  554. package/src/models/StateRequest.ts +0 -143
  555. package/src/models/TimezoneEnum.ts +0 -915
  556. package/src/models/TransferCycleIssueRequestRequest.ts +0 -68
  557. package/src/models/TransferCycleWorkItems200Response.ts +0 -64
  558. package/src/models/TransferCycleWorkItems400Response.ts +0 -64
  559. package/src/models/TypeEnum.ts +0 -59
  560. package/src/models/UserAssetUploadRequest.ts +0 -121
  561. package/src/models/UserLite.ts +0 -108
  562. package/src/models/index.ts +0 -97
  563. package/src/oauth/api.ts +0 -183
  564. package/src/oauth/models.ts +0 -30
  565. package/src/runtime.ts +0 -431
  566. package/tsconfig.json +0 -20
package/dist/oauth/api.js DELETED
@@ -1,243 +0,0 @@
1
- "use strict";
2
- var __extends = (this && this.__extends) || (function () {
3
- var extendStatics = function (d, b) {
4
- extendStatics = Object.setPrototypeOf ||
5
- ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
6
- function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
7
- return extendStatics(d, b);
8
- };
9
- return function (d, b) {
10
- if (typeof b !== "function" && b !== null)
11
- throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
12
- extendStatics(d, b);
13
- function __() { this.constructor = d; }
14
- d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
15
- };
16
- })();
17
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
18
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
19
- return new (P || (P = Promise))(function (resolve, reject) {
20
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
21
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
22
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
23
- step((generator = generator.apply(thisArg, _arguments || [])).next());
24
- });
25
- };
26
- var __generator = (this && this.__generator) || function (thisArg, body) {
27
- var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
28
- return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
29
- function verb(n) { return function (v) { return step([n, v]); }; }
30
- function step(op) {
31
- if (f) throw new TypeError("Generator is already executing.");
32
- while (g && (g = 0, op[0] && (_ = 0)), _) try {
33
- if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
34
- if (y = 0, t) op = [op[0] & 2, t.value];
35
- switch (op[0]) {
36
- case 0: case 1: t = op; break;
37
- case 4: _.label++; return { value: op[1], done: false };
38
- case 5: _.label++; y = op[1]; op = [0]; continue;
39
- case 7: op = _.ops.pop(); _.trys.pop(); continue;
40
- default:
41
- if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
42
- if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
43
- if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
44
- if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
45
- if (t[2]) _.ops.pop();
46
- _.trys.pop(); continue;
47
- }
48
- op = body.call(thisArg, _);
49
- } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
50
- if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
51
- }
52
- };
53
- Object.defineProperty(exports, "__esModule", { value: true });
54
- exports.OAuthApi = void 0;
55
- var runtime = require("../runtime");
56
- /**
57
- * OAuth API helper class
58
- */
59
- var OAuthApi = /** @class */ (function (_super) {
60
- __extends(OAuthApi, _super);
61
- function OAuthApi(configuration, oauthConfig) {
62
- var _this = _super.call(this, configuration) || this;
63
- if (oauthConfig) {
64
- _this.clientId = oauthConfig.clientId;
65
- _this.clientSecret = oauthConfig.clientSecret;
66
- _this.redirectUri = oauthConfig.redirectUri;
67
- _this.baseUrl = configuration.basePath || "https://api.plane.so";
68
- }
69
- return _this;
70
- }
71
- /**
72
- * Get the authorization URL for the OAuth flow
73
- * @param responseType - The response type (default: "code")
74
- * @param state - Optional state parameter for security
75
- * @returns The authorization URL
76
- */
77
- OAuthApi.prototype.getAuthorizationUrl = function (responseType, state) {
78
- if (responseType === void 0) { responseType = "code"; }
79
- var params = new URLSearchParams({
80
- client_id: this.clientId,
81
- response_type: responseType,
82
- redirect_uri: this.redirectUri,
83
- });
84
- if (state) {
85
- params.append("state", state);
86
- }
87
- return "".concat(this.baseUrl, "/auth/o/authorize-app/?").concat(params.toString());
88
- };
89
- /**
90
- * Exchange authorization code for access token
91
- * @param code - The authorization code
92
- * @param grantType - The grant type (default: "authorization_code")
93
- * @returns Promise resolving to token response
94
- */
95
- OAuthApi.prototype.exchangeCodeForToken = function (code_1) {
96
- return __awaiter(this, arguments, void 0, function (code, grantType) {
97
- var data, headers, response;
98
- if (grantType === void 0) { grantType = "authorization_code"; }
99
- return __generator(this, function (_a) {
100
- switch (_a.label) {
101
- case 0:
102
- data = new URLSearchParams({
103
- grant_type: grantType,
104
- code: code,
105
- client_id: this.clientId,
106
- client_secret: this.clientSecret,
107
- redirect_uri: this.redirectUri,
108
- });
109
- headers = {
110
- "Cache-Control": "no-cache",
111
- "Content-Type": "application/x-www-form-urlencoded",
112
- };
113
- return [4 /*yield*/, this.request({
114
- path: "/auth/o/token/",
115
- method: "POST",
116
- headers: headers,
117
- body: data,
118
- })];
119
- case 1:
120
- response = _a.sent();
121
- return [4 /*yield*/, response.json()];
122
- case 2: return [2 /*return*/, _a.sent()];
123
- }
124
- });
125
- });
126
- };
127
- /**
128
- * Get a new access token using a refresh token
129
- * @param refreshToken - The refresh token
130
- * @returns Promise resolving to token response
131
- */
132
- OAuthApi.prototype.getRefreshToken = function (refreshToken) {
133
- return __awaiter(this, void 0, void 0, function () {
134
- var data, headers, response;
135
- return __generator(this, function (_a) {
136
- switch (_a.label) {
137
- case 0:
138
- data = new URLSearchParams({
139
- grant_type: "refresh_token",
140
- refresh_token: refreshToken,
141
- client_id: this.clientId,
142
- client_secret: this.clientSecret,
143
- });
144
- headers = {
145
- "Cache-Control": "no-cache",
146
- "Content-Type": "application/x-www-form-urlencoded",
147
- };
148
- return [4 /*yield*/, this.request({
149
- path: "/auth/o/token/",
150
- method: "POST",
151
- headers: headers,
152
- body: data,
153
- })];
154
- case 1:
155
- response = _a.sent();
156
- return [4 /*yield*/, response.json()];
157
- case 2: return [2 /*return*/, _a.sent()];
158
- }
159
- });
160
- });
161
- };
162
- /**
163
- * Get a new access token using client credentials for bot/app installations
164
- * @param appInstallationId - The app installation ID
165
- * @returns Promise resolving to token response
166
- */
167
- OAuthApi.prototype.getBotToken = function (appInstallationId) {
168
- return __awaiter(this, void 0, void 0, function () {
169
- var data, headers, response;
170
- return __generator(this, function (_a) {
171
- switch (_a.label) {
172
- case 0:
173
- data = new URLSearchParams({
174
- grant_type: "client_credentials",
175
- app_installation_id: appInstallationId,
176
- });
177
- headers = {
178
- "Cache-Control": "no-cache",
179
- "Content-Type": "application/x-www-form-urlencoded",
180
- Authorization: "Basic ".concat(this.getBasicAuthToken()),
181
- };
182
- return [4 /*yield*/, this.request({
183
- path: "/auth/o/token/",
184
- method: "POST",
185
- headers: headers,
186
- body: data,
187
- })];
188
- case 1:
189
- response = _a.sent();
190
- return [4 /*yield*/, response.json()];
191
- case 2: return [2 /*return*/, _a.sent()];
192
- }
193
- });
194
- });
195
- };
196
- /**
197
- * Get an app installation by ID using the bot token
198
- * @param token - The bot token from getBotToken method
199
- * @param appInstallationId - The app installation ID
200
- * @returns Promise resolving to app installation
201
- */
202
- OAuthApi.prototype.getAppInstallations = function (token, appInstallationId) {
203
- return __awaiter(this, void 0, void 0, function () {
204
- var headers, path, response, data;
205
- return __generator(this, function (_a) {
206
- switch (_a.label) {
207
- case 0:
208
- headers = {
209
- Authorization: "Bearer ".concat(token),
210
- };
211
- path = "/auth/o/app-installation/";
212
- if (appInstallationId) {
213
- path += "?id=".concat(appInstallationId);
214
- }
215
- return [4 /*yield*/, this.request({
216
- path: path,
217
- method: "GET",
218
- headers: headers,
219
- })];
220
- case 1:
221
- response = _a.sent();
222
- return [4 /*yield*/, response.json()];
223
- case 2:
224
- data = _a.sent();
225
- if (!data || data.length === 0) {
226
- throw new runtime.ResponseError(response, "App installation not found");
227
- }
228
- return [2 /*return*/, data];
229
- }
230
- });
231
- });
232
- };
233
- /**
234
- * Generate basic auth token from client_id and client_secret
235
- * @returns Base64 encoded basic auth token
236
- */
237
- OAuthApi.prototype.getBasicAuthToken = function () {
238
- var credentials = "".concat(this.clientId, ":").concat(this.clientSecret);
239
- return btoa(credentials);
240
- };
241
- return OAuthApi;
242
- }(runtime.BaseAPI));
243
- exports.OAuthApi = OAuthApi;
package/dist/runtime.d.ts DELETED
@@ -1,183 +0,0 @@
1
- /**
2
- * The Plane REST API
3
- * The Plane REST API Visit our quick start guide and full API documentation at [developers.plane.so](https://developers.plane.so/api-reference/introduction).
4
- *
5
- * The version of the API Spec: 0.0.1
6
- * Contact: support@plane.so
7
- *
8
- * NOTE: This class is auto generated.
9
- * Do not edit the class manually.
10
- */
11
- export declare const BASE_PATH: string;
12
- export interface ConfigurationParameters {
13
- basePath?: string;
14
- fetchApi?: FetchAPI;
15
- middleware?: Middleware[];
16
- queryParamsStringify?: (params: HTTPQuery) => string;
17
- username?: string;
18
- password?: string;
19
- apiKey?: string | Promise<string> | ((name: string) => string | Promise<string>);
20
- accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string | Promise<string>);
21
- headers?: HTTPHeaders;
22
- credentials?: RequestCredentials;
23
- }
24
- export declare class Configuration {
25
- private configuration;
26
- constructor(configuration?: ConfigurationParameters);
27
- set config(configuration: Configuration);
28
- get basePath(): string;
29
- get fetchApi(): FetchAPI | undefined;
30
- get middleware(): Middleware[];
31
- get queryParamsStringify(): (params: HTTPQuery) => string;
32
- get username(): string | undefined;
33
- get password(): string | undefined;
34
- get apiKey(): ((name: string) => string | Promise<string>) | undefined;
35
- get accessToken(): ((name?: string, scopes?: string[]) => string | Promise<string>) | undefined;
36
- get headers(): HTTPHeaders | undefined;
37
- get credentials(): RequestCredentials | undefined;
38
- }
39
- export declare const DefaultConfig: Configuration;
40
- /**
41
- * This is the base class for all generated API classes.
42
- */
43
- export declare class BaseAPI {
44
- protected configuration: Configuration;
45
- private static readonly jsonRegex;
46
- private middleware;
47
- constructor(configuration?: Configuration);
48
- withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]): T;
49
- withPreMiddleware<T extends BaseAPI>(this: T, ...preMiddlewares: Array<Middleware['pre']>): T;
50
- withPostMiddleware<T extends BaseAPI>(this: T, ...postMiddlewares: Array<Middleware['post']>): T;
51
- /**
52
- * Check if the given MIME is a JSON MIME.
53
- * JSON MIME examples:
54
- * application/json
55
- * application/json; charset=UTF8
56
- * APPLICATION/JSON
57
- * application/vnd.company+json
58
- * @param mime - MIME (Multipurpose Internet Mail Extensions)
59
- * @return True if the given MIME is JSON, false otherwise.
60
- */
61
- protected isJsonMime(mime: string | null | undefined): boolean;
62
- protected request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>;
63
- private createFetchParams;
64
- private fetchApi;
65
- /**
66
- * Create a shallow clone of `this` by constructing a new instance
67
- * and then shallow cloning data members.
68
- */
69
- private clone;
70
- }
71
- export declare class ResponseError extends Error {
72
- response: Response;
73
- name: "ResponseError";
74
- constructor(response: Response, msg?: string);
75
- }
76
- export declare class FetchError extends Error {
77
- cause: Error;
78
- name: "FetchError";
79
- constructor(cause: Error, msg?: string);
80
- }
81
- export declare class RequiredError extends Error {
82
- field: string;
83
- name: "RequiredError";
84
- constructor(field: string, msg?: string);
85
- }
86
- export declare const COLLECTION_FORMATS: {
87
- csv: string;
88
- ssv: string;
89
- tsv: string;
90
- pipes: string;
91
- };
92
- export type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
93
- export type Json = any;
94
- export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
95
- export type HTTPHeaders = {
96
- [key: string]: string;
97
- };
98
- export type HTTPQuery = {
99
- [key: string]: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery;
100
- };
101
- export type HTTPBody = Json | FormData | URLSearchParams;
102
- export type HTTPRequestInit = {
103
- headers?: HTTPHeaders;
104
- method: HTTPMethod;
105
- credentials?: RequestCredentials;
106
- body?: HTTPBody;
107
- };
108
- export type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
109
- export type InitOverrideFunction = (requestContext: {
110
- init: HTTPRequestInit;
111
- context: RequestOpts;
112
- }) => Promise<RequestInit>;
113
- export interface FetchParams {
114
- url: string;
115
- init: RequestInit;
116
- }
117
- export interface RequestOpts {
118
- path: string;
119
- method: HTTPMethod;
120
- headers: HTTPHeaders;
121
- query?: HTTPQuery;
122
- body?: HTTPBody;
123
- }
124
- export declare function querystring(params: HTTPQuery, prefix?: string): string;
125
- export declare function exists(json: any, key: string): boolean;
126
- export declare function mapValues(data: any, fn: (item: any) => any): {
127
- [key: string]: any;
128
- };
129
- export declare function canConsumeForm(consumes: Consume[]): boolean;
130
- export interface Consume {
131
- contentType: string;
132
- }
133
- export interface RequestContext {
134
- fetch: FetchAPI;
135
- url: string;
136
- init: RequestInit;
137
- }
138
- export interface ResponseContext {
139
- fetch: FetchAPI;
140
- url: string;
141
- init: RequestInit;
142
- response: Response;
143
- }
144
- export interface ErrorContext {
145
- fetch: FetchAPI;
146
- url: string;
147
- init: RequestInit;
148
- error: unknown;
149
- response?: Response;
150
- }
151
- export interface Middleware {
152
- pre?(context: RequestContext): Promise<FetchParams | void>;
153
- post?(context: ResponseContext): Promise<Response | void>;
154
- onError?(context: ErrorContext): Promise<Response | void>;
155
- }
156
- export interface ApiResponse<T> {
157
- raw: Response;
158
- value(): Promise<T>;
159
- }
160
- export interface ResponseTransformer<T> {
161
- (json: any): T;
162
- }
163
- export declare class JSONApiResponse<T> {
164
- raw: Response;
165
- private transformer;
166
- constructor(raw: Response, transformer?: ResponseTransformer<T>);
167
- value(): Promise<T>;
168
- }
169
- export declare class VoidApiResponse {
170
- raw: Response;
171
- constructor(raw: Response);
172
- value(): Promise<void>;
173
- }
174
- export declare class BlobApiResponse {
175
- raw: Response;
176
- constructor(raw: Response);
177
- value(): Promise<Blob>;
178
- }
179
- export declare class TextApiResponse {
180
- raw: Response;
181
- constructor(raw: Response);
182
- value(): Promise<string>;
183
- }