@leonardo-ai/sdk 4.6.0 → 4.14.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 (449) hide show
  1. package/README.md +132 -44
  2. package/docs/sdks/dataset/README.md +16 -21
  3. package/docs/sdks/{element → elements}/README.md +5 -4
  4. package/docs/sdks/{model → image}/README.md +32 -121
  5. package/docs/sdks/initimages/README.md +182 -0
  6. package/docs/sdks/models/README.md +180 -0
  7. package/docs/sdks/motion/README.md +50 -0
  8. package/docs/sdks/pricingcalculator/README.md +48 -0
  9. package/docs/sdks/prompt/README.md +4 -2
  10. package/docs/sdks/realtimecanvas/README.md +190 -0
  11. package/docs/sdks/texture/README.md +92 -0
  12. package/docs/sdks/{initimage → threedmodelassets}/README.md +17 -62
  13. package/docs/sdks/user/README.md +2 -1
  14. package/docs/sdks/variation/README.md +52 -7
  15. package/hooks/hooks.d.ts +5 -1
  16. package/hooks/hooks.d.ts.map +1 -1
  17. package/hooks/hooks.js +11 -0
  18. package/hooks/hooks.js.map +1 -1
  19. package/hooks/index.d.ts +2 -2
  20. package/hooks/index.d.ts.map +1 -1
  21. package/hooks/index.js +2 -2
  22. package/hooks/index.js.map +1 -1
  23. package/hooks/types.d.ts +29 -16
  24. package/hooks/types.d.ts.map +1 -1
  25. package/index.d.ts +2 -2
  26. package/index.d.ts.map +1 -1
  27. package/index.js +2 -2
  28. package/index.js.map +1 -1
  29. package/lib/config.d.ts +6 -5
  30. package/lib/config.d.ts.map +1 -1
  31. package/lib/config.js +5 -5
  32. package/lib/config.js.map +1 -1
  33. package/lib/encodings.d.ts +16 -1
  34. package/lib/encodings.d.ts.map +1 -1
  35. package/lib/encodings.js +55 -23
  36. package/lib/encodings.js.map +1 -1
  37. package/lib/http.d.ts +66 -3
  38. package/lib/http.d.ts.map +1 -1
  39. package/lib/http.js +216 -17
  40. package/lib/http.js.map +1 -1
  41. package/lib/is-plain-object.d.ts +2 -0
  42. package/lib/is-plain-object.d.ts.map +1 -0
  43. package/lib/is-plain-object.js +42 -0
  44. package/lib/is-plain-object.js.map +1 -0
  45. package/lib/primitives.d.ts +16 -0
  46. package/lib/primitives.d.ts.map +1 -0
  47. package/lib/primitives.js +30 -0
  48. package/lib/primitives.js.map +1 -0
  49. package/lib/schemas.d.ts +4 -0
  50. package/lib/schemas.d.ts.map +1 -1
  51. package/lib/schemas.js +22 -26
  52. package/lib/schemas.js.map +1 -1
  53. package/lib/sdks.d.ts +31 -9
  54. package/lib/sdks.d.ts.map +1 -1
  55. package/lib/sdks.js +66 -32
  56. package/lib/sdks.js.map +1 -1
  57. package/lib/security.d.ts +2 -2
  58. package/lib/security.d.ts.map +1 -1
  59. package/package.json +8 -9
  60. package/sdk/dataset.d.ts +4 -4
  61. package/sdk/dataset.d.ts.map +1 -1
  62. package/sdk/dataset.js +111 -129
  63. package/sdk/dataset.js.map +1 -1
  64. package/sdk/{element.d.ts → elements.d.ts} +5 -5
  65. package/sdk/elements.d.ts.map +1 -0
  66. package/sdk/{element.js → elements.js} +29 -35
  67. package/sdk/elements.js.map +1 -0
  68. package/sdk/image.d.ts +36 -0
  69. package/sdk/image.d.ts.map +1 -0
  70. package/sdk/image.js +316 -0
  71. package/sdk/image.js.map +1 -0
  72. package/sdk/index.d.ts +1 -1
  73. package/sdk/index.d.ts.map +1 -1
  74. package/sdk/index.js +1 -1
  75. package/sdk/index.js.map +1 -1
  76. package/sdk/initimages.d.ts +36 -0
  77. package/sdk/initimages.d.ts.map +1 -0
  78. package/sdk/initimages.js +304 -0
  79. package/sdk/initimages.js.map +1 -0
  80. package/sdk/models/errors/index.d.ts +2 -2
  81. package/sdk/models/errors/index.d.ts.map +1 -1
  82. package/sdk/models/errors/index.js +2 -2
  83. package/sdk/models/errors/index.js.map +1 -1
  84. package/sdk/models/errors/sdkerror.d.ts +1 -0
  85. package/sdk/models/errors/sdkerror.d.ts.map +1 -1
  86. package/sdk/models/errors/sdkerror.js +3 -1
  87. package/sdk/models/errors/sdkerror.js.map +1 -1
  88. package/sdk/models/operations/createdataset.d.ts +72 -40
  89. package/sdk/models/operations/createdataset.d.ts.map +1 -1
  90. package/sdk/models/operations/createdataset.js +100 -95
  91. package/sdk/models/operations/createdataset.js.map +1 -1
  92. package/sdk/models/operations/creategeneration.d.ts +166 -122
  93. package/sdk/models/operations/creategeneration.d.ts.map +1 -1
  94. package/sdk/models/operations/creategeneration.js +219 -279
  95. package/sdk/models/operations/creategeneration.js.map +1 -1
  96. package/sdk/models/operations/createlcmgeneration.d.ts +83 -61
  97. package/sdk/models/operations/createlcmgeneration.d.ts.map +1 -1
  98. package/sdk/models/operations/createlcmgeneration.js +109 -148
  99. package/sdk/models/operations/createlcmgeneration.js.map +1 -1
  100. package/sdk/models/operations/createmodel.d.ts +81 -57
  101. package/sdk/models/operations/createmodel.d.ts.map +1 -1
  102. package/sdk/models/operations/createmodel.js +119 -124
  103. package/sdk/models/operations/createmodel.js.map +1 -1
  104. package/sdk/models/operations/createsvdmotiongeneration.d.ts +76 -48
  105. package/sdk/models/operations/createsvdmotiongeneration.d.ts.map +1 -1
  106. package/sdk/models/operations/createsvdmotiongeneration.js +96 -115
  107. package/sdk/models/operations/createsvdmotiongeneration.js.map +1 -1
  108. package/sdk/models/operations/createtexturegeneration.d.ts +79 -54
  109. package/sdk/models/operations/createtexturegeneration.d.ts.map +1 -1
  110. package/sdk/models/operations/createtexturegeneration.js +124 -135
  111. package/sdk/models/operations/createtexturegeneration.js.map +1 -1
  112. package/sdk/models/operations/createuniversalupscalerjob.d.ts +157 -0
  113. package/sdk/models/operations/createuniversalupscalerjob.d.ts.map +1 -0
  114. package/sdk/models/operations/createuniversalupscalerjob.js +147 -0
  115. package/sdk/models/operations/createuniversalupscalerjob.js.map +1 -0
  116. package/sdk/models/operations/createvariationnobg.d.ts +73 -42
  117. package/sdk/models/operations/createvariationnobg.d.ts.map +1 -1
  118. package/sdk/models/operations/createvariationnobg.js +90 -95
  119. package/sdk/models/operations/createvariationnobg.js.map +1 -1
  120. package/sdk/models/operations/createvariationunzoom.d.ts +73 -42
  121. package/sdk/models/operations/createvariationunzoom.d.ts.map +1 -1
  122. package/sdk/models/operations/createvariationunzoom.js +90 -95
  123. package/sdk/models/operations/createvariationunzoom.js.map +1 -1
  124. package/sdk/models/operations/createvariationupscale.d.ts +72 -40
  125. package/sdk/models/operations/createvariationupscale.d.ts.map +1 -1
  126. package/sdk/models/operations/createvariationupscale.js +92 -95
  127. package/sdk/models/operations/createvariationupscale.js.map +1 -1
  128. package/sdk/models/operations/delete3dmodelbyid.d.ts +93 -52
  129. package/sdk/models/operations/delete3dmodelbyid.d.ts.map +1 -1
  130. package/sdk/models/operations/delete3dmodelbyid.js +127 -117
  131. package/sdk/models/operations/delete3dmodelbyid.js.map +1 -1
  132. package/sdk/models/operations/deletedatasetbyid.d.ts +71 -38
  133. package/sdk/models/operations/deletedatasetbyid.d.ts.map +1 -1
  134. package/sdk/models/operations/deletedatasetbyid.js +102 -95
  135. package/sdk/models/operations/deletedatasetbyid.js.map +1 -1
  136. package/sdk/models/operations/deletegenerationbyid.d.ts +71 -38
  137. package/sdk/models/operations/deletegenerationbyid.d.ts.map +1 -1
  138. package/sdk/models/operations/deletegenerationbyid.js +98 -93
  139. package/sdk/models/operations/deletegenerationbyid.js.map +1 -1
  140. package/sdk/models/operations/deleteinitimagebyid.d.ts +71 -38
  141. package/sdk/models/operations/deleteinitimagebyid.d.ts.map +1 -1
  142. package/sdk/models/operations/deleteinitimagebyid.js +98 -93
  143. package/sdk/models/operations/deleteinitimagebyid.js.map +1 -1
  144. package/sdk/models/operations/deletemodelbyid.d.ts +71 -38
  145. package/sdk/models/operations/deletemodelbyid.d.ts.map +1 -1
  146. package/sdk/models/operations/deletemodelbyid.js +98 -95
  147. package/sdk/models/operations/deletemodelbyid.js.map +1 -1
  148. package/sdk/models/operations/deletetexturegenerationbyid.d.ts +93 -52
  149. package/sdk/models/operations/deletetexturegenerationbyid.d.ts.map +1 -1
  150. package/sdk/models/operations/deletetexturegenerationbyid.js +131 -127
  151. package/sdk/models/operations/deletetexturegenerationbyid.js.map +1 -1
  152. package/sdk/models/operations/getdatasetbyid.d.ts +95 -60
  153. package/sdk/models/operations/getdatasetbyid.d.ts.map +1 -1
  154. package/sdk/models/operations/getdatasetbyid.js +139 -137
  155. package/sdk/models/operations/getdatasetbyid.js.map +1 -1
  156. package/sdk/models/operations/getgenerationbyid.d.ts +184 -159
  157. package/sdk/models/operations/getgenerationbyid.d.ts.map +1 -1
  158. package/sdk/models/operations/getgenerationbyid.js +283 -376
  159. package/sdk/models/operations/getgenerationbyid.js.map +1 -1
  160. package/sdk/models/operations/getgenerationsbyuserid.d.ts +186 -162
  161. package/sdk/models/operations/getgenerationsbyuserid.d.ts.map +1 -1
  162. package/sdk/models/operations/getgenerationsbyuserid.js +277 -380
  163. package/sdk/models/operations/getgenerationsbyuserid.js.map +1 -1
  164. package/sdk/models/operations/getinitimagebyid.d.ts +73 -42
  165. package/sdk/models/operations/getinitimagebyid.d.ts.map +1 -1
  166. package/sdk/models/operations/getinitimagebyid.js +106 -103
  167. package/sdk/models/operations/getinitimagebyid.js.map +1 -1
  168. package/sdk/models/operations/getmodelbyid.d.ts +83 -61
  169. package/sdk/models/operations/getmodelbyid.d.ts.map +1 -1
  170. package/sdk/models/operations/getmodelbyid.js +125 -140
  171. package/sdk/models/operations/getmodelbyid.js.map +1 -1
  172. package/sdk/models/operations/getuserself.d.ts +81 -58
  173. package/sdk/models/operations/getuserself.d.ts.map +1 -1
  174. package/sdk/models/operations/getuserself.js +118 -155
  175. package/sdk/models/operations/getuserself.js.map +1 -1
  176. package/sdk/models/operations/getvariationbyid.d.ts +76 -47
  177. package/sdk/models/operations/getvariationbyid.d.ts.map +1 -1
  178. package/sdk/models/operations/getvariationbyid.js +111 -112
  179. package/sdk/models/operations/getvariationbyid.js.map +1 -1
  180. package/sdk/models/operations/index.d.ts +36 -33
  181. package/sdk/models/operations/index.d.ts.map +1 -1
  182. package/sdk/models/operations/index.js +36 -33
  183. package/sdk/models/operations/index.js.map +1 -1
  184. package/sdk/models/operations/listelements.d.ts +63 -47
  185. package/sdk/models/operations/listelements.d.ts.map +1 -1
  186. package/sdk/models/operations/listelements.js +88 -102
  187. package/sdk/models/operations/listelements.js.map +1 -1
  188. package/sdk/models/operations/listplatformmodels.d.ts +77 -50
  189. package/sdk/models/operations/listplatformmodels.d.ts.map +1 -1
  190. package/sdk/models/operations/listplatformmodels.js +130 -121
  191. package/sdk/models/operations/listplatformmodels.js.map +1 -1
  192. package/sdk/models/operations/performalchemyupscalelcm.d.ts +88 -71
  193. package/sdk/models/operations/performalchemyupscalelcm.d.ts.map +1 -1
  194. package/sdk/models/operations/performalchemyupscalelcm.js +123 -174
  195. package/sdk/models/operations/performalchemyupscalelcm.js.map +1 -1
  196. package/sdk/models/operations/performinpaintinglcm.d.ts +84 -63
  197. package/sdk/models/operations/performinpaintinglcm.d.ts.map +1 -1
  198. package/sdk/models/operations/performinpaintinglcm.js +115 -152
  199. package/sdk/models/operations/performinpaintinglcm.js.map +1 -1
  200. package/sdk/models/operations/performinstantrefine.d.ts +83 -61
  201. package/sdk/models/operations/performinstantrefine.d.ts.map +1 -1
  202. package/sdk/models/operations/performinstantrefine.js +113 -148
  203. package/sdk/models/operations/performinstantrefine.js.map +1 -1
  204. package/sdk/models/operations/pricingcalculator.d.ts +476 -0
  205. package/sdk/models/operations/pricingcalculator.d.ts.map +1 -0
  206. package/sdk/models/operations/pricingcalculator.js +391 -0
  207. package/sdk/models/operations/pricingcalculator.js.map +1 -0
  208. package/sdk/models/operations/promptimprove.d.ts +72 -40
  209. package/sdk/models/operations/promptimprove.d.ts.map +1 -1
  210. package/sdk/models/operations/promptimprove.js +88 -95
  211. package/sdk/models/operations/promptimprove.js.map +1 -1
  212. package/sdk/models/operations/promptrandom.d.ts +55 -32
  213. package/sdk/models/operations/promptrandom.d.ts.map +1 -1
  214. package/sdk/models/operations/promptrandom.js +73 -81
  215. package/sdk/models/operations/promptrandom.js.map +1 -1
  216. package/sdk/models/operations/uploadcanvasinitimage.d.ts +140 -0
  217. package/sdk/models/operations/uploadcanvasinitimage.d.ts.map +1 -0
  218. package/sdk/models/operations/uploadcanvasinitimage.js +152 -0
  219. package/sdk/models/operations/uploadcanvasinitimage.js.map +1 -0
  220. package/sdk/models/operations/uploaddatasetimage.d.ts +92 -54
  221. package/sdk/models/operations/uploaddatasetimage.d.ts.map +1 -1
  222. package/sdk/models/operations/uploaddatasetimage.js +121 -129
  223. package/sdk/models/operations/uploaddatasetimage.js.map +1 -1
  224. package/sdk/models/operations/uploaddatasetimagefromgen.d.ts +89 -48
  225. package/sdk/models/operations/uploaddatasetimagefromgen.d.ts.map +1 -1
  226. package/sdk/models/operations/uploaddatasetimagefromgen.js +119 -117
  227. package/sdk/models/operations/uploaddatasetimagefromgen.js.map +1 -1
  228. package/sdk/models/operations/uploadinitimage.d.ts +74 -44
  229. package/sdk/models/operations/uploadinitimage.d.ts.map +1 -1
  230. package/sdk/models/operations/uploadinitimage.js +92 -107
  231. package/sdk/models/operations/uploadinitimage.js.map +1 -1
  232. package/sdk/models/operations/uploadmodelasset.d.ts +75 -46
  233. package/sdk/models/operations/uploadmodelasset.d.ts.map +1 -1
  234. package/sdk/models/operations/uploadmodelasset.js +94 -111
  235. package/sdk/models/operations/uploadmodelasset.js.map +1 -1
  236. package/sdk/models/shared/canvasrequesttype.d.ts +25 -0
  237. package/sdk/models/shared/canvasrequesttype.d.ts.map +1 -0
  238. package/sdk/models/shared/canvasrequesttype.js +56 -0
  239. package/sdk/models/shared/canvasrequesttype.js.map +1 -0
  240. package/sdk/models/shared/controlnetinput.d.ts +93 -0
  241. package/sdk/models/shared/controlnetinput.d.ts.map +1 -0
  242. package/sdk/models/shared/controlnetinput.js +107 -0
  243. package/sdk/models/shared/controlnetinput.js.map +1 -0
  244. package/sdk/models/shared/controlnettype.d.ts +16 -2
  245. package/sdk/models/shared/controlnettype.d.ts.map +1 -1
  246. package/sdk/models/shared/controlnettype.js +18 -3
  247. package/sdk/models/shared/controlnettype.js.map +1 -1
  248. package/sdk/models/shared/custommodeltype.d.ts +13 -1
  249. package/sdk/models/shared/custommodeltype.d.ts.map +1 -1
  250. package/sdk/models/shared/custommodeltype.js +15 -2
  251. package/sdk/models/shared/custommodeltype.js.map +1 -1
  252. package/sdk/models/shared/elementinput.d.ts +18 -10
  253. package/sdk/models/shared/elementinput.d.ts.map +1 -1
  254. package/sdk/models/shared/elementinput.js +18 -23
  255. package/sdk/models/shared/elementinput.js.map +1 -1
  256. package/sdk/models/shared/index.d.ts +15 -11
  257. package/sdk/models/shared/index.d.ts.map +1 -1
  258. package/sdk/models/shared/index.js +15 -11
  259. package/sdk/models/shared/index.js.map +1 -1
  260. package/sdk/models/shared/jobstatus.d.ts +13 -1
  261. package/sdk/models/shared/jobstatus.d.ts.map +1 -1
  262. package/sdk/models/shared/jobstatus.js +15 -2
  263. package/sdk/models/shared/jobstatus.js.map +1 -1
  264. package/sdk/models/shared/lcmgenerationstyle.d.ts +13 -1
  265. package/sdk/models/shared/lcmgenerationstyle.d.ts.map +1 -1
  266. package/sdk/models/shared/lcmgenerationstyle.js +15 -2
  267. package/sdk/models/shared/lcmgenerationstyle.js.map +1 -1
  268. package/sdk/models/shared/pricingcalculatorservices.d.ts +28 -0
  269. package/sdk/models/shared/pricingcalculatorservices.d.ts.map +1 -0
  270. package/sdk/models/shared/pricingcalculatorservices.js +59 -0
  271. package/sdk/models/shared/pricingcalculatorservices.js.map +1 -0
  272. package/sdk/models/shared/sdgenerationschedulers.d.ts +13 -1
  273. package/sdk/models/shared/sdgenerationschedulers.d.ts.map +1 -1
  274. package/sdk/models/shared/sdgenerationschedulers.js +15 -2
  275. package/sdk/models/shared/sdgenerationschedulers.js.map +1 -1
  276. package/sdk/models/shared/sdgenerationstyle.d.ts +13 -1
  277. package/sdk/models/shared/sdgenerationstyle.d.ts.map +1 -1
  278. package/sdk/models/shared/sdgenerationstyle.js +15 -2
  279. package/sdk/models/shared/sdgenerationstyle.js.map +1 -1
  280. package/sdk/models/shared/sdversions.d.ts +13 -1
  281. package/sdk/models/shared/sdversions.d.ts.map +1 -1
  282. package/sdk/models/shared/sdversions.js +15 -2
  283. package/sdk/models/shared/sdversions.js.map +1 -1
  284. package/sdk/models/shared/security.d.ts +17 -8
  285. package/sdk/models/shared/security.d.ts.map +1 -1
  286. package/sdk/models/shared/security.js +16 -19
  287. package/sdk/models/shared/security.js.map +1 -1
  288. package/sdk/models/shared/strength.d.ts +13 -1
  289. package/sdk/models/shared/strength.d.ts.map +1 -1
  290. package/sdk/models/shared/strength.js +15 -2
  291. package/sdk/models/shared/strength.js.map +1 -1
  292. package/sdk/models/shared/universalupscalerstyle.d.ts +25 -0
  293. package/sdk/models/shared/universalupscalerstyle.d.ts.map +1 -0
  294. package/sdk/models/shared/universalupscalerstyle.js +56 -0
  295. package/sdk/models/shared/universalupscalerstyle.js.map +1 -0
  296. package/sdk/models/shared/variationtype.d.ts +13 -1
  297. package/sdk/models/shared/variationtype.d.ts.map +1 -1
  298. package/sdk/models/shared/variationtype.js +15 -2
  299. package/sdk/models/shared/variationtype.js.map +1 -1
  300. package/sdk/models.d.ts +36 -0
  301. package/sdk/models.d.ts.map +1 -0
  302. package/sdk/models.js +299 -0
  303. package/sdk/models.js.map +1 -0
  304. package/sdk/motion.d.ts +15 -0
  305. package/sdk/motion.d.ts.map +1 -0
  306. package/sdk/motion.js +121 -0
  307. package/sdk/motion.js.map +1 -0
  308. package/sdk/pricingcalculator.d.ts +15 -0
  309. package/sdk/pricingcalculator.d.ts.map +1 -0
  310. package/sdk/pricingcalculator.js +119 -0
  311. package/sdk/pricingcalculator.js.map +1 -0
  312. package/sdk/prompt.d.ts +4 -4
  313. package/sdk/prompt.d.ts.map +1 -1
  314. package/sdk/prompt.js +49 -57
  315. package/sdk/prompt.js.map +1 -1
  316. package/sdk/realtimecanvas.d.ts +36 -0
  317. package/sdk/realtimecanvas.d.ts.map +1 -0
  318. package/sdk/realtimecanvas.js +296 -0
  319. package/sdk/realtimecanvas.js.map +1 -0
  320. package/sdk/sdk.d.ts +33 -18
  321. package/sdk/sdk.d.ts.map +1 -1
  322. package/sdk/sdk.js +54 -29
  323. package/sdk/sdk.js.map +1 -1
  324. package/sdk/texture.d.ts +22 -0
  325. package/sdk/texture.d.ts.map +1 -0
  326. package/sdk/texture.js +186 -0
  327. package/sdk/texture.js.map +1 -0
  328. package/sdk/threedmodelassets.d.ts +22 -0
  329. package/sdk/threedmodelassets.d.ts.map +1 -0
  330. package/sdk/threedmodelassets.js +184 -0
  331. package/sdk/threedmodelassets.js.map +1 -0
  332. package/sdk/types/enums.d.ts +12 -0
  333. package/sdk/types/enums.d.ts.map +1 -0
  334. package/sdk/types/enums.js +11 -0
  335. package/sdk/types/enums.js.map +1 -0
  336. package/sdk/types/index.d.ts +6 -4
  337. package/sdk/types/index.d.ts.map +1 -1
  338. package/sdk/types/index.js +10 -8
  339. package/sdk/types/index.js.map +1 -1
  340. package/sdk/user.d.ts +3 -3
  341. package/sdk/user.d.ts.map +1 -1
  342. package/sdk/user.js +26 -32
  343. package/sdk/user.js.map +1 -1
  344. package/sdk/variation.d.ts +13 -6
  345. package/sdk/variation.d.ts.map +1 -1
  346. package/sdk/variation.js +154 -111
  347. package/sdk/variation.js.map +1 -1
  348. package/src/hooks/hooks.ts +19 -1
  349. package/src/hooks/index.ts +2 -2
  350. package/src/hooks/types.ts +31 -16
  351. package/src/index.ts +2 -2
  352. package/src/lib/config.ts +7 -6
  353. package/src/lib/encodings.ts +72 -13
  354. package/src/lib/http.ts +450 -159
  355. package/src/lib/is-plain-object.ts +43 -0
  356. package/src/lib/primitives.ts +40 -0
  357. package/src/lib/schemas.ts +37 -3
  358. package/src/lib/sdks.ts +102 -31
  359. package/src/lib/security.ts +2 -2
  360. package/src/sdk/dataset.ts +122 -140
  361. package/src/sdk/{element.ts → elements.ts} +25 -32
  362. package/src/sdk/image.ts +377 -0
  363. package/src/sdk/index.ts +1 -1
  364. package/src/sdk/initimages.ts +359 -0
  365. package/src/sdk/models/errors/index.ts +2 -2
  366. package/src/sdk/models/errors/sdkerror.ts +4 -1
  367. package/src/sdk/models/operations/createdataset.ts +160 -134
  368. package/src/sdk/models/operations/creategeneration.ts +365 -391
  369. package/src/sdk/models/operations/createlcmgeneration.ts +181 -208
  370. package/src/sdk/models/operations/createmodel.ts +185 -173
  371. package/src/sdk/models/operations/createsvdmotiongeneration.ts +162 -181
  372. package/src/sdk/models/operations/createtexturegeneration.ts +193 -204
  373. package/src/sdk/models/operations/createuniversalupscalerjob.ts +271 -0
  374. package/src/sdk/models/operations/createvariationnobg.ts +160 -144
  375. package/src/sdk/models/operations/createvariationunzoom.ts +157 -152
  376. package/src/sdk/models/operations/createvariationupscale.ts +161 -161
  377. package/src/sdk/models/operations/delete3dmodelbyid.ts +209 -168
  378. package/src/sdk/models/operations/deletedatasetbyid.ts +168 -133
  379. package/src/sdk/models/operations/deletegenerationbyid.ts +161 -136
  380. package/src/sdk/models/operations/deleteinitimagebyid.ts +158 -136
  381. package/src/sdk/models/operations/deletemodelbyid.ts +160 -132
  382. package/src/sdk/models/operations/deletetexturegenerationbyid.ts +213 -210
  383. package/src/sdk/models/operations/getdatasetbyid.ts +217 -188
  384. package/src/sdk/models/operations/getgenerationbyid.ts +459 -548
  385. package/src/sdk/models/operations/getgenerationsbyuserid.ts +457 -596
  386. package/src/sdk/models/operations/getinitimagebyid.ts +174 -144
  387. package/src/sdk/models/operations/getmodelbyid.ts +196 -193
  388. package/src/sdk/models/operations/getuserself.ts +176 -206
  389. package/src/sdk/models/operations/getvariationbyid.ts +181 -162
  390. package/src/sdk/models/operations/index.ts +36 -33
  391. package/src/sdk/models/operations/listelements.ts +139 -148
  392. package/src/sdk/models/operations/listplatformmodels.ts +200 -178
  393. package/src/sdk/models/operations/performalchemyupscalelcm.ts +201 -268
  394. package/src/sdk/models/operations/performinpaintinglcm.ts +188 -226
  395. package/src/sdk/models/operations/performinstantrefine.ts +185 -220
  396. package/src/sdk/models/operations/pricingcalculator.ts +883 -0
  397. package/src/sdk/models/operations/promptimprove.ts +157 -136
  398. package/src/sdk/models/operations/promptrandom.ts +125 -121
  399. package/src/sdk/models/operations/uploadcanvasinitimage.ts +256 -0
  400. package/src/sdk/models/operations/uploaddatasetimage.ts +200 -177
  401. package/src/sdk/models/operations/uploaddatasetimagefromgen.ts +196 -187
  402. package/src/sdk/models/operations/uploadinitimage.ts +163 -152
  403. package/src/sdk/models/operations/uploadmodelasset.ts +166 -158
  404. package/src/sdk/models/shared/canvasrequesttype.ts +34 -0
  405. package/src/sdk/models/shared/controlnetinput.ts +130 -0
  406. package/src/sdk/models/shared/controlnettype.ts +20 -2
  407. package/src/sdk/models/shared/custommodeltype.ts +16 -1
  408. package/src/sdk/models/shared/elementinput.ts +29 -31
  409. package/src/sdk/models/shared/index.ts +15 -11
  410. package/src/sdk/models/shared/jobstatus.ts +15 -1
  411. package/src/sdk/models/shared/lcmgenerationstyle.ts +16 -1
  412. package/src/sdk/models/shared/pricingcalculatorservices.ts +39 -0
  413. package/src/sdk/models/shared/sdgenerationschedulers.ts +16 -1
  414. package/src/sdk/models/shared/sdgenerationstyle.ts +16 -1
  415. package/src/sdk/models/shared/sdversions.ts +17 -1
  416. package/src/sdk/models/shared/security.ts +23 -25
  417. package/src/sdk/models/shared/strength.ts +15 -1
  418. package/src/sdk/models/shared/universalupscalerstyle.ts +34 -0
  419. package/src/sdk/models/shared/variationtype.ts +17 -1
  420. package/src/sdk/models.ts +347 -0
  421. package/src/sdk/motion.ts +123 -0
  422. package/src/sdk/pricingcalculator.ts +119 -0
  423. package/src/sdk/prompt.ts +51 -60
  424. package/src/sdk/realtimecanvas.ts +361 -0
  425. package/src/sdk/sdk.ts +54 -24
  426. package/src/sdk/texture.ts +208 -0
  427. package/src/sdk/threedmodelassets.ts +204 -0
  428. package/src/sdk/types/enums.ts +16 -0
  429. package/src/sdk/types/index.ts +6 -4
  430. package/src/sdk/user.ts +24 -31
  431. package/src/sdk/variation.ts +186 -121
  432. package/docs/sdks/generation/README.md +0 -503
  433. package/sdk/element.d.ts.map +0 -1
  434. package/sdk/element.js.map +0 -1
  435. package/sdk/generation.d.ts +0 -85
  436. package/sdk/generation.d.ts.map +0 -1
  437. package/sdk/generation.js +0 -781
  438. package/sdk/generation.js.map +0 -1
  439. package/sdk/initimage.d.ts +0 -29
  440. package/sdk/initimage.d.ts.map +0 -1
  441. package/sdk/initimage.js +0 -257
  442. package/sdk/initimage.js.map +0 -1
  443. package/sdk/model.d.ts +0 -50
  444. package/sdk/model.d.ts.map +0 -1
  445. package/sdk/model.js +0 -446
  446. package/sdk/model.js.map +0 -1
  447. package/src/sdk/generation.ts +0 -984
  448. package/src/sdk/initimage.ts +0 -293
  449. package/src/sdk/model.ts +0 -536
@@ -1,18 +1,16 @@
1
- # Model
2
- (*model*)
1
+ # Image
2
+ (*image*)
3
3
 
4
4
  ### Available Operations
5
5
 
6
- * [createModel](#createmodel) - Train a Custom Model
7
- * [delete3DModelById](#delete3dmodelbyid) - Delete 3D Model by ID
8
- * [deleteModelById](#deletemodelbyid) - Delete a Single Custom Model by ID
9
- * [getModelById](#getmodelbyid) - Get a Single Custom Model by ID
10
- * [listPlatformModels](#listplatformmodels) - List Platform Models
11
- * [uploadModelAsset](#uploadmodelasset) - Upload 3D Model
6
+ * [createGeneration](#creategeneration) - Create a Generation of Images
7
+ * [deleteGenerationById](#deletegenerationbyid) - Delete a Single Generation
8
+ * [getGenerationById](#getgenerationbyid) - Get a Single Generation
9
+ * [getGenerationsByUserId](#getgenerationsbyuserid) - Get generations by user ID
12
10
 
13
- ## createModel
11
+ ## createGeneration
14
12
 
15
- This endpoint will train a new custom model
13
+ This endpoint will generate images
16
14
 
17
15
  ### Example Usage
18
16
 
@@ -24,11 +22,7 @@ const leonardo = new Leonardo({
24
22
  });
25
23
 
26
24
  async function run() {
27
- const result = await leonardo.model.createModel({
28
- datasetId: "<value>",
29
- instancePrompt: "<value>",
30
- name: "<value>",
31
- });
25
+ const result = await leonardo.image.createGeneration({});
32
26
 
33
27
  // Handle the result
34
28
  console.log(result)
@@ -41,23 +35,24 @@ run();
41
35
 
42
36
  | Parameter | Type | Required | Description |
43
37
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
44
- | `request` | [operations.CreateModelRequestBody](../../sdk/models/operations/createmodelrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
38
+ | `request` | [operations.CreateGenerationRequestBody](../../sdk/models/operations/creategenerationrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
45
39
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
46
40
  | `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. |
41
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
47
42
 
48
43
 
49
44
  ### Response
50
45
 
51
- **Promise<[operations.CreateModelResponse](../../sdk/models/operations/createmodelresponse.md)>**
46
+ **Promise\<[operations.CreateGenerationResponse](../../sdk/models/operations/creategenerationresponse.md)\>**
52
47
  ### Errors
53
48
 
54
49
  | Error Object | Status Code | Content Type |
55
50
  | --------------- | --------------- | --------------- |
56
51
  | errors.SDKError | 4xx-5xx | */* |
57
52
 
58
- ## delete3DModelById
53
+ ## deleteGenerationById
59
54
 
60
- This endpoint deletes the specific 3D Model
55
+ This endpoint deletes a specific generation
61
56
 
62
57
  ### Example Usage
63
58
 
@@ -69,10 +64,7 @@ const leonardo = new Leonardo({
69
64
  });
70
65
 
71
66
  async function run() {
72
- const id = "<value>";
73
- const requestBody = {};
74
-
75
- const result = await leonardo.model.delete3DModelById(id, requestBody);
67
+ const result = await leonardo.image.deleteGenerationById("<value>");
76
68
 
77
69
  // Handle the result
78
70
  console.log(result)
@@ -85,24 +77,24 @@ run();
85
77
 
86
78
  | Parameter | Type | Required | Description |
87
79
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
88
- | `id` | *string* | :heavy_check_mark: | _"id" is required (enter it either in parameters or request body)_ |
89
- | `requestBody` | [operations.Delete3DModelByIdRequestBody](../../sdk/models/operations/delete3dmodelbyidrequestbody.md) | :heavy_minus_sign: | Query parameters can also be provided in the request body as a JSON object |
80
+ | `id` | *string* | :heavy_check_mark: | The ID of the generation to delete. |
90
81
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
91
82
  | `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. |
83
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
92
84
 
93
85
 
94
86
  ### Response
95
87
 
96
- **Promise<[operations.Delete3DModelByIdResponse](../../sdk/models/operations/delete3dmodelbyidresponse.md)>**
88
+ **Promise\<[operations.DeleteGenerationByIdResponse](../../sdk/models/operations/deletegenerationbyidresponse.md)\>**
97
89
  ### Errors
98
90
 
99
91
  | Error Object | Status Code | Content Type |
100
92
  | --------------- | --------------- | --------------- |
101
93
  | errors.SDKError | 4xx-5xx | */* |
102
94
 
103
- ## deleteModelById
95
+ ## getGenerationById
104
96
 
105
- This endpoint will delete a specific custom model
97
+ This endpoint will provide information about a specific generation
106
98
 
107
99
  ### Example Usage
108
100
 
@@ -114,9 +106,7 @@ const leonardo = new Leonardo({
114
106
  });
115
107
 
116
108
  async function run() {
117
- const id = "<value>";
118
-
119
- const result = await leonardo.model.deleteModelById(id);
109
+ const result = await leonardo.image.getGenerationById("<value>");
120
110
 
121
111
  // Handle the result
122
112
  console.log(result)
@@ -129,23 +119,24 @@ run();
129
119
 
130
120
  | Parameter | Type | Required | Description |
131
121
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
132
- | `id` | *string* | :heavy_check_mark: | The ID of the model to delete. |
122
+ | `id` | *string* | :heavy_check_mark: | The ID of the generation to return. |
133
123
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
134
124
  | `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. |
125
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
135
126
 
136
127
 
137
128
  ### Response
138
129
 
139
- **Promise<[operations.DeleteModelByIdResponse](../../sdk/models/operations/deletemodelbyidresponse.md)>**
130
+ **Promise\<[operations.GetGenerationByIdResponse](../../sdk/models/operations/getgenerationbyidresponse.md)\>**
140
131
  ### Errors
141
132
 
142
133
  | Error Object | Status Code | Content Type |
143
134
  | --------------- | --------------- | --------------- |
144
135
  | errors.SDKError | 4xx-5xx | */* |
145
136
 
146
- ## getModelById
137
+ ## getGenerationsByUserId
147
138
 
148
- This endpoint gets the specific custom model
139
+ This endpoint returns all generations by a specific user
149
140
 
150
141
  ### Example Usage
151
142
 
@@ -157,9 +148,7 @@ const leonardo = new Leonardo({
157
148
  });
158
149
 
159
150
  async function run() {
160
- const id = "<value>";
161
-
162
- const result = await leonardo.model.getModelById(id);
151
+ const result = await leonardo.image.getGenerationsByUserId("<value>", 10, 0);
163
152
 
164
153
  // Handle the result
165
154
  console.log(result)
@@ -172,95 +161,17 @@ run();
172
161
 
173
162
  | Parameter | Type | Required | Description |
174
163
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
175
- | `id` | *string* | :heavy_check_mark: | The ID of the custom model to return. |
164
+ | `userId` | *string* | :heavy_check_mark: | N/A |
165
+ | `limit` | *number* | :heavy_minus_sign: | N/A |
166
+ | `offset` | *number* | :heavy_minus_sign: | N/A |
176
167
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
177
168
  | `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. |
169
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
178
170
 
179
171
 
180
172
  ### Response
181
173
 
182
- **Promise<[operations.GetModelByIdResponse](../../sdk/models/operations/getmodelbyidresponse.md)>**
183
- ### Errors
184
-
185
- | Error Object | Status Code | Content Type |
186
- | --------------- | --------------- | --------------- |
187
- | errors.SDKError | 4xx-5xx | */* |
188
-
189
- ## listPlatformModels
190
-
191
- Get a list of public Platform Models available for use with generations.
192
-
193
- ### Example Usage
194
-
195
- ```typescript
196
- import { Leonardo } from "@leonardo-ai/sdk";
197
-
198
- const leonardo = new Leonardo({
199
- bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
200
- });
201
-
202
- async function run() {
203
- const result = await leonardo.model.listPlatformModels();
204
-
205
- // Handle the result
206
- console.log(result)
207
- }
208
-
209
- run();
210
- ```
211
-
212
- ### Parameters
213
-
214
- | Parameter | Type | Required | Description |
215
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
216
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
217
- | `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. |
218
-
219
-
220
- ### Response
221
-
222
- **Promise<[operations.ListPlatformModelsResponse](../../sdk/models/operations/listplatformmodelsresponse.md)>**
223
- ### Errors
224
-
225
- | Error Object | Status Code | Content Type |
226
- | --------------- | --------------- | --------------- |
227
- | errors.SDKError | 4xx-5xx | */* |
228
-
229
- ## uploadModelAsset
230
-
231
- This endpoint returns presigned details to upload a 3D model to S3
232
-
233
- ### Example Usage
234
-
235
- ```typescript
236
- import { Leonardo } from "@leonardo-ai/sdk";
237
-
238
- const leonardo = new Leonardo({
239
- bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
240
- });
241
-
242
- async function run() {
243
- const result = await leonardo.model.uploadModelAsset({});
244
-
245
- // Handle the result
246
- console.log(result)
247
- }
248
-
249
- run();
250
- ```
251
-
252
- ### Parameters
253
-
254
- | Parameter | Type | Required | Description |
255
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
256
- | `request` | [operations.UploadModelAssetRequestBody](../../sdk/models/operations/uploadmodelassetrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
257
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
258
- | `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. |
259
-
260
-
261
- ### Response
262
-
263
- **Promise<[operations.UploadModelAssetResponse](../../sdk/models/operations/uploadmodelassetresponse.md)>**
174
+ **Promise\<[operations.GetGenerationsByUserIdResponse](../../sdk/models/operations/getgenerationsbyuseridresponse.md)\>**
264
175
  ### Errors
265
176
 
266
177
  | Error Object | Status Code | Content Type |
@@ -0,0 +1,182 @@
1
+ # InitImages
2
+ (*initImages*)
3
+
4
+ ### Available Operations
5
+
6
+ * [deleteInitImageById](#deleteinitimagebyid) - Delete init image
7
+ * [getInitImageById](#getinitimagebyid) - Get single init image
8
+ * [uploadCanvasInitImage](#uploadcanvasinitimage) - Upload Canvas Editor init and mask image
9
+ * [uploadInitImage](#uploadinitimage) - Upload init image
10
+
11
+ ## deleteInitImageById
12
+
13
+ This endpoint deletes an init image
14
+
15
+ ### Example Usage
16
+
17
+ ```typescript
18
+ import { Leonardo } from "@leonardo-ai/sdk";
19
+
20
+ const leonardo = new Leonardo({
21
+ bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
22
+ });
23
+
24
+ async function run() {
25
+ const result = await leonardo.initImages.deleteInitImageById("<value>");
26
+
27
+ // Handle the result
28
+ console.log(result)
29
+ }
30
+
31
+ run();
32
+ ```
33
+
34
+ ### Parameters
35
+
36
+ | Parameter | Type | Required | Description |
37
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
38
+ | `id` | *string* | :heavy_check_mark: | _"id" is required_ |
39
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
40
+ | `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. |
41
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
42
+
43
+
44
+ ### Response
45
+
46
+ **Promise\<[operations.DeleteInitImageByIdResponse](../../sdk/models/operations/deleteinitimagebyidresponse.md)\>**
47
+ ### Errors
48
+
49
+ | Error Object | Status Code | Content Type |
50
+ | --------------- | --------------- | --------------- |
51
+ | errors.SDKError | 4xx-5xx | */* |
52
+
53
+ ## getInitImageById
54
+
55
+ This endpoint will return a single init image
56
+
57
+ ### Example Usage
58
+
59
+ ```typescript
60
+ import { Leonardo } from "@leonardo-ai/sdk";
61
+
62
+ const leonardo = new Leonardo({
63
+ bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
64
+ });
65
+
66
+ async function run() {
67
+ const result = await leonardo.initImages.getInitImageById("<value>");
68
+
69
+ // Handle the result
70
+ console.log(result)
71
+ }
72
+
73
+ run();
74
+ ```
75
+
76
+ ### Parameters
77
+
78
+ | Parameter | Type | Required | Description |
79
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
80
+ | `id` | *string* | :heavy_check_mark: | _"id" is required_ |
81
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
82
+ | `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. |
83
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
84
+
85
+
86
+ ### Response
87
+
88
+ **Promise\<[operations.GetInitImageByIdResponse](../../sdk/models/operations/getinitimagebyidresponse.md)\>**
89
+ ### Errors
90
+
91
+ | Error Object | Status Code | Content Type |
92
+ | --------------- | --------------- | --------------- |
93
+ | errors.SDKError | 4xx-5xx | */* |
94
+
95
+ ## uploadCanvasInitImage
96
+
97
+ This endpoint returns presigned details to upload an init image and a mask image to S3
98
+
99
+ ### Example Usage
100
+
101
+ ```typescript
102
+ import { Leonardo } from "@leonardo-ai/sdk";
103
+
104
+ const leonardo = new Leonardo({
105
+ bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
106
+ });
107
+
108
+ async function run() {
109
+ const result = await leonardo.initImages.uploadCanvasInitImage({
110
+ initExtension: "<value>",
111
+ maskExtension: "<value>",
112
+ });
113
+
114
+ // Handle the result
115
+ console.log(result)
116
+ }
117
+
118
+ run();
119
+ ```
120
+
121
+ ### Parameters
122
+
123
+ | Parameter | Type | Required | Description |
124
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
125
+ | `request` | [operations.UploadCanvasInitImageRequestBody](../../sdk/models/operations/uploadcanvasinitimagerequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
126
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
127
+ | `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. |
128
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
129
+
130
+
131
+ ### Response
132
+
133
+ **Promise\<[operations.UploadCanvasInitImageResponse](../../sdk/models/operations/uploadcanvasinitimageresponse.md)\>**
134
+ ### Errors
135
+
136
+ | Error Object | Status Code | Content Type |
137
+ | --------------- | --------------- | --------------- |
138
+ | errors.SDKError | 4xx-5xx | */* |
139
+
140
+ ## uploadInitImage
141
+
142
+ This endpoint returns presigned details to upload an init image to S3
143
+
144
+ ### Example Usage
145
+
146
+ ```typescript
147
+ import { Leonardo } from "@leonardo-ai/sdk";
148
+
149
+ const leonardo = new Leonardo({
150
+ bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
151
+ });
152
+
153
+ async function run() {
154
+ const result = await leonardo.initImages.uploadInitImage({
155
+ extension: "png",
156
+ });
157
+
158
+ // Handle the result
159
+ console.log(result)
160
+ }
161
+
162
+ run();
163
+ ```
164
+
165
+ ### Parameters
166
+
167
+ | Parameter | Type | Required | Description |
168
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
169
+ | `request` | [operations.UploadInitImageRequestBody](../../sdk/models/operations/uploadinitimagerequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
170
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
171
+ | `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. |
172
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
173
+
174
+
175
+ ### Response
176
+
177
+ **Promise\<[operations.UploadInitImageResponse](../../sdk/models/operations/uploadinitimageresponse.md)\>**
178
+ ### Errors
179
+
180
+ | Error Object | Status Code | Content Type |
181
+ | --------------- | --------------- | --------------- |
182
+ | errors.SDKError | 4xx-5xx | */* |