hcloud-sdk 17.0.0 → 18.0.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 (275) hide show
  1. package/changelog.md +176 -76
  2. package/lib/Base.d.ts +2 -1
  3. package/lib/Hcloud.d.ts +6 -3
  4. package/lib/Hcloud.js +16 -5
  5. package/lib/helper/ValidationHelper.d.ts +10 -2
  6. package/lib/helper/ValidationHelper.js +55 -7
  7. package/lib/interfaces/auditor/index.d.ts +13 -2
  8. package/lib/interfaces/auditor/index.js +9 -1
  9. package/lib/interfaces/cosmo/asset/index.d.ts +185 -0
  10. package/lib/interfaces/cosmo/asset/index.js +82 -0
  11. package/lib/interfaces/cosmo/comment/index.d.ts +38 -0
  12. package/lib/interfaces/cosmo/comment/index.js +8 -0
  13. package/lib/interfaces/cosmo/event/index.d.ts +31 -0
  14. package/lib/interfaces/cosmo/event/index.js +17 -0
  15. package/lib/interfaces/cosmo/location/index.d.ts +4 -0
  16. package/lib/interfaces/cosmo/namespace/index.d.ts +9 -0
  17. package/lib/interfaces/cosmo/namespace/index.js +9 -0
  18. package/lib/interfaces/cosmo/permissions.d.ts +96 -0
  19. package/lib/interfaces/cosmo/permissions.js +58 -0
  20. package/lib/interfaces/cosmo/share/index.d.ts +28 -0
  21. package/lib/interfaces/cosmo/share/index.js +2 -0
  22. package/lib/interfaces/cosmo/space/index.d.ts +25 -0
  23. package/lib/interfaces/cosmo/space/index.js +2 -0
  24. package/lib/interfaces/cosmo/tag/tag.d.ts +12 -0
  25. package/lib/interfaces/cosmo/tag/tag.js +2 -0
  26. package/lib/interfaces/global/Products.d.ts +2 -2
  27. package/lib/interfaces/global/Products.js +1 -1
  28. package/lib/interfaces/high5/index.d.ts +7 -7
  29. package/lib/interfaces/high5/index.js +7 -7
  30. package/lib/interfaces/{friday → high5}/space/database/document/index.d.ts +1 -1
  31. package/lib/interfaces/{friday → high5}/space/database/document/index.js +2 -1
  32. package/lib/interfaces/high5/space/database/index.js +2 -0
  33. package/lib/interfaces/high5/space/event/stream/design/StreamDesign.d.ts +9 -2
  34. package/lib/interfaces/high5/space/execution/index.d.ts +2 -1
  35. package/lib/interfaces/high5/space/job/JobLog.d.ts +16 -0
  36. package/lib/interfaces/high5/space/job/JobLog.js +2 -0
  37. package/lib/interfaces/high5/space/job/index.d.ts +38 -0
  38. package/lib/interfaces/high5/space/job/index.js +8 -0
  39. package/lib/interfaces/high5/stats.d.ts +21 -0
  40. package/lib/interfaces/high5/stats.js +2 -0
  41. package/lib/interfaces/idp/oauth/index.d.ts +4 -3
  42. package/lib/interfaces/idp/organization/index.d.ts +1 -0
  43. package/lib/interfaces/idp/organization/index.js +1 -0
  44. package/lib/interfaces/idp/organization/license/index.d.ts +13 -11
  45. package/lib/interfaces/idp/organization/member/index.d.ts +1 -0
  46. package/lib/interfaces/idp/organization/stats.d.ts +7 -0
  47. package/lib/interfaces/idp/organization/stats.js +2 -0
  48. package/lib/interfaces/idp/organization/team/index.d.ts +0 -1
  49. package/lib/interfaces/idp/user/Message.d.ts +21 -0
  50. package/lib/interfaces/idp/user/Message.js +14 -0
  51. package/lib/interfaces/idp/user/NotificationSettings.d.ts +1 -0
  52. package/lib/interfaces/idp/user/Scopes.d.ts +1 -7
  53. package/lib/interfaces/idp/user/Scopes.js +0 -9
  54. package/lib/interfaces/idp/user/index.d.ts +2 -1
  55. package/lib/interfaces/mailer/index.d.ts +30 -1
  56. package/lib/interfaces/mailer/index.js +87 -1
  57. package/lib/interfaces/mothership/index.d.ts +3 -1
  58. package/lib/interfaces/mothership/index.js +15 -0
  59. package/lib/interfaces/mothership/stats.d.ts +4 -0
  60. package/lib/interfaces/mothership/stats.js +2 -0
  61. package/lib/interfaces/nats/index.d.ts +54 -24
  62. package/lib/interfaces/nats/index.js +87 -58
  63. package/lib/interfaces/shorts/index.d.ts +10 -0
  64. package/lib/interfaces/shorts/index.js +2 -0
  65. package/lib/service/agent/bundle/dev/index.d.ts +16 -6
  66. package/lib/service/agent/bundle/dev/index.js +12 -10
  67. package/lib/service/agent/bundle/index.d.ts +10 -4
  68. package/lib/service/agent/bundle/index.js +6 -6
  69. package/lib/service/agent/context/index.d.ts +22 -8
  70. package/lib/service/agent/context/index.js +15 -14
  71. package/lib/service/auditor/index.d.ts +8 -4
  72. package/lib/service/auditor/index.js +5 -5
  73. package/lib/service/auditor/internal/index.d.ts +27 -3
  74. package/lib/service/auditor/internal/index.js +34 -5
  75. package/lib/service/bouncer/features/index.d.ts +4 -2
  76. package/lib/service/bouncer/features/index.js +2 -2
  77. package/lib/service/cosmo/asset/index.d.ts +219 -0
  78. package/lib/service/cosmo/asset/index.js +314 -0
  79. package/lib/service/cosmo/comment/index.d.ts +122 -0
  80. package/lib/service/cosmo/comment/index.js +161 -0
  81. package/lib/service/cosmo/event/index.d.ts +23 -0
  82. package/lib/service/cosmo/event/index.js +40 -0
  83. package/lib/service/cosmo/folder/index.d.ts +27 -0
  84. package/lib/service/cosmo/folder/index.js +47 -0
  85. package/lib/service/cosmo/index.d.ts +49 -0
  86. package/lib/service/cosmo/index.js +119 -0
  87. package/lib/service/cosmo/internal/index.d.ts +7 -0
  88. package/lib/service/cosmo/internal/index.js +17 -0
  89. package/lib/service/cosmo/internal/space/index.d.ts +15 -0
  90. package/lib/service/cosmo/internal/space/index.js +34 -0
  91. package/lib/service/cosmo/location/index.d.ts +40 -0
  92. package/lib/service/cosmo/location/index.js +63 -0
  93. package/lib/service/cosmo/namespace/index.d.ts +42 -0
  94. package/lib/service/cosmo/namespace/index.js +65 -0
  95. package/lib/service/cosmo/organization/index.d.ts +47 -0
  96. package/lib/service/cosmo/organization/index.js +64 -0
  97. package/lib/service/cosmo/permissions/index.d.ts +131 -0
  98. package/lib/service/cosmo/permissions/index.js +181 -0
  99. package/lib/service/cosmo/production/index.d.ts +26 -0
  100. package/lib/service/cosmo/production/index.js +45 -0
  101. package/lib/service/cosmo/share/index.d.ts +161 -0
  102. package/lib/service/cosmo/share/index.js +215 -0
  103. package/lib/service/cosmo/space/index.d.ts +104 -0
  104. package/lib/service/cosmo/space/index.js +146 -0
  105. package/lib/service/cosmo/tag/index.d.ts +67 -0
  106. package/lib/service/cosmo/tag/index.js +93 -0
  107. package/lib/service/dali/avatar/DaliCosmoSpace.d.ts +10 -4
  108. package/lib/service/dali/avatar/DaliCosmoSpace.js +8 -7
  109. package/lib/service/dali/avatar/DaliFuseSpace.d.ts +10 -4
  110. package/lib/service/dali/avatar/DaliFuseSpace.js +7 -6
  111. package/lib/service/dali/avatar/DaliHigh5Pool.d.ts +10 -4
  112. package/lib/service/dali/avatar/DaliHigh5Pool.js +7 -6
  113. package/lib/service/dali/avatar/DaliHigh5Space.d.ts +10 -4
  114. package/lib/service/dali/avatar/DaliHigh5Space.js +7 -6
  115. package/lib/service/dali/avatar/DaliOAuthApp.d.ts +10 -4
  116. package/lib/service/dali/avatar/DaliOAuthApp.js +7 -6
  117. package/lib/service/dali/avatar/DaliOrganization.d.ts +10 -4
  118. package/lib/service/dali/avatar/DaliOrganization.js +7 -6
  119. package/lib/service/dali/avatar/DaliServiceAccount.d.ts +10 -4
  120. package/lib/service/dali/avatar/DaliServiceAccount.js +7 -6
  121. package/lib/service/dali/avatar/DaliTeam.d.ts +10 -4
  122. package/lib/service/dali/avatar/DaliTeam.js +7 -6
  123. package/lib/service/dali/avatar/DaliUser.d.ts +10 -4
  124. package/lib/service/dali/avatar/DaliUser.js +7 -6
  125. package/lib/service/dali/index.d.ts +4 -5
  126. package/lib/service/dali/index.js +2 -5
  127. package/lib/service/fuse/index.d.ts +4 -2
  128. package/lib/service/fuse/index.js +2 -2
  129. package/lib/service/fuse/internal/index.d.ts +4 -2
  130. package/lib/service/fuse/internal/index.js +3 -2
  131. package/lib/service/fuse/internal/space/cronjob/log/index.d.ts +4 -2
  132. package/lib/service/fuse/internal/space/cronjob/log/index.js +2 -2
  133. package/lib/service/fuse/internal/space/index.d.ts +7 -3
  134. package/lib/service/fuse/internal/space/index.js +6 -4
  135. package/lib/service/fuse/space/cronjob/index.d.ts +35 -13
  136. package/lib/service/fuse/space/cronjob/index.js +48 -50
  137. package/lib/service/fuse/space/cronjob/log/index.d.ts +8 -4
  138. package/lib/service/fuse/space/cronjob/log/index.js +5 -5
  139. package/lib/service/fuse/space/index.d.ts +27 -11
  140. package/lib/service/fuse/space/index.js +19 -18
  141. package/lib/service/high5/execution/index.d.ts +4 -2
  142. package/lib/service/high5/execution/index.js +3 -2
  143. package/lib/service/high5/execution/status/index.d.ts +5 -3
  144. package/lib/service/high5/execution/status/index.js +3 -3
  145. package/lib/service/high5/index.d.ts +7 -2
  146. package/lib/service/high5/index.js +9 -2
  147. package/lib/service/high5/internal/index.d.ts +4 -2
  148. package/lib/service/high5/internal/index.js +3 -2
  149. package/lib/service/high5/internal/space/index.d.ts +10 -3
  150. package/lib/service/high5/internal/space/index.js +13 -4
  151. package/lib/service/high5/internal/space/job/index.d.ts +7 -0
  152. package/lib/service/high5/internal/space/job/index.js +17 -0
  153. package/lib/service/high5/internal/space/job/log/index.d.ts +17 -0
  154. package/lib/service/high5/internal/space/job/log/index.js +34 -0
  155. package/lib/service/high5/joinToken/index.d.ts +14 -6
  156. package/lib/service/high5/joinToken/index.js +10 -9
  157. package/lib/service/high5/space/database/document/array/index.d.ts +73 -0
  158. package/lib/service/high5/space/database/document/array/index.js +102 -0
  159. package/lib/service/{friday → high5}/space/database/document/index.d.ts +26 -10
  160. package/lib/service/{friday → high5}/space/database/document/index.js +31 -16
  161. package/lib/service/high5/space/database/document/number/index.d.ts +51 -0
  162. package/lib/service/high5/space/database/document/number/index.js +77 -0
  163. package/lib/service/{friday → high5}/space/database/index.d.ts +22 -12
  164. package/lib/service/{friday → high5}/space/database/index.js +18 -17
  165. package/lib/service/high5/space/event/index.d.ts +17 -7
  166. package/lib/service/high5/space/event/index.js +12 -11
  167. package/lib/service/high5/space/event/stream/design/DesignOperations.d.ts +4 -2
  168. package/lib/service/high5/space/event/stream/design/DesignOperations.js +2 -2
  169. package/lib/service/high5/space/event/stream/design/index.d.ts +10 -4
  170. package/lib/service/high5/space/event/stream/design/index.js +7 -6
  171. package/lib/service/high5/space/event/stream/design/snapshot/index.d.ts +16 -6
  172. package/lib/service/high5/space/event/stream/design/snapshot/index.js +12 -10
  173. package/lib/service/high5/space/event/stream/index.d.ts +32 -12
  174. package/lib/service/high5/space/event/stream/index.js +22 -21
  175. package/lib/service/high5/space/execution/index.d.ts +19 -7
  176. package/lib/service/high5/space/execution/index.js +17 -12
  177. package/lib/service/high5/space/execution/log/index.d.ts +8 -4
  178. package/lib/service/high5/space/execution/log/index.js +5 -5
  179. package/lib/service/high5/space/execution/status/index.d.ts +7 -3
  180. package/lib/service/high5/space/execution/status/index.js +4 -4
  181. package/lib/service/high5/space/index.d.ts +43 -14
  182. package/lib/service/high5/space/index.js +45 -23
  183. package/lib/service/high5/space/job/index.d.ts +145 -0
  184. package/lib/service/high5/space/job/index.js +201 -0
  185. package/lib/service/high5/space/job/log/index.d.ts +35 -0
  186. package/lib/service/high5/space/job/log/index.js +58 -0
  187. package/lib/service/high5/space/node/index.d.ts +20 -8
  188. package/lib/service/high5/space/node/index.js +14 -13
  189. package/lib/service/high5/space/pool/index.d.ts +27 -11
  190. package/lib/service/high5/space/pool/index.js +19 -18
  191. package/lib/service/high5/space/secret/index.d.ts +17 -7
  192. package/lib/service/high5/space/secret/index.js +12 -11
  193. package/lib/service/high5/space/stat/index.d.ts +12 -0
  194. package/lib/service/high5/space/stat/index.js +31 -0
  195. package/lib/service/high5/space/wave/index.d.ts +16 -6
  196. package/lib/service/high5/space/wave/index.js +11 -10
  197. package/lib/service/high5/space/webhook/index.d.ts +32 -12
  198. package/lib/service/high5/space/webhook/index.js +25 -21
  199. package/lib/service/high5/space/webhook/log/index.d.ts +4 -2
  200. package/lib/service/high5/space/webhook/log/index.js +2 -2
  201. package/lib/service/high5/stat/index.d.ts +11 -0
  202. package/lib/service/high5/stat/index.js +30 -0
  203. package/lib/service/high5/wave/s3/index.d.ts +31 -8
  204. package/lib/service/high5/wave/s3/index.js +42 -21
  205. package/lib/service/idp/guest/index.d.ts +42 -0
  206. package/lib/service/idp/guest/index.js +66 -0
  207. package/lib/service/idp/index.d.ts +25 -7
  208. package/lib/service/idp/index.js +23 -12
  209. package/lib/service/idp/internal/index.d.ts +5 -3
  210. package/lib/service/idp/internal/index.js +5 -3
  211. package/lib/service/idp/oauth/index.d.ts +16 -6
  212. package/lib/service/idp/oauth/index.js +15 -15
  213. package/lib/service/idp/organization/index.d.ts +19 -5
  214. package/lib/service/idp/organization/index.js +19 -8
  215. package/lib/service/idp/organization/license/index.d.ts +7 -3
  216. package/lib/service/idp/organization/license/index.js +4 -4
  217. package/lib/service/idp/organization/member/index.d.ts +20 -8
  218. package/lib/service/idp/organization/member/index.js +15 -13
  219. package/lib/service/idp/organization/member/invitations/index.d.ts +23 -9
  220. package/lib/service/idp/organization/member/invitations/index.js +72 -59
  221. package/lib/service/idp/organization/service-accounts/index.d.ts +20 -8
  222. package/lib/service/idp/organization/service-accounts/index.js +13 -12
  223. package/lib/service/idp/organization/settings/domain/index.d.ts +13 -5
  224. package/lib/service/idp/organization/settings/domain/index.js +9 -8
  225. package/lib/service/idp/organization/settings/domain/saml/index.d.ts +16 -6
  226. package/lib/service/idp/organization/settings/domain/saml/index.js +19 -18
  227. package/lib/service/idp/organization/settings/oauth/index.d.ts +23 -9
  228. package/lib/service/idp/organization/settings/oauth/index.js +16 -15
  229. package/lib/service/idp/organization/stat/index.d.ts +11 -0
  230. package/lib/service/idp/organization/stat/index.js +30 -0
  231. package/lib/service/idp/organization/team/index.d.ts +22 -10
  232. package/lib/service/idp/organization/team/index.js +14 -13
  233. package/lib/service/idp/registration/index.d.ts +10 -4
  234. package/lib/service/idp/registration/index.js +15 -9
  235. package/lib/service/idp/user/index.d.ts +33 -11
  236. package/lib/service/idp/user/index.js +29 -16
  237. package/lib/service/idp/user/license/index.d.ts +7 -3
  238. package/lib/service/idp/user/license/index.js +4 -4
  239. package/lib/service/idp/user/message/index.d.ts +61 -0
  240. package/lib/service/idp/user/message/index.js +92 -0
  241. package/lib/service/idp/user/password/index.d.ts +4 -2
  242. package/lib/service/idp/user/password/index.js +2 -2
  243. package/lib/service/idp/user/settings/connections/index.d.ts +4 -2
  244. package/lib/service/idp/user/settings/connections/index.js +2 -2
  245. package/lib/service/idp/user/settings/general/index.d.ts +10 -4
  246. package/lib/service/idp/user/settings/general/index.js +6 -6
  247. package/lib/service/idp/user/settings/notifications/index.d.ts +7 -3
  248. package/lib/service/idp/user/settings/notifications/index.js +4 -4
  249. package/lib/service/idp/user/settings/oauthApps/index.d.ts +7 -3
  250. package/lib/service/idp/user/settings/oauthApps/index.js +6 -5
  251. package/lib/service/idp/user/settings/pats/index.d.ts +22 -8
  252. package/lib/service/idp/user/settings/pats/index.js +17 -15
  253. package/lib/service/idp/user/settings/twoFactor/totp/index.d.ts +16 -6
  254. package/lib/service/idp/user/settings/twoFactor/totp/index.js +13 -10
  255. package/lib/service/mailer/index.d.ts +4 -2
  256. package/lib/service/mailer/index.js +2 -2
  257. package/lib/service/mailer/internal/index.d.ts +13 -5
  258. package/lib/service/mailer/internal/index.js +8 -8
  259. package/lib/service/mothership/index.d.ts +35 -13
  260. package/lib/service/mothership/index.js +32 -17
  261. package/lib/service/nats/index.js +58 -43
  262. package/lib/service/shorts/index.d.ts +18 -0
  263. package/lib/service/{friday → shorts}/index.js +13 -10
  264. package/lib/service/shorts/internal/index.d.ts +72 -0
  265. package/lib/service/shorts/internal/index.js +104 -0
  266. package/package.json +1 -1
  267. package/lib/interfaces/friday/index.d.ts +0 -3
  268. package/lib/interfaces/friday/index.js +0 -19
  269. package/lib/interfaces/friday/space/index.d.ts +0 -21
  270. package/lib/interfaces/friday/space/index.js +0 -11
  271. package/lib/service/friday/index.d.ts +0 -13
  272. package/lib/service/friday/space/index.d.ts +0 -81
  273. package/lib/service/friday/space/index.js +0 -150
  274. /package/lib/interfaces/{friday/space/database → cosmo/location}/index.js +0 -0
  275. /package/lib/interfaces/{friday → high5}/space/database/index.d.ts +0 -0
@@ -18,10 +18,10 @@ class High5Wave extends Base_1.default {
18
18
  * @param spacePatchWaveEngine - Patch wave engine object holding url and version
19
19
  * @returns WaveEngine object
20
20
  */
21
- patchSpaceWaveEngine(orgName, spaceName, spacePatchWaveEngine) {
21
+ patchSpaceWaveEngine(orgName, spaceName, spacePatchWaveEngine, raw) {
22
22
  return __awaiter(this, void 0, void 0, function* () {
23
23
  const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/wave/engine`), spacePatchWaveEngine);
24
- return resp.data;
24
+ return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
25
25
  });
26
26
  }
27
27
  /**
@@ -30,10 +30,10 @@ class High5Wave extends Base_1.default {
30
30
  * @param spaceName - Name of the space
31
31
  * @returns WaveEngine object
32
32
  */
33
- getSpaceWaveEngine(orgName, spaceName) {
33
+ getSpaceWaveEngine(orgName, spaceName, raw) {
34
34
  return __awaiter(this, void 0, void 0, function* () {
35
35
  const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/wave/engine`));
36
- return resp.data;
36
+ return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
37
37
  });
38
38
  }
39
39
  /**
@@ -43,10 +43,10 @@ class High5Wave extends Base_1.default {
43
43
  * @param spacePatchWaveCatalog - Patch wave catalog object holding url, version and optionally a minimumEngineVersion
44
44
  * @returns WaveCatalog object
45
45
  */
46
- addUpdateSpaceWaveCatalog(orgName, spaceName, spacePatchCatalog) {
46
+ addUpdateSpaceWaveCatalog(orgName, spaceName, spacePatchCatalog, raw) {
47
47
  return __awaiter(this, void 0, void 0, function* () {
48
48
  const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/wave/catalog`), spacePatchCatalog);
49
- return resp.data;
49
+ return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
50
50
  });
51
51
  }
52
52
  /**
@@ -55,15 +55,16 @@ class High5Wave extends Base_1.default {
55
55
  * @param spaceName - Name of the space
56
56
  * @returns WaveCatalog array
57
57
  */
58
- getSpaceWaveCatalogs(orgName, spaceName) {
58
+ getSpaceWaveCatalogs(orgName, spaceName, raw) {
59
59
  return __awaiter(this, void 0, void 0, function* () {
60
60
  const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/wave/catalog`));
61
- return resp.data;
61
+ return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
62
62
  });
63
63
  }
64
- deleteSpaceWaveCatalog(orgName, spaceName, catalogId) {
64
+ deleteSpaceWaveCatalog(orgName, spaceName, catalogId, raw) {
65
65
  return __awaiter(this, void 0, void 0, function* () {
66
- yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/wave/catalog/${catalogId}`));
66
+ const resp = yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/wave/catalog/${catalogId}`));
67
+ return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
67
68
  });
68
69
  }
69
70
  getEndpoint(endpoint) {
@@ -1,4 +1,4 @@
1
- import Base from "../../../../Base";
1
+ import Base, { MaybeRaw } from "../../../../Base";
2
2
  import { PaginatedResponse, SearchParams } from "../../../../interfaces/global";
3
3
  import { KeyValuePair, Webhook, WebhookCreate, WebhookUpdate } from "../../../../interfaces/high5/space/webhook";
4
4
  import { High5WebhookLog } from "./log";
@@ -15,10 +15,12 @@ export declare class High5Webhook extends Base {
15
15
  * @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
16
16
  * @returns Object containing an array of Webhooks and the total number of results found in the database (independent of limit and page)
17
17
  */
18
- searchWebhooks({ orgName, spaceName, filters, sorting, limit, page, }: SearchParams & {
18
+ searchWebhooks<R extends boolean = false>({ orgName, spaceName, filters, sorting, limit, page }: SearchParams & {
19
19
  orgName: string;
20
20
  spaceName: string;
21
- }): Promise<PaginatedResponse<Webhook>>;
21
+ }, raw?: {
22
+ raw: R;
23
+ }): Promise<MaybeRaw<R, PaginatedResponse<Webhook>>>;
22
24
  /**
23
25
  * Requests a Webhhok by its ID.
24
26
  * @param orgName Name of the Organization
@@ -26,7 +28,9 @@ export declare class High5Webhook extends Base {
26
28
  * @param webhookId ID of the Webhook
27
29
  * @returns The requested Webhook
28
30
  */
29
- getWebhook(orgName: string, spaceName: string, webhookId: string): Promise<Webhook>;
31
+ getWebhook<R extends boolean = false>(orgName: string, spaceName: string, webhookId: string, raw?: {
32
+ raw: R;
33
+ }): Promise<MaybeRaw<R, Webhook>>;
30
34
  /**
31
35
  * Generates a new URL for the specified Webhook. This is suggested if a leak of the current URL is likely.
32
36
  * @param orgName Name of the Organization
@@ -34,7 +38,9 @@ export declare class High5Webhook extends Base {
34
38
  * @param webhookId ID of the Webhook
35
39
  * @returns The updated Webhook
36
40
  */
37
- regenerateWebhookUrl(orgName: string, spaceName: string, webhookId: string): Promise<Webhook>;
41
+ regenerateWebhookUrl<R extends boolean = false>(orgName: string, spaceName: string, webhookId: string, raw?: {
42
+ raw: R;
43
+ }): Promise<MaybeRaw<R, Webhook>>;
38
44
  /**
39
45
  * Creates a new Webhook in the specified High5 space.
40
46
  * @param orgName Name of the Organization
@@ -42,7 +48,9 @@ export declare class High5Webhook extends Base {
42
48
  * @param WebhookCreate Object/JSON containing the name, token, eventId, spaceId, target and (optionally) security headers for the new webhook
43
49
  * @returns The created Webhook
44
50
  */
45
- createWebhook(orgName: string, spaceName: string, WebhookCreate: WebhookCreate): Promise<Webhook>;
51
+ createWebhook<R extends boolean = false>(orgName: string, spaceName: string, WebhookCreate: WebhookCreate, raw?: {
52
+ raw: R;
53
+ }): Promise<MaybeRaw<R, Webhook>>;
46
54
  /**
47
55
  * Updates an existing Webhook.
48
56
  * @param orgName Name of the Organization
@@ -51,26 +59,34 @@ export declare class High5Webhook extends Base {
51
59
  * @param WebhookCreate Object/JSON containing the name, token, eventId, spaceId, target and (optionally) security headers for the updated webhook
52
60
  * @returns the updated Webhook
53
61
  */
54
- updateWebhook(orgName: string, spaceName: string, webhookId: string, webhookUpdate: WebhookUpdate): Promise<Webhook>;
62
+ updateWebhook<R extends boolean = false>(orgName: string, spaceName: string, webhookId: string, webhookUpdate: WebhookUpdate, raw?: {
63
+ raw: R;
64
+ }): Promise<MaybeRaw<R, Webhook>>;
55
65
  /**
56
66
  * Deletes a Webhook by its ID.
57
67
  * @param orgName Name of the Organization
58
68
  * @param spaceName Name of the Space
59
69
  * @param webhookId ID of the webhook to be deleted
60
70
  */
61
- deleteWebhook(orgName: string, spaceName: string, webhookId: string): Promise<void>;
71
+ deleteWebhook<R extends boolean = false>(orgName: string, spaceName: string, webhookId: string, raw?: {
72
+ raw: R;
73
+ }): Promise<MaybeRaw<R, Webhook[]>>;
62
74
  /**
63
75
  * Executes all Events and Streams connected to the specified Webhook.
64
76
  * @param webhookUrl URL of the webhook to be triggered / executed
65
77
  */
66
- triggerWebhook(webhookUrl: string): Promise<void>;
78
+ triggerWebhook<R extends boolean = false>(webhookUrl: string, raw?: {
79
+ raw: R;
80
+ }): Promise<MaybeRaw<R, void>>;
67
81
  /**
68
82
  * Executes a webhook by its URL.
69
83
  * @param webhookUrl Webhook URL to be triggered / executed (your hcloud domain + webhook.relativeUrl)
70
84
  * @param payload Payload to be used in the event execution that will be triggered by the webhook, as JSON.
71
85
  * @param headers (optional) Security headers.
72
86
  */
73
- executeWebhookByUrl(webhookUrl: string, payload: unknown, headers?: KeyValuePair<string>): Promise<void>;
87
+ executeWebhookByUrl<R extends boolean = false>(webhookUrl: string, payload: unknown, headers?: KeyValuePair<string>, raw?: {
88
+ raw: R;
89
+ }): Promise<MaybeRaw<R, void>>;
74
90
  /**
75
91
  * Respond to a webhook via callback.
76
92
  * @param callbackURL Full or partial URL callback URL. This URL is unique per webhook execution
@@ -78,13 +94,17 @@ export declare class High5Webhook extends Base {
78
94
  * @param headers (optional) HTTP headers to send in the response
79
95
  * @param body (optional) Body to send in the HTTP response
80
96
  */
81
- respondToWebhook(callbackURL: string, status: number, headers?: Record<string, string | string[]>, body?: string): Promise<void>;
97
+ respondToWebhook<R extends boolean = false>(callbackURL: string, status: number, headers?: Record<string, string | string[]>, body?: string, raw?: {
98
+ raw: R;
99
+ }): Promise<MaybeRaw<R, void>>;
82
100
  /**
83
101
  * Validates the provided webhook URL by sending a challenge query parameter.
84
102
  * @param url Webhook URL to be validated (your hcloud domain + webhook.relativeUrl)
85
103
  * @param challenge String to be returned
86
104
  * @returns The provided challenge string as plaint text
87
105
  */
88
- validateWebhookUrl(webhookUrl: string, challenge: string): Promise<string>;
106
+ validateWebhookUrl<R extends boolean = false>(webhookUrl: string, challenge: string, raw?: {
107
+ raw: R;
108
+ }): Promise<MaybeRaw<R, string>>;
89
109
  protected getEndpoint(endpoint: string): string;
90
110
  }
@@ -31,14 +31,14 @@ class High5Webhook extends Base_1.default {
31
31
  * @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
32
32
  * @returns Object containing an array of Webhooks and the total number of results found in the database (independent of limit and page)
33
33
  */
34
- searchWebhooks(_a) {
35
- return __awaiter(this, arguments, void 0, function* ({ orgName, spaceName, filters, sorting, limit = 25, page = 0, }) {
34
+ searchWebhooks(_a, raw_1) {
35
+ return __awaiter(this, arguments, void 0, function* ({ orgName, spaceName, filters, sorting, limit = 25, page = 0 }, raw) {
36
36
  const filtersDTO = filters === null || filters === void 0 ? void 0 : filters.map((f) => new searchFilter_1.SearchFilterDTO(f));
37
37
  const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/webhooks/search?limit=${limit}&page=${page}`), {
38
38
  filters: filtersDTO,
39
39
  sorting: sorting,
40
40
  });
41
- return (0, paginatedResponseHelper_1.createPaginatedResponse)(resp);
41
+ return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? Object.assign(Object.assign({}, resp), { data: (0, paginatedResponseHelper_1.createPaginatedResponse)(resp) }) : (0, paginatedResponseHelper_1.createPaginatedResponse)(resp));
42
42
  });
43
43
  }
44
44
  /**
@@ -48,10 +48,10 @@ class High5Webhook extends Base_1.default {
48
48
  * @param webhookId ID of the Webhook
49
49
  * @returns The requested Webhook
50
50
  */
51
- getWebhook(orgName, spaceName, webhookId) {
51
+ getWebhook(orgName, spaceName, webhookId, raw) {
52
52
  return __awaiter(this, void 0, void 0, function* () {
53
53
  const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/webhooks/${webhookId}`));
54
- return resp.data;
54
+ return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
55
55
  });
56
56
  }
57
57
  /**
@@ -61,10 +61,10 @@ class High5Webhook extends Base_1.default {
61
61
  * @param webhookId ID of the Webhook
62
62
  * @returns The updated Webhook
63
63
  */
64
- regenerateWebhookUrl(orgName, spaceName, webhookId) {
64
+ regenerateWebhookUrl(orgName, spaceName, webhookId, raw) {
65
65
  return __awaiter(this, void 0, void 0, function* () {
66
66
  const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/webhooks/${webhookId}/regenerateUrl`));
67
- return resp.data;
67
+ return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
68
68
  });
69
69
  }
70
70
  /**
@@ -74,10 +74,10 @@ class High5Webhook extends Base_1.default {
74
74
  * @param WebhookCreate Object/JSON containing the name, token, eventId, spaceId, target and (optionally) security headers for the new webhook
75
75
  * @returns The created Webhook
76
76
  */
77
- createWebhook(orgName, spaceName, WebhookCreate) {
77
+ createWebhook(orgName, spaceName, WebhookCreate, raw) {
78
78
  return __awaiter(this, void 0, void 0, function* () {
79
79
  const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/webhooks`), WebhookCreate);
80
- return resp.data;
80
+ return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
81
81
  });
82
82
  }
83
83
  /**
@@ -88,10 +88,10 @@ class High5Webhook extends Base_1.default {
88
88
  * @param WebhookCreate Object/JSON containing the name, token, eventId, spaceId, target and (optionally) security headers for the updated webhook
89
89
  * @returns the updated Webhook
90
90
  */
91
- updateWebhook(orgName, spaceName, webhookId, webhookUpdate) {
91
+ updateWebhook(orgName, spaceName, webhookId, webhookUpdate, raw) {
92
92
  return __awaiter(this, void 0, void 0, function* () {
93
93
  const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/webhooks/${webhookId}`), webhookUpdate);
94
- return resp.data;
94
+ return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
95
95
  });
96
96
  }
97
97
  /**
@@ -100,18 +100,20 @@ class High5Webhook extends Base_1.default {
100
100
  * @param spaceName Name of the Space
101
101
  * @param webhookId ID of the webhook to be deleted
102
102
  */
103
- deleteWebhook(orgName, spaceName, webhookId) {
103
+ deleteWebhook(orgName, spaceName, webhookId, raw) {
104
104
  return __awaiter(this, void 0, void 0, function* () {
105
- yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/webhooks/${webhookId}`));
105
+ const resp = yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/webhooks/${webhookId}`));
106
+ return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
106
107
  });
107
108
  }
108
109
  /**
109
110
  * Executes all Events and Streams connected to the specified Webhook.
110
111
  * @param webhookUrl URL of the webhook to be triggered / executed
111
112
  */
112
- triggerWebhook(webhookUrl) {
113
+ triggerWebhook(webhookUrl, raw) {
113
114
  return __awaiter(this, void 0, void 0, function* () {
114
- yield this.axios.post(this.getEndpoint(webhookUrl));
115
+ const resp = yield this.axios.post(this.getEndpoint(webhookUrl));
116
+ return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
115
117
  });
116
118
  }
117
119
  /**
@@ -120,7 +122,7 @@ class High5Webhook extends Base_1.default {
120
122
  * @param payload Payload to be used in the event execution that will be triggered by the webhook, as JSON.
121
123
  * @param headers (optional) Security headers.
122
124
  */
123
- executeWebhookByUrl(webhookUrl, payload, headers) {
125
+ executeWebhookByUrl(webhookUrl, payload, headers, raw) {
124
126
  return __awaiter(this, void 0, void 0, function* () {
125
127
  const h = {};
126
128
  if (headers) {
@@ -128,9 +130,10 @@ class High5Webhook extends Base_1.default {
128
130
  h[key] = headers[key];
129
131
  });
130
132
  }
131
- yield this.axios.post(this.getEndpoint(webhookUrl), payload, {
133
+ const resp = yield this.axios.post(this.getEndpoint(webhookUrl), payload, {
132
134
  headers: h,
133
135
  });
136
+ return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
134
137
  });
135
138
  }
136
139
  /**
@@ -140,10 +143,11 @@ class High5Webhook extends Base_1.default {
140
143
  * @param headers (optional) HTTP headers to send in the response
141
144
  * @param body (optional) Body to send in the HTTP response
142
145
  */
143
- respondToWebhook(callbackURL, status, headers, body) {
146
+ respondToWebhook(callbackURL, status, headers, body, raw) {
144
147
  return __awaiter(this, void 0, void 0, function* () {
145
148
  const url = callbackURL.startsWith("http") ? callbackURL : this.getEndpoint(callbackURL);
146
- yield this.axios.post(url, { status, headers: headers !== null && headers !== void 0 ? headers : {}, body }, { headers: { "Content-Type": "application/json" } });
149
+ const resp = yield this.axios.post(url, { status, headers: headers !== null && headers !== void 0 ? headers : {}, body }, { headers: { "Content-Type": "application/json" } });
150
+ return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
147
151
  });
148
152
  }
149
153
  /**
@@ -152,10 +156,10 @@ class High5Webhook extends Base_1.default {
152
156
  * @param challenge String to be returned
153
157
  * @returns The provided challenge string as plaint text
154
158
  */
155
- validateWebhookUrl(webhookUrl, challenge) {
159
+ validateWebhookUrl(webhookUrl, challenge, raw) {
156
160
  return __awaiter(this, void 0, void 0, function* () {
157
161
  const resp = yield this.axios.get(this.getEndpoint(`${webhookUrl}?challenge=${challenge}`));
158
- return resp.data;
162
+ return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
159
163
  });
160
164
  }
161
165
  getEndpoint(endpoint) {
@@ -1,4 +1,4 @@
1
- import Base from "../../../../../Base";
1
+ import Base, { MaybeRaw } from "../../../../../Base";
2
2
  import { PaginatedResponse } from "../../../../../interfaces/global";
3
3
  import { WebhookLog } from "../../../../../interfaces/high5/space/webhook";
4
4
  export declare class High5WebhookLog extends Base {
@@ -11,6 +11,8 @@ export declare class High5WebhookLog extends Base {
11
11
  * @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
12
12
  * @returns Object containing an array of Webhook logs and the total number of results found in the database (independent of limit and page)
13
13
  */
14
- getWebhookLogs(orgName: string, spaceName: string, webhookId: string, limit?: number, page?: number): Promise<PaginatedResponse<WebhookLog>>;
14
+ getWebhookLogs<R extends boolean = false>(orgName: string, spaceName: string, webhookId: string, limit?: number, page?: number, raw?: {
15
+ raw: R;
16
+ }): Promise<MaybeRaw<R, PaginatedResponse<WebhookLog>>>;
15
17
  protected getEndpoint(endpoint: string): string;
16
18
  }
@@ -22,12 +22,12 @@ class High5WebhookLog extends Base_1.default {
22
22
  * @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
23
23
  * @returns Object containing an array of Webhook logs and the total number of results found in the database (independent of limit and page)
24
24
  */
25
- getWebhookLogs(orgName, spaceName, webhookId, limit, page) {
25
+ getWebhookLogs(orgName, spaceName, webhookId, limit, page, raw) {
26
26
  return __awaiter(this, void 0, void 0, function* () {
27
27
  limit = limit || 25;
28
28
  page = page || 0;
29
29
  const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/webhooks/${webhookId}/logs?limit=${limit}&page=${page}`));
30
- return (0, paginatedResponseHelper_1.createPaginatedResponse)(resp);
30
+ return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? Object.assign(Object.assign({}, resp), { data: (0, paginatedResponseHelper_1.createPaginatedResponse)(resp) }) : (0, paginatedResponseHelper_1.createPaginatedResponse)(resp));
31
31
  });
32
32
  }
33
33
  getEndpoint(endpoint) {
@@ -0,0 +1,11 @@
1
+ import Base from "../../../Base";
2
+ import { Stats } from "../../../interfaces/high5/stats";
3
+ export declare class High5OrgStat extends Base {
4
+ /**
5
+ * Retrieves usage statistics for a specific organization.
6
+ * @param orgName Name of the organization
7
+ * @returns Statistics information
8
+ */
9
+ getStats(orgName: string): Promise<Stats>;
10
+ protected getEndpoint(endpoint: string): string;
11
+ }
@@ -0,0 +1,30 @@
1
+ "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.High5OrgStat = void 0;
13
+ const Base_1 = require("../../../Base");
14
+ class High5OrgStat extends Base_1.default {
15
+ /**
16
+ * Retrieves usage statistics for a specific organization.
17
+ * @param orgName Name of the organization
18
+ * @returns Statistics information
19
+ */
20
+ getStats(orgName) {
21
+ return __awaiter(this, void 0, void 0, function* () {
22
+ const resp = yield this.axios.get(this.getEndpoint(`/org/${orgName}/stats`));
23
+ return resp.data;
24
+ });
25
+ }
26
+ getEndpoint(endpoint) {
27
+ return `${this.options.server}/api/high5/v1${endpoint}`;
28
+ }
29
+ }
30
+ exports.High5OrgStat = High5OrgStat;
@@ -1,6 +1,7 @@
1
1
  import { AxiosInstance } from "axios";
2
- import Base, { Options } from "../../../../Base";
2
+ import Base, { MaybeRaw, Options } from "../../../../Base";
3
3
  import { Catalog, CatalogRegistry, Engine, EngineRegistry, StreamNodeSpecifications, StreamNodeSpecificationWrappedWithEngineVersion, WildcardRegistry } from "../../../../interfaces/high5";
4
+ import { Release } from "../../../../interfaces/high5/wave/changelog";
4
5
  /**
5
6
  * Class for reading the S3 bucket of a wave engine and catalogs
6
7
  */
@@ -11,45 +12,67 @@ export declare class S3 extends Base {
11
12
  * @param waveBucketUrl Public base url to S3 bucket
12
13
  * @returns registry.json
13
14
  */
14
- getCatalogRegistry(waveBucketUrl: string): Promise<CatalogRegistry>;
15
+ getCatalogRegistry<R extends boolean = false>(waveBucketUrl: string, raw?: {
16
+ raw: R;
17
+ }): Promise<MaybeRaw<R, CatalogRegistry>>;
15
18
  /**
16
19
  * Get the registry.json of the default wave engine from the S3 bucket
17
20
  * @param waveBucketUrl Public base url to S3 bucket
18
21
  * @returns registry.json
19
22
  */
20
- getEngineRegistry(waveBucketUrl: string): Promise<EngineRegistry>;
23
+ getEngineRegistry<R extends boolean = false>(waveBucketUrl: string, raw?: {
24
+ raw: R;
25
+ }): Promise<MaybeRaw<R, EngineRegistry>>;
21
26
  /**
22
27
  * Get the catalog.json from the S3 bucket
23
28
  * @param catalogUrl Public url of the catalog
24
29
  * @returns index.json of catalog
25
30
  */
26
- getCatalog(catalogUrl: string): Promise<Catalog>;
31
+ getCatalog<R extends boolean = false>(catalogUrl: string, raw?: {
32
+ raw: R;
33
+ }): Promise<MaybeRaw<R, Catalog>>;
27
34
  /**
28
35
  * Get the catalog.json from the S3 bucket
29
36
  * @param catalogUrl Public url of the catalog
30
37
  * @returns index.json of catalog
31
38
  */
32
- getEngine(engineUrl: string): Promise<Engine>;
39
+ getEngine<R extends boolean = false>(engineUrl: string, raw?: {
40
+ raw: R;
41
+ }): Promise<MaybeRaw<R, Engine>>;
33
42
  /**
34
43
  * Get a list of available wildcards of a specific engine version from the S3 bucket
35
44
  * @param engineUrl Public url of the engine
36
45
  * @param engineVersion Version of the enigne
37
46
  * @returns Wildcards.json list of available wildcards
38
47
  */
39
- getWildcardsOfEngine(engineUrl: string, engineVersion: string): Promise<WildcardRegistry>;
48
+ getWildcardsOfEngine<R extends boolean = false>(engineUrl: string, engineVersion: string, raw?: {
49
+ raw: R;
50
+ }): Promise<MaybeRaw<R, WildcardRegistry>>;
40
51
  /**
41
52
  * Get the node specifications of all nodes of a specific catalog version from the S3 bucket
42
53
  * @param catalogUrl Public url of the catalog
43
54
  * @param version The catalog version
44
55
  * @returns StreamNodeSpecification[] | StreamNodeSpecificationWrappedWithEngineVersion an array of all node specification of that catalog version, maybe wrapped in an object with the engine version
45
56
  */
46
- getCatalogVersion(catalogUrl: string, version: string): Promise<StreamNodeSpecifications[] | StreamNodeSpecificationWrappedWithEngineVersion>;
57
+ getCatalogVersion<R extends boolean = false>(catalogUrl: string, version: string, raw?: {
58
+ raw: R;
59
+ }): Promise<MaybeRaw<R, StreamNodeSpecifications[] | StreamNodeSpecificationWrappedWithEngineVersion>>;
47
60
  /**
48
61
  * Get the node documentation from the S3 bucket
49
62
  * @param catalogUrl Public url of the catalog
50
63
  * @param version The catalog version
51
64
  * @returns string the markdown documentation of the node
52
65
  */
53
- getNodeDocumentation(catalogUrl: string, version: string, nodeName: string): Promise<string>;
66
+ getNodeDocumentation<R extends boolean = false>(catalogUrl: string, version: string, nodeName: string, raw?: {
67
+ raw: R;
68
+ }): Promise<MaybeRaw<R, string>>;
69
+ /**
70
+ * Get the catalogs changelog from the S3 bucket
71
+ * @param catalogUrl Public url of the catalog
72
+ * @returns string the changelog.json of the node
73
+ */
74
+ getChangelog<R extends boolean = false>(catalogUrl: string, raw?: {
75
+ raw: R;
76
+ }): Promise<MaybeRaw<R, Release[]>>;
54
77
  protected getEndpoint(): string;
55
78
  }
@@ -27,12 +27,12 @@ class S3 extends Base_1.default {
27
27
  * @param waveBucketUrl Public base url to S3 bucket
28
28
  * @returns registry.json
29
29
  */
30
- getCatalogRegistry(waveBucketUrl) {
30
+ getCatalogRegistry(waveBucketUrl, raw) {
31
31
  return __awaiter(this, void 0, void 0, function* () {
32
32
  const resp = yield axios_1.default.get(`${waveBucketUrl}/catalogs/registry.json`, {
33
- headers: Object.assign(Object.assign({}, axios_2.disableCacheHeaders), { "x-hcloud-user-agent": sdkVersion }),
33
+ headers: Object.assign(Object.assign({}, axios_2.disableCacheHeaders), { "x-hcloud-user-agent": sdkVersion, Authorization: undefined }),
34
34
  });
35
- return resp.data;
35
+ return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
36
36
  });
37
37
  }
38
38
  /**
@@ -40,12 +40,12 @@ class S3 extends Base_1.default {
40
40
  * @param waveBucketUrl Public base url to S3 bucket
41
41
  * @returns registry.json
42
42
  */
43
- getEngineRegistry(waveBucketUrl) {
43
+ getEngineRegistry(waveBucketUrl, raw) {
44
44
  return __awaiter(this, void 0, void 0, function* () {
45
45
  const resp = yield axios_1.default.get(`${waveBucketUrl}/engines/registry.json`, {
46
- headers: Object.assign(Object.assign({}, axios_2.disableCacheHeaders), { "x-hcloud-user-agent": sdkVersion }),
46
+ headers: Object.assign(Object.assign({}, axios_2.disableCacheHeaders), { "x-hcloud-user-agent": sdkVersion, Authorization: undefined }),
47
47
  });
48
- return resp.data;
48
+ return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
49
49
  });
50
50
  }
51
51
  /**
@@ -53,10 +53,12 @@ class S3 extends Base_1.default {
53
53
  * @param catalogUrl Public url of the catalog
54
54
  * @returns index.json of catalog
55
55
  */
56
- getCatalog(catalogUrl) {
56
+ getCatalog(catalogUrl, raw) {
57
57
  return __awaiter(this, void 0, void 0, function* () {
58
- const resp = yield axios_1.default.get(`${catalogUrl}`, { headers: Object.assign(Object.assign({}, axios_2.disableCacheHeaders), { "x-hcloud-user-agent": sdkVersion }) });
59
- return resp.data;
58
+ const resp = yield axios_1.default.get(`${catalogUrl}`, {
59
+ headers: Object.assign(Object.assign({}, axios_2.disableCacheHeaders), { "x-hcloud-user-agent": sdkVersion, Authorization: undefined }),
60
+ });
61
+ return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
60
62
  });
61
63
  }
62
64
  /**
@@ -64,10 +66,12 @@ class S3 extends Base_1.default {
64
66
  * @param catalogUrl Public url of the catalog
65
67
  * @returns index.json of catalog
66
68
  */
67
- getEngine(engineUrl) {
69
+ getEngine(engineUrl, raw) {
68
70
  return __awaiter(this, void 0, void 0, function* () {
69
- const resp = yield axios_1.default.get(`${engineUrl}`, { headers: Object.assign(Object.assign({}, axios_2.disableCacheHeaders), { "x-hcloud-user-agent": sdkVersion }) });
70
- return resp.data;
71
+ const resp = yield axios_1.default.get(`${engineUrl}`, {
72
+ headers: Object.assign(Object.assign({}, axios_2.disableCacheHeaders), { "x-hcloud-user-agent": sdkVersion, Authorization: undefined }),
73
+ });
74
+ return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
71
75
  });
72
76
  }
73
77
  /**
@@ -76,12 +80,12 @@ class S3 extends Base_1.default {
76
80
  * @param engineVersion Version of the enigne
77
81
  * @returns Wildcards.json list of available wildcards
78
82
  */
79
- getWildcardsOfEngine(engineUrl, engineVersion) {
83
+ getWildcardsOfEngine(engineUrl, engineVersion, raw) {
80
84
  return __awaiter(this, void 0, void 0, function* () {
81
85
  const resp = yield axios_1.default.get(`${engineUrl.replace("/index.json", "")}/${engineVersion}/wildcards.json`, {
82
- headers: Object.assign(Object.assign({}, axios_2.disableCacheHeaders), { "x-hcloud-user-agent": sdkVersion }),
86
+ headers: Object.assign(Object.assign({}, axios_2.disableCacheHeaders), { "x-hcloud-user-agent": sdkVersion, Authorization: undefined }),
83
87
  });
84
- return resp.data;
88
+ return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
85
89
  });
86
90
  }
87
91
  /**
@@ -90,13 +94,13 @@ class S3 extends Base_1.default {
90
94
  * @param version The catalog version
91
95
  * @returns StreamNodeSpecification[] | StreamNodeSpecificationWrappedWithEngineVersion an array of all node specification of that catalog version, maybe wrapped in an object with the engine version
92
96
  */
93
- getCatalogVersion(catalogUrl, version) {
97
+ getCatalogVersion(catalogUrl, version, raw) {
94
98
  return __awaiter(this, void 0, void 0, function* () {
95
99
  const specificationUrl = catalogUrl.split("/").slice(0, -1).join("/") + "/" + version + "/specification.json";
96
100
  const resp = yield axios_1.default.get(specificationUrl, {
97
- headers: Object.assign(Object.assign({}, axios_2.disableCacheHeaders), { "x-hcloud-user-agent": sdkVersion }),
101
+ headers: Object.assign(Object.assign({}, axios_2.disableCacheHeaders), { "x-hcloud-user-agent": sdkVersion, Authorization: undefined }),
98
102
  });
99
- return resp.data;
103
+ return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
100
104
  });
101
105
  }
102
106
  /**
@@ -105,13 +109,30 @@ class S3 extends Base_1.default {
105
109
  * @param version The catalog version
106
110
  * @returns string the markdown documentation of the node
107
111
  */
108
- getNodeDocumentation(catalogUrl, version, nodeName) {
112
+ getNodeDocumentation(catalogUrl, version, nodeName, raw) {
109
113
  return __awaiter(this, void 0, void 0, function* () {
110
114
  const specificationUrl = catalogUrl.split("/").slice(0, -1).join("/") + `/${version}/docs/${nodeName}.md`;
111
- const resp = yield axios_1.default.get(specificationUrl).catch(err => {
115
+ const resp = yield axios_1.default
116
+ .get(specificationUrl, { headers: Object.assign(Object.assign({}, axios_2.disableCacheHeaders), { "x-hcloud-user-agent": sdkVersion, Authorization: undefined }) })
117
+ .catch(err => {
118
+ throw new Error(`Node documentation not found: ${err}`);
119
+ });
120
+ return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
121
+ });
122
+ }
123
+ /**
124
+ * Get the catalogs changelog from the S3 bucket
125
+ * @param catalogUrl Public url of the catalog
126
+ * @returns string the changelog.json of the node
127
+ */
128
+ getChangelog(catalogUrl, raw) {
129
+ return __awaiter(this, void 0, void 0, function* () {
130
+ const resp = yield axios_1.default
131
+ .get(catalogUrl + "changelog.json", { headers: Object.assign(Object.assign({}, axios_2.disableCacheHeaders), { "x-hcloud-user-agent": sdkVersion, Authorization: undefined }) })
132
+ .catch(err => {
112
133
  throw new Error(`Node documentation not found: ${err}`);
113
134
  });
114
- return resp.data;
135
+ return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
115
136
  });
116
137
  }
117
138
  getEndpoint() {
@@ -0,0 +1,42 @@
1
+ import Base, { MaybeRaw } from "../../../Base";
2
+ import { SuccessfulAuth } from "../../../interfaces/idp";
3
+ export declare class IdpGuest extends Base {
4
+ /**
5
+ * Creates a new guest user account.
6
+ *
7
+ * @param email - The email address of the guest to create.
8
+ * @param name - The display name of the guest user.
9
+ * @param emailHMAC - An HMAC signature of the email, used for validation.
10
+ * @returns A promise resolving to a `SuccessfulAuth` object containing:
11
+ * - `user`: The created `User` object.
12
+ * - `token`: An authorization token returned by the API.
13
+ */
14
+ createGuest<R extends boolean = false>(email: string, name: string, emailHMAC: string, raw?: {
15
+ raw: R;
16
+ }): Promise<MaybeRaw<R, SuccessfulAuth>>;
17
+ /**
18
+ * Logs in as an existing guest user.
19
+ *
20
+ * @param email - The email address of the guest to log in.
21
+ * @param emailHMAC - An HMAC signature of the email, used for validation.
22
+ * @returns A promise resolving to a `SuccessfulAuth` object containing:
23
+ * - `user`: The authenticated `User` object.
24
+ * - `token`: An authorization token returned by the API.
25
+ */
26
+ loginAsGuest<R extends boolean = false>(email: string, emailHMAC: string, raw?: {
27
+ raw: R;
28
+ }): Promise<MaybeRaw<R, SuccessfulAuth>>;
29
+ /**
30
+ * Checks whether an email corresponds to a guest account.
31
+ *
32
+ * @param email - The email address to check.
33
+ * @returns A promise resolving to one of:
34
+ * - `"no user"` → No user exists with the given email.
35
+ * - `"not guest"` → A user exists but is not a guest.
36
+ * - `"guest"` → The email belongs to a guest account.
37
+ */
38
+ isGuest<R extends boolean = false>(email: string, raw?: {
39
+ raw: R;
40
+ }): Promise<MaybeRaw<R, "no user" | "not guest" | "guest">>;
41
+ protected getEndpoint(endpoint: string): string;
42
+ }