@markupai/api 0.0.6

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 (398) hide show
  1. package/Client.d.ts +40 -0
  2. package/Client.js +32 -0
  3. package/LICENSE +201 -0
  4. package/README.md +165 -0
  5. package/api/errors/ContentTooLargeError.d.ts +8 -0
  6. package/api/errors/ContentTooLargeError.js +52 -0
  7. package/api/errors/ForbiddenError.d.ts +9 -0
  8. package/api/errors/ForbiddenError.js +52 -0
  9. package/api/errors/InternalServerError.d.ts +9 -0
  10. package/api/errors/InternalServerError.js +52 -0
  11. package/api/errors/NotFoundError.d.ts +9 -0
  12. package/api/errors/NotFoundError.js +52 -0
  13. package/api/errors/UnprocessableEntityError.d.ts +8 -0
  14. package/api/errors/UnprocessableEntityError.js +52 -0
  15. package/api/errors/index.d.ts +5 -0
  16. package/api/errors/index.js +21 -0
  17. package/api/index.d.ts +3 -0
  18. package/api/index.js +19 -0
  19. package/api/resources/index.d.ts +8 -0
  20. package/api/resources/index.js +47 -0
  21. package/api/resources/styleChecks/client/Client.d.ts +70 -0
  22. package/api/resources/styleChecks/client/Client.js +215 -0
  23. package/api/resources/styleChecks/client/index.d.ts +1 -0
  24. package/api/resources/styleChecks/client/index.js +17 -0
  25. package/api/resources/styleChecks/client/requests/StyleChecksCreateStyleCheckRequest.d.ts +22 -0
  26. package/api/resources/styleChecks/client/requests/StyleChecksCreateStyleCheckRequest.js +5 -0
  27. package/api/resources/styleChecks/client/requests/index.d.ts +1 -0
  28. package/api/resources/styleChecks/client/requests/index.js +2 -0
  29. package/api/resources/styleChecks/index.d.ts +1 -0
  30. package/api/resources/styleChecks/index.js +17 -0
  31. package/api/resources/styleGuides/client/Client.d.ts +109 -0
  32. package/api/resources/styleGuides/client/Client.js +394 -0
  33. package/api/resources/styleGuides/client/index.d.ts +1 -0
  34. package/api/resources/styleGuides/client/index.js +17 -0
  35. package/api/resources/styleGuides/client/requests/BodyStyleGuidesUpdateStyleGuide.d.ts +13 -0
  36. package/api/resources/styleGuides/client/requests/BodyStyleGuidesUpdateStyleGuide.js +5 -0
  37. package/api/resources/styleGuides/client/requests/StyleGuideRequestBody.d.ts +11 -0
  38. package/api/resources/styleGuides/client/requests/StyleGuideRequestBody.js +5 -0
  39. package/api/resources/styleGuides/client/requests/index.d.ts +2 -0
  40. package/api/resources/styleGuides/client/requests/index.js +2 -0
  41. package/api/resources/styleGuides/index.d.ts +1 -0
  42. package/api/resources/styleGuides/index.js +17 -0
  43. package/api/resources/styleRewrites/client/Client.d.ts +70 -0
  44. package/api/resources/styleRewrites/client/Client.js +215 -0
  45. package/api/resources/styleRewrites/client/index.d.ts +1 -0
  46. package/api/resources/styleRewrites/client/index.js +17 -0
  47. package/api/resources/styleRewrites/client/requests/StyleRewritesCreateStyleRewriteRequest.d.ts +22 -0
  48. package/api/resources/styleRewrites/client/requests/StyleRewritesCreateStyleRewriteRequest.js +5 -0
  49. package/api/resources/styleRewrites/client/requests/index.d.ts +1 -0
  50. package/api/resources/styleRewrites/client/requests/index.js +2 -0
  51. package/api/resources/styleRewrites/index.d.ts +1 -0
  52. package/api/resources/styleRewrites/index.js +17 -0
  53. package/api/resources/styleSuggestions/client/Client.d.ts +70 -0
  54. package/api/resources/styleSuggestions/client/Client.js +215 -0
  55. package/api/resources/styleSuggestions/client/index.d.ts +1 -0
  56. package/api/resources/styleSuggestions/client/index.js +17 -0
  57. package/api/resources/styleSuggestions/client/requests/StyleSuggestionsCreateStyleSuggestionRequest.d.ts +22 -0
  58. package/api/resources/styleSuggestions/client/requests/StyleSuggestionsCreateStyleSuggestionRequest.js +5 -0
  59. package/api/resources/styleSuggestions/client/requests/index.d.ts +1 -0
  60. package/api/resources/styleSuggestions/client/requests/index.js +2 -0
  61. package/api/resources/styleSuggestions/index.d.ts +1 -0
  62. package/api/resources/styleSuggestions/index.js +17 -0
  63. package/api/types/CheckOptions.d.ts +9 -0
  64. package/api/types/CheckOptions.js +5 -0
  65. package/api/types/ClarityScore.d.ts +14 -0
  66. package/api/types/ClarityScore.js +5 -0
  67. package/api/types/Dialects.d.ts +9 -0
  68. package/api/types/Dialects.js +11 -0
  69. package/api/types/ErrorResponse.d.ts +11 -0
  70. package/api/types/ErrorResponse.js +5 -0
  71. package/api/types/GrammarCategory.d.ts +13 -0
  72. package/api/types/GrammarCategory.js +15 -0
  73. package/api/types/GrammarScore.d.ts +7 -0
  74. package/api/types/GrammarScore.js +5 -0
  75. package/api/types/Issue.d.ts +13 -0
  76. package/api/types/Issue.js +5 -0
  77. package/api/types/IssueCategory.d.ts +13 -0
  78. package/api/types/IssueCategory.js +15 -0
  79. package/api/types/QualityScore.d.ts +6 -0
  80. package/api/types/QualityScore.js +5 -0
  81. package/api/types/RewriteResponse.d.ts +15 -0
  82. package/api/types/RewriteResponse.js +5 -0
  83. package/api/types/ScoreOutput.d.ts +12 -0
  84. package/api/types/ScoreOutput.js +5 -0
  85. package/api/types/SentenceLengthCategory.d.ts +13 -0
  86. package/api/types/SentenceLengthCategory.js +15 -0
  87. package/api/types/SentenceStructureCategory.d.ts +14 -0
  88. package/api/types/SentenceStructureCategory.js +16 -0
  89. package/api/types/SimpleVocabCategory.d.ts +8 -0
  90. package/api/types/SimpleVocabCategory.js +10 -0
  91. package/api/types/StyleCheckResponse.d.ts +13 -0
  92. package/api/types/StyleCheckResponse.js +5 -0
  93. package/api/types/StyleGuide.d.ts +10 -0
  94. package/api/types/StyleGuide.js +5 -0
  95. package/api/types/StyleGuideCategory.d.ts +15 -0
  96. package/api/types/StyleGuideCategory.js +17 -0
  97. package/api/types/StyleGuideResponse.d.ts +19 -0
  98. package/api/types/StyleGuideResponse.js +5 -0
  99. package/api/types/StyleGuideScore.d.ts +7 -0
  100. package/api/types/StyleGuideScore.js +5 -0
  101. package/api/types/StyleGuideStatus.d.ts +10 -0
  102. package/api/types/StyleGuideStatus.js +12 -0
  103. package/api/types/StyleGuides.d.ts +11 -0
  104. package/api/types/StyleGuides.js +13 -0
  105. package/api/types/Subcategory.d.ts +8 -0
  106. package/api/types/Subcategory.js +5 -0
  107. package/api/types/Suggestion.d.ts +14 -0
  108. package/api/types/Suggestion.js +5 -0
  109. package/api/types/SuggestionResponse.d.ts +13 -0
  110. package/api/types/SuggestionResponse.js +5 -0
  111. package/api/types/TermReplaceCategory.d.ts +8 -0
  112. package/api/types/TermReplaceCategory.js +10 -0
  113. package/api/types/TerminologyScore.d.ts +7 -0
  114. package/api/types/TerminologyScore.js +5 -0
  115. package/api/types/ToneCategory.d.ts +12 -0
  116. package/api/types/ToneCategory.js +14 -0
  117. package/api/types/ToneScore.d.ts +12 -0
  118. package/api/types/ToneScore.js +5 -0
  119. package/api/types/Tones.d.ts +12 -0
  120. package/api/types/Tones.js +14 -0
  121. package/api/types/WebhookResponse.d.ts +7 -0
  122. package/api/types/WebhookResponse.js +5 -0
  123. package/api/types/WorkflowResponse.d.ts +8 -0
  124. package/api/types/WorkflowResponse.js +5 -0
  125. package/api/types/WorkflowStatus.d.ts +10 -0
  126. package/api/types/WorkflowStatus.js +12 -0
  127. package/api/types/index.d.ts +32 -0
  128. package/api/types/index.js +48 -0
  129. package/core/auth/BasicAuth.d.ts +8 -0
  130. package/core/auth/BasicAuth.js +26 -0
  131. package/core/auth/BearerToken.d.ts +5 -0
  132. package/core/auth/BearerToken.js +15 -0
  133. package/core/auth/index.d.ts +2 -0
  134. package/core/auth/index.js +7 -0
  135. package/core/fetcher/APIResponse.d.ts +20 -0
  136. package/core/fetcher/APIResponse.js +2 -0
  137. package/core/fetcher/Fetcher.d.ts +39 -0
  138. package/core/fetcher/Fetcher.js +107 -0
  139. package/core/fetcher/Headers.d.ts +2 -0
  140. package/core/fetcher/Headers.js +84 -0
  141. package/core/fetcher/HttpResponsePromise.d.ts +58 -0
  142. package/core/fetcher/HttpResponsePromise.js +103 -0
  143. package/core/fetcher/RawResponse.d.ts +29 -0
  144. package/core/fetcher/RawResponse.js +44 -0
  145. package/core/fetcher/Supplier.d.ts +4 -0
  146. package/core/fetcher/Supplier.js +22 -0
  147. package/core/fetcher/createRequestUrl.d.ts +1 -0
  148. package/core/fetcher/createRequestUrl.js +12 -0
  149. package/core/fetcher/getFetchFn.d.ts +4 -0
  150. package/core/fetcher/getFetchFn.js +68 -0
  151. package/core/fetcher/getHeader.d.ts +1 -0
  152. package/core/fetcher/getHeader.js +11 -0
  153. package/core/fetcher/getRequestBody.d.ts +7 -0
  154. package/core/fetcher/getRequestBody.js +23 -0
  155. package/core/fetcher/getResponseBody.d.ts +1 -0
  156. package/core/fetcher/getResponseBody.js +54 -0
  157. package/core/fetcher/index.d.ts +8 -0
  158. package/core/fetcher/index.js +15 -0
  159. package/core/fetcher/makeRequest.d.ts +1 -0
  160. package/core/fetcher/makeRequest.js +42 -0
  161. package/core/fetcher/requestWithRetries.d.ts +1 -0
  162. package/core/fetcher/requestWithRetries.js +40 -0
  163. package/core/fetcher/signals.d.ts +11 -0
  164. package/core/fetcher/signals.js +36 -0
  165. package/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.d.ts +30 -0
  166. package/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.js +247 -0
  167. package/core/fetcher/stream-wrappers/NodePre18StreamWrapper.d.ts +21 -0
  168. package/core/fetcher/stream-wrappers/NodePre18StreamWrapper.js +126 -0
  169. package/core/fetcher/stream-wrappers/UndiciStreamWrapper.d.ts +31 -0
  170. package/core/fetcher/stream-wrappers/UndiciStreamWrapper.js +229 -0
  171. package/core/fetcher/stream-wrappers/chooseStreamWrapper.d.ts +18 -0
  172. package/core/fetcher/stream-wrappers/chooseStreamWrapper.js +59 -0
  173. package/core/form-data-utils/FormDataWrapper.d.ts +63 -0
  174. package/core/form-data-utils/FormDataWrapper.js +227 -0
  175. package/core/form-data-utils/encodeAsFormParameter.d.ts +4 -0
  176. package/core/form-data-utils/encodeAsFormParameter.js +18 -0
  177. package/core/form-data-utils/index.d.ts +2 -0
  178. package/core/form-data-utils/index.js +20 -0
  179. package/core/index.d.ts +4 -0
  180. package/core/index.js +20 -0
  181. package/core/json.d.ts +15 -0
  182. package/core/json.js +24 -0
  183. package/core/runtime/index.d.ts +1 -0
  184. package/core/runtime/index.js +5 -0
  185. package/core/runtime/runtime.d.ts +9 -0
  186. package/core/runtime/runtime.js +103 -0
  187. package/dist/Client.d.ts +40 -0
  188. package/dist/Client.js +32 -0
  189. package/dist/api/errors/ContentTooLargeError.d.ts +8 -0
  190. package/dist/api/errors/ContentTooLargeError.js +52 -0
  191. package/dist/api/errors/ForbiddenError.d.ts +9 -0
  192. package/dist/api/errors/ForbiddenError.js +52 -0
  193. package/dist/api/errors/InternalServerError.d.ts +9 -0
  194. package/dist/api/errors/InternalServerError.js +52 -0
  195. package/dist/api/errors/NotFoundError.d.ts +9 -0
  196. package/dist/api/errors/NotFoundError.js +52 -0
  197. package/dist/api/errors/UnprocessableEntityError.d.ts +8 -0
  198. package/dist/api/errors/UnprocessableEntityError.js +52 -0
  199. package/dist/api/errors/index.d.ts +5 -0
  200. package/dist/api/errors/index.js +21 -0
  201. package/dist/api/index.d.ts +3 -0
  202. package/dist/api/index.js +19 -0
  203. package/dist/api/resources/index.d.ts +8 -0
  204. package/dist/api/resources/index.js +47 -0
  205. package/dist/api/resources/styleChecks/client/Client.d.ts +70 -0
  206. package/dist/api/resources/styleChecks/client/Client.js +215 -0
  207. package/dist/api/resources/styleChecks/client/index.d.ts +1 -0
  208. package/dist/api/resources/styleChecks/client/index.js +17 -0
  209. package/dist/api/resources/styleChecks/client/requests/StyleChecksCreateStyleCheckRequest.d.ts +22 -0
  210. package/dist/api/resources/styleChecks/client/requests/StyleChecksCreateStyleCheckRequest.js +5 -0
  211. package/dist/api/resources/styleChecks/client/requests/index.d.ts +1 -0
  212. package/dist/api/resources/styleChecks/client/requests/index.js +2 -0
  213. package/dist/api/resources/styleChecks/index.d.ts +1 -0
  214. package/dist/api/resources/styleChecks/index.js +17 -0
  215. package/dist/api/resources/styleGuides/client/Client.d.ts +109 -0
  216. package/dist/api/resources/styleGuides/client/Client.js +394 -0
  217. package/dist/api/resources/styleGuides/client/index.d.ts +1 -0
  218. package/dist/api/resources/styleGuides/client/index.js +17 -0
  219. package/dist/api/resources/styleGuides/client/requests/BodyStyleGuidesUpdateStyleGuide.d.ts +13 -0
  220. package/dist/api/resources/styleGuides/client/requests/BodyStyleGuidesUpdateStyleGuide.js +5 -0
  221. package/dist/api/resources/styleGuides/client/requests/StyleGuideRequestBody.d.ts +11 -0
  222. package/dist/api/resources/styleGuides/client/requests/StyleGuideRequestBody.js +5 -0
  223. package/dist/api/resources/styleGuides/client/requests/index.d.ts +2 -0
  224. package/dist/api/resources/styleGuides/client/requests/index.js +2 -0
  225. package/dist/api/resources/styleGuides/index.d.ts +1 -0
  226. package/dist/api/resources/styleGuides/index.js +17 -0
  227. package/dist/api/resources/styleRewrites/client/Client.d.ts +70 -0
  228. package/dist/api/resources/styleRewrites/client/Client.js +215 -0
  229. package/dist/api/resources/styleRewrites/client/index.d.ts +1 -0
  230. package/dist/api/resources/styleRewrites/client/index.js +17 -0
  231. package/dist/api/resources/styleRewrites/client/requests/StyleRewritesCreateStyleRewriteRequest.d.ts +22 -0
  232. package/dist/api/resources/styleRewrites/client/requests/StyleRewritesCreateStyleRewriteRequest.js +5 -0
  233. package/dist/api/resources/styleRewrites/client/requests/index.d.ts +1 -0
  234. package/dist/api/resources/styleRewrites/client/requests/index.js +2 -0
  235. package/dist/api/resources/styleRewrites/index.d.ts +1 -0
  236. package/dist/api/resources/styleRewrites/index.js +17 -0
  237. package/dist/api/resources/styleSuggestions/client/Client.d.ts +70 -0
  238. package/dist/api/resources/styleSuggestions/client/Client.js +215 -0
  239. package/dist/api/resources/styleSuggestions/client/index.d.ts +1 -0
  240. package/dist/api/resources/styleSuggestions/client/index.js +17 -0
  241. package/dist/api/resources/styleSuggestions/client/requests/StyleSuggestionsCreateStyleSuggestionRequest.d.ts +22 -0
  242. package/dist/api/resources/styleSuggestions/client/requests/StyleSuggestionsCreateStyleSuggestionRequest.js +5 -0
  243. package/dist/api/resources/styleSuggestions/client/requests/index.d.ts +1 -0
  244. package/dist/api/resources/styleSuggestions/client/requests/index.js +2 -0
  245. package/dist/api/resources/styleSuggestions/index.d.ts +1 -0
  246. package/dist/api/resources/styleSuggestions/index.js +17 -0
  247. package/dist/api/types/CheckOptions.d.ts +9 -0
  248. package/dist/api/types/CheckOptions.js +5 -0
  249. package/dist/api/types/ClarityScore.d.ts +14 -0
  250. package/dist/api/types/ClarityScore.js +5 -0
  251. package/dist/api/types/Dialects.d.ts +9 -0
  252. package/dist/api/types/Dialects.js +11 -0
  253. package/dist/api/types/ErrorResponse.d.ts +11 -0
  254. package/dist/api/types/ErrorResponse.js +5 -0
  255. package/dist/api/types/GrammarCategory.d.ts +13 -0
  256. package/dist/api/types/GrammarCategory.js +15 -0
  257. package/dist/api/types/GrammarScore.d.ts +7 -0
  258. package/dist/api/types/GrammarScore.js +5 -0
  259. package/dist/api/types/Issue.d.ts +13 -0
  260. package/dist/api/types/Issue.js +5 -0
  261. package/dist/api/types/IssueCategory.d.ts +13 -0
  262. package/dist/api/types/IssueCategory.js +15 -0
  263. package/dist/api/types/QualityScore.d.ts +6 -0
  264. package/dist/api/types/QualityScore.js +5 -0
  265. package/dist/api/types/RewriteResponse.d.ts +15 -0
  266. package/dist/api/types/RewriteResponse.js +5 -0
  267. package/dist/api/types/ScoreOutput.d.ts +12 -0
  268. package/dist/api/types/ScoreOutput.js +5 -0
  269. package/dist/api/types/SentenceLengthCategory.d.ts +13 -0
  270. package/dist/api/types/SentenceLengthCategory.js +15 -0
  271. package/dist/api/types/SentenceStructureCategory.d.ts +14 -0
  272. package/dist/api/types/SentenceStructureCategory.js +16 -0
  273. package/dist/api/types/SimpleVocabCategory.d.ts +8 -0
  274. package/dist/api/types/SimpleVocabCategory.js +10 -0
  275. package/dist/api/types/StyleCheckResponse.d.ts +13 -0
  276. package/dist/api/types/StyleCheckResponse.js +5 -0
  277. package/dist/api/types/StyleGuide.d.ts +10 -0
  278. package/dist/api/types/StyleGuide.js +5 -0
  279. package/dist/api/types/StyleGuideCategory.d.ts +15 -0
  280. package/dist/api/types/StyleGuideCategory.js +17 -0
  281. package/dist/api/types/StyleGuideResponse.d.ts +19 -0
  282. package/dist/api/types/StyleGuideResponse.js +5 -0
  283. package/dist/api/types/StyleGuideScore.d.ts +7 -0
  284. package/dist/api/types/StyleGuideScore.js +5 -0
  285. package/dist/api/types/StyleGuideStatus.d.ts +10 -0
  286. package/dist/api/types/StyleGuideStatus.js +12 -0
  287. package/dist/api/types/StyleGuides.d.ts +11 -0
  288. package/dist/api/types/StyleGuides.js +13 -0
  289. package/dist/api/types/Subcategory.d.ts +8 -0
  290. package/dist/api/types/Subcategory.js +5 -0
  291. package/dist/api/types/Suggestion.d.ts +14 -0
  292. package/dist/api/types/Suggestion.js +5 -0
  293. package/dist/api/types/SuggestionResponse.d.ts +13 -0
  294. package/dist/api/types/SuggestionResponse.js +5 -0
  295. package/dist/api/types/TermReplaceCategory.d.ts +8 -0
  296. package/dist/api/types/TermReplaceCategory.js +10 -0
  297. package/dist/api/types/TerminologyScore.d.ts +7 -0
  298. package/dist/api/types/TerminologyScore.js +5 -0
  299. package/dist/api/types/ToneCategory.d.ts +12 -0
  300. package/dist/api/types/ToneCategory.js +14 -0
  301. package/dist/api/types/ToneScore.d.ts +12 -0
  302. package/dist/api/types/ToneScore.js +5 -0
  303. package/dist/api/types/Tones.d.ts +12 -0
  304. package/dist/api/types/Tones.js +14 -0
  305. package/dist/api/types/WebhookResponse.d.ts +7 -0
  306. package/dist/api/types/WebhookResponse.js +5 -0
  307. package/dist/api/types/WorkflowResponse.d.ts +8 -0
  308. package/dist/api/types/WorkflowResponse.js +5 -0
  309. package/dist/api/types/WorkflowStatus.d.ts +10 -0
  310. package/dist/api/types/WorkflowStatus.js +12 -0
  311. package/dist/api/types/index.d.ts +32 -0
  312. package/dist/api/types/index.js +48 -0
  313. package/dist/core/auth/BasicAuth.d.ts +8 -0
  314. package/dist/core/auth/BasicAuth.js +26 -0
  315. package/dist/core/auth/BearerToken.d.ts +5 -0
  316. package/dist/core/auth/BearerToken.js +15 -0
  317. package/dist/core/auth/index.d.ts +2 -0
  318. package/dist/core/auth/index.js +7 -0
  319. package/dist/core/fetcher/APIResponse.d.ts +20 -0
  320. package/dist/core/fetcher/APIResponse.js +2 -0
  321. package/dist/core/fetcher/Fetcher.d.ts +39 -0
  322. package/dist/core/fetcher/Fetcher.js +107 -0
  323. package/dist/core/fetcher/Headers.d.ts +2 -0
  324. package/dist/core/fetcher/Headers.js +84 -0
  325. package/dist/core/fetcher/HttpResponsePromise.d.ts +58 -0
  326. package/dist/core/fetcher/HttpResponsePromise.js +103 -0
  327. package/dist/core/fetcher/RawResponse.d.ts +29 -0
  328. package/dist/core/fetcher/RawResponse.js +44 -0
  329. package/dist/core/fetcher/Supplier.d.ts +4 -0
  330. package/dist/core/fetcher/Supplier.js +22 -0
  331. package/dist/core/fetcher/createRequestUrl.d.ts +1 -0
  332. package/dist/core/fetcher/createRequestUrl.js +12 -0
  333. package/dist/core/fetcher/getFetchFn.d.ts +4 -0
  334. package/dist/core/fetcher/getFetchFn.js +68 -0
  335. package/dist/core/fetcher/getHeader.d.ts +1 -0
  336. package/dist/core/fetcher/getHeader.js +11 -0
  337. package/dist/core/fetcher/getRequestBody.d.ts +7 -0
  338. package/dist/core/fetcher/getRequestBody.js +23 -0
  339. package/dist/core/fetcher/getResponseBody.d.ts +1 -0
  340. package/dist/core/fetcher/getResponseBody.js +54 -0
  341. package/dist/core/fetcher/index.d.ts +8 -0
  342. package/dist/core/fetcher/index.js +15 -0
  343. package/dist/core/fetcher/makeRequest.d.ts +1 -0
  344. package/dist/core/fetcher/makeRequest.js +42 -0
  345. package/dist/core/fetcher/requestWithRetries.d.ts +1 -0
  346. package/dist/core/fetcher/requestWithRetries.js +40 -0
  347. package/dist/core/fetcher/signals.d.ts +11 -0
  348. package/dist/core/fetcher/signals.js +36 -0
  349. package/dist/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.d.ts +30 -0
  350. package/dist/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.js +247 -0
  351. package/dist/core/fetcher/stream-wrappers/NodePre18StreamWrapper.d.ts +21 -0
  352. package/dist/core/fetcher/stream-wrappers/NodePre18StreamWrapper.js +126 -0
  353. package/dist/core/fetcher/stream-wrappers/UndiciStreamWrapper.d.ts +31 -0
  354. package/dist/core/fetcher/stream-wrappers/UndiciStreamWrapper.js +229 -0
  355. package/dist/core/fetcher/stream-wrappers/chooseStreamWrapper.d.ts +18 -0
  356. package/dist/core/fetcher/stream-wrappers/chooseStreamWrapper.js +59 -0
  357. package/dist/core/form-data-utils/FormDataWrapper.d.ts +63 -0
  358. package/dist/core/form-data-utils/FormDataWrapper.js +227 -0
  359. package/dist/core/form-data-utils/encodeAsFormParameter.d.ts +4 -0
  360. package/dist/core/form-data-utils/encodeAsFormParameter.js +18 -0
  361. package/dist/core/form-data-utils/index.d.ts +2 -0
  362. package/dist/core/form-data-utils/index.js +20 -0
  363. package/dist/core/index.d.ts +4 -0
  364. package/dist/core/index.js +20 -0
  365. package/dist/core/json.d.ts +15 -0
  366. package/dist/core/json.js +24 -0
  367. package/dist/core/runtime/index.d.ts +1 -0
  368. package/dist/core/runtime/index.js +5 -0
  369. package/dist/core/runtime/runtime.d.ts +9 -0
  370. package/dist/core/runtime/runtime.js +103 -0
  371. package/dist/environments.d.ts +7 -0
  372. package/dist/environments.js +9 -0
  373. package/dist/errors/MarkupAIError.d.ts +15 -0
  374. package/dist/errors/MarkupAIError.js +30 -0
  375. package/dist/errors/MarkupAITimeoutError.d.ts +6 -0
  376. package/dist/errors/MarkupAITimeoutError.js +13 -0
  377. package/dist/errors/index.d.ts +2 -0
  378. package/dist/errors/index.js +7 -0
  379. package/dist/index.d.ts +4 -0
  380. package/dist/index.js +44 -0
  381. package/dist/version.d.ts +1 -0
  382. package/dist/version.js +4 -0
  383. package/environments.d.ts +7 -0
  384. package/environments.js +9 -0
  385. package/errors/MarkupAIError.d.ts +15 -0
  386. package/errors/MarkupAIError.js +30 -0
  387. package/errors/MarkupAITimeoutError.d.ts +6 -0
  388. package/errors/MarkupAITimeoutError.js +13 -0
  389. package/errors/index.d.ts +2 -0
  390. package/errors/index.js +7 -0
  391. package/index.d.ts +4 -0
  392. package/index.js +44 -0
  393. package/jest.config.mjs +8 -0
  394. package/package.json +46 -0
  395. package/reference.md +748 -0
  396. package/scripts/rename-to-esm-files.js +115 -0
  397. package/version.d.ts +1 -0
  398. package/version.js +4 -0
package/reference.md ADDED
@@ -0,0 +1,748 @@
1
+ # Reference
2
+
3
+ ## Style Guides
4
+
5
+ <details><summary><code>client.styleGuides.<a href="/src/api/resources/styleGuides/client/Client.ts">listStyleGuides</a>() -> MarkupAI.StyleGuideResponse[]</code></summary>
6
+ <dl>
7
+ <dd>
8
+
9
+ #### 📝 Description
10
+
11
+ <dl>
12
+ <dd>
13
+
14
+ <dl>
15
+ <dd>
16
+
17
+ Retrieve all style guides associated with your organization.
18
+
19
+ </dd>
20
+ </dl>
21
+ </dd>
22
+ </dl>
23
+
24
+ #### 🔌 Usage
25
+
26
+ <dl>
27
+ <dd>
28
+
29
+ <dl>
30
+ <dd>
31
+
32
+ ```typescript
33
+ await client.styleGuides.listStyleGuides();
34
+ ```
35
+
36
+ </dd>
37
+ </dl>
38
+ </dd>
39
+ </dl>
40
+
41
+ #### ⚙️ Parameters
42
+
43
+ <dl>
44
+ <dd>
45
+
46
+ <dl>
47
+ <dd>
48
+
49
+ **requestOptions:** `StyleGuides.RequestOptions`
50
+
51
+ </dd>
52
+ </dl>
53
+ </dd>
54
+ </dl>
55
+
56
+ </dd>
57
+ </dl>
58
+ </details>
59
+
60
+ <details><summary><code>client.styleGuides.<a href="/src/api/resources/styleGuides/client/Client.ts">createStyleGuide</a>(file_upload, { ...params }) -> MarkupAI.StyleGuideResponse</code></summary>
61
+ <dl>
62
+ <dd>
63
+
64
+ #### 📝 Description
65
+
66
+ <dl>
67
+ <dd>
68
+
69
+ <dl>
70
+ <dd>
71
+
72
+ Create a new style guide that can be used in checks, suggestions, and rewrites.
73
+
74
+ </dd>
75
+ </dl>
76
+ </dd>
77
+ </dl>
78
+
79
+ #### 🔌 Usage
80
+
81
+ <dl>
82
+ <dd>
83
+
84
+ <dl>
85
+ <dd>
86
+
87
+ ```typescript
88
+ await client.styleGuides.createStyleGuide(fs.createReadStream("/path/to/your/file"), {});
89
+ ```
90
+
91
+ </dd>
92
+ </dl>
93
+ </dd>
94
+ </dl>
95
+
96
+ #### ⚙️ Parameters
97
+
98
+ <dl>
99
+ <dd>
100
+
101
+ <dl>
102
+ <dd>
103
+
104
+ **file_upload:** `File | fs.ReadStream | Blob`
105
+
106
+ </dd>
107
+ </dl>
108
+
109
+ <dl>
110
+ <dd>
111
+
112
+ **request:** `MarkupAI.StyleGuideRequestBody`
113
+
114
+ </dd>
115
+ </dl>
116
+
117
+ <dl>
118
+ <dd>
119
+
120
+ **requestOptions:** `StyleGuides.RequestOptions`
121
+
122
+ </dd>
123
+ </dl>
124
+ </dd>
125
+ </dl>
126
+
127
+ </dd>
128
+ </dl>
129
+ </details>
130
+
131
+ <details><summary><code>client.styleGuides.<a href="/src/api/resources/styleGuides/client/Client.ts">getStyleGuide</a>(styleGuideId) -> MarkupAI.StyleGuideResponse</code></summary>
132
+ <dl>
133
+ <dd>
134
+
135
+ #### 📝 Description
136
+
137
+ <dl>
138
+ <dd>
139
+
140
+ <dl>
141
+ <dd>
142
+
143
+ Retrieve a specific style guide by ID, including its metadata such as `name` and `status`.
144
+
145
+ </dd>
146
+ </dl>
147
+ </dd>
148
+ </dl>
149
+
150
+ #### 🔌 Usage
151
+
152
+ <dl>
153
+ <dd>
154
+
155
+ <dl>
156
+ <dd>
157
+
158
+ ```typescript
159
+ await client.styleGuides.getStyleGuide("style_guide_id");
160
+ ```
161
+
162
+ </dd>
163
+ </dl>
164
+ </dd>
165
+ </dl>
166
+
167
+ #### ⚙️ Parameters
168
+
169
+ <dl>
170
+ <dd>
171
+
172
+ <dl>
173
+ <dd>
174
+
175
+ **styleGuideId:** `string` — The ID of the style guide.
176
+
177
+ </dd>
178
+ </dl>
179
+
180
+ <dl>
181
+ <dd>
182
+
183
+ **requestOptions:** `StyleGuides.RequestOptions`
184
+
185
+ </dd>
186
+ </dl>
187
+ </dd>
188
+ </dl>
189
+
190
+ </dd>
191
+ </dl>
192
+ </details>
193
+
194
+ <details><summary><code>client.styleGuides.<a href="/src/api/resources/styleGuides/client/Client.ts">deleteStyleGuide</a>(styleGuideId) -> void</code></summary>
195
+ <dl>
196
+ <dd>
197
+
198
+ #### 📝 Description
199
+
200
+ <dl>
201
+ <dd>
202
+
203
+ <dl>
204
+ <dd>
205
+
206
+ Delete a style guide by ID.
207
+
208
+ </dd>
209
+ </dl>
210
+ </dd>
211
+ </dl>
212
+
213
+ #### 🔌 Usage
214
+
215
+ <dl>
216
+ <dd>
217
+
218
+ <dl>
219
+ <dd>
220
+
221
+ ```typescript
222
+ await client.styleGuides.deleteStyleGuide("style_guide_id");
223
+ ```
224
+
225
+ </dd>
226
+ </dl>
227
+ </dd>
228
+ </dl>
229
+
230
+ #### ⚙️ Parameters
231
+
232
+ <dl>
233
+ <dd>
234
+
235
+ <dl>
236
+ <dd>
237
+
238
+ **styleGuideId:** `string` — The ID of the style guide.
239
+
240
+ </dd>
241
+ </dl>
242
+
243
+ <dl>
244
+ <dd>
245
+
246
+ **requestOptions:** `StyleGuides.RequestOptions`
247
+
248
+ </dd>
249
+ </dl>
250
+ </dd>
251
+ </dl>
252
+
253
+ </dd>
254
+ </dl>
255
+ </details>
256
+
257
+ <details><summary><code>client.styleGuides.<a href="/src/api/resources/styleGuides/client/Client.ts">updateStyleGuide</a>(styleGuideId, { ...params }) -> MarkupAI.StyleGuideResponse</code></summary>
258
+ <dl>
259
+ <dd>
260
+
261
+ #### 📝 Description
262
+
263
+ <dl>
264
+ <dd>
265
+
266
+ <dl>
267
+ <dd>
268
+
269
+ Update the name of an existing style guide.
270
+
271
+ </dd>
272
+ </dl>
273
+ </dd>
274
+ </dl>
275
+
276
+ #### 🔌 Usage
277
+
278
+ <dl>
279
+ <dd>
280
+
281
+ <dl>
282
+ <dd>
283
+
284
+ ```typescript
285
+ await client.styleGuides.updateStyleGuide("style_guide_id", {
286
+ name: "name",
287
+ });
288
+ ```
289
+
290
+ </dd>
291
+ </dl>
292
+ </dd>
293
+ </dl>
294
+
295
+ #### ⚙️ Parameters
296
+
297
+ <dl>
298
+ <dd>
299
+
300
+ <dl>
301
+ <dd>
302
+
303
+ **styleGuideId:** `string` — The ID of the style guide.
304
+
305
+ </dd>
306
+ </dl>
307
+
308
+ <dl>
309
+ <dd>
310
+
311
+ **request:** `MarkupAI.BodyStyleGuidesUpdateStyleGuide`
312
+
313
+ </dd>
314
+ </dl>
315
+
316
+ <dl>
317
+ <dd>
318
+
319
+ **requestOptions:** `StyleGuides.RequestOptions`
320
+
321
+ </dd>
322
+ </dl>
323
+ </dd>
324
+ </dl>
325
+
326
+ </dd>
327
+ </dl>
328
+ </details>
329
+
330
+ ## Style Checks
331
+
332
+ <details><summary><code>client.styleChecks.<a href="/src/api/resources/styleChecks/client/Client.ts">createStyleCheck</a>(file_upload, { ...params }) -> MarkupAI.WorkflowResponse</code></summary>
333
+ <dl>
334
+ <dd>
335
+
336
+ #### 📝 Description
337
+
338
+ <dl>
339
+ <dd>
340
+
341
+ <dl>
342
+ <dd>
343
+
344
+ Start a style and brand check workflow. Returns a workflow ID to use for polling results.
345
+
346
+ </dd>
347
+ </dl>
348
+ </dd>
349
+ </dl>
350
+
351
+ #### 🔌 Usage
352
+
353
+ <dl>
354
+ <dd>
355
+
356
+ <dl>
357
+ <dd>
358
+
359
+ ```typescript
360
+ await client.styleChecks.createStyleCheck(fs.createReadStream("/path/to/your/file"), {
361
+ dialect: "american_english",
362
+ tone: "academic",
363
+ style_guide: "style_guide",
364
+ });
365
+ ```
366
+
367
+ </dd>
368
+ </dl>
369
+ </dd>
370
+ </dl>
371
+
372
+ #### ⚙️ Parameters
373
+
374
+ <dl>
375
+ <dd>
376
+
377
+ <dl>
378
+ <dd>
379
+
380
+ **file_upload:** `File | fs.ReadStream | Blob`
381
+
382
+ </dd>
383
+ </dl>
384
+
385
+ <dl>
386
+ <dd>
387
+
388
+ **request:** `MarkupAI.StyleChecksCreateStyleCheckRequest`
389
+
390
+ </dd>
391
+ </dl>
392
+
393
+ <dl>
394
+ <dd>
395
+
396
+ **requestOptions:** `StyleChecks.RequestOptions`
397
+
398
+ </dd>
399
+ </dl>
400
+ </dd>
401
+ </dl>
402
+
403
+ </dd>
404
+ </dl>
405
+ </details>
406
+
407
+ <details><summary><code>client.styleChecks.<a href="/src/api/resources/styleChecks/client/Client.ts">getStyleCheck</a>(workflowId) -> MarkupAI.StyleCheckResponse</code></summary>
408
+ <dl>
409
+ <dd>
410
+
411
+ #### 📝 Description
412
+
413
+ <dl>
414
+ <dd>
415
+
416
+ <dl>
417
+ <dd>
418
+
419
+ Retrieve the results of a style and brand check workflow. Returns `running` or `complete` status.
420
+
421
+ </dd>
422
+ </dl>
423
+ </dd>
424
+ </dl>
425
+
426
+ #### 🔌 Usage
427
+
428
+ <dl>
429
+ <dd>
430
+
431
+ <dl>
432
+ <dd>
433
+
434
+ ```typescript
435
+ await client.styleChecks.getStyleCheck("workflow_id");
436
+ ```
437
+
438
+ </dd>
439
+ </dl>
440
+ </dd>
441
+ </dl>
442
+
443
+ #### ⚙️ Parameters
444
+
445
+ <dl>
446
+ <dd>
447
+
448
+ <dl>
449
+ <dd>
450
+
451
+ **workflowId:** `string`
452
+
453
+ </dd>
454
+ </dl>
455
+
456
+ <dl>
457
+ <dd>
458
+
459
+ **requestOptions:** `StyleChecks.RequestOptions`
460
+
461
+ </dd>
462
+ </dl>
463
+ </dd>
464
+ </dl>
465
+
466
+ </dd>
467
+ </dl>
468
+ </details>
469
+
470
+ ## Style Suggestions
471
+
472
+ <details><summary><code>client.styleSuggestions.<a href="/src/api/resources/styleSuggestions/client/Client.ts">createStyleSuggestion</a>(file_upload, { ...params }) -> MarkupAI.WorkflowResponse</code></summary>
473
+ <dl>
474
+ <dd>
475
+
476
+ #### 📝 Description
477
+
478
+ <dl>
479
+ <dd>
480
+
481
+ <dl>
482
+ <dd>
483
+
484
+ Start a style and brand suggestion workflow. Returns a workflow ID to use for polling results.
485
+
486
+ </dd>
487
+ </dl>
488
+ </dd>
489
+ </dl>
490
+
491
+ #### 🔌 Usage
492
+
493
+ <dl>
494
+ <dd>
495
+
496
+ <dl>
497
+ <dd>
498
+
499
+ ```typescript
500
+ await client.styleSuggestions.createStyleSuggestion(fs.createReadStream("/path/to/your/file"), {
501
+ dialect: "american_english",
502
+ tone: "academic",
503
+ style_guide: "style_guide",
504
+ });
505
+ ```
506
+
507
+ </dd>
508
+ </dl>
509
+ </dd>
510
+ </dl>
511
+
512
+ #### ⚙️ Parameters
513
+
514
+ <dl>
515
+ <dd>
516
+
517
+ <dl>
518
+ <dd>
519
+
520
+ **file_upload:** `File | fs.ReadStream | Blob`
521
+
522
+ </dd>
523
+ </dl>
524
+
525
+ <dl>
526
+ <dd>
527
+
528
+ **request:** `MarkupAI.StyleSuggestionsCreateStyleSuggestionRequest`
529
+
530
+ </dd>
531
+ </dl>
532
+
533
+ <dl>
534
+ <dd>
535
+
536
+ **requestOptions:** `StyleSuggestions.RequestOptions`
537
+
538
+ </dd>
539
+ </dl>
540
+ </dd>
541
+ </dl>
542
+
543
+ </dd>
544
+ </dl>
545
+ </details>
546
+
547
+ <details><summary><code>client.styleSuggestions.<a href="/src/api/resources/styleSuggestions/client/Client.ts">getStyleSuggestion</a>(workflowId) -> MarkupAI.SuggestionResponse</code></summary>
548
+ <dl>
549
+ <dd>
550
+
551
+ #### 📝 Description
552
+
553
+ <dl>
554
+ <dd>
555
+
556
+ <dl>
557
+ <dd>
558
+
559
+ Retrieve the results of a style and brand suggestion workflow. Returns `running` or `complete` status.
560
+
561
+ </dd>
562
+ </dl>
563
+ </dd>
564
+ </dl>
565
+
566
+ #### 🔌 Usage
567
+
568
+ <dl>
569
+ <dd>
570
+
571
+ <dl>
572
+ <dd>
573
+
574
+ ```typescript
575
+ await client.styleSuggestions.getStyleSuggestion("workflow_id");
576
+ ```
577
+
578
+ </dd>
579
+ </dl>
580
+ </dd>
581
+ </dl>
582
+
583
+ #### ⚙️ Parameters
584
+
585
+ <dl>
586
+ <dd>
587
+
588
+ <dl>
589
+ <dd>
590
+
591
+ **workflowId:** `string`
592
+
593
+ </dd>
594
+ </dl>
595
+
596
+ <dl>
597
+ <dd>
598
+
599
+ **requestOptions:** `StyleSuggestions.RequestOptions`
600
+
601
+ </dd>
602
+ </dl>
603
+ </dd>
604
+ </dl>
605
+
606
+ </dd>
607
+ </dl>
608
+ </details>
609
+
610
+ ## Style Rewrites
611
+
612
+ <details><summary><code>client.styleRewrites.<a href="/src/api/resources/styleRewrites/client/Client.ts">createStyleRewrite</a>(file_upload, { ...params }) -> MarkupAI.WorkflowResponse</code></summary>
613
+ <dl>
614
+ <dd>
615
+
616
+ #### 📝 Description
617
+
618
+ <dl>
619
+ <dd>
620
+
621
+ <dl>
622
+ <dd>
623
+
624
+ Start a style and brand rewrite workflow. Returns a workflow ID to use for polling results.
625
+
626
+ </dd>
627
+ </dl>
628
+ </dd>
629
+ </dl>
630
+
631
+ #### 🔌 Usage
632
+
633
+ <dl>
634
+ <dd>
635
+
636
+ <dl>
637
+ <dd>
638
+
639
+ ```typescript
640
+ await client.styleRewrites.createStyleRewrite(fs.createReadStream("/path/to/your/file"), {
641
+ dialect: "american_english",
642
+ tone: "academic",
643
+ style_guide: "style_guide",
644
+ });
645
+ ```
646
+
647
+ </dd>
648
+ </dl>
649
+ </dd>
650
+ </dl>
651
+
652
+ #### ⚙️ Parameters
653
+
654
+ <dl>
655
+ <dd>
656
+
657
+ <dl>
658
+ <dd>
659
+
660
+ **file_upload:** `File | fs.ReadStream | Blob`
661
+
662
+ </dd>
663
+ </dl>
664
+
665
+ <dl>
666
+ <dd>
667
+
668
+ **request:** `MarkupAI.StyleRewritesCreateStyleRewriteRequest`
669
+
670
+ </dd>
671
+ </dl>
672
+
673
+ <dl>
674
+ <dd>
675
+
676
+ **requestOptions:** `StyleRewrites.RequestOptions`
677
+
678
+ </dd>
679
+ </dl>
680
+ </dd>
681
+ </dl>
682
+
683
+ </dd>
684
+ </dl>
685
+ </details>
686
+
687
+ <details><summary><code>client.styleRewrites.<a href="/src/api/resources/styleRewrites/client/Client.ts">getStyleRewrite</a>(workflowId) -> MarkupAI.RewriteResponse</code></summary>
688
+ <dl>
689
+ <dd>
690
+
691
+ #### 📝 Description
692
+
693
+ <dl>
694
+ <dd>
695
+
696
+ <dl>
697
+ <dd>
698
+
699
+ Retrieve the results of a rewrite workflow. Returns `running` or `complete` status.
700
+
701
+ </dd>
702
+ </dl>
703
+ </dd>
704
+ </dl>
705
+
706
+ #### 🔌 Usage
707
+
708
+ <dl>
709
+ <dd>
710
+
711
+ <dl>
712
+ <dd>
713
+
714
+ ```typescript
715
+ await client.styleRewrites.getStyleRewrite("workflow_id");
716
+ ```
717
+
718
+ </dd>
719
+ </dl>
720
+ </dd>
721
+ </dl>
722
+
723
+ #### ⚙️ Parameters
724
+
725
+ <dl>
726
+ <dd>
727
+
728
+ <dl>
729
+ <dd>
730
+
731
+ **workflowId:** `string`
732
+
733
+ </dd>
734
+ </dl>
735
+
736
+ <dl>
737
+ <dd>
738
+
739
+ **requestOptions:** `StyleRewrites.RequestOptions`
740
+
741
+ </dd>
742
+ </dl>
743
+ </dd>
744
+ </dl>
745
+
746
+ </dd>
747
+ </dl>
748
+ </details>