@unkey/api 0.33.1 → 2.0.0-alpha.1

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 (632) hide show
  1. package/.devcontainer/README.md +35 -0
  2. package/.devcontainer/devcontainer.json +45 -0
  3. package/FUNCTIONS.md +109 -0
  4. package/{LICENSE.md → LICENSE} +1 -1
  5. package/README.md +440 -66
  6. package/RUNTIMES.md +48 -0
  7. package/dist/commonjs/core.d.ts +10 -0
  8. package/dist/commonjs/core.d.ts.map +1 -0
  9. package/dist/commonjs/core.js +17 -0
  10. package/dist/commonjs/core.js.map +1 -0
  11. package/dist/commonjs/funcs/livenessCheck.d.ts +17 -0
  12. package/dist/commonjs/funcs/livenessCheck.d.ts.map +1 -0
  13. package/dist/commonjs/funcs/livenessCheck.js +126 -0
  14. package/dist/commonjs/funcs/livenessCheck.js.map +1 -0
  15. package/dist/commonjs/funcs/ratelimitDeleteOverride.d.ts +12 -0
  16. package/dist/commonjs/funcs/ratelimitDeleteOverride.d.ts.map +1 -0
  17. package/dist/commonjs/funcs/ratelimitDeleteOverride.js +137 -0
  18. package/dist/commonjs/funcs/ratelimitDeleteOverride.js.map +1 -0
  19. package/dist/commonjs/funcs/ratelimitGetOverride.d.ts +12 -0
  20. package/dist/commonjs/funcs/ratelimitGetOverride.d.ts.map +1 -0
  21. package/dist/commonjs/funcs/ratelimitGetOverride.js +137 -0
  22. package/dist/commonjs/funcs/ratelimitGetOverride.js.map +1 -0
  23. package/dist/commonjs/funcs/ratelimitLimit.d.ts +15 -0
  24. package/dist/commonjs/funcs/ratelimitLimit.d.ts.map +1 -0
  25. package/dist/commonjs/funcs/ratelimitLimit.js +140 -0
  26. package/dist/commonjs/funcs/ratelimitLimit.js.map +1 -0
  27. package/dist/commonjs/funcs/ratelimitSetOverride.d.ts +12 -0
  28. package/dist/commonjs/funcs/ratelimitSetOverride.d.ts.map +1 -0
  29. package/dist/commonjs/funcs/ratelimitSetOverride.js +137 -0
  30. package/dist/commonjs/funcs/ratelimitSetOverride.js.map +1 -0
  31. package/dist/commonjs/hooks/hooks.d.ts +24 -0
  32. package/dist/commonjs/hooks/hooks.d.ts.map +1 -0
  33. package/dist/commonjs/hooks/hooks.js +86 -0
  34. package/dist/commonjs/hooks/hooks.js.map +1 -0
  35. package/dist/commonjs/hooks/index.d.ts +3 -0
  36. package/dist/commonjs/hooks/index.d.ts.map +1 -0
  37. package/dist/commonjs/hooks/index.js +22 -0
  38. package/dist/commonjs/hooks/index.js.map +1 -0
  39. package/dist/commonjs/hooks/registration.d.ts +3 -0
  40. package/dist/commonjs/hooks/registration.d.ts.map +1 -0
  41. package/dist/commonjs/hooks/registration.js +15 -0
  42. package/dist/commonjs/hooks/registration.js.map +1 -0
  43. package/dist/commonjs/hooks/types.d.ts +78 -0
  44. package/dist/commonjs/hooks/types.d.ts.map +1 -0
  45. package/dist/commonjs/hooks/types.js +6 -0
  46. package/dist/commonjs/hooks/types.js.map +1 -0
  47. package/dist/commonjs/index.d.ts +4 -0
  48. package/dist/commonjs/index.d.ts.map +1 -0
  49. package/dist/commonjs/index.js +46 -0
  50. package/dist/commonjs/index.js.map +1 -0
  51. package/dist/commonjs/lib/base64.d.ts +10 -0
  52. package/dist/commonjs/lib/base64.d.ts.map +1 -0
  53. package/dist/commonjs/lib/base64.js +71 -0
  54. package/dist/commonjs/lib/base64.js.map +1 -0
  55. package/dist/commonjs/lib/config.d.ts +34 -0
  56. package/dist/commonjs/lib/config.d.ts.map +1 -0
  57. package/dist/commonjs/lib/config.js +35 -0
  58. package/dist/commonjs/lib/config.js.map +1 -0
  59. package/dist/commonjs/lib/dlv.d.ts +14 -0
  60. package/dist/commonjs/lib/dlv.d.ts.map +1 -0
  61. package/dist/commonjs/lib/dlv.js +49 -0
  62. package/dist/commonjs/lib/dlv.js.map +1 -0
  63. package/dist/commonjs/lib/encodings.d.ts +52 -0
  64. package/dist/commonjs/lib/encodings.d.ts.map +1 -0
  65. package/dist/commonjs/lib/encodings.js +368 -0
  66. package/dist/commonjs/lib/encodings.js.map +1 -0
  67. package/dist/commonjs/lib/env.d.ts +15 -0
  68. package/dist/commonjs/lib/env.d.ts.map +1 -0
  69. package/dist/commonjs/lib/env.js +65 -0
  70. package/dist/commonjs/lib/env.js.map +1 -0
  71. package/dist/commonjs/lib/files.d.ts +8 -0
  72. package/dist/commonjs/lib/files.d.ts.map +1 -0
  73. package/dist/commonjs/lib/files.js +36 -0
  74. package/dist/commonjs/lib/files.js.map +1 -0
  75. package/dist/commonjs/lib/http.d.ts +67 -0
  76. package/dist/commonjs/lib/http.d.ts.map +1 -0
  77. package/dist/commonjs/lib/http.js +217 -0
  78. package/dist/commonjs/lib/http.js.map +1 -0
  79. package/dist/commonjs/lib/is-plain-object.d.ts +2 -0
  80. package/dist/commonjs/lib/is-plain-object.d.ts.map +1 -0
  81. package/dist/commonjs/lib/is-plain-object.js +41 -0
  82. package/dist/commonjs/lib/is-plain-object.js.map +1 -0
  83. package/dist/commonjs/lib/logger.d.ts +6 -0
  84. package/dist/commonjs/lib/logger.d.ts.map +1 -0
  85. package/dist/commonjs/lib/logger.js +6 -0
  86. package/dist/commonjs/lib/logger.js.map +1 -0
  87. package/dist/commonjs/lib/matchers.d.ts +64 -0
  88. package/dist/commonjs/lib/matchers.d.ts.map +1 -0
  89. package/dist/commonjs/lib/matchers.js +200 -0
  90. package/dist/commonjs/lib/matchers.js.map +1 -0
  91. package/dist/commonjs/lib/primitives.d.ts +26 -0
  92. package/dist/commonjs/lib/primitives.d.ts.map +1 -0
  93. package/dist/commonjs/lib/primitives.js +111 -0
  94. package/dist/commonjs/lib/primitives.js.map +1 -0
  95. package/dist/commonjs/lib/retries.d.ts +38 -0
  96. package/dist/commonjs/lib/retries.d.ts.map +1 -0
  97. package/dist/commonjs/lib/retries.js +153 -0
  98. package/dist/commonjs/lib/retries.js.map +1 -0
  99. package/dist/commonjs/lib/schemas.d.ts +19 -0
  100. package/dist/commonjs/lib/schemas.d.ts.map +1 -0
  101. package/dist/commonjs/lib/schemas.js +62 -0
  102. package/dist/commonjs/lib/schemas.js.map +1 -0
  103. package/dist/commonjs/lib/sdks.d.ts +60 -0
  104. package/dist/commonjs/lib/sdks.d.ts.map +1 -0
  105. package/dist/commonjs/lib/sdks.js +274 -0
  106. package/dist/commonjs/lib/sdks.js.map +1 -0
  107. package/dist/commonjs/lib/security.d.ts +83 -0
  108. package/dist/commonjs/lib/security.d.ts.map +1 -0
  109. package/dist/commonjs/lib/security.js +144 -0
  110. package/dist/commonjs/lib/security.js.map +1 -0
  111. package/dist/commonjs/lib/url.d.ts +5 -0
  112. package/dist/commonjs/lib/url.d.ts.map +1 -0
  113. package/dist/commonjs/lib/url.js +25 -0
  114. package/dist/commonjs/lib/url.js.map +1 -0
  115. package/dist/commonjs/models/components/index.d.ts +12 -0
  116. package/dist/commonjs/models/components/index.d.ts.map +1 -0
  117. package/dist/commonjs/models/components/index.js +31 -0
  118. package/dist/commonjs/models/components/index.js.map +1 -0
  119. package/dist/commonjs/models/components/security.d.ts +29 -0
  120. package/dist/commonjs/models/components/security.d.ts.map +1 -0
  121. package/dist/commonjs/models/components/security.js +69 -0
  122. package/dist/commonjs/models/components/security.js.map +1 -0
  123. package/dist/commonjs/models/components/v2livenessresponsebody.d.ts +32 -0
  124. package/dist/commonjs/models/components/v2livenessresponsebody.d.ts.map +1 -0
  125. package/dist/commonjs/models/components/v2livenessresponsebody.js +69 -0
  126. package/dist/commonjs/models/components/v2livenessresponsebody.js.map +1 -0
  127. package/dist/commonjs/models/components/v2ratelimitdeleteoverriderequestbody.d.ts +45 -0
  128. package/dist/commonjs/models/components/v2ratelimitdeleteoverriderequestbody.d.ts.map +1 -0
  129. package/dist/commonjs/models/components/v2ratelimitdeleteoverriderequestbody.js +73 -0
  130. package/dist/commonjs/models/components/v2ratelimitdeleteoverriderequestbody.js.map +1 -0
  131. package/dist/commonjs/models/components/v2ratelimitdeleteoverrideresponsebody.d.ts +25 -0
  132. package/dist/commonjs/models/components/v2ratelimitdeleteoverrideresponsebody.d.ts.map +1 -0
  133. package/dist/commonjs/models/components/v2ratelimitdeleteoverrideresponsebody.js +65 -0
  134. package/dist/commonjs/models/components/v2ratelimitdeleteoverrideresponsebody.js.map +1 -0
  135. package/dist/commonjs/models/components/v2ratelimitgetoverriderequestbody.d.ts +45 -0
  136. package/dist/commonjs/models/components/v2ratelimitgetoverriderequestbody.d.ts.map +1 -0
  137. package/dist/commonjs/models/components/v2ratelimitgetoverriderequestbody.js +73 -0
  138. package/dist/commonjs/models/components/v2ratelimitgetoverriderequestbody.js.map +1 -0
  139. package/dist/commonjs/models/components/v2ratelimitgetoverrideresponsebody.d.ts +52 -0
  140. package/dist/commonjs/models/components/v2ratelimitgetoverrideresponsebody.d.ts.map +1 -0
  141. package/dist/commonjs/models/components/v2ratelimitgetoverrideresponsebody.js +77 -0
  142. package/dist/commonjs/models/components/v2ratelimitgetoverrideresponsebody.js.map +1 -0
  143. package/dist/commonjs/models/components/v2ratelimitlimitrequestbody.d.ts +52 -0
  144. package/dist/commonjs/models/components/v2ratelimitlimitrequestbody.d.ts.map +1 -0
  145. package/dist/commonjs/models/components/v2ratelimitlimitrequestbody.js +77 -0
  146. package/dist/commonjs/models/components/v2ratelimitlimitrequestbody.js.map +1 -0
  147. package/dist/commonjs/models/components/v2ratelimitlimitresponsebody.d.ts +52 -0
  148. package/dist/commonjs/models/components/v2ratelimitlimitresponsebody.d.ts.map +1 -0
  149. package/dist/commonjs/models/components/v2ratelimitlimitresponsebody.js +77 -0
  150. package/dist/commonjs/models/components/v2ratelimitlimitresponsebody.js.map +1 -0
  151. package/dist/commonjs/models/components/v2ratelimitsetoverriderequestbody.d.ts +55 -0
  152. package/dist/commonjs/models/components/v2ratelimitsetoverriderequestbody.d.ts.map +1 -0
  153. package/dist/commonjs/models/components/v2ratelimitsetoverriderequestbody.js +77 -0
  154. package/dist/commonjs/models/components/v2ratelimitsetoverriderequestbody.js.map +1 -0
  155. package/dist/commonjs/models/components/v2ratelimitsetoverrideresponsebody.d.ts +32 -0
  156. package/dist/commonjs/models/components/v2ratelimitsetoverrideresponsebody.d.ts.map +1 -0
  157. package/dist/commonjs/models/components/v2ratelimitsetoverrideresponsebody.js +69 -0
  158. package/dist/commonjs/models/components/v2ratelimitsetoverrideresponsebody.js.map +1 -0
  159. package/dist/commonjs/models/components/validationerror.d.ts +42 -0
  160. package/dist/commonjs/models/components/validationerror.d.ts.map +1 -0
  161. package/dist/commonjs/models/components/validationerror.js +73 -0
  162. package/dist/commonjs/models/components/validationerror.js.map +1 -0
  163. package/dist/commonjs/models/errors/apierror.d.ts +8 -0
  164. package/dist/commonjs/models/errors/apierror.d.ts.map +1 -0
  165. package/dist/commonjs/models/errors/apierror.js +21 -0
  166. package/dist/commonjs/models/errors/apierror.js.map +1 -0
  167. package/dist/commonjs/models/errors/badrequesterror.d.ts +92 -0
  168. package/dist/commonjs/models/errors/badrequesterror.d.ts.map +1 -0
  169. package/dist/commonjs/models/errors/badrequesterror.js +97 -0
  170. package/dist/commonjs/models/errors/badrequesterror.js.map +1 -0
  171. package/dist/commonjs/models/errors/forbiddenerror.d.ts +82 -0
  172. package/dist/commonjs/models/errors/forbiddenerror.d.ts.map +1 -0
  173. package/dist/commonjs/models/errors/forbiddenerror.js +93 -0
  174. package/dist/commonjs/models/errors/forbiddenerror.js.map +1 -0
  175. package/dist/commonjs/models/errors/httpclienterrors.d.ts +44 -0
  176. package/dist/commonjs/models/errors/httpclienterrors.d.ts.map +1 -0
  177. package/dist/commonjs/models/errors/httpclienterrors.js +78 -0
  178. package/dist/commonjs/models/errors/httpclienterrors.js.map +1 -0
  179. package/dist/commonjs/models/errors/index.d.ts +10 -0
  180. package/dist/commonjs/models/errors/index.d.ts.map +1 -0
  181. package/dist/commonjs/models/errors/index.js +29 -0
  182. package/dist/commonjs/models/errors/index.js.map +1 -0
  183. package/dist/commonjs/models/errors/internalservererror.d.ts +82 -0
  184. package/dist/commonjs/models/errors/internalservererror.d.ts.map +1 -0
  185. package/dist/commonjs/models/errors/internalservererror.js +93 -0
  186. package/dist/commonjs/models/errors/internalservererror.js.map +1 -0
  187. package/dist/commonjs/models/errors/notfounderror.d.ts +82 -0
  188. package/dist/commonjs/models/errors/notfounderror.d.ts.map +1 -0
  189. package/dist/commonjs/models/errors/notfounderror.js +93 -0
  190. package/dist/commonjs/models/errors/notfounderror.js.map +1 -0
  191. package/dist/commonjs/models/errors/preconditionfailederror.d.ts +82 -0
  192. package/dist/commonjs/models/errors/preconditionfailederror.d.ts.map +1 -0
  193. package/dist/commonjs/models/errors/preconditionfailederror.js +93 -0
  194. package/dist/commonjs/models/errors/preconditionfailederror.js.map +1 -0
  195. package/dist/commonjs/models/errors/sdkvalidationerror.d.ts +20 -0
  196. package/dist/commonjs/models/errors/sdkvalidationerror.d.ts.map +1 -0
  197. package/dist/commonjs/models/errors/sdkvalidationerror.js +115 -0
  198. package/dist/commonjs/models/errors/sdkvalidationerror.js.map +1 -0
  199. package/dist/commonjs/models/errors/unauthorizederror.d.ts +82 -0
  200. package/dist/commonjs/models/errors/unauthorizederror.d.ts.map +1 -0
  201. package/dist/commonjs/models/errors/unauthorizederror.js +93 -0
  202. package/dist/commonjs/models/errors/unauthorizederror.js.map +1 -0
  203. package/dist/commonjs/models/operations/index.d.ts +6 -0
  204. package/dist/commonjs/models/operations/index.d.ts.map +1 -0
  205. package/dist/commonjs/models/operations/index.js +25 -0
  206. package/dist/commonjs/models/operations/index.js.map +1 -0
  207. package/dist/commonjs/models/operations/liveness.d.ts +48 -0
  208. package/dist/commonjs/models/operations/liveness.d.ts.map +1 -0
  209. package/dist/commonjs/models/operations/liveness.js +95 -0
  210. package/dist/commonjs/models/operations/liveness.js.map +1 -0
  211. package/dist/commonjs/models/operations/ratelimitdeleteoverride.d.ts +48 -0
  212. package/dist/commonjs/models/operations/ratelimitdeleteoverride.d.ts.map +1 -0
  213. package/dist/commonjs/models/operations/ratelimitdeleteoverride.js +95 -0
  214. package/dist/commonjs/models/operations/ratelimitdeleteoverride.js.map +1 -0
  215. package/dist/commonjs/models/operations/ratelimitgetoverride.d.ts +48 -0
  216. package/dist/commonjs/models/operations/ratelimitgetoverride.d.ts.map +1 -0
  217. package/dist/commonjs/models/operations/ratelimitgetoverride.js +95 -0
  218. package/dist/commonjs/models/operations/ratelimitgetoverride.js.map +1 -0
  219. package/dist/commonjs/models/operations/ratelimitsetoverride.d.ts +48 -0
  220. package/dist/commonjs/models/operations/ratelimitsetoverride.d.ts.map +1 -0
  221. package/dist/commonjs/models/operations/ratelimitsetoverride.js +95 -0
  222. package/dist/commonjs/models/operations/ratelimitsetoverride.js.map +1 -0
  223. package/dist/commonjs/models/operations/v1ratelimitlimit.d.ts +48 -0
  224. package/dist/commonjs/models/operations/v1ratelimitlimit.d.ts.map +1 -0
  225. package/dist/commonjs/models/operations/v1ratelimitlimit.js +95 -0
  226. package/dist/commonjs/models/operations/v1ratelimitlimit.js.map +1 -0
  227. package/dist/commonjs/package.json +3 -0
  228. package/dist/commonjs/sdk/index.d.ts +2 -0
  229. package/dist/commonjs/sdk/index.d.ts.map +1 -0
  230. package/dist/commonjs/sdk/index.js +21 -0
  231. package/dist/commonjs/sdk/index.js.map +1 -0
  232. package/dist/commonjs/sdk/liveness.d.ts +12 -0
  233. package/dist/commonjs/sdk/liveness.d.ts.map +1 -0
  234. package/dist/commonjs/sdk/liveness.js +22 -0
  235. package/dist/commonjs/sdk/liveness.js.map +1 -0
  236. package/dist/commonjs/sdk/ratelimit.d.ts +13 -0
  237. package/dist/commonjs/sdk/ratelimit.d.ts.map +1 -0
  238. package/dist/commonjs/sdk/ratelimit.js +31 -0
  239. package/dist/commonjs/sdk/ratelimit.js.map +1 -0
  240. package/dist/commonjs/sdk/sdk.d.ts +10 -0
  241. package/dist/commonjs/sdk/sdk.d.ts.map +1 -0
  242. package/dist/commonjs/sdk/sdk.js +19 -0
  243. package/dist/commonjs/sdk/sdk.js.map +1 -0
  244. package/dist/commonjs/types/async.d.ts +23 -0
  245. package/dist/commonjs/types/async.d.ts.map +1 -0
  246. package/dist/commonjs/types/async.js +44 -0
  247. package/dist/commonjs/types/async.js.map +1 -0
  248. package/dist/commonjs/types/blobs.d.ts +4 -0
  249. package/dist/commonjs/types/blobs.d.ts.map +1 -0
  250. package/dist/commonjs/types/blobs.js +62 -0
  251. package/dist/commonjs/types/blobs.js.map +1 -0
  252. package/dist/commonjs/types/constdatetime.d.ts +3 -0
  253. package/dist/commonjs/types/constdatetime.d.ts.map +1 -0
  254. package/dist/commonjs/types/constdatetime.js +46 -0
  255. package/dist/commonjs/types/constdatetime.js.map +1 -0
  256. package/dist/commonjs/types/enums.d.ts +12 -0
  257. package/dist/commonjs/types/enums.d.ts.map +1 -0
  258. package/dist/commonjs/types/enums.js +10 -0
  259. package/dist/commonjs/types/enums.js.map +1 -0
  260. package/dist/commonjs/types/fp.d.ts +31 -0
  261. package/dist/commonjs/types/fp.d.ts.map +1 -0
  262. package/dist/commonjs/types/fp.js +37 -0
  263. package/dist/commonjs/types/fp.js.map +1 -0
  264. package/dist/commonjs/types/index.d.ts +8 -0
  265. package/dist/commonjs/types/index.d.ts.map +1 -0
  266. package/dist/commonjs/types/index.js +16 -0
  267. package/dist/commonjs/types/index.js.map +1 -0
  268. package/dist/commonjs/types/operations.d.ts +27 -0
  269. package/dist/commonjs/types/operations.d.ts.map +1 -0
  270. package/dist/commonjs/types/operations.js +83 -0
  271. package/dist/commonjs/types/operations.js.map +1 -0
  272. package/dist/commonjs/types/rfcdate.d.ts +21 -0
  273. package/dist/commonjs/types/rfcdate.d.ts.map +1 -0
  274. package/dist/commonjs/types/rfcdate.js +46 -0
  275. package/dist/commonjs/types/rfcdate.js.map +1 -0
  276. package/dist/commonjs/types/streams.d.ts +2 -0
  277. package/dist/commonjs/types/streams.d.ts.map +1 -0
  278. package/dist/commonjs/types/streams.js +18 -0
  279. package/dist/commonjs/types/streams.js.map +1 -0
  280. package/dist/esm/core.d.ts +10 -0
  281. package/dist/esm/core.d.ts.map +1 -0
  282. package/dist/esm/core.js +13 -0
  283. package/dist/esm/core.js.map +1 -0
  284. package/dist/esm/funcs/livenessCheck.d.ts +17 -0
  285. package/dist/esm/funcs/livenessCheck.d.ts.map +1 -0
  286. package/dist/esm/funcs/livenessCheck.js +90 -0
  287. package/dist/esm/funcs/livenessCheck.js.map +1 -0
  288. package/dist/esm/funcs/ratelimitDeleteOverride.d.ts +12 -0
  289. package/dist/esm/funcs/ratelimitDeleteOverride.d.ts.map +1 -0
  290. package/dist/esm/funcs/ratelimitDeleteOverride.js +101 -0
  291. package/dist/esm/funcs/ratelimitDeleteOverride.js.map +1 -0
  292. package/dist/esm/funcs/ratelimitGetOverride.d.ts +12 -0
  293. package/dist/esm/funcs/ratelimitGetOverride.d.ts.map +1 -0
  294. package/dist/esm/funcs/ratelimitGetOverride.js +101 -0
  295. package/dist/esm/funcs/ratelimitGetOverride.js.map +1 -0
  296. package/dist/esm/funcs/ratelimitLimit.d.ts +15 -0
  297. package/dist/esm/funcs/ratelimitLimit.d.ts.map +1 -0
  298. package/dist/esm/funcs/ratelimitLimit.js +104 -0
  299. package/dist/esm/funcs/ratelimitLimit.js.map +1 -0
  300. package/dist/esm/funcs/ratelimitSetOverride.d.ts +12 -0
  301. package/dist/esm/funcs/ratelimitSetOverride.d.ts.map +1 -0
  302. package/dist/esm/funcs/ratelimitSetOverride.js +101 -0
  303. package/dist/esm/funcs/ratelimitSetOverride.js.map +1 -0
  304. package/dist/esm/hooks/hooks.d.ts +24 -0
  305. package/dist/esm/hooks/hooks.d.ts.map +1 -0
  306. package/dist/esm/hooks/hooks.js +82 -0
  307. package/dist/esm/hooks/hooks.js.map +1 -0
  308. package/dist/esm/hooks/index.d.ts +3 -0
  309. package/dist/esm/hooks/index.d.ts.map +1 -0
  310. package/dist/esm/hooks/index.js +6 -0
  311. package/dist/esm/hooks/index.js.map +1 -0
  312. package/dist/esm/hooks/registration.d.ts +3 -0
  313. package/dist/esm/hooks/registration.d.ts.map +1 -0
  314. package/dist/esm/hooks/registration.js +12 -0
  315. package/dist/esm/hooks/registration.js.map +1 -0
  316. package/dist/esm/hooks/types.d.ts +78 -0
  317. package/dist/esm/hooks/types.d.ts.map +1 -0
  318. package/dist/esm/hooks/types.js +5 -0
  319. package/dist/esm/hooks/types.js.map +1 -0
  320. package/dist/esm/index.d.ts +4 -0
  321. package/dist/esm/index.d.ts.map +1 -0
  322. package/dist/esm/index.js +7 -0
  323. package/dist/esm/index.js.map +1 -0
  324. package/dist/esm/lib/base64.d.ts +10 -0
  325. package/dist/esm/lib/base64.d.ts.map +1 -0
  326. package/dist/esm/lib/base64.js +29 -0
  327. package/dist/esm/lib/base64.js.map +1 -0
  328. package/dist/esm/lib/config.d.ts +34 -0
  329. package/dist/esm/lib/config.d.ts.map +1 -0
  330. package/dist/esm/lib/config.js +31 -0
  331. package/dist/esm/lib/config.js.map +1 -0
  332. package/dist/esm/lib/dlv.d.ts +14 -0
  333. package/dist/esm/lib/dlv.d.ts.map +1 -0
  334. package/dist/esm/lib/dlv.js +46 -0
  335. package/dist/esm/lib/dlv.js.map +1 -0
  336. package/dist/esm/lib/encodings.d.ts +52 -0
  337. package/dist/esm/lib/encodings.d.ts.map +1 -0
  338. package/dist/esm/lib/encodings.js +354 -0
  339. package/dist/esm/lib/encodings.js.map +1 -0
  340. package/dist/esm/lib/env.d.ts +15 -0
  341. package/dist/esm/lib/env.d.ts.map +1 -0
  342. package/dist/esm/lib/env.js +27 -0
  343. package/dist/esm/lib/env.js.map +1 -0
  344. package/dist/esm/lib/files.d.ts +8 -0
  345. package/dist/esm/lib/files.d.ts.map +1 -0
  346. package/dist/esm/lib/files.js +33 -0
  347. package/dist/esm/lib/files.js.map +1 -0
  348. package/dist/esm/lib/http.d.ts +67 -0
  349. package/dist/esm/lib/http.d.ts.map +1 -0
  350. package/dist/esm/lib/http.js +207 -0
  351. package/dist/esm/lib/http.js.map +1 -0
  352. package/dist/esm/lib/is-plain-object.d.ts +2 -0
  353. package/dist/esm/lib/is-plain-object.d.ts.map +1 -0
  354. package/dist/esm/lib/is-plain-object.js +38 -0
  355. package/dist/esm/lib/is-plain-object.js.map +1 -0
  356. package/dist/esm/lib/logger.d.ts +6 -0
  357. package/dist/esm/lib/logger.d.ts.map +1 -0
  358. package/dist/esm/lib/logger.js +5 -0
  359. package/dist/esm/lib/logger.js.map +1 -0
  360. package/dist/esm/lib/matchers.d.ts +64 -0
  361. package/dist/esm/lib/matchers.d.ts.map +1 -0
  362. package/dist/esm/lib/matchers.js +182 -0
  363. package/dist/esm/lib/matchers.js.map +1 -0
  364. package/dist/esm/lib/primitives.d.ts +26 -0
  365. package/dist/esm/lib/primitives.d.ts.map +1 -0
  366. package/dist/esm/lib/primitives.js +103 -0
  367. package/dist/esm/lib/primitives.js.map +1 -0
  368. package/dist/esm/lib/retries.d.ts +38 -0
  369. package/dist/esm/lib/retries.d.ts.map +1 -0
  370. package/dist/esm/lib/retries.js +147 -0
  371. package/dist/esm/lib/retries.js.map +1 -0
  372. package/dist/esm/lib/schemas.d.ts +19 -0
  373. package/dist/esm/lib/schemas.d.ts.map +1 -0
  374. package/dist/esm/lib/schemas.js +57 -0
  375. package/dist/esm/lib/schemas.js.map +1 -0
  376. package/dist/esm/lib/sdks.d.ts +60 -0
  377. package/dist/esm/lib/sdks.d.ts.map +1 -0
  378. package/dist/esm/lib/sdks.js +270 -0
  379. package/dist/esm/lib/sdks.js.map +1 -0
  380. package/dist/esm/lib/security.d.ts +83 -0
  381. package/dist/esm/lib/security.d.ts.map +1 -0
  382. package/dist/esm/lib/security.js +137 -0
  383. package/dist/esm/lib/security.js.map +1 -0
  384. package/dist/esm/lib/url.d.ts +5 -0
  385. package/dist/esm/lib/url.d.ts.map +1 -0
  386. package/dist/esm/lib/url.js +22 -0
  387. package/dist/esm/lib/url.js.map +1 -0
  388. package/dist/esm/models/components/index.d.ts +12 -0
  389. package/dist/esm/models/components/index.d.ts.map +1 -0
  390. package/dist/esm/models/components/index.js +15 -0
  391. package/dist/esm/models/components/index.js.map +1 -0
  392. package/dist/esm/models/components/security.d.ts +29 -0
  393. package/dist/esm/models/components/security.d.ts.map +1 -0
  394. package/dist/esm/models/components/security.js +31 -0
  395. package/dist/esm/models/components/security.js.map +1 -0
  396. package/dist/esm/models/components/v2livenessresponsebody.d.ts +32 -0
  397. package/dist/esm/models/components/v2livenessresponsebody.d.ts.map +1 -0
  398. package/dist/esm/models/components/v2livenessresponsebody.js +31 -0
  399. package/dist/esm/models/components/v2livenessresponsebody.js.map +1 -0
  400. package/dist/esm/models/components/v2ratelimitdeleteoverriderequestbody.d.ts +45 -0
  401. package/dist/esm/models/components/v2ratelimitdeleteoverriderequestbody.d.ts.map +1 -0
  402. package/dist/esm/models/components/v2ratelimitdeleteoverriderequestbody.js +35 -0
  403. package/dist/esm/models/components/v2ratelimitdeleteoverriderequestbody.js.map +1 -0
  404. package/dist/esm/models/components/v2ratelimitdeleteoverrideresponsebody.d.ts +25 -0
  405. package/dist/esm/models/components/v2ratelimitdeleteoverrideresponsebody.d.ts.map +1 -0
  406. package/dist/esm/models/components/v2ratelimitdeleteoverrideresponsebody.js +27 -0
  407. package/dist/esm/models/components/v2ratelimitdeleteoverrideresponsebody.js.map +1 -0
  408. package/dist/esm/models/components/v2ratelimitgetoverriderequestbody.d.ts +45 -0
  409. package/dist/esm/models/components/v2ratelimitgetoverriderequestbody.d.ts.map +1 -0
  410. package/dist/esm/models/components/v2ratelimitgetoverriderequestbody.js +35 -0
  411. package/dist/esm/models/components/v2ratelimitgetoverriderequestbody.js.map +1 -0
  412. package/dist/esm/models/components/v2ratelimitgetoverrideresponsebody.d.ts +52 -0
  413. package/dist/esm/models/components/v2ratelimitgetoverrideresponsebody.d.ts.map +1 -0
  414. package/dist/esm/models/components/v2ratelimitgetoverrideresponsebody.js +39 -0
  415. package/dist/esm/models/components/v2ratelimitgetoverrideresponsebody.js.map +1 -0
  416. package/dist/esm/models/components/v2ratelimitlimitrequestbody.d.ts +52 -0
  417. package/dist/esm/models/components/v2ratelimitlimitrequestbody.d.ts.map +1 -0
  418. package/dist/esm/models/components/v2ratelimitlimitrequestbody.js +39 -0
  419. package/dist/esm/models/components/v2ratelimitlimitrequestbody.js.map +1 -0
  420. package/dist/esm/models/components/v2ratelimitlimitresponsebody.d.ts +52 -0
  421. package/dist/esm/models/components/v2ratelimitlimitresponsebody.d.ts.map +1 -0
  422. package/dist/esm/models/components/v2ratelimitlimitresponsebody.js +39 -0
  423. package/dist/esm/models/components/v2ratelimitlimitresponsebody.js.map +1 -0
  424. package/dist/esm/models/components/v2ratelimitsetoverriderequestbody.d.ts +55 -0
  425. package/dist/esm/models/components/v2ratelimitsetoverriderequestbody.d.ts.map +1 -0
  426. package/dist/esm/models/components/v2ratelimitsetoverriderequestbody.js +39 -0
  427. package/dist/esm/models/components/v2ratelimitsetoverriderequestbody.js.map +1 -0
  428. package/dist/esm/models/components/v2ratelimitsetoverrideresponsebody.d.ts +32 -0
  429. package/dist/esm/models/components/v2ratelimitsetoverrideresponsebody.d.ts.map +1 -0
  430. package/dist/esm/models/components/v2ratelimitsetoverrideresponsebody.js +31 -0
  431. package/dist/esm/models/components/v2ratelimitsetoverrideresponsebody.js.map +1 -0
  432. package/dist/esm/models/components/validationerror.d.ts +42 -0
  433. package/dist/esm/models/components/validationerror.d.ts.map +1 -0
  434. package/dist/esm/models/components/validationerror.js +35 -0
  435. package/dist/esm/models/components/validationerror.js.map +1 -0
  436. package/dist/esm/models/errors/apierror.d.ts +8 -0
  437. package/dist/esm/models/errors/apierror.d.ts.map +1 -0
  438. package/dist/esm/models/errors/apierror.js +17 -0
  439. package/dist/esm/models/errors/apierror.js.map +1 -0
  440. package/dist/esm/models/errors/badrequesterror.d.ts +92 -0
  441. package/dist/esm/models/errors/badrequesterror.d.ts.map +1 -0
  442. package/dist/esm/models/errors/badrequesterror.js +60 -0
  443. package/dist/esm/models/errors/badrequesterror.js.map +1 -0
  444. package/dist/esm/models/errors/forbiddenerror.d.ts +82 -0
  445. package/dist/esm/models/errors/forbiddenerror.d.ts.map +1 -0
  446. package/dist/esm/models/errors/forbiddenerror.js +56 -0
  447. package/dist/esm/models/errors/forbiddenerror.js.map +1 -0
  448. package/dist/esm/models/errors/httpclienterrors.d.ts +44 -0
  449. package/dist/esm/models/errors/httpclienterrors.d.ts.map +1 -0
  450. package/dist/esm/models/errors/httpclienterrors.js +69 -0
  451. package/dist/esm/models/errors/httpclienterrors.js.map +1 -0
  452. package/dist/esm/models/errors/index.d.ts +10 -0
  453. package/dist/esm/models/errors/index.d.ts.map +1 -0
  454. package/dist/esm/models/errors/index.js +13 -0
  455. package/dist/esm/models/errors/index.js.map +1 -0
  456. package/dist/esm/models/errors/internalservererror.d.ts +82 -0
  457. package/dist/esm/models/errors/internalservererror.d.ts.map +1 -0
  458. package/dist/esm/models/errors/internalservererror.js +56 -0
  459. package/dist/esm/models/errors/internalservererror.js.map +1 -0
  460. package/dist/esm/models/errors/notfounderror.d.ts +82 -0
  461. package/dist/esm/models/errors/notfounderror.d.ts.map +1 -0
  462. package/dist/esm/models/errors/notfounderror.js +56 -0
  463. package/dist/esm/models/errors/notfounderror.js.map +1 -0
  464. package/dist/esm/models/errors/preconditionfailederror.d.ts +82 -0
  465. package/dist/esm/models/errors/preconditionfailederror.d.ts.map +1 -0
  466. package/dist/esm/models/errors/preconditionfailederror.js +56 -0
  467. package/dist/esm/models/errors/preconditionfailederror.js.map +1 -0
  468. package/dist/esm/models/errors/sdkvalidationerror.d.ts +20 -0
  469. package/dist/esm/models/errors/sdkvalidationerror.d.ts.map +1 -0
  470. package/dist/esm/models/errors/sdkvalidationerror.js +77 -0
  471. package/dist/esm/models/errors/sdkvalidationerror.js.map +1 -0
  472. package/dist/esm/models/errors/unauthorizederror.d.ts +82 -0
  473. package/dist/esm/models/errors/unauthorizederror.d.ts.map +1 -0
  474. package/dist/esm/models/errors/unauthorizederror.js +56 -0
  475. package/dist/esm/models/errors/unauthorizederror.js.map +1 -0
  476. package/dist/esm/models/operations/index.d.ts +6 -0
  477. package/dist/esm/models/operations/index.d.ts.map +1 -0
  478. package/dist/esm/models/operations/index.js +9 -0
  479. package/dist/esm/models/operations/index.js.map +1 -0
  480. package/dist/esm/models/operations/liveness.d.ts +48 -0
  481. package/dist/esm/models/operations/liveness.d.ts.map +1 -0
  482. package/dist/esm/models/operations/liveness.js +57 -0
  483. package/dist/esm/models/operations/liveness.js.map +1 -0
  484. package/dist/esm/models/operations/ratelimitdeleteoverride.d.ts +48 -0
  485. package/dist/esm/models/operations/ratelimitdeleteoverride.d.ts.map +1 -0
  486. package/dist/esm/models/operations/ratelimitdeleteoverride.js +57 -0
  487. package/dist/esm/models/operations/ratelimitdeleteoverride.js.map +1 -0
  488. package/dist/esm/models/operations/ratelimitgetoverride.d.ts +48 -0
  489. package/dist/esm/models/operations/ratelimitgetoverride.d.ts.map +1 -0
  490. package/dist/esm/models/operations/ratelimitgetoverride.js +57 -0
  491. package/dist/esm/models/operations/ratelimitgetoverride.js.map +1 -0
  492. package/dist/esm/models/operations/ratelimitsetoverride.d.ts +48 -0
  493. package/dist/esm/models/operations/ratelimitsetoverride.d.ts.map +1 -0
  494. package/dist/esm/models/operations/ratelimitsetoverride.js +57 -0
  495. package/dist/esm/models/operations/ratelimitsetoverride.js.map +1 -0
  496. package/dist/esm/models/operations/v1ratelimitlimit.d.ts +48 -0
  497. package/dist/esm/models/operations/v1ratelimitlimit.d.ts.map +1 -0
  498. package/dist/esm/models/operations/v1ratelimitlimit.js +57 -0
  499. package/dist/esm/models/operations/v1ratelimitlimit.js.map +1 -0
  500. package/dist/esm/package.json +3 -0
  501. package/dist/esm/sdk/index.d.ts +2 -0
  502. package/dist/esm/sdk/index.d.ts.map +1 -0
  503. package/dist/esm/sdk/index.js +5 -0
  504. package/dist/esm/sdk/index.js.map +1 -0
  505. package/dist/esm/sdk/liveness.d.ts +12 -0
  506. package/dist/esm/sdk/liveness.d.ts.map +1 -0
  507. package/dist/esm/sdk/liveness.js +18 -0
  508. package/dist/esm/sdk/liveness.js.map +1 -0
  509. package/dist/esm/sdk/ratelimit.d.ts +13 -0
  510. package/dist/esm/sdk/ratelimit.d.ts.map +1 -0
  511. package/dist/esm/sdk/ratelimit.js +27 -0
  512. package/dist/esm/sdk/ratelimit.js.map +1 -0
  513. package/dist/esm/sdk/sdk.d.ts +10 -0
  514. package/dist/esm/sdk/sdk.d.ts.map +1 -0
  515. package/dist/esm/sdk/sdk.js +15 -0
  516. package/dist/esm/sdk/sdk.js.map +1 -0
  517. package/dist/esm/types/async.d.ts +23 -0
  518. package/dist/esm/types/async.d.ts.map +1 -0
  519. package/dist/esm/types/async.js +40 -0
  520. package/dist/esm/types/async.js.map +1 -0
  521. package/dist/esm/types/blobs.d.ts +4 -0
  522. package/dist/esm/types/blobs.d.ts.map +1 -0
  523. package/dist/esm/types/blobs.js +25 -0
  524. package/dist/esm/types/blobs.js.map +1 -0
  525. package/dist/esm/types/constdatetime.d.ts +3 -0
  526. package/dist/esm/types/constdatetime.d.ts.map +1 -0
  527. package/dist/esm/types/constdatetime.js +10 -0
  528. package/dist/esm/types/constdatetime.js.map +1 -0
  529. package/dist/esm/types/enums.d.ts +12 -0
  530. package/dist/esm/types/enums.d.ts.map +1 -0
  531. package/dist/esm/types/enums.js +7 -0
  532. package/dist/esm/types/enums.js.map +1 -0
  533. package/dist/esm/types/fp.d.ts +31 -0
  534. package/dist/esm/types/fp.d.ts.map +1 -0
  535. package/dist/esm/types/fp.js +31 -0
  536. package/dist/esm/types/fp.js.map +1 -0
  537. package/dist/esm/types/index.d.ts +8 -0
  538. package/dist/esm/types/index.d.ts.map +1 -0
  539. package/dist/esm/types/index.js +8 -0
  540. package/dist/esm/types/index.js.map +1 -0
  541. package/dist/esm/types/operations.d.ts +27 -0
  542. package/dist/esm/types/operations.d.ts.map +1 -0
  543. package/dist/esm/types/operations.js +77 -0
  544. package/dist/esm/types/operations.js.map +1 -0
  545. package/dist/esm/types/rfcdate.d.ts +21 -0
  546. package/dist/esm/types/rfcdate.d.ts.map +1 -0
  547. package/dist/esm/types/rfcdate.js +42 -0
  548. package/dist/esm/types/rfcdate.js.map +1 -0
  549. package/dist/esm/types/streams.d.ts +2 -0
  550. package/dist/esm/types/streams.d.ts.map +1 -0
  551. package/dist/esm/types/streams.js +15 -0
  552. package/dist/esm/types/streams.js.map +1 -0
  553. package/docs/sdks/liveness/README.md +81 -0
  554. package/docs/sdks/ratelimit/README.md +339 -0
  555. package/docs/sdks/unkey/README.md +5 -0
  556. package/jsr.json +27 -0
  557. package/package.json +120 -34
  558. package/src/core.ts +13 -0
  559. package/src/funcs/livenessCheck.ts +169 -0
  560. package/src/funcs/ratelimitDeleteOverride.ts +203 -0
  561. package/src/funcs/ratelimitGetOverride.ts +201 -0
  562. package/src/funcs/ratelimitLimit.ts +204 -0
  563. package/src/funcs/ratelimitSetOverride.ts +201 -0
  564. package/src/hooks/hooks.ts +132 -0
  565. package/src/hooks/index.ts +6 -0
  566. package/src/hooks/registration.ts +14 -0
  567. package/src/hooks/types.ts +110 -0
  568. package/src/index.ts +7 -0
  569. package/src/lib/base64.ts +37 -0
  570. package/src/lib/config.ts +60 -0
  571. package/src/lib/dlv.ts +53 -0
  572. package/src/lib/encodings.ts +483 -0
  573. package/src/lib/env.ts +41 -0
  574. package/src/lib/files.ts +40 -0
  575. package/src/lib/http.ts +323 -0
  576. package/src/lib/is-plain-object.ts +43 -0
  577. package/src/lib/logger.ts +9 -0
  578. package/src/lib/matchers.ts +319 -0
  579. package/src/lib/primitives.ts +150 -0
  580. package/src/lib/retries.ts +218 -0
  581. package/src/lib/schemas.ts +91 -0
  582. package/src/lib/sdks.ts +395 -0
  583. package/src/lib/security.ts +261 -0
  584. package/src/lib/url.ts +33 -0
  585. package/src/models/components/index.ts +15 -0
  586. package/src/models/components/security.ts +62 -0
  587. package/src/models/components/v2livenessresponsebody.ts +69 -0
  588. package/src/models/components/v2ratelimitdeleteoverriderequestbody.ts +91 -0
  589. package/src/models/components/v2ratelimitdeleteoverrideresponsebody.ts +63 -0
  590. package/src/models/components/v2ratelimitgetoverriderequestbody.ts +89 -0
  591. package/src/models/components/v2ratelimitgetoverrideresponsebody.ts +101 -0
  592. package/src/models/components/v2ratelimitlimitrequestbody.ts +99 -0
  593. package/src/models/components/v2ratelimitlimitresponsebody.ts +99 -0
  594. package/src/models/components/v2ratelimitsetoverriderequestbody.ts +103 -0
  595. package/src/models/components/v2ratelimitsetoverrideresponsebody.ts +73 -0
  596. package/src/models/components/validationerror.ts +81 -0
  597. package/src/models/errors/apierror.ts +27 -0
  598. package/src/models/errors/badrequesterror.ts +148 -0
  599. package/src/models/errors/forbiddenerror.ts +135 -0
  600. package/src/models/errors/httpclienterrors.ts +62 -0
  601. package/src/models/errors/index.ts +13 -0
  602. package/src/models/errors/internalservererror.ts +135 -0
  603. package/src/models/errors/notfounderror.ts +135 -0
  604. package/src/models/errors/preconditionfailederror.ts +135 -0
  605. package/src/models/errors/sdkvalidationerror.ts +97 -0
  606. package/src/models/errors/unauthorizederror.ts +135 -0
  607. package/src/models/operations/index.ts +9 -0
  608. package/src/models/operations/liveness.ts +112 -0
  609. package/src/models/operations/ratelimitdeleteoverride.ts +118 -0
  610. package/src/models/operations/ratelimitgetoverride.ts +116 -0
  611. package/src/models/operations/ratelimitsetoverride.ts +116 -0
  612. package/src/models/operations/v1ratelimitlimit.ts +114 -0
  613. package/src/sdk/index.ts +5 -0
  614. package/src/sdk/liveness.ts +25 -0
  615. package/src/sdk/ratelimit.ts +61 -0
  616. package/src/sdk/sdk.ts +19 -0
  617. package/src/types/async.ts +68 -0
  618. package/src/types/blobs.ts +31 -0
  619. package/src/types/constdatetime.ts +15 -0
  620. package/src/types/enums.ts +16 -0
  621. package/src/types/fp.ts +50 -0
  622. package/src/types/index.ts +11 -0
  623. package/src/types/operations.ts +105 -0
  624. package/src/types/rfcdate.ts +54 -0
  625. package/src/types/streams.ts +21 -0
  626. package/tsconfig.json +41 -0
  627. package/dist/index.d.mts +0 -5147
  628. package/dist/index.d.ts +0 -5147
  629. package/dist/index.js +0 -355
  630. package/dist/index.js.map +0 -1
  631. package/dist/index.mjs +0 -325
  632. package/dist/index.mjs.map +0 -1
package/README.md CHANGED
@@ -1,118 +1,492 @@
1
- <div align="center">
2
- <h1 align="center">@unkey/api</h1>
3
- <h5>`@unkey/api` is a TypeScript client for Unkey. If you prefer a typed experience over calling HTTP endpoints directly, this SDK is for you.</h5>
4
- </div>
1
+ # @unkey/api
2
+
3
+ Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@unkey/api* API.
5
4
 
6
- <div align="center">
7
- <a href="https://www.unkey.com/docs/libraries/ts/sdk/overview">Documentation</a>
5
+ <div align="left">
6
+ <a href="https://www.speakeasy.com/?utm_source=@unkey/api&utm_campaign=typescript"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
7
+ <a href="https://opensource.org/licenses/MIT">
8
+ <img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
9
+ </a>
8
10
  </div>
9
- <br/>
10
11
 
11
- ## Installation
12
+
13
+ <br /><br />
14
+ > [!IMPORTANT]
15
+ > This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your [workspace](https://app.speakeasy.com/org/unkey/unkey). Delete this section before > publishing to a package manager.
16
+
17
+ <!-- Start Summary [summary] -->
18
+ ## Summary
19
+
20
+
21
+ <!-- End Summary [summary] -->
22
+
23
+ <!-- Start Table of Contents [toc] -->
24
+ ## Table of Contents
25
+ <!-- $toc-max-depth=2 -->
26
+ * [@unkey/api](#unkeyapi)
27
+ * [SDK Installation](#sdk-installation)
28
+ * [Requirements](#requirements)
29
+ * [SDK Example Usage](#sdk-example-usage)
30
+ * [Authentication](#authentication)
31
+ * [Available Resources and Operations](#available-resources-and-operations)
32
+ * [Standalone functions](#standalone-functions)
33
+ * [Retries](#retries)
34
+ * [Error Handling](#error-handling)
35
+ * [Server Selection](#server-selection)
36
+ * [Custom HTTP Client](#custom-http-client)
37
+ * [Debugging](#debugging)
38
+ * [Development](#development)
39
+ * [Maturity](#maturity)
40
+ * [Contributions](#contributions)
41
+
42
+ <!-- End Table of Contents [toc] -->
43
+
44
+ <!-- Start SDK Installation [installation] -->
45
+ ## SDK Installation
46
+
47
+ > [!TIP]
48
+ > To finish publishing your SDK to npm and others you must [run your first generation action](https://www.speakeasy.com/docs/github-setup#step-by-step-guide).
49
+
50
+
51
+ The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
52
+
53
+ ### NPM
54
+
55
+ ```bash
56
+ npm add https://github.com/unkeyed/unkey-ts
57
+ ```
58
+
59
+ ### PNPM
12
60
 
13
61
  ```bash
14
- npm install @unkey/api
62
+ pnpm add https://github.com/unkeyed/unkey-ts
15
63
  ```
16
64
 
17
- ## Quickstart
65
+ ### Bun
66
+
67
+ ```bash
68
+ bun add https://github.com/unkeyed/unkey-ts
69
+ ```
18
70
 
19
- 1. Create a new Unkey Root Key in the settings.
20
- 2. Use the root key to initialize the client:
71
+ ### Yarn
21
72
 
22
- ```ts
23
- import { Unkey } from "@unkey/api";
73
+ ```bash
74
+ yarn add https://github.com/unkeyed/unkey-ts zod
24
75
 
25
- const unkey = new Unkey({ rootKey: "<UNKEY_ROOT_KEY>" });
76
+ # Note that Yarn does not install peer dependencies automatically. You will need
77
+ # to install zod as shown above.
26
78
  ```
27
79
 
28
- **Important:** Always keep your root key safe and reset it if you suspect it has been compromised.
80
+ > [!NOTE]
81
+ > This package is published with CommonJS and ES Modules (ESM) support.
82
+ <!-- End SDK Installation [installation] -->
29
83
 
30
- ## Usage
84
+ <!-- Start Requirements [requirements] -->
85
+ ## Requirements
31
86
 
32
- ### Verifying a Key
87
+ For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
88
+ <!-- End Requirements [requirements] -->
33
89
 
34
- ```ts
35
- import { verifyKey } from "@unkey/api";
90
+ <!-- Start SDK Example Usage [usage] -->
91
+ ## SDK Example Usage
36
92
 
37
- const { result, error } = await verifyKey("key_123");
93
+ ### Example
38
94
 
39
- if (error) {
40
- console.error(error.message);
41
- // Handle potential network or bad request error
42
- // A link to our docs will be in the `error.docs` field
43
- return;
95
+ ```typescript
96
+ import { Unkey } from "@unkey/api";
97
+
98
+ const unkey = new Unkey({
99
+ rootKey: "UNKEY_ROOT_KEY",
100
+ });
101
+
102
+ async function run() {
103
+ const result = await unkey.ratelimit.limit({
104
+ namespace: "sms.sign_up",
105
+ duration: 455106,
106
+ identifier: "<value>",
107
+ limit: 568662,
108
+ });
109
+
110
+ // Handle the result
111
+ console.log(result);
44
112
  }
45
113
 
46
- if (!result.valid) {
47
- // Do not grant access
48
- return;
114
+ run();
115
+
116
+ ```
117
+ <!-- End SDK Example Usage [usage] -->
118
+
119
+ <!-- Start Authentication [security] -->
120
+ ## Authentication
121
+
122
+ ### Per-Client Security Schemes
123
+
124
+ This SDK supports the following security scheme globally:
125
+
126
+ | Name | Type | Scheme | Environment Variable |
127
+ | --------- | ---- | ----------- | -------------------- |
128
+ | `rootKey` | http | HTTP Bearer | `UNKEY_ROOT_KEY` |
129
+
130
+ To authenticate with the API the `rootKey` parameter must be set when initializing the SDK client instance. For example:
131
+ ```typescript
132
+ import { Unkey } from "@unkey/api";
133
+
134
+ const unkey = new Unkey({
135
+ rootKey: "UNKEY_ROOT_KEY",
136
+ });
137
+
138
+ async function run() {
139
+ const result = await unkey.ratelimit.limit({
140
+ namespace: "sms.sign_up",
141
+ duration: 455106,
142
+ identifier: "<value>",
143
+ limit: 568662,
144
+ });
145
+
146
+ // Handle the result
147
+ console.log(result);
49
148
  }
50
149
 
51
- // Process request
52
- console.log(result);
150
+ run();
151
+
53
152
  ```
153
+ <!-- End Authentication [security] -->
154
+
155
+ <!-- Start Available Resources and Operations [operations] -->
156
+ ## Available Resources and Operations
157
+
158
+ <details open>
159
+ <summary>Available methods</summary>
160
+
161
+ ### [liveness](docs/sdks/liveness/README.md)
54
162
 
55
- ## Response Format
163
+ * [check](docs/sdks/liveness/README.md#check) - Liveness check
56
164
 
57
- All methods return either an `error` or a `result` field, never both and never none. This approach helps with proper error handling.
165
+ ### [ratelimit](docs/sdks/ratelimit/README.md)
166
+
167
+ * [limit](docs/sdks/ratelimit/README.md#limit) - TODO
168
+ * [setOverride](docs/sdks/ratelimit/README.md#setoverride)
169
+ * [getOverride](docs/sdks/ratelimit/README.md#getoverride)
170
+ * [deleteOverride](docs/sdks/ratelimit/README.md#deleteoverride)
171
+
172
+
173
+ </details>
174
+ <!-- End Available Resources and Operations [operations] -->
175
+
176
+ <!-- Start Standalone functions [standalone-funcs] -->
177
+ ## Standalone functions
178
+
179
+ All the methods listed above are available as standalone functions. These
180
+ functions are ideal for use in applications running in the browser, serverless
181
+ runtimes or other environments where application bundle size is a primary
182
+ concern. When using a bundler to build your application, all unused
183
+ functionality will be either excluded from the final bundle or tree-shaken away.
184
+
185
+ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
186
+
187
+ <details>
188
+
189
+ <summary>Available standalone functions</summary>
190
+
191
+ - [`livenessCheck`](docs/sdks/liveness/README.md#check) - Liveness check
192
+ - [`ratelimitDeleteOverride`](docs/sdks/ratelimit/README.md#deleteoverride)
193
+ - [`ratelimitGetOverride`](docs/sdks/ratelimit/README.md#getoverride)
194
+ - [`ratelimitLimit`](docs/sdks/ratelimit/README.md#limit) - TODO
195
+ - [`ratelimitSetOverride`](docs/sdks/ratelimit/README.md#setoverride)
196
+
197
+ </details>
198
+ <!-- End Standalone functions [standalone-funcs] -->
199
+
200
+ <!-- Start Retries [retries] -->
201
+ ## Retries
202
+
203
+ Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
204
+
205
+ To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
206
+ ```typescript
207
+ import { Unkey } from "@unkey/api";
58
208
 
59
- ### Success Response
209
+ const unkey = new Unkey({
210
+ rootKey: "UNKEY_ROOT_KEY",
211
+ });
60
212
 
61
- ```ts
62
- {
63
- result: T; // The result depends on what method you called
213
+ async function run() {
214
+ const result = await unkey.ratelimit.limit({
215
+ namespace: "sms.sign_up",
216
+ duration: 455106,
217
+ identifier: "<value>",
218
+ limit: 568662,
219
+ }, {
220
+ retries: {
221
+ strategy: "backoff",
222
+ backoff: {
223
+ initialInterval: 1,
224
+ maxInterval: 50,
225
+ exponent: 1.1,
226
+ maxElapsedTime: 100,
227
+ },
228
+ retryConnectionErrors: false,
229
+ },
230
+ });
231
+
232
+ // Handle the result
233
+ console.log(result);
64
234
  }
235
+
236
+ run();
237
+
65
238
  ```
66
239
 
67
- ### Error Response
240
+ If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
241
+ ```typescript
242
+ import { Unkey } from "@unkey/api";
68
243
 
69
- ```ts
70
- {
71
- error: {
72
- message: string;
73
- docs: string; // URL to relevant documentation
74
- }
244
+ const unkey = new Unkey({
245
+ retryConfig: {
246
+ strategy: "backoff",
247
+ backoff: {
248
+ initialInterval: 1,
249
+ maxInterval: 50,
250
+ exponent: 1.1,
251
+ maxElapsedTime: 100,
252
+ },
253
+ retryConnectionErrors: false,
254
+ },
255
+ rootKey: "UNKEY_ROOT_KEY",
256
+ });
257
+
258
+ async function run() {
259
+ const result = await unkey.ratelimit.limit({
260
+ namespace: "sms.sign_up",
261
+ duration: 455106,
262
+ identifier: "<value>",
263
+ limit: 568662,
264
+ });
265
+
266
+ // Handle the result
267
+ console.log(result);
75
268
  }
269
+
270
+ run();
271
+
76
272
  ```
273
+ <!-- End Retries [retries] -->
274
+
275
+ <!-- Start Error Handling [errors] -->
276
+ ## Error Handling
277
+
278
+ Some methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `limit` method may throw the following errors:
77
279
 
78
- ## Configuration Options
280
+ | Error Type | Status Code | Content Type |
281
+ | -------------------------- | ----------- | ------------------------ |
282
+ | errors.BadRequestError | 400 | application/problem+json |
283
+ | errors.UnauthorizedError | 401 | application/problem+json |
284
+ | errors.ForbiddenError | 403 | application/problem+json |
285
+ | errors.NotFoundError | 404 | application/problem+json |
286
+ | errors.InternalServerError | 500 | application/problem+json |
287
+ | errors.APIError | 4XX, 5XX | \*/\* |
79
288
 
80
- ### Base URL
289
+ If the method throws an error and it is not captured by the known errors, it will default to throwing a `APIError`.
81
290
 
82
- You can customize the base URL for all requests:
291
+ ```typescript
292
+ import { Unkey } from "@unkey/api";
293
+ import {
294
+ BadRequestError,
295
+ ForbiddenError,
296
+ InternalServerError,
297
+ NotFoundError,
298
+ SDKValidationError,
299
+ UnauthorizedError,
300
+ } from "@unkey/api/models/errors";
83
301
 
84
- ```ts
85
302
  const unkey = new Unkey({
86
- rootKey: "<UNKEY_ROOT_KEY>",
87
- baseUrl: "https://my.domain",
303
+ rootKey: "UNKEY_ROOT_KEY",
88
304
  });
305
+
306
+ async function run() {
307
+ let result;
308
+ try {
309
+ result = await unkey.ratelimit.limit({
310
+ namespace: "sms.sign_up",
311
+ duration: 455106,
312
+ identifier: "<value>",
313
+ limit: 568662,
314
+ });
315
+
316
+ // Handle the result
317
+ console.log(result);
318
+ } catch (err) {
319
+ switch (true) {
320
+ // The server response does not match the expected SDK schema
321
+ case (err instanceof SDKValidationError): {
322
+ // Pretty-print will provide a human-readable multi-line error message
323
+ console.error(err.pretty());
324
+ // Raw value may also be inspected
325
+ console.error(err.rawValue);
326
+ return;
327
+ }
328
+ case (err instanceof BadRequestError): {
329
+ // Handle err.data$: BadRequestErrorData
330
+ console.error(err);
331
+ return;
332
+ }
333
+ case (err instanceof UnauthorizedError): {
334
+ // Handle err.data$: UnauthorizedErrorData
335
+ console.error(err);
336
+ return;
337
+ }
338
+ case (err instanceof ForbiddenError): {
339
+ // Handle err.data$: ForbiddenErrorData
340
+ console.error(err);
341
+ return;
342
+ }
343
+ case (err instanceof NotFoundError): {
344
+ // Handle err.data$: NotFoundErrorData
345
+ console.error(err);
346
+ return;
347
+ }
348
+ case (err instanceof InternalServerError): {
349
+ // Handle err.data$: InternalServerErrorData
350
+ console.error(err);
351
+ return;
352
+ }
353
+ default: {
354
+ // Other errors such as network errors, see HTTPClientErrors for more details
355
+ throw err;
356
+ }
357
+ }
358
+ }
359
+ }
360
+
361
+ run();
362
+
89
363
  ```
90
364
 
91
- ### Retries
365
+ Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.
366
+
367
+ In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the `models/errors/httpclienterrors.ts` module:
368
+
369
+ | HTTP Client Error | Description |
370
+ | ---------------------------------------------------- | ---------------------------------------------------- |
371
+ | RequestAbortedError | HTTP request was aborted by the client |
372
+ | RequestTimeoutError | HTTP request timed out due to an AbortSignal signal |
373
+ | ConnectionError | HTTP client was unable to make a request to a server |
374
+ | InvalidRequestError | Any input used to create a request is invalid |
375
+ | UnexpectedClientError | Unrecognised or unexpected error |
376
+ <!-- End Error Handling [errors] -->
92
377
 
93
- Configure retry behavior for network errors:
378
+ <!-- Start Server Selection [server] -->
379
+ ## Server Selection
380
+
381
+ ### Override Server URL Per-Client
382
+
383
+ The default server can be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
384
+ ```typescript
385
+ import { Unkey } from "@unkey/api";
94
386
 
95
- ```ts
96
387
  const unkey = new Unkey({
97
- rootKey: "<UNKEY_ROOT_KEY>",
98
- retry: {
99
- attempts: 3,
100
- backoff: (retryCount) => retryCount * 1000,
101
- },
388
+ serverURL: "https://api.unkey.com",
389
+ rootKey: "UNKEY_ROOT_KEY",
102
390
  });
391
+
392
+ async function run() {
393
+ const result = await unkey.ratelimit.limit({
394
+ namespace: "sms.sign_up",
395
+ duration: 455106,
396
+ identifier: "<value>",
397
+ limit: 568662,
398
+ });
399
+
400
+ // Handle the result
401
+ console.log(result);
402
+ }
403
+
404
+ run();
405
+
103
406
  ```
407
+ <!-- End Server Selection [server] -->
104
408
 
105
- ### Disable Telemetry
409
+ <!-- Start Custom HTTP Client [http-client] -->
410
+ ## Custom HTTP Client
106
411
 
107
- To opt out of anonymous telemetry data collection:
412
+ The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native
413
+ [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). This
414
+ client is a thin wrapper around `fetch` and provides the ability to attach hooks
415
+ around the request lifecycle that can be used to modify the request or handle
416
+ errors and response.
108
417
 
109
- ```ts
110
- const unkey = new Unkey({
111
- rootKey: "<UNKEY_ROOT_KEY>",
112
- disableTelemetry: true,
418
+ The `HTTPClient` constructor takes an optional `fetcher` argument that can be
419
+ used to integrate a third-party HTTP client or when writing tests to mock out
420
+ the HTTP client and feed in fixtures.
421
+
422
+ The following example shows how to use the `"beforeRequest"` hook to to add a
423
+ custom header and a timeout to requests and how to use the `"requestError"` hook
424
+ to log errors:
425
+
426
+ ```typescript
427
+ import { Unkey } from "@unkey/api";
428
+ import { HTTPClient } from "@unkey/api/lib/http";
429
+
430
+ const httpClient = new HTTPClient({
431
+ // fetcher takes a function that has the same signature as native `fetch`.
432
+ fetcher: (request) => {
433
+ return fetch(request);
434
+ }
113
435
  });
436
+
437
+ httpClient.addHook("beforeRequest", (request) => {
438
+ const nextRequest = new Request(request, {
439
+ signal: request.signal || AbortSignal.timeout(5000)
440
+ });
441
+
442
+ nextRequest.headers.set("x-custom-header", "custom value");
443
+
444
+ return nextRequest;
445
+ });
446
+
447
+ httpClient.addHook("requestError", (error, request) => {
448
+ console.group("Request Error");
449
+ console.log("Reason:", `${error}`);
450
+ console.log("Endpoint:", `${request.method} ${request.url}`);
451
+ console.groupEnd();
452
+ });
453
+
454
+ const sdk = new Unkey({ httpClient });
114
455
  ```
456
+ <!-- End Custom HTTP Client [http-client] -->
457
+
458
+ <!-- Start Debugging [debug] -->
459
+ ## Debugging
460
+
461
+ You can setup your SDK to emit debug logs for SDK requests and responses.
462
+
463
+ You can pass a logger that matches `console`'s interface as an SDK option.
464
+
465
+ > [!WARNING]
466
+ > Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
467
+
468
+ ```typescript
469
+ import { Unkey } from "@unkey/api";
470
+
471
+ const sdk = new Unkey({ debugLogger: console });
472
+ ```
473
+
474
+ You can also enable a default debug logger by setting an environment variable `UNKEY_DEBUG` to true.
475
+ <!-- End Debugging [debug] -->
476
+
477
+ <!-- Placeholder for Future Speakeasy SDK Sections -->
478
+
479
+ # Development
480
+
481
+ ## Maturity
482
+
483
+ This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
484
+ to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
485
+ looking for the latest version.
486
+
487
+ ## Contributions
115
488
 
116
- ### Documentation
489
+ While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation.
490
+ We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.
117
491
 
118
- [Read the full documentation](https://www.unkey.com/docs/libraries/ts/sdk/overview)
492
+ ### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=@unkey/api&utm_campaign=typescript)
package/RUNTIMES.md ADDED
@@ -0,0 +1,48 @@
1
+ # Supported JavaScript runtimes
2
+
3
+ This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features:
4
+
5
+ * [Web Fetch API][web-fetch]
6
+ * [Web Streams API][web-streams] and in particular `ReadableStream`
7
+ * [Async iterables][async-iter] using `Symbol.asyncIterator`
8
+
9
+ [web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
10
+ [web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
11
+ [async-iter]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_async_iterator_and_async_iterable_protocols
12
+
13
+ Runtime environments that are explicitly supported are:
14
+
15
+ - Evergreen browsers which include: Chrome, Safari, Edge, Firefox
16
+ - Node.js active and maintenance LTS releases
17
+ - Currently, this is v18 and v20
18
+ - Bun v1 and above
19
+ - Deno v1.39
20
+ - Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
21
+
22
+ [deno-file-streaming]: https://github.com/denoland/deno/issues/11018
23
+
24
+ ## Recommended TypeScript compiler options
25
+
26
+ The following `tsconfig.json` options are recommended for projects using this
27
+ SDK in order to get static type support for features like async iterables,
28
+ streams and `fetch`-related APIs ([`for await...of`][for-await-of],
29
+ [`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and
30
+ so on):
31
+
32
+ [for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
33
+ [abort-signal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
34
+ [request]: https://developer.mozilla.org/en-US/docs/Web/API/Request
35
+ [response]: https://developer.mozilla.org/en-US/docs/Web/API/Response
36
+
37
+ ```jsonc
38
+ {
39
+ "compilerOptions": {
40
+ "target": "es2020", // or higher
41
+ "lib": ["es2020", "dom", "dom.iterable"],
42
+ }
43
+ }
44
+ ```
45
+
46
+ While `target` can be set to older ECMAScript versions, it may result in extra,
47
+ unnecessary compatibility code being generated if you are not targeting old
48
+ runtimes.
@@ -0,0 +1,10 @@
1
+ import { ClientSDK } from "./lib/sdks.js";
2
+ /**
3
+ * A minimal client to use when calling standalone SDK functions. Typically, an
4
+ * instance of this class would be instantiated once at the start of an
5
+ * application and passed around through some dependency injection mechanism to
6
+ * parts of an application that need to make SDK calls.
7
+ */
8
+ export declare class UnkeyCore extends ClientSDK {
9
+ }
10
+ //# sourceMappingURL=core.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../../src/core.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C;;;;;GAKG;AACH,qBAAa,SAAU,SAAQ,SAAS;CAAG"}
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+ /*
3
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.UnkeyCore = void 0;
7
+ const sdks_js_1 = require("./lib/sdks.js");
8
+ /**
9
+ * A minimal client to use when calling standalone SDK functions. Typically, an
10
+ * instance of this class would be instantiated once at the start of an
11
+ * application and passed around through some dependency injection mechanism to
12
+ * parts of an application that need to make SDK calls.
13
+ */
14
+ class UnkeyCore extends sdks_js_1.ClientSDK {
15
+ }
16
+ exports.UnkeyCore = UnkeyCore;
17
+ //# sourceMappingURL=core.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"core.js","sourceRoot":"","sources":["../../src/core.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,2CAA0C;AAE1C;;;;;GAKG;AACH,MAAa,SAAU,SAAQ,mBAAS;CAAG;AAA3C,8BAA2C"}
@@ -0,0 +1,17 @@
1
+ import { UnkeyCore } from "../core.js";
2
+ import { RequestOptions } from "../lib/sdks.js";
3
+ import { APIError } from "../models/errors/apierror.js";
4
+ import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
5
+ import * as errors from "../models/errors/index.js";
6
+ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
7
+ import * as operations from "../models/operations/index.js";
8
+ import { APIPromise } from "../types/async.js";
9
+ import { Result } from "../types/fp.js";
10
+ /**
11
+ * Liveness check
12
+ *
13
+ * @remarks
14
+ * This endpoint checks if the service is alive.
15
+ */
16
+ export declare function livenessCheck(client: UnkeyCore, options?: RequestOptions): APIPromise<Result<operations.LivenessResponse, errors.PreconditionFailedError | errors.InternalServerError | APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
17
+ //# sourceMappingURL=livenessCheck.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"livenessCheck.d.ts","sourceRoot":"","sources":["../../../src/funcs/livenessCheck.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAGvC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;GAKG;AACH,wBAAgB,aAAa,CAC3B,MAAM,EAAE,SAAS,EACjB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,UAAU,CAAC,gBAAgB,EACzB,MAAM,CAAC,uBAAuB,GAC9B,MAAM,CAAC,mBAAmB,GAC1B,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CAKA"}