@crevio/sdk 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (336) hide show
  1. package/README.md +8 -12
  2. package/RUNTIMES.md +6 -6
  3. package/dist/commonjs/funcs/accountsGet.js +1 -1
  4. package/dist/commonjs/funcs/accountsGet.js.map +1 -1
  5. package/dist/commonjs/funcs/checkoutsCreate.js +1 -1
  6. package/dist/commonjs/funcs/checkoutsCreate.js.map +1 -1
  7. package/dist/commonjs/funcs/productsGet.js +1 -1
  8. package/dist/commonjs/funcs/productsGet.js.map +1 -1
  9. package/dist/commonjs/funcs/productsList.js +2 -2
  10. package/dist/commonjs/funcs/productsList.js.map +1 -1
  11. package/dist/commonjs/funcs/userDelete.js +1 -1
  12. package/dist/commonjs/funcs/userDelete.js.map +1 -1
  13. package/dist/commonjs/funcs/userGet.js +1 -1
  14. package/dist/commonjs/funcs/userGet.js.map +1 -1
  15. package/dist/commonjs/hooks/hooks.d.ts.map +1 -1
  16. package/dist/commonjs/hooks/hooks.js +0 -2
  17. package/dist/commonjs/hooks/hooks.js.map +1 -1
  18. package/dist/commonjs/lib/base64.d.ts +1 -1
  19. package/dist/commonjs/lib/base64.d.ts.map +1 -1
  20. package/dist/commonjs/lib/base64.js +1 -1
  21. package/dist/commonjs/lib/base64.js.map +1 -1
  22. package/dist/commonjs/lib/config.d.ts +4 -4
  23. package/dist/commonjs/lib/config.d.ts.map +1 -1
  24. package/dist/commonjs/lib/config.js +5 -5
  25. package/dist/commonjs/lib/config.js.map +1 -1
  26. package/dist/commonjs/lib/encodings.d.ts +1 -0
  27. package/dist/commonjs/lib/encodings.d.ts.map +1 -1
  28. package/dist/commonjs/lib/encodings.js +12 -1
  29. package/dist/commonjs/lib/encodings.js.map +1 -1
  30. package/dist/commonjs/lib/env.d.ts +1 -1
  31. package/dist/commonjs/lib/env.d.ts.map +1 -1
  32. package/dist/commonjs/lib/env.js +19 -2
  33. package/dist/commonjs/lib/env.js.map +1 -1
  34. package/dist/commonjs/lib/schemas.d.ts +1 -1
  35. package/dist/commonjs/lib/schemas.d.ts.map +1 -1
  36. package/dist/commonjs/lib/schemas.js +2 -2
  37. package/dist/commonjs/lib/schemas.js.map +1 -1
  38. package/dist/commonjs/lib/security.d.ts.map +1 -1
  39. package/dist/commonjs/lib/security.js.map +1 -1
  40. package/dist/commonjs/lib/url.js +1 -1
  41. package/dist/commonjs/lib/url.js.map +1 -1
  42. package/dist/commonjs/models/account.d.ts +4 -29
  43. package/dist/commonjs/models/account.d.ts.map +1 -1
  44. package/dist/commonjs/models/account.js +2 -34
  45. package/dist/commonjs/models/account.js.map +1 -1
  46. package/dist/commonjs/models/accountslim.d.ts +1 -22
  47. package/dist/commonjs/models/accountslim.d.ts.map +1 -1
  48. package/dist/commonjs/models/accountslim.js +2 -23
  49. package/dist/commonjs/models/accountslim.js.map +1 -1
  50. package/dist/commonjs/models/checkoutrequest.d.ts +1 -48
  51. package/dist/commonjs/models/checkoutrequest.d.ts.map +1 -1
  52. package/dist/commonjs/models/checkoutrequest.js +2 -78
  53. package/dist/commonjs/models/checkoutrequest.js.map +1 -1
  54. package/dist/commonjs/models/checkoutresponse.d.ts +1 -21
  55. package/dist/commonjs/models/checkoutresponse.d.ts.map +1 -1
  56. package/dist/commonjs/models/checkoutresponse.js +2 -27
  57. package/dist/commonjs/models/checkoutresponse.js.map +1 -1
  58. package/dist/commonjs/models/errors/error.d.ts +1 -20
  59. package/dist/commonjs/models/errors/error.d.ts.map +1 -1
  60. package/dist/commonjs/models/errors/error.js +2 -20
  61. package/dist/commonjs/models/errors/error.js.map +1 -1
  62. package/dist/commonjs/models/errors/index.d.ts +1 -0
  63. package/dist/commonjs/models/errors/index.d.ts.map +1 -1
  64. package/dist/commonjs/models/errors/index.js +1 -0
  65. package/dist/commonjs/models/errors/index.js.map +1 -1
  66. package/dist/commonjs/models/errors/responsevalidationerror.js +1 -1
  67. package/dist/commonjs/models/errors/responsevalidationerror.js.map +1 -1
  68. package/dist/commonjs/models/errors/sdkvalidationerror.d.ts +1 -1
  69. package/dist/commonjs/models/errors/sdkvalidationerror.d.ts.map +1 -1
  70. package/dist/commonjs/models/errors/sdkvalidationerror.js +1 -1
  71. package/dist/commonjs/models/errors/sdkvalidationerror.js.map +1 -1
  72. package/dist/commonjs/models/fileattachment.d.ts +1 -24
  73. package/dist/commonjs/models/fileattachment.d.ts.map +1 -1
  74. package/dist/commonjs/models/fileattachment.js +2 -30
  75. package/dist/commonjs/models/fileattachment.js.map +1 -1
  76. package/dist/commonjs/models/imageattachment.d.ts +1 -24
  77. package/dist/commonjs/models/imageattachment.d.ts.map +1 -1
  78. package/dist/commonjs/models/imageattachment.js +2 -30
  79. package/dist/commonjs/models/imageattachment.js.map +1 -1
  80. package/dist/commonjs/models/linkinbiopage.d.ts +1 -22
  81. package/dist/commonjs/models/linkinbiopage.d.ts.map +1 -1
  82. package/dist/commonjs/models/linkinbiopage.js +2 -23
  83. package/dist/commonjs/models/linkinbiopage.js.map +1 -1
  84. package/dist/commonjs/models/operations/delete.d.ts +1 -18
  85. package/dist/commonjs/models/operations/delete.d.ts.map +1 -1
  86. package/dist/commonjs/models/operations/delete.js +2 -19
  87. package/dist/commonjs/models/operations/delete.js.map +1 -1
  88. package/dist/commonjs/models/operations/getaccount.d.ts +1 -18
  89. package/dist/commonjs/models/operations/getaccount.d.ts.map +1 -1
  90. package/dist/commonjs/models/operations/getaccount.js +2 -26
  91. package/dist/commonjs/models/operations/getaccount.js.map +1 -1
  92. package/dist/commonjs/models/operations/getproduct.d.ts +1 -18
  93. package/dist/commonjs/models/operations/getproduct.d.ts.map +1 -1
  94. package/dist/commonjs/models/operations/getproduct.js +2 -26
  95. package/dist/commonjs/models/operations/getproduct.js.map +1 -1
  96. package/dist/commonjs/models/pricevariant.d.ts +1 -27
  97. package/dist/commonjs/models/pricevariant.d.ts.map +1 -1
  98. package/dist/commonjs/models/pricevariant.js +2 -32
  99. package/dist/commonjs/models/pricevariant.js.map +1 -1
  100. package/dist/commonjs/models/product.d.ts +8 -62
  101. package/dist/commonjs/models/product.d.ts.map +1 -1
  102. package/dist/commonjs/models/product.js +3 -61
  103. package/dist/commonjs/models/product.js.map +1 -1
  104. package/dist/commonjs/models/review.d.ts +1 -23
  105. package/dist/commonjs/models/review.d.ts.map +1 -1
  106. package/dist/commonjs/models/review.js +2 -28
  107. package/dist/commonjs/models/review.js.map +1 -1
  108. package/dist/commonjs/models/security.d.ts +1 -18
  109. package/dist/commonjs/models/security.d.ts.map +1 -1
  110. package/dist/commonjs/models/security.js +2 -26
  111. package/dist/commonjs/models/security.js.map +1 -1
  112. package/dist/commonjs/models/seo.d.ts +1 -22
  113. package/dist/commonjs/models/seo.d.ts.map +1 -1
  114. package/dist/commonjs/models/seo.js +2 -24
  115. package/dist/commonjs/models/seo.js.map +1 -1
  116. package/dist/commonjs/models/sociallink.d.ts +1 -23
  117. package/dist/commonjs/models/sociallink.d.ts.map +1 -1
  118. package/dist/commonjs/models/sociallink.js +2 -24
  119. package/dist/commonjs/models/sociallink.js.map +1 -1
  120. package/dist/commonjs/models/user.d.ts +3 -39
  121. package/dist/commonjs/models/user.d.ts.map +1 -1
  122. package/dist/commonjs/models/user.js +2 -54
  123. package/dist/commonjs/models/user.js.map +1 -1
  124. package/dist/commonjs/types/blobs.d.ts +1 -1
  125. package/dist/commonjs/types/blobs.d.ts.map +1 -1
  126. package/dist/commonjs/types/blobs.js +1 -1
  127. package/dist/commonjs/types/blobs.js.map +1 -1
  128. package/dist/commonjs/types/constdatetime.d.ts +1 -1
  129. package/dist/commonjs/types/constdatetime.d.ts.map +1 -1
  130. package/dist/commonjs/types/constdatetime.js +1 -1
  131. package/dist/commonjs/types/constdatetime.js.map +1 -1
  132. package/dist/commonjs/types/enums.d.ts +8 -11
  133. package/dist/commonjs/types/enums.d.ts.map +1 -1
  134. package/dist/commonjs/types/enums.js +59 -3
  135. package/dist/commonjs/types/enums.js.map +1 -1
  136. package/dist/commonjs/types/index.d.ts +2 -2
  137. package/dist/commonjs/types/index.d.ts.map +1 -1
  138. package/dist/commonjs/types/index.js +16 -3
  139. package/dist/commonjs/types/index.js.map +1 -1
  140. package/dist/commonjs/types/unrecognized.d.ts +16 -0
  141. package/dist/commonjs/types/unrecognized.d.ts.map +1 -0
  142. package/dist/commonjs/types/unrecognized.js +34 -0
  143. package/dist/commonjs/types/unrecognized.js.map +1 -0
  144. package/dist/esm/funcs/accountsGet.js +1 -1
  145. package/dist/esm/funcs/accountsGet.js.map +1 -1
  146. package/dist/esm/funcs/checkoutsCreate.js +1 -1
  147. package/dist/esm/funcs/checkoutsCreate.js.map +1 -1
  148. package/dist/esm/funcs/productsGet.js +1 -1
  149. package/dist/esm/funcs/productsGet.js.map +1 -1
  150. package/dist/esm/funcs/productsList.js +2 -2
  151. package/dist/esm/funcs/productsList.js.map +1 -1
  152. package/dist/esm/funcs/userDelete.js +1 -1
  153. package/dist/esm/funcs/userDelete.js.map +1 -1
  154. package/dist/esm/funcs/userGet.js +1 -1
  155. package/dist/esm/funcs/userGet.js.map +1 -1
  156. package/dist/esm/hooks/hooks.d.ts.map +1 -1
  157. package/dist/esm/hooks/hooks.js +0 -2
  158. package/dist/esm/hooks/hooks.js.map +1 -1
  159. package/dist/esm/lib/base64.d.ts +1 -1
  160. package/dist/esm/lib/base64.d.ts.map +1 -1
  161. package/dist/esm/lib/base64.js +1 -1
  162. package/dist/esm/lib/base64.js.map +1 -1
  163. package/dist/esm/lib/config.d.ts +4 -4
  164. package/dist/esm/lib/config.d.ts.map +1 -1
  165. package/dist/esm/lib/config.js +5 -5
  166. package/dist/esm/lib/config.js.map +1 -1
  167. package/dist/esm/lib/encodings.d.ts +1 -0
  168. package/dist/esm/lib/encodings.d.ts.map +1 -1
  169. package/dist/esm/lib/encodings.js +12 -1
  170. package/dist/esm/lib/encodings.js.map +1 -1
  171. package/dist/esm/lib/env.d.ts +1 -1
  172. package/dist/esm/lib/env.d.ts.map +1 -1
  173. package/dist/esm/lib/env.js +19 -2
  174. package/dist/esm/lib/env.js.map +1 -1
  175. package/dist/esm/lib/schemas.d.ts +1 -1
  176. package/dist/esm/lib/schemas.d.ts.map +1 -1
  177. package/dist/esm/lib/schemas.js +1 -1
  178. package/dist/esm/lib/schemas.js.map +1 -1
  179. package/dist/esm/lib/security.d.ts.map +1 -1
  180. package/dist/esm/lib/security.js.map +1 -1
  181. package/dist/esm/lib/url.js +1 -1
  182. package/dist/esm/lib/url.js.map +1 -1
  183. package/dist/esm/models/account.d.ts +4 -29
  184. package/dist/esm/models/account.d.ts.map +1 -1
  185. package/dist/esm/models/account.js +4 -35
  186. package/dist/esm/models/account.js.map +1 -1
  187. package/dist/esm/models/accountslim.d.ts +1 -22
  188. package/dist/esm/models/accountslim.d.ts.map +1 -1
  189. package/dist/esm/models/accountslim.js +1 -21
  190. package/dist/esm/models/accountslim.js.map +1 -1
  191. package/dist/esm/models/checkoutrequest.d.ts +1 -48
  192. package/dist/esm/models/checkoutrequest.d.ts.map +1 -1
  193. package/dist/esm/models/checkoutrequest.js +1 -74
  194. package/dist/esm/models/checkoutrequest.js.map +1 -1
  195. package/dist/esm/models/checkoutresponse.d.ts +1 -21
  196. package/dist/esm/models/checkoutresponse.d.ts.map +1 -1
  197. package/dist/esm/models/checkoutresponse.js +1 -25
  198. package/dist/esm/models/checkoutresponse.js.map +1 -1
  199. package/dist/esm/models/errors/error.d.ts +1 -20
  200. package/dist/esm/models/errors/error.d.ts.map +1 -1
  201. package/dist/esm/models/errors/error.js +1 -19
  202. package/dist/esm/models/errors/error.js.map +1 -1
  203. package/dist/esm/models/errors/index.d.ts +1 -0
  204. package/dist/esm/models/errors/index.d.ts.map +1 -1
  205. package/dist/esm/models/errors/index.js +1 -0
  206. package/dist/esm/models/errors/index.js.map +1 -1
  207. package/dist/esm/models/errors/responsevalidationerror.js +1 -1
  208. package/dist/esm/models/errors/responsevalidationerror.js.map +1 -1
  209. package/dist/esm/models/errors/sdkvalidationerror.d.ts +1 -1
  210. package/dist/esm/models/errors/sdkvalidationerror.d.ts.map +1 -1
  211. package/dist/esm/models/errors/sdkvalidationerror.js +1 -1
  212. package/dist/esm/models/errors/sdkvalidationerror.js.map +1 -1
  213. package/dist/esm/models/fileattachment.d.ts +1 -24
  214. package/dist/esm/models/fileattachment.d.ts.map +1 -1
  215. package/dist/esm/models/fileattachment.js +1 -28
  216. package/dist/esm/models/fileattachment.js.map +1 -1
  217. package/dist/esm/models/imageattachment.d.ts +1 -24
  218. package/dist/esm/models/imageattachment.d.ts.map +1 -1
  219. package/dist/esm/models/imageattachment.js +1 -28
  220. package/dist/esm/models/imageattachment.js.map +1 -1
  221. package/dist/esm/models/linkinbiopage.d.ts +1 -22
  222. package/dist/esm/models/linkinbiopage.d.ts.map +1 -1
  223. package/dist/esm/models/linkinbiopage.js +1 -21
  224. package/dist/esm/models/linkinbiopage.js.map +1 -1
  225. package/dist/esm/models/operations/delete.d.ts +1 -18
  226. package/dist/esm/models/operations/delete.d.ts.map +1 -1
  227. package/dist/esm/models/operations/delete.js +1 -17
  228. package/dist/esm/models/operations/delete.js.map +1 -1
  229. package/dist/esm/models/operations/getaccount.d.ts +1 -18
  230. package/dist/esm/models/operations/getaccount.d.ts.map +1 -1
  231. package/dist/esm/models/operations/getaccount.js +1 -24
  232. package/dist/esm/models/operations/getaccount.js.map +1 -1
  233. package/dist/esm/models/operations/getproduct.d.ts +1 -18
  234. package/dist/esm/models/operations/getproduct.d.ts.map +1 -1
  235. package/dist/esm/models/operations/getproduct.js +1 -24
  236. package/dist/esm/models/operations/getproduct.js.map +1 -1
  237. package/dist/esm/models/pricevariant.d.ts +1 -27
  238. package/dist/esm/models/pricevariant.d.ts.map +1 -1
  239. package/dist/esm/models/pricevariant.js +1 -30
  240. package/dist/esm/models/pricevariant.js.map +1 -1
  241. package/dist/esm/models/product.d.ts +8 -62
  242. package/dist/esm/models/product.d.ts.map +1 -1
  243. package/dist/esm/models/product.js +8 -65
  244. package/dist/esm/models/product.js.map +1 -1
  245. package/dist/esm/models/review.d.ts +1 -23
  246. package/dist/esm/models/review.d.ts.map +1 -1
  247. package/dist/esm/models/review.js +1 -26
  248. package/dist/esm/models/review.js.map +1 -1
  249. package/dist/esm/models/security.d.ts +1 -18
  250. package/dist/esm/models/security.d.ts.map +1 -1
  251. package/dist/esm/models/security.js +1 -24
  252. package/dist/esm/models/security.js.map +1 -1
  253. package/dist/esm/models/seo.d.ts +1 -22
  254. package/dist/esm/models/seo.d.ts.map +1 -1
  255. package/dist/esm/models/seo.js +1 -22
  256. package/dist/esm/models/seo.js.map +1 -1
  257. package/dist/esm/models/sociallink.d.ts +1 -23
  258. package/dist/esm/models/sociallink.d.ts.map +1 -1
  259. package/dist/esm/models/sociallink.js +1 -22
  260. package/dist/esm/models/sociallink.js.map +1 -1
  261. package/dist/esm/models/user.d.ts +3 -39
  262. package/dist/esm/models/user.d.ts.map +1 -1
  263. package/dist/esm/models/user.js +3 -54
  264. package/dist/esm/models/user.js.map +1 -1
  265. package/dist/esm/types/blobs.d.ts +1 -1
  266. package/dist/esm/types/blobs.d.ts.map +1 -1
  267. package/dist/esm/types/blobs.js +1 -1
  268. package/dist/esm/types/blobs.js.map +1 -1
  269. package/dist/esm/types/constdatetime.d.ts +1 -1
  270. package/dist/esm/types/constdatetime.d.ts.map +1 -1
  271. package/dist/esm/types/constdatetime.js +1 -1
  272. package/dist/esm/types/constdatetime.js.map +1 -1
  273. package/dist/esm/types/enums.d.ts +8 -11
  274. package/dist/esm/types/enums.d.ts.map +1 -1
  275. package/dist/esm/types/enums.js +22 -2
  276. package/dist/esm/types/enums.js.map +1 -1
  277. package/dist/esm/types/index.d.ts +2 -2
  278. package/dist/esm/types/index.d.ts.map +1 -1
  279. package/dist/esm/types/index.js +1 -1
  280. package/dist/esm/types/index.js.map +1 -1
  281. package/dist/esm/types/unrecognized.d.ts +16 -0
  282. package/dist/esm/types/unrecognized.d.ts.map +1 -0
  283. package/dist/esm/types/unrecognized.js +31 -0
  284. package/dist/esm/types/unrecognized.js.map +1 -0
  285. package/examples/package-lock.json +4 -4
  286. package/examples/userGet.example.ts +2 -2
  287. package/jsr.json +1 -1
  288. package/package.json +4 -4
  289. package/src/funcs/accountsGet.ts +1 -1
  290. package/src/funcs/checkoutsCreate.ts +1 -1
  291. package/src/funcs/productsGet.ts +1 -1
  292. package/src/funcs/productsList.ts +2 -2
  293. package/src/funcs/userDelete.ts +1 -1
  294. package/src/funcs/userGet.ts +1 -1
  295. package/src/hooks/hooks.ts +0 -3
  296. package/src/lib/base64.ts +1 -1
  297. package/src/lib/config.ts +5 -5
  298. package/src/lib/encodings.ts +17 -3
  299. package/src/lib/env.ts +21 -5
  300. package/src/lib/schemas.ts +1 -1
  301. package/src/lib/security.ts +4 -1
  302. package/src/lib/url.ts +1 -1
  303. package/src/models/account.ts +3 -65
  304. package/src/models/accountslim.ts +1 -36
  305. package/src/models/checkoutrequest.ts +1 -120
  306. package/src/models/checkoutresponse.ts +1 -43
  307. package/src/models/errors/error.ts +1 -32
  308. package/src/models/errors/index.ts +1 -0
  309. package/src/models/errors/responsevalidationerror.ts +1 -1
  310. package/src/models/errors/sdkvalidationerror.ts +1 -1
  311. package/src/models/fileattachment.ts +1 -45
  312. package/src/models/imageattachment.ts +1 -47
  313. package/src/models/linkinbiopage.ts +1 -36
  314. package/src/models/operations/delete.ts +1 -28
  315. package/src/models/operations/getaccount.ts +1 -40
  316. package/src/models/operations/getproduct.ts +1 -40
  317. package/src/models/pricevariant.ts +1 -50
  318. package/src/models/product.ts +6 -117
  319. package/src/models/review.ts +1 -42
  320. package/src/models/security.ts +1 -40
  321. package/src/models/seo.ts +1 -33
  322. package/src/models/sociallink.ts +1 -38
  323. package/src/models/user.ts +2 -87
  324. package/src/types/blobs.ts +7 -6
  325. package/src/types/constdatetime.ts +1 -1
  326. package/src/types/enums.ts +38 -9
  327. package/src/types/index.ts +2 -2
  328. package/src/types/unrecognized.ts +35 -0
  329. package/tsconfig.json +0 -1
  330. package/.devcontainer/README.md +0 -30
  331. package/docs/sdks/accounts/README.md +0 -84
  332. package/docs/sdks/checkouts/README.md +0 -96
  333. package/docs/sdks/crevio/README.md +0 -7
  334. package/docs/sdks/products/README.md +0 -154
  335. package/docs/sdks/user/README.md +0 -149
  336. package/examples/README.md +0 -31
@@ -1,154 +0,0 @@
1
- # Products
2
- (*products*)
3
-
4
- ## Overview
5
-
6
- Digital product catalog
7
-
8
- ### Available Operations
9
-
10
- * [list](#list) - List products
11
- * [get](#get) - Get product details
12
-
13
- ## list
14
-
15
- Returns a list of published products for the current account
16
-
17
- ### Example Usage
18
-
19
- <!-- UsageSnippet language="typescript" operationID="list" method="get" path="/products" -->
20
- ```typescript
21
- import { Crevio } from "@crevio/sdk";
22
-
23
- const crevio = new Crevio({
24
- apiKeyAuth: process.env["CREVIO_API_KEY_AUTH"] ?? "",
25
- });
26
-
27
- async function run() {
28
- const result = await crevio.products.list();
29
-
30
- console.log(result);
31
- }
32
-
33
- run();
34
- ```
35
-
36
- ### Standalone function
37
-
38
- The standalone function version of this method:
39
-
40
- ```typescript
41
- import { CrevioCore } from "@crevio/sdk/core.js";
42
- import { productsList } from "@crevio/sdk/funcs/productsList.js";
43
-
44
- // Use `CrevioCore` for best tree-shaking performance.
45
- // You can create one instance of it to use across an application.
46
- const crevio = new CrevioCore({
47
- apiKeyAuth: process.env["CREVIO_API_KEY_AUTH"] ?? "",
48
- });
49
-
50
- async function run() {
51
- const res = await productsList(crevio);
52
- if (res.ok) {
53
- const { value: result } = res;
54
- console.log(result);
55
- } else {
56
- console.log("productsList failed:", res.error);
57
- }
58
- }
59
-
60
- run();
61
- ```
62
-
63
- ### Parameters
64
-
65
- | Parameter | Type | Required | Description |
66
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
67
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
68
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
69
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
70
-
71
- ### Response
72
-
73
- **Promise\<[models.Product[]](../../models/.md)\>**
74
-
75
- ### Errors
76
-
77
- | Error Type | Status Code | Content Type |
78
- | ------------------------- | ------------------------- | ------------------------- |
79
- | errors.ErrorT | 401, 404 | application/json |
80
- | errors.CrevioDefaultError | 4XX, 5XX | \*/\* |
81
-
82
- ## get
83
-
84
- Returns detailed information about a specific product
85
-
86
- ### Example Usage
87
-
88
- <!-- UsageSnippet language="typescript" operationID="getProduct" method="get" path="/products/{prefix_id}" -->
89
- ```typescript
90
- import { Crevio } from "@crevio/sdk";
91
-
92
- const crevio = new Crevio({
93
- apiKeyAuth: process.env["CREVIO_API_KEY_AUTH"] ?? "",
94
- });
95
-
96
- async function run() {
97
- const result = await crevio.products.get({
98
- prefixId: "prod_xyz456",
99
- });
100
-
101
- console.log(result);
102
- }
103
-
104
- run();
105
- ```
106
-
107
- ### Standalone function
108
-
109
- The standalone function version of this method:
110
-
111
- ```typescript
112
- import { CrevioCore } from "@crevio/sdk/core.js";
113
- import { productsGet } from "@crevio/sdk/funcs/productsGet.js";
114
-
115
- // Use `CrevioCore` for best tree-shaking performance.
116
- // You can create one instance of it to use across an application.
117
- const crevio = new CrevioCore({
118
- apiKeyAuth: process.env["CREVIO_API_KEY_AUTH"] ?? "",
119
- });
120
-
121
- async function run() {
122
- const res = await productsGet(crevio, {
123
- prefixId: "prod_xyz456",
124
- });
125
- if (res.ok) {
126
- const { value: result } = res;
127
- console.log(result);
128
- } else {
129
- console.log("productsGet failed:", res.error);
130
- }
131
- }
132
-
133
- run();
134
- ```
135
-
136
- ### Parameters
137
-
138
- | Parameter | Type | Required | Description |
139
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
140
- | `request` | [operations.GetProductRequest](../../models/operations/getproductrequest.md) | :heavy_check_mark: | The request object to use for the request. |
141
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
142
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
143
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
144
-
145
- ### Response
146
-
147
- **Promise\<[models.Product](../../models/product.md)\>**
148
-
149
- ### Errors
150
-
151
- | Error Type | Status Code | Content Type |
152
- | ------------------------- | ------------------------- | ------------------------- |
153
- | errors.ErrorT | 401, 404 | application/json |
154
- | errors.CrevioDefaultError | 4XX, 5XX | \*/\* |
@@ -1,149 +0,0 @@
1
- # User
2
- (*user*)
3
-
4
- ## Overview
5
-
6
- User account management
7
-
8
- ### Available Operations
9
-
10
- * [get](#get) - Get current user information
11
- * [delete](#delete) - Delete current user account
12
-
13
- ## get
14
-
15
- Returns the profile information of the authenticated user
16
-
17
- ### Example Usage
18
-
19
- <!-- UsageSnippet language="typescript" operationID="getMe" method="get" path="/me" -->
20
- ```typescript
21
- import { Crevio } from "@crevio/sdk";
22
-
23
- const crevio = new Crevio({
24
- apiKeyAuth: process.env["CREVIO_API_KEY_AUTH"] ?? "",
25
- });
26
-
27
- async function run() {
28
- const result = await crevio.user.get();
29
-
30
- console.log(result);
31
- }
32
-
33
- run();
34
- ```
35
-
36
- ### Standalone function
37
-
38
- The standalone function version of this method:
39
-
40
- ```typescript
41
- import { CrevioCore } from "@crevio/sdk/core.js";
42
- import { userGet } from "@crevio/sdk/funcs/userGet.js";
43
-
44
- // Use `CrevioCore` for best tree-shaking performance.
45
- // You can create one instance of it to use across an application.
46
- const crevio = new CrevioCore({
47
- apiKeyAuth: process.env["CREVIO_API_KEY_AUTH"] ?? "",
48
- });
49
-
50
- async function run() {
51
- const res = await userGet(crevio);
52
- if (res.ok) {
53
- const { value: result } = res;
54
- console.log(result);
55
- } else {
56
- console.log("userGet failed:", res.error);
57
- }
58
- }
59
-
60
- run();
61
- ```
62
-
63
- ### Parameters
64
-
65
- | Parameter | Type | Required | Description |
66
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
67
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
68
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
69
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
70
-
71
- ### Response
72
-
73
- **Promise\<[models.User](../../models/user.md)\>**
74
-
75
- ### Errors
76
-
77
- | Error Type | Status Code | Content Type |
78
- | ------------------------- | ------------------------- | ------------------------- |
79
- | errors.ErrorT | 401 | application/json |
80
- | errors.CrevioDefaultError | 4XX, 5XX | \*/\* |
81
-
82
- ## delete
83
-
84
- Permanently deletes the authenticated user account
85
-
86
- ### Example Usage
87
-
88
- <!-- UsageSnippet language="typescript" operationID="delete" method="delete" path="/me" -->
89
- ```typescript
90
- import { Crevio } from "@crevio/sdk";
91
-
92
- const crevio = new Crevio({
93
- apiKeyAuth: process.env["CREVIO_API_KEY_AUTH"] ?? "",
94
- });
95
-
96
- async function run() {
97
- const result = await crevio.user.delete();
98
-
99
- console.log(result);
100
- }
101
-
102
- run();
103
- ```
104
-
105
- ### Standalone function
106
-
107
- The standalone function version of this method:
108
-
109
- ```typescript
110
- import { CrevioCore } from "@crevio/sdk/core.js";
111
- import { userDelete } from "@crevio/sdk/funcs/userDelete.js";
112
-
113
- // Use `CrevioCore` for best tree-shaking performance.
114
- // You can create one instance of it to use across an application.
115
- const crevio = new CrevioCore({
116
- apiKeyAuth: process.env["CREVIO_API_KEY_AUTH"] ?? "",
117
- });
118
-
119
- async function run() {
120
- const res = await userDelete(crevio);
121
- if (res.ok) {
122
- const { value: result } = res;
123
- console.log(result);
124
- } else {
125
- console.log("userDelete failed:", res.error);
126
- }
127
- }
128
-
129
- run();
130
- ```
131
-
132
- ### Parameters
133
-
134
- | Parameter | Type | Required | Description |
135
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
136
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
137
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
138
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
139
-
140
- ### Response
141
-
142
- **Promise\<[operations.DeleteResponse](../../models/operations/deleteresponse.md)\>**
143
-
144
- ### Errors
145
-
146
- | Error Type | Status Code | Content Type |
147
- | ------------------------- | ------------------------- | ------------------------- |
148
- | errors.ErrorT | 401 | application/json |
149
- | errors.CrevioDefaultError | 4XX, 5XX | \*/\* |
@@ -1,31 +0,0 @@
1
- # @crevio/sdk Examples
2
-
3
- This directory contains example scripts demonstrating how to use the @crevio/sdk SDK.
4
-
5
- ## Prerequisites
6
-
7
- - Node.js (v18 or higher)
8
- - npm
9
-
10
- ## Setup
11
-
12
- 1. Copy `.env.template` to `.env`:
13
- ```bash
14
- cp .env.template .env
15
- ```
16
-
17
- 2. Edit `.env` and add your actual credentials (API keys, tokens, etc.)
18
-
19
- ## Running the Examples
20
-
21
- To run an example file from the examples directory:
22
-
23
- ```bash
24
- npm run build && npx tsx example.ts
25
- ```
26
-
27
- ## Creating new examples
28
-
29
- Duplicate an existing example file, they won't be overwritten by the generation process.
30
-
31
-