@northflank/js-client 0.6.1 → 0.7.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 (359) hide show
  1. package/dist/cjs/api-client.d.ts +2168 -128
  2. package/dist/cjs/api-client.js +1 -1
  3. package/dist/cjs/api-endpoint.d.ts +57 -0
  4. package/dist/cjs/api-error.d.ts +16 -0
  5. package/dist/cjs/context/api-client-context-provider.d.ts +47 -0
  6. package/dist/cjs/context/api-client-file-context-provider.d.ts +11 -0
  7. package/dist/cjs/context/api-client-in-memory-context-provider.d.ts +6 -0
  8. package/dist/cjs/context/index.d.ts +3 -0
  9. package/dist/cjs/endpoints/abort/addon/backup.d.ts +21 -0
  10. package/dist/cjs/endpoints/abort/addon/restore.d.ts +26 -0
  11. package/dist/cjs/endpoints/abort/job/build.d.ts +21 -0
  12. package/dist/cjs/endpoints/abort/job/run.d.ts +21 -0
  13. package/dist/cjs/endpoints/abort/service/build.d.ts +21 -0
  14. package/dist/cjs/endpoints/add/domain/subdomain.d.ts +33 -0
  15. package/dist/cjs/endpoints/add/registry.d.ts +47 -0
  16. package/dist/cjs/endpoints/assign/subdomain/service.d.ts +28 -0
  17. package/dist/cjs/endpoints/attach/volume.d.ts +29 -0
  18. package/dist/cjs/endpoints/backup/addon.d.ts +51 -0
  19. package/dist/cjs/endpoints/create/addon/backupSchedule.d.ts +40 -0
  20. package/dist/cjs/endpoints/create/addon.d.ts +101 -0
  21. package/dist/cjs/endpoints/create/cluster.d.ts +97 -0
  22. package/dist/cjs/endpoints/create/domain.d.ts +27 -0
  23. package/dist/cjs/endpoints/create/integration.d.ts +58 -0
  24. package/dist/cjs/endpoints/create/job/cron.d.ts +247 -0
  25. package/dist/cjs/endpoints/create/job/manual.d.ts +237 -0
  26. package/dist/cjs/endpoints/create/project.d.ts +31 -0
  27. package/dist/cjs/endpoints/create/secret.d.ts +83 -0
  28. package/dist/cjs/endpoints/create/service/build.d.ts +161 -0
  29. package/dist/cjs/endpoints/create/service/combined.d.ts +255 -0
  30. package/dist/cjs/endpoints/create/service/deployment.d.ts +242 -0
  31. package/dist/cjs/endpoints/create/template.d.ts +132 -0
  32. package/dist/cjs/endpoints/create/volume.d.ts +78 -0
  33. package/dist/cjs/endpoints/delete/addon/backupSchedule.d.ts +21 -0
  34. package/dist/cjs/endpoints/delete/addon.d.ts +19 -0
  35. package/dist/cjs/endpoints/delete/backup.d.ts +21 -0
  36. package/dist/cjs/endpoints/delete/cluster.d.ts +17 -0
  37. package/dist/cjs/endpoints/delete/domain.d.ts +17 -0
  38. package/dist/cjs/endpoints/delete/integration.d.ts +17 -0
  39. package/dist/cjs/endpoints/delete/job.d.ts +19 -0
  40. package/dist/cjs/endpoints/delete/project.d.ts +17 -0
  41. package/dist/cjs/endpoints/delete/registry.d.ts +17 -0
  42. package/dist/cjs/endpoints/delete/secret.d.ts +19 -0
  43. package/dist/cjs/endpoints/delete/secretLink.d.ts +21 -0
  44. package/dist/cjs/endpoints/delete/service.d.ts +19 -0
  45. package/dist/cjs/endpoints/delete/subdomain.d.ts +19 -0
  46. package/dist/cjs/endpoints/delete/template.d.ts +17 -0
  47. package/dist/cjs/endpoints/delete/volume.d.ts +19 -0
  48. package/dist/cjs/endpoints/detach/volume.d.ts +21 -0
  49. package/dist/cjs/endpoints/get/addon/backup/download.d.ts +24 -0
  50. package/dist/cjs/endpoints/get/addon/backup.d.ts +46 -0
  51. package/dist/cjs/endpoints/get/addon/backupSchedules.d.ts +52 -0
  52. package/dist/cjs/endpoints/get/addon/backups.d.ts +54 -0
  53. package/dist/cjs/endpoints/get/addon/containers.d.ts +40 -0
  54. package/dist/cjs/endpoints/get/addon/credentials.d.ts +24 -0
  55. package/dist/cjs/endpoints/get/addon/types.d.ts +48 -0
  56. package/dist/cjs/endpoints/get/addon/version.d.ts +53 -0
  57. package/dist/cjs/endpoints/get/addon.d.ts +71 -0
  58. package/dist/cjs/endpoints/get/cluster.d.ts +55 -0
  59. package/dist/cjs/endpoints/get/dnsId.d.ts +15 -0
  60. package/dist/cjs/endpoints/get/domain.d.ts +33 -0
  61. package/dist/cjs/endpoints/get/integration.d.ts +37 -0
  62. package/dist/cjs/endpoints/get/invoice/details.d.ts +139 -0
  63. package/dist/cjs/endpoints/get/job/branches.d.ts +49 -0
  64. package/dist/cjs/endpoints/get/job/build.d.ts +42 -0
  65. package/dist/cjs/endpoints/get/job/buildArgumentDetails.d.ts +71 -0
  66. package/dist/cjs/endpoints/get/job/buildArguments.d.ts +29 -0
  67. package/dist/cjs/endpoints/get/job/builds.d.ts +52 -0
  68. package/dist/cjs/endpoints/get/job/containers.d.ts +40 -0
  69. package/dist/cjs/endpoints/get/job/deployment.d.ts +55 -0
  70. package/dist/cjs/endpoints/get/job/healthChecks.d.ts +45 -0
  71. package/dist/cjs/endpoints/get/job/pullRequests.d.ts +49 -0
  72. package/dist/cjs/endpoints/get/job/run.d.ts +44 -0
  73. package/dist/cjs/endpoints/get/job/runs.d.ts +54 -0
  74. package/dist/cjs/endpoints/get/job/runtimeEnvironment.d.ts +29 -0
  75. package/dist/cjs/endpoints/get/job/runtimeEnvironmentDetails.d.ts +71 -0
  76. package/dist/cjs/endpoints/get/job.d.ts +128 -0
  77. package/dist/cjs/endpoints/get/project.d.ts +72 -0
  78. package/dist/cjs/endpoints/get/registry.d.ts +34 -0
  79. package/dist/cjs/endpoints/get/secret.d.ts +55 -0
  80. package/dist/cjs/endpoints/get/secretDetails.d.ts +63 -0
  81. package/dist/cjs/endpoints/get/secretLink.d.ts +44 -0
  82. package/dist/cjs/endpoints/get/service/branches.d.ts +49 -0
  83. package/dist/cjs/endpoints/get/service/build.d.ts +42 -0
  84. package/dist/cjs/endpoints/get/service/buildArgumentDetails.d.ts +71 -0
  85. package/dist/cjs/endpoints/get/service/buildArguments.d.ts +29 -0
  86. package/dist/cjs/endpoints/get/service/builds.d.ts +52 -0
  87. package/dist/cjs/endpoints/get/service/containers.d.ts +40 -0
  88. package/dist/cjs/endpoints/get/service/deployment.d.ts +55 -0
  89. package/dist/cjs/endpoints/get/service/healthChecks.d.ts +45 -0
  90. package/dist/cjs/endpoints/get/service/ports.d.ts +70 -0
  91. package/dist/cjs/endpoints/get/service/pullRequests.d.ts +49 -0
  92. package/dist/cjs/endpoints/get/service/runtimeEnvironment.d.ts +29 -0
  93. package/dist/cjs/endpoints/get/service/runtimeEnvironmentDetails.d.ts +71 -0
  94. package/dist/cjs/endpoints/get/service.d.ts +211 -0
  95. package/dist/cjs/endpoints/get/subdomain.d.ts +30 -0
  96. package/dist/cjs/endpoints/get/template.d.ts +61 -0
  97. package/dist/cjs/endpoints/get/templateRun.d.ts +73 -0
  98. package/dist/cjs/endpoints/get/volume.d.ts +49 -0
  99. package/dist/cjs/endpoints/import/addon/backup.d.ts +31 -0
  100. package/dist/cjs/endpoints/list/addons.d.ts +45 -0
  101. package/dist/cjs/endpoints/list/branches.d.ts +51 -0
  102. package/dist/cjs/endpoints/list/clusters.d.ts +63 -0
  103. package/dist/cjs/endpoints/list/domains.d.ts +34 -0
  104. package/dist/cjs/endpoints/list/integrations.d.ts +36 -0
  105. package/dist/cjs/endpoints/list/invoices.d.ts +40 -0
  106. package/dist/cjs/endpoints/list/jobs.d.ts +46 -0
  107. package/dist/cjs/endpoints/list/plans.d.ts +30 -0
  108. package/dist/cjs/endpoints/list/projects.d.ts +32 -0
  109. package/dist/cjs/endpoints/list/providers.d.ts +37 -0
  110. package/dist/cjs/endpoints/list/regions.d.ts +18 -0
  111. package/dist/cjs/endpoints/list/registries.d.ts +41 -0
  112. package/dist/cjs/endpoints/list/repos.d.ts +51 -0
  113. package/dist/cjs/endpoints/list/secrets.d.ts +54 -0
  114. package/dist/cjs/endpoints/list/services.d.ts +65 -0
  115. package/dist/cjs/endpoints/list/templateRuns.d.ts +54 -0
  116. package/dist/cjs/endpoints/list/templates.d.ts +41 -0
  117. package/dist/cjs/endpoints/list/vcs.d.ts +32 -0
  118. package/dist/cjs/endpoints/list/volumes.d.ts +47 -0
  119. package/dist/cjs/endpoints/pause/addon.d.ts +19 -0
  120. package/dist/cjs/endpoints/pause/job.d.ts +19 -0
  121. package/dist/cjs/endpoints/pause/service.d.ts +19 -0
  122. package/dist/cjs/endpoints/restart/addon.d.ts +19 -0
  123. package/dist/cjs/endpoints/restart/service.d.ts +19 -0
  124. package/dist/cjs/endpoints/restore/addon/backup.d.ts +24 -0
  125. package/dist/cjs/endpoints/resume/addon.d.ts +19 -0
  126. package/dist/cjs/endpoints/resume/job.d.ts +28 -0
  127. package/dist/cjs/endpoints/resume/service.d.ts +28 -0
  128. package/dist/cjs/endpoints/retain/addon/backup.d.ts +21 -0
  129. package/dist/cjs/endpoints/run/template.d.ts +62 -0
  130. package/dist/cjs/endpoints/scale/addon.d.ts +28 -0
  131. package/dist/cjs/endpoints/scale/job.d.ts +30 -0
  132. package/dist/cjs/endpoints/scale/service.d.ts +32 -0
  133. package/dist/cjs/endpoints/start/job/build.d.ts +47 -0
  134. package/dist/cjs/endpoints/start/job/run.d.ts +74 -0
  135. package/dist/cjs/endpoints/start/service/build.d.ts +55 -0
  136. package/dist/cjs/endpoints/suspend/job.d.ts +24 -0
  137. package/dist/cjs/endpoints/unassign/subdomain.d.ts +19 -0
  138. package/dist/cjs/endpoints/update/addon/networkSettings.d.ts +26 -0
  139. package/dist/cjs/endpoints/update/addon/security.d.ts +29 -0
  140. package/dist/cjs/endpoints/update/addon/version.d.ts +24 -0
  141. package/dist/cjs/endpoints/update/cluster.d.ts +76 -0
  142. package/dist/cjs/endpoints/update/integration.d.ts +53 -0
  143. package/dist/cjs/endpoints/update/job/buildArguments.d.ts +29 -0
  144. package/dist/cjs/endpoints/update/job/buildOptions.d.ts +50 -0
  145. package/dist/cjs/endpoints/update/job/buildSource.d.ts +32 -0
  146. package/dist/cjs/endpoints/update/job/cmdOverride.d.ts +24 -0
  147. package/dist/cjs/endpoints/update/job/deployment.d.ts +39 -0
  148. package/dist/cjs/endpoints/update/job/entrypointOverride.d.ts +24 -0
  149. package/dist/cjs/endpoints/update/job/healthChecks.d.ts +45 -0
  150. package/dist/cjs/endpoints/update/job/runtimeEnvironment.d.ts +29 -0
  151. package/dist/cjs/endpoints/update/job/settings.d.ts +32 -0
  152. package/dist/cjs/endpoints/update/registry.d.ts +31 -0
  153. package/dist/cjs/endpoints/update/secret.d.ts +58 -0
  154. package/dist/cjs/endpoints/update/secretLink.d.ts +40 -0
  155. package/dist/cjs/endpoints/update/service/buildArguments.d.ts +29 -0
  156. package/dist/cjs/endpoints/update/service/buildOptions.d.ts +62 -0
  157. package/dist/cjs/endpoints/update/service/buildSource.d.ts +32 -0
  158. package/dist/cjs/endpoints/update/service/cmdOverride.d.ts +24 -0
  159. package/dist/cjs/endpoints/update/service/deployment.d.ts +39 -0
  160. package/dist/cjs/endpoints/update/service/entrypointOverride.d.ts +24 -0
  161. package/dist/cjs/endpoints/update/service/healthChecks.d.ts +45 -0
  162. package/dist/cjs/endpoints/update/service/ports.d.ts +57 -0
  163. package/dist/cjs/endpoints/update/service/runtimeEnvironment.d.ts +34 -0
  164. package/dist/cjs/endpoints/update/template.d.ts +81 -0
  165. package/dist/cjs/endpoints/update/volume.d.ts +33 -0
  166. package/dist/cjs/endpoints/verify/domain.d.ts +17 -0
  167. package/dist/cjs/endpoints/verify/subdomain.d.ts +19 -0
  168. package/dist/cjs/exec-command/client/exec-command-runner.d.ts +70 -0
  169. package/dist/cjs/exec-command/client/exec-command-standard.d.ts +42 -0
  170. package/dist/cjs/port-forward/client/api-helper.d.ts +30 -0
  171. package/dist/cjs/port-forward/client/atomic-write.d.ts +2 -0
  172. package/dist/cjs/port-forward/client/host-file-ast.d.ts +52 -0
  173. package/dist/cjs/port-forward/client/host-file.d.ts +26 -0
  174. package/dist/cjs/port-forward/client/loopback.d.ts +4 -0
  175. package/dist/cjs/port-forward/client/port-forwarder.d.ts +87 -0
  176. package/dist/cjs/port-forward/client/port-tunnel-tcp.d.ts +36 -0
  177. package/dist/cjs/port-forward/client/port-tunnel-udp.d.ts +27 -0
  178. package/dist/cjs/port-forward/client/promise-mutex.d.ts +4 -0
  179. package/dist/cjs/utils.d.ts +21 -0
  180. package/dist/esm/api-client.d.ts +2168 -128
  181. package/dist/esm/api-client.js +15 -1
  182. package/dist/esm/api-endpoint.d.ts +57 -0
  183. package/dist/esm/api-error.d.ts +16 -0
  184. package/dist/esm/context/api-client-context-provider.d.ts +47 -0
  185. package/dist/esm/context/api-client-file-context-provider.d.ts +11 -0
  186. package/dist/esm/context/api-client-in-memory-context-provider.d.ts +6 -0
  187. package/dist/esm/context/index.d.ts +3 -0
  188. package/dist/esm/endpoints/abort/addon/backup.d.ts +21 -0
  189. package/dist/esm/endpoints/abort/addon/restore.d.ts +26 -0
  190. package/dist/esm/endpoints/abort/job/build.d.ts +21 -0
  191. package/dist/esm/endpoints/abort/job/run.d.ts +21 -0
  192. package/dist/esm/endpoints/abort/service/build.d.ts +21 -0
  193. package/dist/esm/endpoints/add/domain/subdomain.d.ts +33 -0
  194. package/dist/esm/endpoints/add/registry.d.ts +47 -0
  195. package/dist/esm/endpoints/assign/subdomain/service.d.ts +28 -0
  196. package/dist/esm/endpoints/attach/volume.d.ts +29 -0
  197. package/dist/esm/endpoints/backup/addon.d.ts +51 -0
  198. package/dist/esm/endpoints/create/addon/backupSchedule.d.ts +40 -0
  199. package/dist/esm/endpoints/create/addon.d.ts +101 -0
  200. package/dist/esm/endpoints/create/cluster.d.ts +97 -0
  201. package/dist/esm/endpoints/create/domain.d.ts +27 -0
  202. package/dist/esm/endpoints/create/integration.d.ts +58 -0
  203. package/dist/esm/endpoints/create/job/cron.d.ts +247 -0
  204. package/dist/esm/endpoints/create/job/manual.d.ts +237 -0
  205. package/dist/esm/endpoints/create/project.d.ts +31 -0
  206. package/dist/esm/endpoints/create/secret.d.ts +83 -0
  207. package/dist/esm/endpoints/create/service/build.d.ts +161 -0
  208. package/dist/esm/endpoints/create/service/combined.d.ts +255 -0
  209. package/dist/esm/endpoints/create/service/deployment.d.ts +242 -0
  210. package/dist/esm/endpoints/create/template.d.ts +132 -0
  211. package/dist/esm/endpoints/create/volume.d.ts +78 -0
  212. package/dist/esm/endpoints/delete/addon/backupSchedule.d.ts +21 -0
  213. package/dist/esm/endpoints/delete/addon.d.ts +19 -0
  214. package/dist/esm/endpoints/delete/backup.d.ts +21 -0
  215. package/dist/esm/endpoints/delete/cluster.d.ts +17 -0
  216. package/dist/esm/endpoints/delete/domain.d.ts +17 -0
  217. package/dist/esm/endpoints/delete/integration.d.ts +17 -0
  218. package/dist/esm/endpoints/delete/job.d.ts +19 -0
  219. package/dist/esm/endpoints/delete/project.d.ts +17 -0
  220. package/dist/esm/endpoints/delete/registry.d.ts +17 -0
  221. package/dist/esm/endpoints/delete/secret.d.ts +19 -0
  222. package/dist/esm/endpoints/delete/secretLink.d.ts +21 -0
  223. package/dist/esm/endpoints/delete/service.d.ts +19 -0
  224. package/dist/esm/endpoints/delete/subdomain.d.ts +19 -0
  225. package/dist/esm/endpoints/delete/template.d.ts +17 -0
  226. package/dist/esm/endpoints/delete/volume.d.ts +19 -0
  227. package/dist/esm/endpoints/detach/volume.d.ts +21 -0
  228. package/dist/esm/endpoints/get/addon/backup/download.d.ts +24 -0
  229. package/dist/esm/endpoints/get/addon/backup.d.ts +46 -0
  230. package/dist/esm/endpoints/get/addon/backupSchedules.d.ts +52 -0
  231. package/dist/esm/endpoints/get/addon/backups.d.ts +54 -0
  232. package/dist/esm/endpoints/get/addon/containers.d.ts +40 -0
  233. package/dist/esm/endpoints/get/addon/credentials.d.ts +24 -0
  234. package/dist/esm/endpoints/get/addon/types.d.ts +48 -0
  235. package/dist/esm/endpoints/get/addon/version.d.ts +53 -0
  236. package/dist/esm/endpoints/get/addon.d.ts +71 -0
  237. package/dist/esm/endpoints/get/cluster.d.ts +55 -0
  238. package/dist/esm/endpoints/get/dnsId.d.ts +15 -0
  239. package/dist/esm/endpoints/get/domain.d.ts +33 -0
  240. package/dist/esm/endpoints/get/integration.d.ts +37 -0
  241. package/dist/esm/endpoints/get/invoice/details.d.ts +139 -0
  242. package/dist/esm/endpoints/get/job/branches.d.ts +49 -0
  243. package/dist/esm/endpoints/get/job/build.d.ts +42 -0
  244. package/dist/esm/endpoints/get/job/buildArgumentDetails.d.ts +71 -0
  245. package/dist/esm/endpoints/get/job/buildArguments.d.ts +29 -0
  246. package/dist/esm/endpoints/get/job/builds.d.ts +52 -0
  247. package/dist/esm/endpoints/get/job/containers.d.ts +40 -0
  248. package/dist/esm/endpoints/get/job/deployment.d.ts +55 -0
  249. package/dist/esm/endpoints/get/job/healthChecks.d.ts +45 -0
  250. package/dist/esm/endpoints/get/job/pullRequests.d.ts +49 -0
  251. package/dist/esm/endpoints/get/job/run.d.ts +44 -0
  252. package/dist/esm/endpoints/get/job/runs.d.ts +54 -0
  253. package/dist/esm/endpoints/get/job/runtimeEnvironment.d.ts +29 -0
  254. package/dist/esm/endpoints/get/job/runtimeEnvironmentDetails.d.ts +71 -0
  255. package/dist/esm/endpoints/get/job.d.ts +128 -0
  256. package/dist/esm/endpoints/get/project.d.ts +72 -0
  257. package/dist/esm/endpoints/get/registry.d.ts +34 -0
  258. package/dist/esm/endpoints/get/secret.d.ts +55 -0
  259. package/dist/esm/endpoints/get/secretDetails.d.ts +63 -0
  260. package/dist/esm/endpoints/get/secretLink.d.ts +44 -0
  261. package/dist/esm/endpoints/get/service/branches.d.ts +49 -0
  262. package/dist/esm/endpoints/get/service/build.d.ts +42 -0
  263. package/dist/esm/endpoints/get/service/buildArgumentDetails.d.ts +71 -0
  264. package/dist/esm/endpoints/get/service/buildArguments.d.ts +29 -0
  265. package/dist/esm/endpoints/get/service/builds.d.ts +52 -0
  266. package/dist/esm/endpoints/get/service/containers.d.ts +40 -0
  267. package/dist/esm/endpoints/get/service/deployment.d.ts +55 -0
  268. package/dist/esm/endpoints/get/service/healthChecks.d.ts +45 -0
  269. package/dist/esm/endpoints/get/service/ports.d.ts +70 -0
  270. package/dist/esm/endpoints/get/service/pullRequests.d.ts +49 -0
  271. package/dist/esm/endpoints/get/service/runtimeEnvironment.d.ts +29 -0
  272. package/dist/esm/endpoints/get/service/runtimeEnvironmentDetails.d.ts +71 -0
  273. package/dist/esm/endpoints/get/service.d.ts +211 -0
  274. package/dist/esm/endpoints/get/subdomain.d.ts +30 -0
  275. package/dist/esm/endpoints/get/template.d.ts +61 -0
  276. package/dist/esm/endpoints/get/templateRun.d.ts +73 -0
  277. package/dist/esm/endpoints/get/volume.d.ts +49 -0
  278. package/dist/esm/endpoints/import/addon/backup.d.ts +31 -0
  279. package/dist/esm/endpoints/list/addons.d.ts +45 -0
  280. package/dist/esm/endpoints/list/branches.d.ts +51 -0
  281. package/dist/esm/endpoints/list/clusters.d.ts +63 -0
  282. package/dist/esm/endpoints/list/domains.d.ts +34 -0
  283. package/dist/esm/endpoints/list/integrations.d.ts +36 -0
  284. package/dist/esm/endpoints/list/invoices.d.ts +40 -0
  285. package/dist/esm/endpoints/list/jobs.d.ts +46 -0
  286. package/dist/esm/endpoints/list/plans.d.ts +30 -0
  287. package/dist/esm/endpoints/list/projects.d.ts +32 -0
  288. package/dist/esm/endpoints/list/providers.d.ts +37 -0
  289. package/dist/esm/endpoints/list/regions.d.ts +18 -0
  290. package/dist/esm/endpoints/list/registries.d.ts +41 -0
  291. package/dist/esm/endpoints/list/repos.d.ts +51 -0
  292. package/dist/esm/endpoints/list/secrets.d.ts +54 -0
  293. package/dist/esm/endpoints/list/services.d.ts +65 -0
  294. package/dist/esm/endpoints/list/templateRuns.d.ts +54 -0
  295. package/dist/esm/endpoints/list/templates.d.ts +41 -0
  296. package/dist/esm/endpoints/list/vcs.d.ts +32 -0
  297. package/dist/esm/endpoints/list/volumes.d.ts +47 -0
  298. package/dist/esm/endpoints/pause/addon.d.ts +19 -0
  299. package/dist/esm/endpoints/pause/job.d.ts +19 -0
  300. package/dist/esm/endpoints/pause/service.d.ts +19 -0
  301. package/dist/esm/endpoints/restart/addon.d.ts +19 -0
  302. package/dist/esm/endpoints/restart/service.d.ts +19 -0
  303. package/dist/esm/endpoints/restore/addon/backup.d.ts +24 -0
  304. package/dist/esm/endpoints/resume/addon.d.ts +19 -0
  305. package/dist/esm/endpoints/resume/job.d.ts +28 -0
  306. package/dist/esm/endpoints/resume/service.d.ts +28 -0
  307. package/dist/esm/endpoints/retain/addon/backup.d.ts +21 -0
  308. package/dist/esm/endpoints/run/template.d.ts +62 -0
  309. package/dist/esm/endpoints/scale/addon.d.ts +28 -0
  310. package/dist/esm/endpoints/scale/job.d.ts +30 -0
  311. package/dist/esm/endpoints/scale/service.d.ts +32 -0
  312. package/dist/esm/endpoints/start/job/build.d.ts +47 -0
  313. package/dist/esm/endpoints/start/job/run.d.ts +74 -0
  314. package/dist/esm/endpoints/start/service/build.d.ts +55 -0
  315. package/dist/esm/endpoints/suspend/job.d.ts +24 -0
  316. package/dist/esm/endpoints/unassign/subdomain.d.ts +19 -0
  317. package/dist/esm/endpoints/update/addon/networkSettings.d.ts +26 -0
  318. package/dist/esm/endpoints/update/addon/security.d.ts +29 -0
  319. package/dist/esm/endpoints/update/addon/version.d.ts +24 -0
  320. package/dist/esm/endpoints/update/cluster.d.ts +76 -0
  321. package/dist/esm/endpoints/update/integration.d.ts +53 -0
  322. package/dist/esm/endpoints/update/job/buildArguments.d.ts +29 -0
  323. package/dist/esm/endpoints/update/job/buildOptions.d.ts +50 -0
  324. package/dist/esm/endpoints/update/job/buildSource.d.ts +32 -0
  325. package/dist/esm/endpoints/update/job/cmdOverride.d.ts +24 -0
  326. package/dist/esm/endpoints/update/job/deployment.d.ts +39 -0
  327. package/dist/esm/endpoints/update/job/entrypointOverride.d.ts +24 -0
  328. package/dist/esm/endpoints/update/job/healthChecks.d.ts +45 -0
  329. package/dist/esm/endpoints/update/job/runtimeEnvironment.d.ts +29 -0
  330. package/dist/esm/endpoints/update/job/settings.d.ts +32 -0
  331. package/dist/esm/endpoints/update/registry.d.ts +31 -0
  332. package/dist/esm/endpoints/update/secret.d.ts +58 -0
  333. package/dist/esm/endpoints/update/secretLink.d.ts +40 -0
  334. package/dist/esm/endpoints/update/service/buildArguments.d.ts +29 -0
  335. package/dist/esm/endpoints/update/service/buildOptions.d.ts +62 -0
  336. package/dist/esm/endpoints/update/service/buildSource.d.ts +32 -0
  337. package/dist/esm/endpoints/update/service/cmdOverride.d.ts +24 -0
  338. package/dist/esm/endpoints/update/service/deployment.d.ts +39 -0
  339. package/dist/esm/endpoints/update/service/entrypointOverride.d.ts +24 -0
  340. package/dist/esm/endpoints/update/service/healthChecks.d.ts +45 -0
  341. package/dist/esm/endpoints/update/service/ports.d.ts +57 -0
  342. package/dist/esm/endpoints/update/service/runtimeEnvironment.d.ts +34 -0
  343. package/dist/esm/endpoints/update/template.d.ts +81 -0
  344. package/dist/esm/endpoints/update/volume.d.ts +33 -0
  345. package/dist/esm/endpoints/verify/domain.d.ts +17 -0
  346. package/dist/esm/endpoints/verify/subdomain.d.ts +19 -0
  347. package/dist/esm/exec-command/client/exec-command-runner.d.ts +70 -0
  348. package/dist/esm/exec-command/client/exec-command-standard.d.ts +42 -0
  349. package/dist/esm/port-forward/client/api-helper.d.ts +30 -0
  350. package/dist/esm/port-forward/client/atomic-write.d.ts +2 -0
  351. package/dist/esm/port-forward/client/host-file-ast.d.ts +52 -0
  352. package/dist/esm/port-forward/client/host-file.d.ts +26 -0
  353. package/dist/esm/port-forward/client/loopback.d.ts +4 -0
  354. package/dist/esm/port-forward/client/port-forwarder.d.ts +87 -0
  355. package/dist/esm/port-forward/client/port-tunnel-tcp.d.ts +36 -0
  356. package/dist/esm/port-forward/client/port-tunnel-udp.d.ts +27 -0
  357. package/dist/esm/port-forward/client/promise-mutex.d.ts +4 -0
  358. package/dist/esm/utils.d.ts +21 -0
  359. package/package.json +1 -1
@@ -98,7 +98,13 @@ declare class ApiClientInMemoryContextProvider extends ApiClientContextProvider
98
98
  protected writeContext(context: ApiClientContextWrapper): Promise<void>;
99
99
  }
100
100
 
101
- declare type ApiCallError = {
101
+ declare class NorthflankApiCallError extends Error implements ApiCallError {
102
+ id?: any;
103
+ details?: any;
104
+ status: number;
105
+ constructor(callError: ApiCallError);
106
+ }
107
+ interface ApiCallError {
102
108
  /** Http status response code */
103
109
  status: number;
104
110
  /** Error message */
@@ -107,7 +113,8 @@ declare type ApiCallError = {
107
113
  id?: string;
108
114
  /** Error details */
109
115
  details?: any;
110
- };
116
+ }
117
+
111
118
  interface ApiCallResponse<R> {
112
119
  data: R;
113
120
  rawResponse: Response;
@@ -127,6 +134,9 @@ interface ApiCallResponse<R> {
127
134
  'count': number;
128
135
  };
129
136
  }
137
+ interface ApiEndpoint<T, R> {
138
+ requiredPermissions?: string | undefined;
139
+ }
130
140
  declare abstract class ApiEndpoint<T, R> {
131
141
  protected readonly opts: ApiClientOpts;
132
142
  protected contextProvider: ApiClientContextProvider;
@@ -218,6 +228,7 @@ declare type ListServicesOptions = {
218
228
  declare class ListServicesEndpoint extends GetApiEndpoint<ListServicesRequest, ListServicesResult> {
219
229
  description: string;
220
230
  withAuth: boolean;
231
+ requiredPermissions: string;
221
232
  endpointUrl: (opts: ListServicesRequest) => string;
222
233
  body: () => undefined;
223
234
  }
@@ -262,6 +273,7 @@ declare type ListAddonsOptions = {
262
273
  declare class ListAddonsEndpoint extends GetApiEndpoint<ListAddonsRequest, ListAddonsResult> {
263
274
  description: string;
264
275
  withAuth: boolean;
276
+ requiredPermissions: string;
265
277
  endpointUrl: (opts: ListAddonsRequest) => string;
266
278
  body: () => undefined;
267
279
  }
@@ -491,6 +503,7 @@ declare type ListProjectsOptions = {
491
503
  declare class ListProjectsEndpoint extends GetApiEndpoint<ListProjectsRequest, ListProjectsResult> {
492
504
  description: string;
493
505
  withAuth: boolean;
506
+ requiredPermissions: string;
494
507
  endpointUrl: (opts: ListProjectsRequest) => string;
495
508
  body: () => undefined;
496
509
  }
@@ -511,7 +524,9 @@ declare type CreateProjectData = {
511
524
  /** The description of the project. Example: "This is a new project." */
512
525
  'description'?: string;
513
526
  /** The region the project will be hosted in. Example: "europe-west" */
514
- 'region': string;
527
+ 'region'?: string;
528
+ /** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
529
+ 'clusterId'?: string;
515
530
  /** The color of the project in the Northflank App. Example: "#EF233C" */
516
531
  'color'?: string;
517
532
  };
@@ -519,6 +534,7 @@ declare type CreateProjectData = {
519
534
  declare class CreateProjectEndpoint extends PostApiEndpoint<CreateProjectRequest, CreateProjectResult> {
520
535
  description: string;
521
536
  withAuth: boolean;
537
+ requiredPermissions: string;
522
538
  endpointUrl: (opts: CreateProjectRequest) => string;
523
539
  body: (payload: CreateProjectRequest) => string;
524
540
  }
@@ -590,6 +606,7 @@ declare type GetProjectParameters = {
590
606
  declare class GetProjectEndpoint extends GetApiEndpoint<GetProjectRequest, GetProjectResult> {
591
607
  description: string;
592
608
  withAuth: boolean;
609
+ requiredPermissions: string;
593
610
  endpointUrl: (opts: GetProjectRequest) => string;
594
611
  body: () => undefined;
595
612
  }
@@ -606,6 +623,7 @@ declare type DeleteProjectParameters = {
606
623
  declare class DeleteProjectEndpoint extends DeleteApiEndpoint<DeleteProjectRequest, DeleteProjectResult> {
607
624
  description: string;
608
625
  withAuth: boolean;
626
+ requiredPermissions: string;
609
627
  endpointUrl: (opts: DeleteProjectRequest) => string;
610
628
  body: () => undefined;
611
629
  }
@@ -683,13 +701,20 @@ declare type CreateAddonData = {
683
701
  'billing': {
684
702
  /** The ID of the deployment plan to use. Example: "nf-compute-20" */
685
703
  'deploymentPlan': string;
686
- /** The type of storage. Only configurable if the relevant feature flag is enabled for you account */
704
+ /** The type of storage. Only configurable if the relevant feature flag is enabled for you account Example: "ssd" */
687
705
  'storageClass'?: 'ssd' | 'hdd';
688
706
  /** The size of the addon storage, in megabytes. Example: 4096 */
689
707
  'storage': number;
690
708
  /** The number of addon replicas to run. Example: 1 */
691
709
  'replicas': number;
692
710
  };
711
+ /** Optional object containing data about an existing addon to fork. If provided, the addon will be created from that existing addon backup. */
712
+ 'source'?: {
713
+ /** ID of the addon to fork. Example: "existing-addon" */
714
+ 'addonId': string;
715
+ /** ID of a backup belonging to that addon to use for the fork. Example: "existing-backup" */
716
+ 'backupId': string;
717
+ };
693
718
  /** Enables access to the addon via TLS (if supported by the addon type). */
694
719
  'tlsEnabled'?: boolean;
695
720
  /** Enables external access to the addon via TLS (if supported by the addon type). */
@@ -699,6 +724,7 @@ declare type CreateAddonData = {
699
724
  declare class CreateAddonEndpoint extends PostApiEndpoint<CreateAddonRequest, CreateAddonResult> {
700
725
  description: string;
701
726
  withAuth: boolean;
727
+ requiredPermissions: string;
702
728
  endpointUrl: (opts: CreateAddonRequest) => string;
703
729
  body: (payload: CreateAddonRequest) => string;
704
730
  }
@@ -769,6 +795,7 @@ declare type GetAddonParameters = {
769
795
  declare class GetAddonEndpoint extends GetApiEndpoint<GetAddonRequest, GetAddonResult> {
770
796
  description: string;
771
797
  withAuth: boolean;
798
+ requiredPermissions: string;
772
799
  endpointUrl: (opts: GetAddonRequest) => string;
773
800
  body: () => undefined;
774
801
  }
@@ -787,6 +814,7 @@ declare type DeleteAddonParameters = {
787
814
  declare class DeleteAddonEndpoint extends DeleteApiEndpoint<DeleteAddonRequest, DeleteAddonResult> {
788
815
  description: string;
789
816
  withAuth: boolean;
817
+ requiredPermissions: string;
790
818
  endpointUrl: (opts: DeleteAddonRequest) => string;
791
819
  body: () => undefined;
792
820
  }
@@ -810,6 +838,7 @@ declare type GetAddonCredentialsParameters = {
810
838
  declare class GetAddonCredentialsEndpoint extends GetApiEndpoint<GetAddonCredentialsRequest, GetAddonCredentialsResult> {
811
839
  description: string;
812
840
  withAuth: boolean;
841
+ requiredPermissions: string;
813
842
  endpointUrl: (opts: GetAddonCredentialsRequest) => string;
814
843
  body: () => undefined;
815
844
  }
@@ -857,6 +886,7 @@ declare type GetAddonTypesRequest = {};
857
886
  declare class GetAddonTypesEndpoint extends GetApiEndpoint<GetAddonTypesRequest, GetAddonTypesResult> {
858
887
  description: string;
859
888
  withAuth: boolean;
889
+ requiredPermissions: string;
860
890
  endpointUrl: (opts: GetAddonTypesRequest) => string;
861
891
  body: () => undefined;
862
892
  }
@@ -884,6 +914,7 @@ declare type ScaleAddonData = {
884
914
  declare class ScaleAddonEndpoint extends PostApiEndpoint<ScaleAddonRequest, ScaleAddonResult> {
885
915
  description: string;
886
916
  withAuth: boolean;
917
+ requiredPermissions: string;
887
918
  endpointUrl: (opts: ScaleAddonRequest) => string;
888
919
  body: (payload: ScaleAddonRequest) => string;
889
920
  }
@@ -936,6 +967,7 @@ declare type GetAddonVersionParameters = {
936
967
  declare class GetAddonVersionEndpoint extends GetApiEndpoint<GetAddonVersionRequest, GetAddonVersionResult> {
937
968
  description: string;
938
969
  withAuth: boolean;
970
+ requiredPermissions: string;
939
971
  endpointUrl: (opts: GetAddonVersionRequest) => string;
940
972
  body: () => undefined;
941
973
  }
@@ -959,6 +991,7 @@ declare type UpdateAddonVersionData = {
959
991
  declare class UpdateAddonVersionEndpoint extends PostApiEndpoint<UpdateAddonVersionRequest, UpdateAddonVersionResult> {
960
992
  description: string;
961
993
  withAuth: boolean;
994
+ requiredPermissions: string;
962
995
  endpointUrl: (opts: UpdateAddonVersionRequest) => string;
963
996
  body: (payload: UpdateAddonVersionRequest) => string;
964
997
  }
@@ -984,6 +1017,7 @@ declare type UpdateAddonNetworksettingsData = {
984
1017
  declare class UpdateAddonNetworksettingsEndpoint extends PostApiEndpoint<UpdateAddonNetworksettingsRequest, UpdateAddonNetworksettingsResult> {
985
1018
  description: string;
986
1019
  withAuth: boolean;
1020
+ requiredPermissions: string;
987
1021
  endpointUrl: (opts: UpdateAddonNetworksettingsRequest) => string;
988
1022
  body: (payload: UpdateAddonNetworksettingsRequest) => string;
989
1023
  }
@@ -1012,6 +1046,7 @@ declare type UpdateAddonSecurityData = {
1012
1046
  declare class UpdateAddonSecurityEndpoint extends PostApiEndpoint<UpdateAddonSecurityRequest, UpdateAddonSecurityResult> {
1013
1047
  description: string;
1014
1048
  withAuth: boolean;
1049
+ requiredPermissions: string;
1015
1050
  endpointUrl: (opts: UpdateAddonSecurityRequest) => string;
1016
1051
  body: (payload: UpdateAddonSecurityRequest) => string;
1017
1052
  }
@@ -1065,6 +1100,7 @@ declare type GetAddonBackupsOptions = {
1065
1100
  declare class GetAddonBackupsEndpoint extends GetApiEndpoint<GetAddonBackupsRequest, GetAddonBackupsResult> {
1066
1101
  description: string;
1067
1102
  withAuth: boolean;
1103
+ requiredPermissions: string;
1068
1104
  endpointUrl: (opts: GetAddonBackupsRequest) => string;
1069
1105
  body: () => undefined;
1070
1106
  }
@@ -1115,6 +1151,7 @@ declare type BackupAddonData = {
1115
1151
  declare class BackupAddonEndpoint extends PostApiEndpoint<BackupAddonRequest, BackupAddonResult> {
1116
1152
  description: string;
1117
1153
  withAuth: boolean;
1154
+ requiredPermissions: string;
1118
1155
  endpointUrl: (opts: BackupAddonRequest) => string;
1119
1156
  body: (payload: BackupAddonRequest) => string;
1120
1157
  }
@@ -1160,6 +1197,7 @@ declare type GetAddonBackupParameters = {
1160
1197
  declare class GetAddonBackupEndpoint extends GetApiEndpoint<GetAddonBackupRequest, GetAddonBackupResult> {
1161
1198
  description: string;
1162
1199
  withAuth: boolean;
1200
+ requiredPermissions: string;
1163
1201
  endpointUrl: (opts: GetAddonBackupRequest) => string;
1164
1202
  body: () => undefined;
1165
1203
  }
@@ -1180,6 +1218,7 @@ declare type DeleteBackupParameters = {
1180
1218
  declare class DeleteBackupEndpoint extends DeleteApiEndpoint<DeleteBackupRequest, DeleteBackupResult> {
1181
1219
  description: string;
1182
1220
  withAuth: boolean;
1221
+ requiredPermissions: string;
1183
1222
  endpointUrl: (opts: DeleteBackupRequest) => string;
1184
1223
  body: () => undefined;
1185
1224
  }
@@ -1203,6 +1242,7 @@ declare type RestoreAddonBackupParameters = {
1203
1242
  declare class RestoreAddonBackupEndpoint extends PostApiEndpoint<RestoreAddonBackupRequest, RestoreAddonBackupResult> {
1204
1243
  description: string;
1205
1244
  withAuth: boolean;
1245
+ requiredPermissions: string;
1206
1246
  endpointUrl: (opts: RestoreAddonBackupRequest) => string;
1207
1247
  body: () => undefined;
1208
1248
  }
@@ -1233,6 +1273,7 @@ declare type ImportAddonBackupData = {
1233
1273
  declare class ImportAddonBackupEndpoint extends PostApiEndpoint<ImportAddonBackupRequest, ImportAddonBackupResult> {
1234
1274
  description: string;
1235
1275
  withAuth: boolean;
1276
+ requiredPermissions: string;
1236
1277
  endpointUrl: (opts: ImportAddonBackupRequest) => string;
1237
1278
  body: (payload: ImportAddonBackupRequest) => string;
1238
1279
  }
@@ -1272,6 +1313,7 @@ declare type GetAddonContainersOptions = {
1272
1313
  declare class GetAddonContainersEndpoint extends GetApiEndpoint<GetAddonContainersRequest, GetAddonContainersResult> {
1273
1314
  description: string;
1274
1315
  withAuth: boolean;
1316
+ requiredPermissions: string;
1275
1317
  endpointUrl: (opts: GetAddonContainersRequest) => string;
1276
1318
  body: () => undefined;
1277
1319
  }
@@ -1290,6 +1332,7 @@ declare type PauseAddonParameters = {
1290
1332
  declare class PauseAddonEndpoint extends PostApiEndpoint<PauseAddonRequest, PauseAddonResult> {
1291
1333
  description: string;
1292
1334
  withAuth: boolean;
1335
+ requiredPermissions: string;
1293
1336
  endpointUrl: (opts: PauseAddonRequest) => string;
1294
1337
  body: () => undefined;
1295
1338
  }
@@ -1308,6 +1351,7 @@ declare type ResumeAddonParameters = {
1308
1351
  declare class ResumeAddonEndpoint extends PostApiEndpoint<ResumeAddonRequest, ResumeAddonResult> {
1309
1352
  description: string;
1310
1353
  withAuth: boolean;
1354
+ requiredPermissions: string;
1311
1355
  endpointUrl: (opts: ResumeAddonRequest) => string;
1312
1356
  body: () => undefined;
1313
1357
  }
@@ -1326,6 +1370,7 @@ declare type RestartAddonParameters = {
1326
1370
  declare class RestartAddonEndpoint extends PostApiEndpoint<RestartAddonRequest, RestartAddonResult> {
1327
1371
  description: string;
1328
1372
  withAuth: boolean;
1373
+ requiredPermissions: string;
1329
1374
  endpointUrl: (opts: RestartAddonRequest) => string;
1330
1375
  body: () => undefined;
1331
1376
  }
@@ -1346,10 +1391,32 @@ declare type AbortAddonBackupParameters = {
1346
1391
  declare class AbortAddonBackupEndpoint extends PostApiEndpoint<AbortAddonBackupRequest, AbortAddonBackupResult> {
1347
1392
  description: string;
1348
1393
  withAuth: boolean;
1394
+ requiredPermissions: string;
1349
1395
  endpointUrl: (opts: AbortAddonBackupRequest) => string;
1350
1396
  body: () => undefined;
1351
1397
  }
1352
1398
 
1399
+ declare type RetainAddonBackupResult = any;
1400
+ declare type RetainAddonBackupCall = (opts: RetainAddonBackupRequest) => Promise<ApiCallResponse<RetainAddonBackupResult>>;
1401
+ declare type RetainAddonBackupRequest = {
1402
+ parameters: RetainAddonBackupParameters;
1403
+ };
1404
+ declare type RetainAddonBackupParameters = {
1405
+ /** ID of the project */ 'projectId': string;
1406
+ /** ID of the addon */
1407
+ 'addonId': string;
1408
+ /** ID of the backup */
1409
+ 'backupId': string;
1410
+ };
1411
+ /** Flags a temporary backup generated by a backup schedule to be retained indefinitely rather than being deleted after the expiry date. */
1412
+ declare class RetainAddonBackupEndpoint extends PostApiEndpoint<RetainAddonBackupRequest, RetainAddonBackupResult> {
1413
+ description: string;
1414
+ withAuth: boolean;
1415
+ requiredPermissions: string;
1416
+ endpointUrl: (opts: RetainAddonBackupRequest) => string;
1417
+ body: () => undefined;
1418
+ }
1419
+
1353
1420
  declare type GetAddonBackupDownloadResult = {
1354
1421
  /** The url to download the backup from. Example: "https://storage.googleapis.com/..." */
1355
1422
  'downloadLink': string;
@@ -1369,6 +1436,7 @@ declare type GetAddonBackupDownloadParameters = {
1369
1436
  declare class GetAddonBackupDownloadEndpoint extends GetApiEndpoint<GetAddonBackupDownloadRequest, GetAddonBackupDownloadResult> {
1370
1437
  description: string;
1371
1438
  withAuth: boolean;
1439
+ requiredPermissions: string;
1372
1440
  endpointUrl: (opts: GetAddonBackupDownloadRequest) => string;
1373
1441
  body: () => undefined;
1374
1442
  }
@@ -1394,10 +1462,849 @@ declare type AbortAddonRestoreData = {
1394
1462
  declare class AbortAddonRestoreEndpoint extends PostApiEndpoint<AbortAddonRestoreRequest, AbortAddonRestoreResult> {
1395
1463
  description: string;
1396
1464
  withAuth: boolean;
1465
+ requiredPermissions: string;
1397
1466
  endpointUrl: (opts: AbortAddonRestoreRequest) => string;
1398
1467
  body: (payload: AbortAddonRestoreRequest) => string;
1399
1468
  }
1400
1469
 
1470
+ declare type GetAddonBackupschedulesResult = {
1471
+ 'schedules'?: {
1472
+ /** ID of the schedule. Example: "62cc20b90956ab62a58e8474" */
1473
+ 'id': string;
1474
+ /** The type of backup being performed. Example: "snapshot" */
1475
+ 'backupType': 'dump' | 'snapshot';
1476
+ /** Information about the scheduling for the backup schedule. */
1477
+ 'scheduling': {
1478
+ /** The interval between backups. Each addon can only have one backup schedule of each interval for each backup type. Example: "weekly" */
1479
+ 'interval': 'hourly' | 'daily' | 'weekly';
1480
+ /** An array of minutes when the backup should be performed. */
1481
+ 'minute': number[];
1482
+ /** An array of hours in 24 hour format when the backup should be performed. At these hours, a backup will be performed at each of the minutes provided in the `minute` field. Required for `daily` and `weekly` intervals and unavailable for `hourly` intervals. */
1483
+ 'hour'?: number[];
1484
+ /** An array of days of the week when the backup should be performed, where `0` represents Monday and `6` represents Sunday. On these days, a backup will be performed at each of the minutes provided in the `minute` field whenever it is an hour from the `hour` field. Required for `weekly` intervals and unavailable for `hourly` and `daily` intervals. */
1485
+ 'day'?: number[];
1486
+ };
1487
+ /** The time, in days, that the backups are retained for. Example: 7 */
1488
+ 'retentionTime': number;
1489
+ /** The timestamp the backup schedule was created. Example: "2022-07-11T13:08:09.626Z" */
1490
+ 'createdAt': string;
1491
+ /** The timestamp the backup schedule was last updated. Example: "2022-07-11T13:08:09.626Z" */
1492
+ 'updatedAt': string;
1493
+ }[];
1494
+ };
1495
+ declare type GetAddonBackupschedulesCall = (opts: GetAddonBackupschedulesRequest) => Promise<ApiCallResponse<GetAddonBackupschedulesResult>>;
1496
+ declare type GetAddonBackupschedulesRequest = {
1497
+ parameters: GetAddonBackupschedulesParameters;
1498
+ options?: GetAddonBackupschedulesOptions;
1499
+ };
1500
+ declare type GetAddonBackupschedulesParameters = {
1501
+ /** ID of the project */ 'projectId': string;
1502
+ /** ID of the addon */
1503
+ 'addonId': string;
1504
+ };
1505
+ declare type GetAddonBackupschedulesOptions = {
1506
+ /** The number of results to display per request. Maximum of 100 results per page. */
1507
+ 'per_page'?: number;
1508
+ /** The page number to access. */
1509
+ 'page'?: number;
1510
+ /** The cursor returned from the previous page of results, used to request the next page. */
1511
+ 'cursor'?: string;
1512
+ };
1513
+ /** Gets details about an addon's backup schedules */
1514
+ declare class GetAddonBackupschedulesEndpoint extends GetApiEndpoint<GetAddonBackupschedulesRequest, GetAddonBackupschedulesResult> {
1515
+ description: string;
1516
+ withAuth: boolean;
1517
+ requiredPermissions: string;
1518
+ endpointUrl: (opts: GetAddonBackupschedulesRequest) => string;
1519
+ body: () => undefined;
1520
+ }
1521
+
1522
+ declare type CreateAddonBackupscheduleResult = {
1523
+ /** ID of the schedule. Example: "62cc20b90956ab62a58e8474" */
1524
+ 'id': string;
1525
+ };
1526
+ declare type CreateAddonBackupscheduleCall = (opts: CreateAddonBackupscheduleRequest) => Promise<ApiCallResponse<CreateAddonBackupscheduleResult>>;
1527
+ declare type CreateAddonBackupscheduleRequest = {
1528
+ parameters: CreateAddonBackupscheduleParameters;
1529
+ data: CreateAddonBackupscheduleData;
1530
+ };
1531
+ declare type CreateAddonBackupscheduleParameters = {
1532
+ /** ID of the project */ 'projectId': string;
1533
+ /** ID of the addon */
1534
+ 'addonId': string;
1535
+ };
1536
+ declare type CreateAddonBackupscheduleData = {
1537
+ /** Schedule for the backup. */
1538
+ 'scheduling': {
1539
+ /** The interval between backups. Each addon can only have one backup schedule of each interval for each backup type. Example: "weekly" */
1540
+ 'interval': 'hourly' | 'daily' | 'weekly';
1541
+ /** An array of minutes when the backup should be performed. */
1542
+ 'minute': number[];
1543
+ /** An array of hours in 24 hour format when the backup should be performed. At these hours, a backup will be performed at each of the minutes provided in the `minute` field. Required for `daily` and `weekly` intervals and unavailable for `hourly` intervals. */
1544
+ 'hour'?: number[];
1545
+ /** An array of days of the week when the backup should be performed, where `0` represents Monday and `6` represents Sunday. On these days, a backup will be performed at each of the minutes provided in the `minute` field whenever it is an hour from the `hour` field. Required for `weekly` intervals and unavailable for `hourly` and `daily` intervals. */
1546
+ 'day'?: number[];
1547
+ };
1548
+ /** The type of the backup to be performed. Example: "snapshot" */
1549
+ 'backupType': 'dump' | 'snapshot';
1550
+ /** The time the backup is retained for, in days. `hourly` backups have a maximum retention of 7 days, `daily` backups have a maximum retention of 60 days and `weekly` backups have a maximum retention of 120 days. Example: 7 */
1551
+ 'retentionTime': number;
1552
+ };
1553
+ /** Create a new backup schedule for an addon. */
1554
+ declare class CreateAddonBackupscheduleEndpoint extends PostApiEndpoint<CreateAddonBackupscheduleRequest, CreateAddonBackupscheduleResult> {
1555
+ description: string;
1556
+ withAuth: boolean;
1557
+ requiredPermissions: string;
1558
+ endpointUrl: (opts: CreateAddonBackupscheduleRequest) => string;
1559
+ body: (payload: CreateAddonBackupscheduleRequest) => string;
1560
+ }
1561
+
1562
+ declare type DeleteAddonBackupscheduleResult = any;
1563
+ declare type DeleteAddonBackupscheduleCall = (opts: DeleteAddonBackupscheduleRequest) => Promise<ApiCallResponse<DeleteAddonBackupscheduleResult>>;
1564
+ declare type DeleteAddonBackupscheduleRequest = {
1565
+ parameters: DeleteAddonBackupscheduleParameters;
1566
+ };
1567
+ declare type DeleteAddonBackupscheduleParameters = {
1568
+ /** ID of the project */ 'projectId': string;
1569
+ /** ID of the addon */
1570
+ 'addonId': string;
1571
+ /** ID of the backup schedule */
1572
+ 'scheduleId': string;
1573
+ };
1574
+ /** Deletes a backup schedule for an addon. */
1575
+ declare class DeleteAddonBackupscheduleEndpoint extends DeleteApiEndpoint<DeleteAddonBackupscheduleRequest, DeleteAddonBackupscheduleResult> {
1576
+ description: string;
1577
+ withAuth: boolean;
1578
+ requiredPermissions: string;
1579
+ endpointUrl: (opts: DeleteAddonBackupscheduleRequest) => string;
1580
+ body: () => undefined;
1581
+ }
1582
+
1583
+ declare type ListInvoicesResult = {
1584
+ 'invoices'?: {
1585
+ /** Information about the billing period of the invoice. */
1586
+ 'period': {
1587
+ /** Unix timestamp of the start of the billing period. Example: 1655823815 */
1588
+ 'start': number;
1589
+ /** Unix timestamp of the end of the billing period. Example: 1655910214 */
1590
+ 'end': number;
1591
+ };
1592
+ /** Currency code for the currency the invoice is billed in. Example: "usd" */
1593
+ 'currency': string;
1594
+ /** Total cost of the invoice, in cents, including tax. Example: 1200 */
1595
+ 'total': number;
1596
+ /** Total cost of the invoice, in cents, excluding tax. Example: 1000 */
1597
+ 'subTotal': number;
1598
+ /** If `timestamp` is passed in, whether the invoice has been paid. */
1599
+ 'paid'?: boolean;
1600
+ };
1601
+ };
1602
+ declare type ListInvoicesCall = (opts: ListInvoicesRequest) => Promise<ApiCallResponse<ListInvoicesResult>>;
1603
+ declare type ListInvoicesRequest = {
1604
+ options?: ListInvoicesOptions;
1605
+ };
1606
+ declare type ListInvoicesOptions = {
1607
+ /** The number of results to display per request. Maximum of 100 results per page. */
1608
+ 'per_page'?: number;
1609
+ /** The page number to access. */
1610
+ 'page'?: number;
1611
+ /** The cursor returned from the previous page of results, used to request the next page. */
1612
+ 'cursor'?: string;
1613
+ };
1614
+ /** Get a list of past invoices */
1615
+ declare class ListInvoicesEndpoint extends GetApiEndpoint<ListInvoicesRequest, ListInvoicesResult> {
1616
+ description: string;
1617
+ withAuth: boolean;
1618
+ requiredPermissions: string;
1619
+ endpointUrl: (opts: ListInvoicesRequest) => string;
1620
+ body: () => undefined;
1621
+ }
1622
+
1623
+ declare type GetInvoiceDetailsResult = {
1624
+ /** Information about the billing period of the invoice. */
1625
+ 'period': {
1626
+ /** Unix timestamp of the start of the billing period. Example: 1655823815 */
1627
+ 'start': number;
1628
+ /** Unix timestamp of the end of the billing period. Example: 1655910214 */
1629
+ 'end': number;
1630
+ };
1631
+ /** Currency code for the currency the invoice is billed in. Example: "usd" */
1632
+ 'currency': string;
1633
+ /** Total cost of the invoice, in cents, including tax. Example: 1200 */
1634
+ 'total': number;
1635
+ /** Total cost of the invoice, in cents, excluding tax. Example: 1000 */
1636
+ 'subTotal': number;
1637
+ /** If `timestamp` is passed in, whether the invoice has been paid. */
1638
+ 'paid'?: boolean;
1639
+ /** Details about the tax on the invoice. */
1640
+ 'tax': {
1641
+ /** Percentage of subtotal to be applied as tax. Example: 20 */
1642
+ 'percent': number;
1643
+ /** Value of the tax on the invoice. Example: 200 */
1644
+ 'value': number;
1645
+ };
1646
+ /** An array of projects billed in this invoice. If `projectId` is passed in, only projects with a `projectId` matching the value will be returned. */
1647
+ 'projects': {
1648
+ /** ID of the project. Example: "default-project" */
1649
+ 'projectId': string;
1650
+ /** Name of the project Example: "Default Project" */
1651
+ 'projectName': string;
1652
+ /** Duration the project has been running in this billing period, in seconds. Example: 259200 */
1653
+ 'duration': string;
1654
+ /** An array of objects belonging to this project that are billed in this invoice. If `addonId`, `serviceId` or `jobId` are passed in, only objects matching that ID will be returned. */
1655
+ 'items': {
1656
+ /** Duration the object has been running in this billing period, in seconds. Example: 172800 */
1657
+ 'duration': string;
1658
+ /** Details about the price of a object, broken down by resource type. */
1659
+ 'price': {
1660
+ /** Price of CPU usage for this object, in cents. Example: 200 */
1661
+ 'cpu': number;
1662
+ /** Price of memory usage for this object, in cents. Example: 200 */
1663
+ 'memory': number;
1664
+ /** Price of storage usage for this object, in cents. Example: 200 */
1665
+ 'storage': number;
1666
+ /** Total price for this object, in cents. Example: 600 */
1667
+ 'total': number;
1668
+ };
1669
+ /** The ID of the object. Example: "example-service" */
1670
+ 'nfObjectId': string;
1671
+ /** The name of the object. Example: "Example Service" */
1672
+ 'nfObjectName': string;
1673
+ /** The type of the object. Example: "service" */
1674
+ 'nfObjectType': 'job' | 'service' | 'addon' | 'volume';
1675
+ }[];
1676
+ /** Details about the price of a project, broken down by resource type. */
1677
+ 'price': {
1678
+ /** Price of CPU usage for this project, in cents. Example: 200 */
1679
+ 'cpu': number;
1680
+ /** Price of memory usage for this project, in cents. Example: 200 */
1681
+ 'memory': number;
1682
+ /** Price of storage usage for this project, in cents. Example: 200 */
1683
+ 'storage': number;
1684
+ /** Total price for this project, in cents. Example: 600 */
1685
+ 'total': number;
1686
+ };
1687
+ /** Details about the price of a project, broken down by object type. */
1688
+ 'objectTypeTotals': {
1689
+ 'addon'?: {
1690
+ /** Details about the price for all addons in this project, broken down by resource type. */
1691
+ 'price'?: {
1692
+ /** Price of CPU usage for all addons in this project, in cents. Example: 200 */
1693
+ 'cpu': number;
1694
+ /** Price of memory usage for all addons in this project, in cents. Example: 200 */
1695
+ 'memory': number;
1696
+ /** Price of storage usage for all addons in this project, in cents. Example: 200 */
1697
+ 'storage': number;
1698
+ /** Total price for all addons in this project, in cents. Example: 600 */
1699
+ 'total': number;
1700
+ };
1701
+ /** Duration addons have been running in this billing period, in seconds. Example: 172800 */
1702
+ 'duration': number;
1703
+ };
1704
+ 'service'?: {
1705
+ /** Details about the price for all services in this project, broken down by resource type. */
1706
+ 'price'?: {
1707
+ /** Price of CPU usage for all services in this project, in cents. Example: 200 */
1708
+ 'cpu': number;
1709
+ /** Price of memory usage for all services in this project, in cents. Example: 200 */
1710
+ 'memory': number;
1711
+ /** Price of storage usage for all services in this project, in cents. Example: 200 */
1712
+ 'storage': number;
1713
+ /** Total price for all services in this project, in cents. Example: 600 */
1714
+ 'total': number;
1715
+ };
1716
+ /** Duration services have been running in this billing period, in seconds. Example: 172800 */
1717
+ 'duration': number;
1718
+ };
1719
+ 'job'?: {
1720
+ /** Details about the price for all jobs in this project, broken down by resource type. */
1721
+ 'price'?: {
1722
+ /** Price of CPU usage for all jobs in this project, in cents. Example: 200 */
1723
+ 'cpu': number;
1724
+ /** Price of memory usage for all jobs in this project, in cents. Example: 200 */
1725
+ 'memory': number;
1726
+ /** Price of storage usage for all jobs in this project, in cents. Example: 200 */
1727
+ 'storage': number;
1728
+ /** Total price for all jobs in this project, in cents. Example: 600 */
1729
+ 'total': number;
1730
+ };
1731
+ /** Duration jobs have been running in this billing period, in seconds. Example: 172800 */
1732
+ 'duration': number;
1733
+ };
1734
+ };
1735
+ }[];
1736
+ };
1737
+ declare type GetInvoiceDetailsCall = (opts: GetInvoiceDetailsRequest) => Promise<ApiCallResponse<GetInvoiceDetailsResult>>;
1738
+ declare type GetInvoiceDetailsRequest = {
1739
+ options?: GetInvoiceDetailsOptions;
1740
+ };
1741
+ declare type GetInvoiceDetailsOptions = {
1742
+ /** Timestamp of an invoice. If passed in, this endpoint will return details about the invoice that time belongs to. */
1743
+ 'timestamp'?: number;
1744
+ /** ID of a project. If passed in, only details about that project will be returned. */
1745
+ 'projectId'?: string;
1746
+ /** ID of a addon. If passed in, only details about that addon will be returned. */
1747
+ 'addonId'?: string;
1748
+ /** ID of a service. If passed in, only details about that service will be returned. */
1749
+ 'serviceId'?: string;
1750
+ /** ID of a job. If passed in, only details about that job will be returned. */
1751
+ 'jobId'?: string;
1752
+ };
1753
+ /** Get details about an invoice. If `timestamp` is passed in as a query parameter, this endpoint returns details about the invoice containing that timestamp. Otherwise, returns a preview invoice displaying billing data from after the most recent invoice. */
1754
+ declare class GetInvoiceDetailsEndpoint extends GetApiEndpoint<GetInvoiceDetailsRequest, GetInvoiceDetailsResult> {
1755
+ description: string;
1756
+ withAuth: boolean;
1757
+ requiredPermissions: string;
1758
+ endpointUrl: (opts: GetInvoiceDetailsRequest) => string;
1759
+ body: () => undefined;
1760
+ }
1761
+
1762
+ declare type ListProvidersResult = {
1763
+ /** An array of supported cloud providers */
1764
+ 'providers': {
1765
+ /** The ID of the provider. Example: "aws" */
1766
+ 'id': string;
1767
+ /** The name of the provider. Example: "Amazon Web Services" */
1768
+ 'name': string;
1769
+ /** The kubernetes engine used. Example: "Elastic Kubernetes Service (EKS)" */
1770
+ 'engine': string;
1771
+ /** An array of available regions */
1772
+ 'regions': string[];
1773
+ /** An array of available kubernetes versions */
1774
+ 'kubernetesVersions': string[];
1775
+ /** An array of supported node types */
1776
+ 'nodeTypes': string[];
1777
+ /** An array of supported node disk sizes */
1778
+ 'diskSizes': number[];
1779
+ /** An object with feature flags to indicate (un)supported features */
1780
+ 'flags': {
1781
+ /** Preemptible/Spot node pool support Example: true */
1782
+ 'preemptible'?: boolean;
1783
+ /** Node pool autoscaling support Example: true */
1784
+ 'autoscaling'?: boolean;
1785
+ };
1786
+ }[];
1787
+ };
1788
+ declare type ListProvidersCall = (opts: ListProvidersRequest) => Promise<ApiCallResponse<ListProvidersResult>>;
1789
+ declare type ListProvidersRequest = {};
1790
+ /** Lists supported cloud providers */
1791
+ declare class ListProvidersEndpoint extends GetApiEndpoint<ListProvidersRequest, ListProvidersResult> {
1792
+ description: string;
1793
+ withAuth: boolean;
1794
+ requiredPermissions: string;
1795
+ endpointUrl: (opts: ListProvidersRequest) => string;
1796
+ body: () => undefined;
1797
+ }
1798
+
1799
+ declare type ListIntegrationsResult = {
1800
+ /** An array of integrations. */
1801
+ 'integrations': {
1802
+ /** Identifier for the integration. Example: "gcp-integration" */
1803
+ 'id': string;
1804
+ /** The name of the integration. Example: "GCP integration" */
1805
+ 'name': string;
1806
+ /** A short description of the integration. Example: "The integration description" */
1807
+ 'description'?: string;
1808
+ /** The cloud provider to which this integration belongs to. Example: "gcp" */
1809
+ 'provider'?: string;
1810
+ /** The time the integration was created. Example: "2021-01-20T11:19:53.175Z" */
1811
+ 'createdAt': string;
1812
+ }[];
1813
+ };
1814
+ declare type ListIntegrationsCall = (opts: ListIntegrationsRequest) => Promise<ApiCallResponse<ListIntegrationsResult>>;
1815
+ declare type ListIntegrationsRequest = {
1816
+ options?: ListIntegrationsOptions;
1817
+ };
1818
+ declare type ListIntegrationsOptions = {
1819
+ /** The number of results to display per request. Maximum of 100 results per page. */
1820
+ 'per_page'?: number;
1821
+ /** The page number to access. */
1822
+ 'page'?: number;
1823
+ /** The cursor returned from the previous page of results, used to request the next page. */
1824
+ 'cursor'?: string;
1825
+ };
1826
+ /** Lists integrations for the authenticated user or team. */
1827
+ declare class ListIntegrationsEndpoint extends GetApiEndpoint<ListIntegrationsRequest, ListIntegrationsResult> {
1828
+ description: string;
1829
+ withAuth: boolean;
1830
+ requiredPermissions: string;
1831
+ endpointUrl: (opts: ListIntegrationsRequest) => string;
1832
+ body: () => undefined;
1833
+ }
1834
+
1835
+ declare type CreateIntegrationResult = {
1836
+ /** Identifier for the integration. Example: "gcp-integration" */
1837
+ 'id': string;
1838
+ /** The name of the integration. Example: "GCP integration" */
1839
+ 'name': string;
1840
+ /** A short description of the integration. Example: "The integration description" */
1841
+ 'description'?: string;
1842
+ /** Cloud provider credential input, required fields dependent on which provider is chosen. */
1843
+ 'credentials': {
1844
+ /** Contents of a GCP key file. */
1845
+ 'keyfileJson'?: string;
1846
+ /** AWS access key. */
1847
+ 'accessKey'?: string;
1848
+ /** AWS secret key. */
1849
+ 'secretKey'?: string;
1850
+ /** DO API key. */
1851
+ 'apiKey'?: string;
1852
+ };
1853
+ /** The time the integration was created. Example: "2021-01-20T11:19:53.175Z" */
1854
+ 'createdAt': string;
1855
+ };
1856
+ declare type CreateIntegrationCall = (opts: CreateIntegrationRequest) => Promise<ApiCallResponse<CreateIntegrationResult>>;
1857
+ declare type CreateIntegrationRequest = {
1858
+ data: CreateIntegrationData;
1859
+ };
1860
+ declare type CreateIntegrationData = {
1861
+ /** The name of the cloud provider integration. Example: "New Integration" */
1862
+ 'name': string;
1863
+ /** The description of the integration. Example: "This is a new cloud provider integration." */
1864
+ 'description'?: string;
1865
+ /** Cloud provider to be used for the selected resource Example: "gcp" */
1866
+ 'provider': 'gcp' | 'aws' | 'azure' | 'do';
1867
+ /** Cloud provider credential input, required fields dependent on which provider is chosen. */
1868
+ 'credentials': {
1869
+ /** Contents of a GCP key file. */
1870
+ 'keyfileJson'?: string;
1871
+ /** AWS access key. */
1872
+ 'accessKey'?: string;
1873
+ /** AWS secret key. */
1874
+ 'secretKey'?: string;
1875
+ /** DO API key. */
1876
+ 'apiKey'?: string;
1877
+ };
1878
+ /** GCP specific data. Required when `provider` is `gcp`. */
1879
+ 'gcp'?: {
1880
+ /** Project ID */
1881
+ 'projectId': string;
1882
+ };
1883
+ };
1884
+ /** Creates a new integration. */
1885
+ declare class CreateIntegrationEndpoint extends PostApiEndpoint<CreateIntegrationRequest, CreateIntegrationResult> {
1886
+ description: string;
1887
+ withAuth: boolean;
1888
+ requiredPermissions: string;
1889
+ endpointUrl: (opts: CreateIntegrationRequest) => string;
1890
+ body: (payload: CreateIntegrationRequest) => string;
1891
+ }
1892
+
1893
+ declare type GetIntegrationResult = {
1894
+ /** Identifier for the integration. Example: "gcp-integration" */
1895
+ 'id': string;
1896
+ /** The name of the integration. Example: "GCP integration" */
1897
+ 'name': string;
1898
+ /** A short description of the integration. Example: "The integration description" */
1899
+ 'description'?: string;
1900
+ /** Cloud provider credential input, required fields dependent on which provider is chosen. */
1901
+ 'credentials': {
1902
+ /** Contents of a GCP key file. */
1903
+ 'keyfileJson'?: string;
1904
+ /** AWS access key. */
1905
+ 'accessKey'?: string;
1906
+ /** AWS secret key. */
1907
+ 'secretKey'?: string;
1908
+ /** DO API key. */
1909
+ 'apiKey'?: string;
1910
+ };
1911
+ /** The time the integration was created. Example: "2021-01-20T11:19:53.175Z" */
1912
+ 'createdAt': string;
1913
+ };
1914
+ declare type GetIntegrationCall = (opts: GetIntegrationRequest) => Promise<ApiCallResponse<GetIntegrationResult>>;
1915
+ declare type GetIntegrationRequest = {
1916
+ parameters: GetIntegrationParameters;
1917
+ };
1918
+ declare type GetIntegrationParameters = {
1919
+ /** ID of the provider integration */ 'integrationId': string;
1920
+ };
1921
+ /** Get information about the given integration */
1922
+ declare class GetIntegrationEndpoint extends GetApiEndpoint<GetIntegrationRequest, GetIntegrationResult> {
1923
+ description: string;
1924
+ withAuth: boolean;
1925
+ requiredPermissions: string;
1926
+ endpointUrl: (opts: GetIntegrationRequest) => string;
1927
+ body: () => undefined;
1928
+ }
1929
+
1930
+ declare type UpdateIntegrationResult = {
1931
+ /** Identifier for the integration. Example: "gcp-integration" */
1932
+ 'id': string;
1933
+ /** The name of the integration. Example: "GCP integration" */
1934
+ 'name': string;
1935
+ /** A short description of the integration. Example: "The integration description" */
1936
+ 'description'?: string;
1937
+ /** Cloud provider credential input, required fields dependent on which provider is chosen. */
1938
+ 'credentials': {
1939
+ /** Contents of a GCP key file. */
1940
+ 'keyfileJson'?: string;
1941
+ /** AWS access key. */
1942
+ 'accessKey'?: string;
1943
+ /** AWS secret key. */
1944
+ 'secretKey'?: string;
1945
+ /** DO API key. */
1946
+ 'apiKey'?: string;
1947
+ };
1948
+ /** The time the integration was created. Example: "2021-01-20T11:19:53.175Z" */
1949
+ 'createdAt': string;
1950
+ };
1951
+ declare type UpdateIntegrationCall = (opts: UpdateIntegrationRequest) => Promise<ApiCallResponse<UpdateIntegrationResult>>;
1952
+ declare type UpdateIntegrationRequest = {
1953
+ parameters: UpdateIntegrationParameters;
1954
+ data: UpdateIntegrationData;
1955
+ };
1956
+ declare type UpdateIntegrationParameters = {
1957
+ /** ID of the provider integration */ 'integrationId': string;
1958
+ };
1959
+ declare type UpdateIntegrationData = {
1960
+ /** The description of the integration. Example: "This is a new description." */
1961
+ 'description'?: string;
1962
+ /** Cloud provider credential input, required fields dependent on which provider is chosen. */
1963
+ 'credentials': {
1964
+ /** Contents of a GCP key file. */
1965
+ 'keyfileJson'?: string;
1966
+ /** AWS access key. */
1967
+ 'accessKey'?: string;
1968
+ /** AWS secret key. */
1969
+ 'secretKey'?: string;
1970
+ /** DO API key. */
1971
+ 'apiKey'?: string;
1972
+ };
1973
+ };
1974
+ /** Update information about the given integration */
1975
+ declare class UpdateIntegrationEndpoint extends PostApiEndpoint<UpdateIntegrationRequest, UpdateIntegrationResult> {
1976
+ description: string;
1977
+ withAuth: boolean;
1978
+ requiredPermissions: string;
1979
+ endpointUrl: (opts: UpdateIntegrationRequest) => string;
1980
+ body: (payload: UpdateIntegrationRequest) => string;
1981
+ }
1982
+
1983
+ declare type DeleteIntegrationResult = any | any;
1984
+ declare type DeleteIntegrationCall = (opts: DeleteIntegrationRequest) => Promise<ApiCallResponse<DeleteIntegrationResult>>;
1985
+ declare type DeleteIntegrationRequest = {
1986
+ parameters: DeleteIntegrationParameters;
1987
+ };
1988
+ declare type DeleteIntegrationParameters = {
1989
+ /** ID of the provider integration */ 'integrationId': string;
1990
+ };
1991
+ /** Delete the given integration. Fails if the integration is associated with existing clusters. */
1992
+ declare class DeleteIntegrationEndpoint extends DeleteApiEndpoint<DeleteIntegrationRequest, DeleteIntegrationResult> {
1993
+ description: string;
1994
+ withAuth: boolean;
1995
+ requiredPermissions: string;
1996
+ endpointUrl: (opts: DeleteIntegrationRequest) => string;
1997
+ body: () => undefined;
1998
+ }
1999
+
2000
+ declare type ListClustersResult = {
2001
+ /** An array of clusters. */
2002
+ 'clusters': {
2003
+ /** Identifier for the cluster. Example: "gcp-cluster-1" */
2004
+ 'id': string;
2005
+ /** The name of the cluster. Example: "GCP Cluster 1" */
2006
+ 'name': string;
2007
+ /** A short description of the cluster. Example: "The cluster description" */
2008
+ 'description'?: string;
2009
+ /** The cloud provider to which this cluster belongs to. Example: "gcp" */
2010
+ 'provider'?: string;
2011
+ /** ID of the provider integration used by this cluster. Example: "gcp-integration" */
2012
+ 'integrationId': string;
2013
+ 'nodePools': {
2014
+ 'availabilityZones'?: string[];
2015
+ 'nodeTypes': string[];
2016
+ 'nodeCount': number;
2017
+ 'autoscaling'?: {
2018
+ 'enabled'?: boolean;
2019
+ 'min'?: number;
2020
+ 'max'?: number;
2021
+ };
2022
+ /** Configures node pool with preemptible / spot instances if enabled. */
2023
+ 'preemptible'?: boolean;
2024
+ 'diskType'?: string;
2025
+ 'diskSize': number;
2026
+ /** ID of existing node pool. Must be passed when modifying existing node pools. Not relevant for new node pools Example: "6aa96121-0345-43ad-bade-af36d540c222" */
2027
+ 'id'?: string;
2028
+ };
2029
+ 'status'?: {
2030
+ 'state'?: {
2031
+ 'state'?: string;
2032
+ 'transitionTime'?: string;
2033
+ };
2034
+ 'nextUpdateAfter'?: string;
2035
+ };
2036
+ /** The time the cluster was created. Example: "2021-01-20T11:19:53.175Z" */
2037
+ 'createdAt': string;
2038
+ /** Indicates if provider resource deletion has been requested by the user. */
2039
+ 'deletionRequested': boolean;
2040
+ }[];
2041
+ };
2042
+ declare type ListClustersCall = (opts: ListClustersRequest) => Promise<ApiCallResponse<ListClustersResult>>;
2043
+ declare type ListClustersRequest = {
2044
+ options?: ListClustersOptions;
2045
+ };
2046
+ declare type ListClustersOptions = {
2047
+ /** The number of results to display per request. Maximum of 100 results per page. */
2048
+ 'per_page'?: number;
2049
+ /** The page number to access. */
2050
+ 'page'?: number;
2051
+ /** The cursor returned from the previous page of results, used to request the next page. */
2052
+ 'cursor'?: string;
2053
+ };
2054
+ /** Lists clusters for the authenticated user or team. */
2055
+ declare class ListClustersEndpoint extends GetApiEndpoint<ListClustersRequest, ListClustersResult> {
2056
+ description: string;
2057
+ withAuth: boolean;
2058
+ requiredPermissions: string;
2059
+ endpointUrl: (opts: ListClustersRequest) => string;
2060
+ body: () => undefined;
2061
+ }
2062
+
2063
+ declare type CreateClusterResult = {
2064
+ /** Identifier for the cluster. Example: "gcp-cluster-1" */
2065
+ 'id': string;
2066
+ /** The name of the cluster. Example: "GCP Cluster 1" */
2067
+ 'name': string;
2068
+ /** A short description of the cluster. Example: "The cluster description" */
2069
+ 'description'?: string;
2070
+ /** The cloud provider to which this cluster belongs to. Example: "gcp" */
2071
+ 'provider'?: string;
2072
+ /** ID of the provider integration used by this cluster. Example: "gcp-integration" */
2073
+ 'integrationId': string;
2074
+ 'nodePools': {
2075
+ 'availabilityZones'?: string[];
2076
+ 'nodeTypes': string[];
2077
+ 'nodeCount': number;
2078
+ 'autoscaling'?: {
2079
+ 'enabled'?: boolean;
2080
+ 'min'?: number;
2081
+ 'max'?: number;
2082
+ };
2083
+ /** Configures node pool with preemptible / spot instances if enabled. */
2084
+ 'preemptible'?: boolean;
2085
+ 'diskType'?: string;
2086
+ 'diskSize': number;
2087
+ /** ID of existing node pool. Must be passed when modifying existing node pools. Not relevant for new node pools Example: "6aa96121-0345-43ad-bade-af36d540c222" */
2088
+ 'id'?: string;
2089
+ };
2090
+ 'status'?: {
2091
+ 'state'?: {
2092
+ 'state'?: string;
2093
+ 'transitionTime'?: string;
2094
+ };
2095
+ 'nextUpdateAfter'?: string;
2096
+ };
2097
+ /** The time the cluster was created. Example: "2021-01-20T11:19:53.175Z" */
2098
+ 'createdAt': string;
2099
+ /** Indicates if provider resource deletion has been requested by the user. */
2100
+ 'deletionRequested': boolean;
2101
+ };
2102
+ declare type CreateClusterCall = (opts: CreateClusterRequest) => Promise<ApiCallResponse<CreateClusterResult>>;
2103
+ declare type CreateClusterRequest = {
2104
+ data: CreateClusterData;
2105
+ };
2106
+ declare type CreateClusterData = {
2107
+ /** The name of the cluster. Example: "GCP Cluster 1" */
2108
+ 'name': string;
2109
+ /** The description of the cluster. Example: "This is a new cluster." */
2110
+ 'description'?: string;
2111
+ /** Cloud provider to be used for the selected resource Example: "gcp" */
2112
+ 'provider': 'gcp' | 'aws' | 'azure' | 'do';
2113
+ /** Region of the cluster. */
2114
+ 'region': string;
2115
+ /** Kubernetes version of the cluster. */
2116
+ 'kubernetesVersion': string;
2117
+ /** Existing integration to use for this cluster. Example: "gcp-integration" */
2118
+ 'integrationId'?: string;
2119
+ /** Cloud provider credential input, required fields dependent on which provider is chosen. */
2120
+ 'integration'?: {
2121
+ /** Contents of a GCP key file. */
2122
+ 'keyfileJson'?: string;
2123
+ /** AWS access key. */
2124
+ 'accessKey'?: string;
2125
+ /** AWS secret key. */
2126
+ 'secretKey'?: string;
2127
+ /** DO API key. */
2128
+ 'apiKey'?: string;
2129
+ };
2130
+ /** An array of node pools. */
2131
+ 'nodePools': {
2132
+ 'availabilityZones'?: string[];
2133
+ 'nodeTypes': string[];
2134
+ 'nodeCount': number;
2135
+ 'autoscaling'?: {
2136
+ 'enabled'?: boolean;
2137
+ 'min'?: number;
2138
+ 'max'?: number;
2139
+ };
2140
+ /** Configures node pool with preemptible / spot instances if enabled. */
2141
+ 'preemptible'?: boolean;
2142
+ 'diskType'?: string;
2143
+ 'diskSize': number;
2144
+ }[];
2145
+ /** GCP specific data. Required when `provider` is `gcp`. */
2146
+ 'gcp'?: {
2147
+ /** Project ID */
2148
+ 'projectId': string;
2149
+ };
2150
+ };
2151
+ /** Creates a new cluster. */
2152
+ declare class CreateClusterEndpoint extends PostApiEndpoint<CreateClusterRequest, CreateClusterResult> {
2153
+ description: string;
2154
+ withAuth: boolean;
2155
+ requiredPermissions: string;
2156
+ endpointUrl: (opts: CreateClusterRequest) => string;
2157
+ body: (payload: CreateClusterRequest) => string;
2158
+ }
2159
+
2160
+ declare type GetClusterResult = {
2161
+ /** Identifier for the cluster. Example: "gcp-cluster-1" */
2162
+ 'id': string;
2163
+ /** The name of the cluster. Example: "GCP Cluster 1" */
2164
+ 'name': string;
2165
+ /** A short description of the cluster. Example: "The cluster description" */
2166
+ 'description'?: string;
2167
+ /** The cloud provider to which this cluster belongs to. Example: "gcp" */
2168
+ 'provider'?: string;
2169
+ /** ID of the provider integration used by this cluster. Example: "gcp-integration" */
2170
+ 'integrationId': string;
2171
+ 'nodePools': {
2172
+ 'availabilityZones'?: string[];
2173
+ 'nodeTypes': string[];
2174
+ 'nodeCount': number;
2175
+ 'autoscaling'?: {
2176
+ 'enabled'?: boolean;
2177
+ 'min'?: number;
2178
+ 'max'?: number;
2179
+ };
2180
+ /** Configures node pool with preemptible / spot instances if enabled. */
2181
+ 'preemptible'?: boolean;
2182
+ 'diskType'?: string;
2183
+ 'diskSize': number;
2184
+ /** ID of existing node pool. Must be passed when modifying existing node pools. Not relevant for new node pools Example: "6aa96121-0345-43ad-bade-af36d540c222" */
2185
+ 'id'?: string;
2186
+ };
2187
+ 'status'?: {
2188
+ 'state'?: {
2189
+ 'state'?: string;
2190
+ 'transitionTime'?: string;
2191
+ };
2192
+ 'nextUpdateAfter'?: string;
2193
+ };
2194
+ /** The time the cluster was created. Example: "2021-01-20T11:19:53.175Z" */
2195
+ 'createdAt': string;
2196
+ /** Indicates if provider resource deletion has been requested by the user. */
2197
+ 'deletionRequested': boolean;
2198
+ };
2199
+ declare type GetClusterCall = (opts: GetClusterRequest) => Promise<ApiCallResponse<GetClusterResult>>;
2200
+ declare type GetClusterRequest = {
2201
+ parameters: GetClusterParameters;
2202
+ };
2203
+ declare type GetClusterParameters = {
2204
+ /** ID of the cluster */ 'clusterId': string;
2205
+ };
2206
+ /** Get information about the given cluster */
2207
+ declare class GetClusterEndpoint extends GetApiEndpoint<GetClusterRequest, GetClusterResult> {
2208
+ description: string;
2209
+ withAuth: boolean;
2210
+ requiredPermissions: string;
2211
+ endpointUrl: (opts: GetClusterRequest) => string;
2212
+ body: () => undefined;
2213
+ }
2214
+
2215
+ declare type UpdateClusterResult = {
2216
+ /** Identifier for the cluster. Example: "gcp-cluster-1" */
2217
+ 'id': string;
2218
+ /** The name of the cluster. Example: "GCP Cluster 1" */
2219
+ 'name': string;
2220
+ /** A short description of the cluster. Example: "The cluster description" */
2221
+ 'description'?: string;
2222
+ /** The cloud provider to which this cluster belongs to. Example: "gcp" */
2223
+ 'provider'?: string;
2224
+ /** ID of the provider integration used by this cluster. Example: "gcp-integration" */
2225
+ 'integrationId': string;
2226
+ 'nodePools': {
2227
+ 'availabilityZones'?: string[];
2228
+ 'nodeTypes': string[];
2229
+ 'nodeCount': number;
2230
+ 'autoscaling'?: {
2231
+ 'enabled'?: boolean;
2232
+ 'min'?: number;
2233
+ 'max'?: number;
2234
+ };
2235
+ /** Configures node pool with preemptible / spot instances if enabled. */
2236
+ 'preemptible'?: boolean;
2237
+ 'diskType'?: string;
2238
+ 'diskSize': number;
2239
+ /** ID of existing node pool. Must be passed when modifying existing node pools. Not relevant for new node pools Example: "6aa96121-0345-43ad-bade-af36d540c222" */
2240
+ 'id'?: string;
2241
+ };
2242
+ 'status'?: {
2243
+ 'state'?: {
2244
+ 'state'?: string;
2245
+ 'transitionTime'?: string;
2246
+ };
2247
+ 'nextUpdateAfter'?: string;
2248
+ };
2249
+ /** The time the cluster was created. Example: "2021-01-20T11:19:53.175Z" */
2250
+ 'createdAt': string;
2251
+ /** Indicates if provider resource deletion has been requested by the user. */
2252
+ 'deletionRequested': boolean;
2253
+ };
2254
+ declare type UpdateClusterCall = (opts: UpdateClusterRequest) => Promise<ApiCallResponse<UpdateClusterResult>>;
2255
+ declare type UpdateClusterRequest = {
2256
+ parameters: UpdateClusterParameters;
2257
+ data: UpdateClusterData;
2258
+ };
2259
+ declare type UpdateClusterParameters = {
2260
+ /** ID of the cluster */ 'clusterId': string;
2261
+ };
2262
+ declare type UpdateClusterData = {
2263
+ /** The description of the cluster. Example: "This is an updated description." */
2264
+ 'description'?: string;
2265
+ 'nodePools': {
2266
+ 'availabilityZones'?: string[];
2267
+ 'nodeTypes': string[];
2268
+ 'nodeCount': number;
2269
+ 'autoscaling'?: {
2270
+ 'enabled'?: boolean;
2271
+ 'min'?: number;
2272
+ 'max'?: number;
2273
+ };
2274
+ /** Configures node pool with preemptible / spot instances if enabled. */
2275
+ 'preemptible'?: boolean;
2276
+ 'diskType'?: string;
2277
+ 'diskSize': number;
2278
+ /** ID of existing node pool. Must be passed when modifying existing node pools. Not relevant for new node pools Example: "6aa96121-0345-43ad-bade-af36d540c222" */
2279
+ 'id'?: string;
2280
+ }[];
2281
+ };
2282
+ /** Update an existing cluster. */
2283
+ declare class UpdateClusterEndpoint extends PostApiEndpoint<UpdateClusterRequest, UpdateClusterResult> {
2284
+ description: string;
2285
+ withAuth: boolean;
2286
+ requiredPermissions: string;
2287
+ endpointUrl: (opts: UpdateClusterRequest) => string;
2288
+ body: (payload: UpdateClusterRequest) => string;
2289
+ }
2290
+
2291
+ declare type DeleteClusterResult = any | any;
2292
+ declare type DeleteClusterCall = (opts: DeleteClusterRequest) => Promise<ApiCallResponse<DeleteClusterResult>>;
2293
+ declare type DeleteClusterRequest = {
2294
+ parameters: DeleteClusterParameters;
2295
+ };
2296
+ declare type DeleteClusterParameters = {
2297
+ /** ID of the cluster */ 'clusterId': string;
2298
+ };
2299
+ /** Delete the given cluster. Fails if the cluster has associated projects. */
2300
+ declare class DeleteClusterEndpoint extends DeleteApiEndpoint<DeleteClusterRequest, DeleteClusterResult> {
2301
+ description: string;
2302
+ withAuth: boolean;
2303
+ requiredPermissions: string;
2304
+ endpointUrl: (opts: DeleteClusterRequest) => string;
2305
+ body: () => undefined;
2306
+ }
2307
+
1401
2308
  declare type ListJobsResult = {
1402
2309
  /** An array of job objects. */
1403
2310
  'jobs': {
@@ -1412,7 +2319,7 @@ declare type ListJobsResult = {
1412
2319
  /** A short description of the job Example: "This is the job description" */
1413
2320
  'description'?: string;
1414
2321
  /** Type of the job (manual or cron) Example: "cron" */
1415
- 'jobType': 'cron' | 'manual';
2322
+ 'jobType': 'manual' | 'cron';
1416
2323
  /** Whether Continuous Integration is disabled */
1417
2324
  'disabledCI': boolean;
1418
2325
  /** Whether Continuous Deployment is disabled */
@@ -1439,6 +2346,7 @@ declare type ListJobsOptions = {
1439
2346
  declare class ListJobsEndpoint extends GetApiEndpoint<ListJobsRequest, ListJobsResult> {
1440
2347
  description: string;
1441
2348
  withAuth: boolean;
2349
+ requiredPermissions: string;
1442
2350
  endpointUrl: (opts: ListJobsRequest) => string;
1443
2351
  body: () => undefined;
1444
2352
  }
@@ -1455,7 +2363,7 @@ declare type GetJobResult = {
1455
2363
  /** ID of the project that the job belongs to Example: "default-project" */
1456
2364
  'projectId': string;
1457
2365
  /** Type of the job (manual or cron) Example: "cron" */
1458
- 'jobType': 'cron' | 'manual';
2366
+ 'jobType': 'manual' | 'cron';
1459
2367
  /** The time the job was created. Example: "2021-01-20T11:19:53.175Z" */
1460
2368
  'createdAt': string;
1461
2369
  'vcsData'?: {
@@ -1487,6 +2395,13 @@ declare type GetJobResult = {
1487
2395
  'builder'?: 'HEROKU_20' | 'HEROKU_18' | 'GOOGLE_V1' | 'CNB_ALPINE' | 'CNB_BIONIC' | 'PAKETO_TINY' | 'PAKETO_BASE' | 'PAKETO_FULL';
1488
2396
  /** Array of custom Buildpacks used. */
1489
2397
  'buildpackLocators'?: string[];
2398
+ /** Should build dependencies be cached? */
2399
+ 'useCache'?: boolean;
2400
+ };
2401
+ /** Details about Buildkit settings. */
2402
+ 'buildkit'?: {
2403
+ /** Should intermediate image layers be cached? */
2404
+ 'useCache'?: boolean;
1490
2405
  };
1491
2406
  /** Details about Kaniko settings. */
1492
2407
  'kaniko'?: {
@@ -1501,6 +2416,31 @@ declare type GetJobResult = {
1501
2416
  'deployment'?: {
1502
2417
  /** Region where this job is deployed and built Example: "europe-west" */
1503
2418
  'region'?: string;
2419
+ /** Details about the Docker overrides for this deployment. */
2420
+ 'docker'?: {
2421
+ /** Details about the CMD override for this deployment. */
2422
+ 'cmd': {
2423
+ /** Whether the CMD override is enabled. Example: true */
2424
+ 'enabled': boolean;
2425
+ /** The CMD to run instead of the default if CMD override is enabled. Example: "nginx -g" */
2426
+ 'value': string;
2427
+ };
2428
+ /** Details about the entrypoint override for this deployment. */
2429
+ 'entrypoint': {
2430
+ /** Whether the entrypoint override is enabled. Example: true */
2431
+ 'enabled': boolean;
2432
+ /** The CMD to run instead of the default if entrypoint override is enabled. Example: "/docker-entrypoint.sh" */
2433
+ 'value': string;
2434
+ };
2435
+ };
2436
+ /** Details about storage settings for this deployment. */
2437
+ 'storage'?: {
2438
+ /** Details about ephemeral storage settings for this deployment. */
2439
+ 'ephemeralStorage'?: {
2440
+ /** Ephemeral storage per container in MB Example: 1024 */
2441
+ 'storageSize': number;
2442
+ };
2443
+ };
1504
2444
  };
1505
2445
  'billing': {
1506
2446
  /** ID of the billing plan used by this job Example: "nf-compute-20" */
@@ -1534,6 +2474,7 @@ declare type GetJobParameters = {
1534
2474
  declare class GetJobEndpoint extends GetApiEndpoint<GetJobRequest, GetJobResult> {
1535
2475
  description: string;
1536
2476
  withAuth: boolean;
2477
+ requiredPermissions: string;
1537
2478
  endpointUrl: (opts: GetJobRequest) => string;
1538
2479
  body: () => undefined;
1539
2480
  }
@@ -1552,6 +2493,7 @@ declare type DeleteJobParameters = {
1552
2493
  declare class DeleteJobEndpoint extends DeleteApiEndpoint<DeleteJobRequest, DeleteJobResult> {
1553
2494
  description: string;
1554
2495
  withAuth: boolean;
2496
+ requiredPermissions: string;
1555
2497
  endpointUrl: (opts: DeleteJobRequest) => string;
1556
2498
  body: () => undefined;
1557
2499
  }
@@ -1598,6 +2540,13 @@ declare type CreateJobManualResult = {
1598
2540
  'builder'?: 'HEROKU_20' | 'HEROKU_18' | 'GOOGLE_V1' | 'CNB_ALPINE' | 'CNB_BIONIC' | 'PAKETO_TINY' | 'PAKETO_BASE' | 'PAKETO_FULL';
1599
2541
  /** Array of custom Buildpacks used. */
1600
2542
  'buildpackLocators'?: string[];
2543
+ /** Should build dependencies be cached? */
2544
+ 'useCache'?: boolean;
2545
+ };
2546
+ /** Details about Buildkit settings. */
2547
+ 'buildkit'?: {
2548
+ /** Should intermediate image layers be cached? */
2549
+ 'useCache'?: boolean;
1601
2550
  };
1602
2551
  /** Details about Kaniko settings. */
1603
2552
  'kaniko'?: {
@@ -1612,13 +2561,38 @@ declare type CreateJobManualResult = {
1612
2561
  'deployment'?: {
1613
2562
  /** Region where this job is deployed and built Example: "europe-west" */
1614
2563
  'region'?: string;
2564
+ /** Details about the Docker overrides for this deployment. */
2565
+ 'docker'?: {
2566
+ /** Details about the CMD override for this deployment. */
2567
+ 'cmd': {
2568
+ /** Whether the CMD override is enabled. Example: true */
2569
+ 'enabled': boolean;
2570
+ /** The CMD to run instead of the default if CMD override is enabled. Example: "nginx -g" */
2571
+ 'value': string;
2572
+ };
2573
+ /** Details about the entrypoint override for this deployment. */
2574
+ 'entrypoint': {
2575
+ /** Whether the entrypoint override is enabled. Example: true */
2576
+ 'enabled': boolean;
2577
+ /** The CMD to run instead of the default if entrypoint override is enabled. Example: "/docker-entrypoint.sh" */
2578
+ 'value': string;
2579
+ };
2580
+ };
2581
+ /** Details about storage settings for this deployment. */
2582
+ 'storage'?: {
2583
+ /** Details about ephemeral storage settings for this deployment. */
2584
+ 'ephemeralStorage'?: {
2585
+ /** Ephemeral storage per container in MB Example: 1024 */
2586
+ 'storageSize': number;
2587
+ };
2588
+ };
1615
2589
  };
1616
2590
  'billing': {
1617
2591
  /** ID of the billing plan used by this job Example: "nf-compute-20" */
1618
2592
  'deploymentPlan': string;
1619
2593
  };
1620
2594
  /** Type of the job (manual or cron) Example: "manual" */
1621
- 'jobType': 'cron' | 'manual';
2595
+ 'jobType': 'manual' | 'cron';
1622
2596
  /** Job settings */
1623
2597
  'settings': {
1624
2598
  /** The number of attempts to rerun a job before it is marked as failed. */
@@ -1655,11 +2629,13 @@ declare type CreateJobManualData = {
1655
2629
  'activeDeadlineSeconds'?: number;
1656
2630
  /** Where to deploy the job from. */
1657
2631
  'deployment'?: {
1658
- /** If set, the service runs a custom command rather than one defined in the Dockerfile. Example: "nginx -g" */
2632
+ /** If set, the job runs a custom command rather than one defined in the Dockerfile. Example: "nginx -g" */
1659
2633
  'cmdOverride'?: string;
2634
+ /** If set, the job runs a custom entrypoint rather than one defined in the Dockerfile. Example: "/custom-entrypoint.sh" */
2635
+ 'entrypointOverride'?: string;
1660
2636
  'storage'?: {
1661
2637
  'ephemeralStorage'?: {
1662
- /** Ephemeral storage per container in MB */
2638
+ /** Ephemeral storage per container in MB Example: 1024 */
1663
2639
  'storageSize'?: number;
1664
2640
  };
1665
2641
  };
@@ -1676,11 +2652,13 @@ declare type CreateJobManualData = {
1676
2652
  'projectBranch': string;
1677
2653
  };
1678
2654
  } | {
1679
- /** If set, the service runs a custom command rather than one defined in the Dockerfile. Example: "nginx -g" */
2655
+ /** If set, the job runs a custom command rather than one defined in the Dockerfile. Example: "nginx -g" */
1680
2656
  'cmdOverride'?: string;
2657
+ /** If set, the job runs a custom entrypoint rather than one defined in the Dockerfile. Example: "/custom-entrypoint.sh" */
2658
+ 'entrypointOverride'?: string;
1681
2659
  'storage'?: {
1682
2660
  'ephemeralStorage'?: {
1683
- /** Ephemeral storage per container in MB */
2661
+ /** Ephemeral storage per container in MB Example: 1024 */
1684
2662
  'storageSize'?: number;
1685
2663
  };
1686
2664
  };
@@ -1691,11 +2669,13 @@ declare type CreateJobManualData = {
1691
2669
  'credentials'?: string;
1692
2670
  };
1693
2671
  } | {
1694
- /** If set, the service runs a custom command rather than one defined in the Dockerfile. Example: "nginx -g" */
2672
+ /** If set, the job runs a custom command rather than one defined in the Dockerfile. Example: "nginx -g" */
1695
2673
  'cmdOverride'?: string;
2674
+ /** If set, the job runs a custom entrypoint rather than one defined in the Dockerfile. Example: "/custom-entrypoint.sh" */
2675
+ 'entrypointOverride'?: string;
1696
2676
  'storage'?: {
1697
2677
  'ephemeralStorage'?: {
1698
- /** Ephemeral storage per container in MB */
2678
+ /** Ephemeral storage per container in MB Example: 1024 */
1699
2679
  'storageSize'?: number;
1700
2680
  };
1701
2681
  };
@@ -1705,7 +2685,7 @@ declare type CreateJobManualData = {
1705
2685
  /** Branch to deploy Example: "master" */
1706
2686
  'branch'?: string;
1707
2687
  /** Commit SHA to deploy, or 'latest' to deploy the most recent commit Example: "latest" */
1708
- 'buildSHA'?: any;
2688
+ 'buildSHA'?: string | 'latest';
1709
2689
  /** ID of the build that should be deployed Example: "premium-guide-6393" */
1710
2690
  'buildId'?: string;
1711
2691
  };
@@ -1718,7 +2698,7 @@ declare type CreateJobManualData = {
1718
2698
  'dockerfile': {
1719
2699
  /** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
1720
2700
  'buildEngine'?: 'kaniko' | 'buildkit';
1721
- /** Should intermediate image layers be cached? Only supported by Kaniko. */
2701
+ /** Should intermediate image layers be cached? */
1722
2702
  'useCache'?: boolean;
1723
2703
  /** The file path of the Dockerfile. Example: "/Dockerfile" */
1724
2704
  'dockerFilePath': string;
@@ -1733,6 +2713,8 @@ declare type CreateJobManualData = {
1733
2713
  'buildpackLocators'?: string[];
1734
2714
  /** The working directory to build in. Example: "/" */
1735
2715
  'buildContext'?: string;
2716
+ /** Should build dependencies be cached? */
2717
+ 'useCache'?: boolean;
1736
2718
  };
1737
2719
  };
1738
2720
  /** An object containing the runtime environment to set for the job. Keys must only contain letters and numbers separated with underscores, may not start with a number Example: {"variable1":"abcdef","variable2":"12345"} */
@@ -1748,6 +2730,7 @@ declare type CreateJobManualData = {
1748
2730
  declare class CreateJobManualEndpoint extends PostApiEndpoint<CreateJobManualRequest, CreateJobManualResult> {
1749
2731
  description: string;
1750
2732
  withAuth: boolean;
2733
+ requiredPermissions: string;
1751
2734
  endpointUrl: (opts: CreateJobManualRequest) => string;
1752
2735
  body: (payload: CreateJobManualRequest) => string;
1753
2736
  }
@@ -1794,6 +2777,13 @@ declare type CreateJobCronResult = {
1794
2777
  'builder'?: 'HEROKU_20' | 'HEROKU_18' | 'GOOGLE_V1' | 'CNB_ALPINE' | 'CNB_BIONIC' | 'PAKETO_TINY' | 'PAKETO_BASE' | 'PAKETO_FULL';
1795
2778
  /** Array of custom Buildpacks used. */
1796
2779
  'buildpackLocators'?: string[];
2780
+ /** Should build dependencies be cached? */
2781
+ 'useCache'?: boolean;
2782
+ };
2783
+ /** Details about Buildkit settings. */
2784
+ 'buildkit'?: {
2785
+ /** Should intermediate image layers be cached? */
2786
+ 'useCache'?: boolean;
1797
2787
  };
1798
2788
  /** Details about Kaniko settings. */
1799
2789
  'kaniko'?: {
@@ -1808,6 +2798,31 @@ declare type CreateJobCronResult = {
1808
2798
  'deployment'?: {
1809
2799
  /** Region where this job is deployed and built Example: "europe-west" */
1810
2800
  'region'?: string;
2801
+ /** Details about the Docker overrides for this deployment. */
2802
+ 'docker'?: {
2803
+ /** Details about the CMD override for this deployment. */
2804
+ 'cmd': {
2805
+ /** Whether the CMD override is enabled. Example: true */
2806
+ 'enabled': boolean;
2807
+ /** The CMD to run instead of the default if CMD override is enabled. Example: "nginx -g" */
2808
+ 'value': string;
2809
+ };
2810
+ /** Details about the entrypoint override for this deployment. */
2811
+ 'entrypoint': {
2812
+ /** Whether the entrypoint override is enabled. Example: true */
2813
+ 'enabled': boolean;
2814
+ /** The CMD to run instead of the default if entrypoint override is enabled. Example: "/docker-entrypoint.sh" */
2815
+ 'value': string;
2816
+ };
2817
+ };
2818
+ /** Details about storage settings for this deployment. */
2819
+ 'storage'?: {
2820
+ /** Details about ephemeral storage settings for this deployment. */
2821
+ 'ephemeralStorage'?: {
2822
+ /** Ephemeral storage per container in MB Example: 1024 */
2823
+ 'storageSize': number;
2824
+ };
2825
+ };
1811
2826
  };
1812
2827
  'billing': {
1813
2828
  /** ID of the billing plan used by this job Example: "nf-compute-20" */
@@ -1828,7 +2843,7 @@ declare type CreateJobCronResult = {
1828
2843
  'activeDeadlineSeconds': number;
1829
2844
  };
1830
2845
  /** Type of the job (manual or cron) Example: "cron" */
1831
- 'jobType': 'cron' | 'manual';
2846
+ 'jobType': 'manual' | 'cron';
1832
2847
  /** Whether the job will be built immediately Example: true */
1833
2848
  'buildInitiated': boolean;
1834
2849
  };
@@ -1857,11 +2872,13 @@ declare type CreateJobCronData = {
1857
2872
  'activeDeadlineSeconds'?: number;
1858
2873
  /** Where to deploy the job from. */
1859
2874
  'deployment'?: {
1860
- /** If set, the service runs a custom command rather than one defined in the Dockerfile. Example: "nginx -g" */
2875
+ /** If set, the job runs a custom command rather than one defined in the Dockerfile. Example: "nginx -g" */
1861
2876
  'cmdOverride'?: string;
2877
+ /** If set, the job runs a custom entrypoint rather than one defined in the Dockerfile. Example: "/custom-entrypoint.sh" */
2878
+ 'entrypointOverride'?: string;
1862
2879
  'storage'?: {
1863
2880
  'ephemeralStorage'?: {
1864
- /** Ephemeral storage per container in MB */
2881
+ /** Ephemeral storage per container in MB Example: 1024 */
1865
2882
  'storageSize'?: number;
1866
2883
  };
1867
2884
  };
@@ -1878,11 +2895,13 @@ declare type CreateJobCronData = {
1878
2895
  'projectBranch': string;
1879
2896
  };
1880
2897
  } | {
1881
- /** If set, the service runs a custom command rather than one defined in the Dockerfile. Example: "nginx -g" */
2898
+ /** If set, the job runs a custom command rather than one defined in the Dockerfile. Example: "nginx -g" */
1882
2899
  'cmdOverride'?: string;
2900
+ /** If set, the job runs a custom entrypoint rather than one defined in the Dockerfile. Example: "/custom-entrypoint.sh" */
2901
+ 'entrypointOverride'?: string;
1883
2902
  'storage'?: {
1884
2903
  'ephemeralStorage'?: {
1885
- /** Ephemeral storage per container in MB */
2904
+ /** Ephemeral storage per container in MB Example: 1024 */
1886
2905
  'storageSize'?: number;
1887
2906
  };
1888
2907
  };
@@ -1893,11 +2912,13 @@ declare type CreateJobCronData = {
1893
2912
  'credentials'?: string;
1894
2913
  };
1895
2914
  } | {
1896
- /** If set, the service runs a custom command rather than one defined in the Dockerfile. Example: "nginx -g" */
2915
+ /** If set, the job runs a custom command rather than one defined in the Dockerfile. Example: "nginx -g" */
1897
2916
  'cmdOverride'?: string;
2917
+ /** If set, the job runs a custom entrypoint rather than one defined in the Dockerfile. Example: "/custom-entrypoint.sh" */
2918
+ 'entrypointOverride'?: string;
1898
2919
  'storage'?: {
1899
2920
  'ephemeralStorage'?: {
1900
- /** Ephemeral storage per container in MB */
2921
+ /** Ephemeral storage per container in MB Example: 1024 */
1901
2922
  'storageSize'?: number;
1902
2923
  };
1903
2924
  };
@@ -1907,7 +2928,7 @@ declare type CreateJobCronData = {
1907
2928
  /** Branch to deploy Example: "master" */
1908
2929
  'branch'?: string;
1909
2930
  /** Commit SHA to deploy, or 'latest' to deploy the most recent commit Example: "latest" */
1910
- 'buildSHA'?: any;
2931
+ 'buildSHA'?: string | 'latest';
1911
2932
  /** ID of the build that should be deployed Example: "premium-guide-6393" */
1912
2933
  'buildId'?: string;
1913
2934
  };
@@ -1920,7 +2941,7 @@ declare type CreateJobCronData = {
1920
2941
  'dockerfile': {
1921
2942
  /** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
1922
2943
  'buildEngine'?: 'kaniko' | 'buildkit';
1923
- /** Should intermediate image layers be cached? Only supported by Kaniko. */
2944
+ /** Should intermediate image layers be cached? */
1924
2945
  'useCache'?: boolean;
1925
2946
  /** The file path of the Dockerfile. Example: "/Dockerfile" */
1926
2947
  'dockerFilePath': string;
@@ -1935,6 +2956,8 @@ declare type CreateJobCronData = {
1935
2956
  'buildpackLocators'?: string[];
1936
2957
  /** The working directory to build in. Example: "/" */
1937
2958
  'buildContext'?: string;
2959
+ /** Should build dependencies be cached? */
2960
+ 'useCache'?: boolean;
1938
2961
  };
1939
2962
  };
1940
2963
  /** An object containing the runtime environment to set for the job. Keys must only contain letters and numbers separated with underscores, may not start with a number Example: {"variable1":"abcdef","variable2":"12345"} */
@@ -1954,6 +2977,7 @@ declare type CreateJobCronData = {
1954
2977
  declare class CreateJobCronEndpoint extends PostApiEndpoint<CreateJobCronRequest, CreateJobCronResult> {
1955
2978
  description: string;
1956
2979
  withAuth: boolean;
2980
+ requiredPermissions: string;
1957
2981
  endpointUrl: (opts: CreateJobCronRequest) => string;
1958
2982
  body: (payload: CreateJobCronRequest) => string;
1959
2983
  }
@@ -1974,7 +2998,7 @@ declare type ScaleJobData = {
1974
2998
  'deploymentPlan'?: string;
1975
2999
  'storage'?: {
1976
3000
  'ephemeralStorage'?: {
1977
- /** Ephemeral storage per container in MB */
3001
+ /** Ephemeral storage per container in MB Example: 1024 */
1978
3002
  'storageSize'?: number;
1979
3003
  };
1980
3004
  };
@@ -1983,10 +3007,82 @@ declare type ScaleJobData = {
1983
3007
  declare class ScaleJobEndpoint extends PostApiEndpoint<ScaleJobRequest, ScaleJobResult> {
1984
3008
  description: string;
1985
3009
  withAuth: boolean;
3010
+ requiredPermissions: string;
1986
3011
  endpointUrl: (opts: ScaleJobRequest) => string;
1987
3012
  body: (payload: ScaleJobRequest) => string;
1988
3013
  }
1989
3014
 
3015
+ declare type SuspendJobResult = any | any;
3016
+ declare type SuspendJobCall = (opts: SuspendJobRequest) => Promise<ApiCallResponse<SuspendJobResult>>;
3017
+ declare type SuspendJobRequest = {
3018
+ parameters: SuspendJobParameters;
3019
+ data: SuspendJobData;
3020
+ };
3021
+ declare type SuspendJobParameters = {
3022
+ /** ID of the project */ 'projectId': string;
3023
+ /** ID of the job */
3024
+ 'jobId': string;
3025
+ };
3026
+ declare type SuspendJobData = {
3027
+ /** In the case of cron jobs, whether scheduling should be paused. Example: true */
3028
+ 'suspended'?: boolean;
3029
+ };
3030
+ /** Modify cron job to toggle suspending of its schedule. */
3031
+ declare class SuspendJobEndpoint extends PostApiEndpoint<SuspendJobRequest, SuspendJobResult> {
3032
+ description: string;
3033
+ withAuth: boolean;
3034
+ requiredPermissions: string;
3035
+ endpointUrl: (opts: SuspendJobRequest) => string;
3036
+ body: (payload: SuspendJobRequest) => string;
3037
+ }
3038
+
3039
+ declare type PauseJobResult = any;
3040
+ declare type PauseJobCall = (opts: PauseJobRequest) => Promise<ApiCallResponse<PauseJobResult>>;
3041
+ declare type PauseJobRequest = {
3042
+ parameters: PauseJobParameters;
3043
+ };
3044
+ declare type PauseJobParameters = {
3045
+ /** ID of the project */ 'projectId': string;
3046
+ /** ID of the job */
3047
+ 'jobId': string;
3048
+ };
3049
+ /** Pause the given job. */
3050
+ declare class PauseJobEndpoint extends PostApiEndpoint<PauseJobRequest, PauseJobResult> {
3051
+ description: string;
3052
+ withAuth: boolean;
3053
+ requiredPermissions: string;
3054
+ endpointUrl: (opts: PauseJobRequest) => string;
3055
+ body: () => undefined;
3056
+ }
3057
+
3058
+ declare type ResumeJobResult = any | any;
3059
+ declare type ResumeJobCall = (opts: ResumeJobRequest) => Promise<ApiCallResponse<ResumeJobResult>>;
3060
+ declare type ResumeJobRequest = {
3061
+ parameters: ResumeJobParameters;
3062
+ data: ResumeJobData;
3063
+ };
3064
+ declare type ResumeJobParameters = {
3065
+ /** ID of the project */ 'projectId': string;
3066
+ /** ID of the job */
3067
+ 'jobId': string;
3068
+ };
3069
+ declare type ResumeJobData = {
3070
+ /** In the case of cron jobs, whether scheduling should be paused. */
3071
+ 'suspended'?: boolean;
3072
+ /** Whether CI should be disabled */
3073
+ 'disabledCI'?: boolean;
3074
+ /** Whether CD should be disabled */
3075
+ 'disabledCD'?: boolean;
3076
+ };
3077
+ /** Resumes the given job. Optionally takes several arguments to override resumed settings. */
3078
+ declare class ResumeJobEndpoint extends PostApiEndpoint<ResumeJobRequest, ResumeJobResult> {
3079
+ description: string;
3080
+ withAuth: boolean;
3081
+ requiredPermissions: string;
3082
+ endpointUrl: (opts: ResumeJobRequest) => string;
3083
+ body: (payload: ResumeJobRequest) => string;
3084
+ }
3085
+
1990
3086
  declare type GetJobRunsResult = {
1991
3087
  /** An array of job run objects. */
1992
3088
  'runs': {
@@ -2036,6 +3132,7 @@ declare type GetJobRunsOptions = {
2036
3132
  declare class GetJobRunsEndpoint extends GetApiEndpoint<GetJobRunsRequest, GetJobRunsResult> {
2037
3133
  description: string;
2038
3134
  withAuth: boolean;
3135
+ requiredPermissions: string;
2039
3136
  endpointUrl: (opts: GetJobRunsRequest) => string;
2040
3137
  body: () => undefined;
2041
3138
  }
@@ -2066,9 +3163,11 @@ declare type StartJobRunData = {
2066
3163
  'deployment'?: {
2067
3164
  /** The CMD override to use when running the job. Example: "nginx -g" */
2068
3165
  'cmdOverride'?: string;
3166
+ /** If set, the job runs a custom entrypoint rather than one defined in the Dockerfile. Example: "/custom-entrypoint.sh" */
3167
+ 'entrypointOverride'?: string;
2069
3168
  'storage'?: {
2070
3169
  'ephemeralStorage'?: {
2071
- /** Ephemeral storage per container in MB */
3170
+ /** Ephemeral storage per container in MB Example: 1024 */
2072
3171
  'storageSize'?: number;
2073
3172
  };
2074
3173
  };
@@ -2079,16 +3178,18 @@ declare type StartJobRunData = {
2079
3178
  /** Branch to deploy Example: "master" */
2080
3179
  'branch'?: string;
2081
3180
  /** Commit SHA to deploy, or 'latest' to deploy the most recent commit Example: "latest" */
2082
- 'buildSHA'?: any;
3181
+ 'buildSHA'?: string | 'latest';
2083
3182
  /** ID of the build that should be deployed Example: "premium-guide-6393" */
2084
3183
  'buildId'?: string;
2085
3184
  };
2086
3185
  } | {
2087
3186
  /** The CMD override to use when running the job. Example: "nginx -g" */
2088
3187
  'cmdOverride'?: string;
3188
+ /** If set, the job runs a custom entrypoint rather than one defined in the Dockerfile. Example: "/custom-entrypoint.sh" */
3189
+ 'entrypointOverride'?: string;
2089
3190
  'storage'?: {
2090
3191
  'ephemeralStorage'?: {
2091
- /** Ephemeral storage per container in MB */
3192
+ /** Ephemeral storage per container in MB Example: 1024 */
2092
3193
  'storageSize'?: number;
2093
3194
  };
2094
3195
  };
@@ -2105,6 +3206,7 @@ declare type StartJobRunData = {
2105
3206
  declare class StartJobRunEndpoint extends PostApiEndpoint<StartJobRunRequest, StartJobRunResult> {
2106
3207
  description: string;
2107
3208
  withAuth: boolean;
3209
+ requiredPermissions: string;
2108
3210
  endpointUrl: (opts: StartJobRunRequest) => string;
2109
3211
  body: (payload: StartJobRunRequest) => string;
2110
3212
  }
@@ -2148,6 +3250,7 @@ declare type GetJobRunParameters = {
2148
3250
  declare class GetJobRunEndpoint extends GetApiEndpoint<GetJobRunRequest, GetJobRunResult> {
2149
3251
  description: string;
2150
3252
  withAuth: boolean;
3253
+ requiredPermissions: string;
2151
3254
  endpointUrl: (opts: GetJobRunRequest) => string;
2152
3255
  body: () => undefined;
2153
3256
  }
@@ -2168,6 +3271,7 @@ declare type AbortJobRunParameters = {
2168
3271
  declare class AbortJobRunEndpoint extends DeleteApiEndpoint<AbortJobRunRequest, AbortJobRunResult> {
2169
3272
  description: string;
2170
3273
  withAuth: boolean;
3274
+ requiredPermissions: string;
2171
3275
  endpointUrl: (opts: AbortJobRunRequest) => string;
2172
3276
  body: () => undefined;
2173
3277
  }
@@ -2199,6 +3303,7 @@ declare type UpdateJobSettingsData = {
2199
3303
  declare class UpdateJobSettingsEndpoint extends PostApiEndpoint<UpdateJobSettingsRequest, UpdateJobSettingsResult> {
2200
3304
  description: string;
2201
3305
  withAuth: boolean;
3306
+ requiredPermissions: string;
2202
3307
  endpointUrl: (opts: UpdateJobSettingsRequest) => string;
2203
3308
  body: (payload: UpdateJobSettingsRequest) => string;
2204
3309
  }
@@ -2222,6 +3327,7 @@ declare type GetJobHealthchecksResult = {
2222
3327
  'initialDelaySeconds': number;
2223
3328
  /** The time between each check, in seconds. Example: 60 */
2224
3329
  'periodSeconds': number;
3330
+ /** The time to wait for a response before marking the health check as a failure. Example: 1 */
2225
3331
  'timeoutSeconds': number;
2226
3332
  /** The maximum number of allowed failures. Example: 3 */
2227
3333
  'failureThreshold': number;
@@ -2242,6 +3348,7 @@ declare type GetJobHealthchecksParameters = {
2242
3348
  declare class GetJobHealthchecksEndpoint extends GetApiEndpoint<GetJobHealthchecksRequest, GetJobHealthchecksResult> {
2243
3349
  description: string;
2244
3350
  withAuth: boolean;
3351
+ requiredPermissions: string;
2245
3352
  endpointUrl: (opts: GetJobHealthchecksRequest) => string;
2246
3353
  body: () => undefined;
2247
3354
  }
@@ -2258,7 +3365,7 @@ declare type UpdateJobHealthchecksParameters = {
2258
3365
  'jobId': string;
2259
3366
  };
2260
3367
  declare type UpdateJobHealthchecksData = {
2261
- /** An array of health checks */
3368
+ /** An array of health checks. */
2262
3369
  'healthChecks': {
2263
3370
  /** The protocol to access the health check with. Example: "HTTP" */
2264
3371
  'protocol': 'HTTP' | 'CMD' | 'TCP';
@@ -2268,7 +3375,7 @@ declare type UpdateJobHealthchecksData = {
2268
3375
  'path'?: string;
2269
3376
  /** The command to run for the health check. Required when protocol is CMD */
2270
3377
  'cmd'?: string;
2271
- /** Port number for the health check endpoint. Required when protocol is HTTP. Example: 3000 */
3378
+ /** Port number for the health check endpoint. Required when protocol is HTTP. Example: 8080 */
2272
3379
  'port'?: number;
2273
3380
  /** Initial delay, in seconds, before the health check is first run. Example: 10 */
2274
3381
  'initialDelaySeconds': number;
@@ -2286,6 +3393,7 @@ declare type UpdateJobHealthchecksData = {
2286
3393
  declare class UpdateJobHealthchecksEndpoint extends PostApiEndpoint<UpdateJobHealthchecksRequest, UpdateJobHealthchecksResult> {
2287
3394
  description: string;
2288
3395
  withAuth: boolean;
3396
+ requiredPermissions: string;
2289
3397
  endpointUrl: (opts: UpdateJobHealthchecksRequest) => string;
2290
3398
  body: (payload: UpdateJobHealthchecksRequest) => string;
2291
3399
  }
@@ -2337,6 +3445,7 @@ declare type GetJobBuildsOptions = {
2337
3445
  declare class GetJobBuildsEndpoint extends GetApiEndpoint<GetJobBuildsRequest, GetJobBuildsResult> {
2338
3446
  description: string;
2339
3447
  withAuth: boolean;
3448
+ requiredPermissions: string;
2340
3449
  endpointUrl: (opts: GetJobBuildsRequest) => string;
2341
3450
  body: () => undefined;
2342
3451
  }
@@ -2383,6 +3492,7 @@ declare type StartJobBuildData = {
2383
3492
  declare class StartJobBuildEndpoint extends PostApiEndpoint<StartJobBuildRequest, StartJobBuildResult> {
2384
3493
  description: string;
2385
3494
  withAuth: boolean;
3495
+ requiredPermissions: string;
2386
3496
  endpointUrl: (opts: StartJobBuildRequest) => string;
2387
3497
  body: (payload: StartJobBuildRequest) => string;
2388
3498
  }
@@ -2424,6 +3534,7 @@ declare type GetJobBuildParameters = {
2424
3534
  declare class GetJobBuildEndpoint extends GetApiEndpoint<GetJobBuildRequest, GetJobBuildResult> {
2425
3535
  description: string;
2426
3536
  withAuth: boolean;
3537
+ requiredPermissions: string;
2427
3538
  endpointUrl: (opts: GetJobBuildRequest) => string;
2428
3539
  body: () => undefined;
2429
3540
  }
@@ -2444,6 +3555,7 @@ declare type AbortJobBuildParameters = {
2444
3555
  declare class AbortJobBuildEndpoint extends DeleteApiEndpoint<AbortJobBuildRequest, AbortJobBuildResult> {
2445
3556
  description: string;
2446
3557
  withAuth: boolean;
3558
+ requiredPermissions: string;
2447
3559
  endpointUrl: (opts: AbortJobBuildRequest) => string;
2448
3560
  body: () => undefined;
2449
3561
  }
@@ -2463,7 +3575,7 @@ declare type UpdateJobBuildoptionsData = {
2463
3575
  'dockerfile': {
2464
3576
  /** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
2465
3577
  'buildEngine'?: 'kaniko' | 'buildkit';
2466
- /** Should intermediate image layers be cached? Only supported by Kaniko. */
3578
+ /** Should intermediate image layers be cached? */
2467
3579
  'useCache'?: boolean;
2468
3580
  /** The file path of the Dockerfile. Example: "/Dockerfile" */
2469
3581
  'dockerFilePath'?: string;
@@ -2480,6 +3592,8 @@ declare type UpdateJobBuildoptionsData = {
2480
3592
  'buildpackLocators'?: string[];
2481
3593
  /** The working directory to build in. Example: "/" */
2482
3594
  'buildContext'?: string;
3595
+ /** Should build dependencies be cached? */
3596
+ 'useCache'?: boolean;
2483
3597
  };
2484
3598
  /** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
2485
3599
  'pathIgnoreRules'?: string[];
@@ -2491,6 +3605,7 @@ declare type UpdateJobBuildoptionsData = {
2491
3605
  declare class UpdateJobBuildoptionsEndpoint extends PostApiEndpoint<UpdateJobBuildoptionsRequest, UpdateJobBuildoptionsResult> {
2492
3606
  description: string;
2493
3607
  withAuth: boolean;
3608
+ requiredPermissions: string;
2494
3609
  endpointUrl: (opts: UpdateJobBuildoptionsRequest) => string;
2495
3610
  body: (payload: UpdateJobBuildoptionsRequest) => string;
2496
3611
  }
@@ -2522,6 +3637,7 @@ declare type UpdateJobBuildsourceData = {
2522
3637
  declare class UpdateJobBuildsourceEndpoint extends PostApiEndpoint<UpdateJobBuildsourceRequest, UpdateJobBuildsourceResult> {
2523
3638
  description: string;
2524
3639
  withAuth: boolean;
3640
+ requiredPermissions: string;
2525
3641
  endpointUrl: (opts: UpdateJobBuildsourceRequest) => string;
2526
3642
  body: (payload: UpdateJobBuildsourceRequest) => string;
2527
3643
  }
@@ -2545,10 +3661,35 @@ declare type UpdateJobCmdoverrideData = {
2545
3661
  declare class UpdateJobCmdoverrideEndpoint extends PostApiEndpoint<UpdateJobCmdoverrideRequest, UpdateJobCmdoverrideResult> {
2546
3662
  description: string;
2547
3663
  withAuth: boolean;
3664
+ requiredPermissions: string;
2548
3665
  endpointUrl: (opts: UpdateJobCmdoverrideRequest) => string;
2549
3666
  body: (payload: UpdateJobCmdoverrideRequest) => string;
2550
3667
  }
2551
3668
 
3669
+ declare type UpdateJobEntrypointoverrideResult = any;
3670
+ declare type UpdateJobEntrypointoverrideCall = (opts: UpdateJobEntrypointoverrideRequest) => Promise<ApiCallResponse<UpdateJobEntrypointoverrideResult>>;
3671
+ declare type UpdateJobEntrypointoverrideRequest = {
3672
+ parameters: UpdateJobEntrypointoverrideParameters;
3673
+ data: UpdateJobEntrypointoverrideData;
3674
+ };
3675
+ declare type UpdateJobEntrypointoverrideParameters = {
3676
+ /** ID of the project */ 'projectId': string;
3677
+ /** ID of the job */
3678
+ 'jobId': string;
3679
+ };
3680
+ declare type UpdateJobEntrypointoverrideData = {
3681
+ /** If set, the service runs a custom entrypoint rather than one defined in the Dockerfile. Example: "/custom-entrypoint.sh" */
3682
+ 'entrypointOverride'?: string;
3683
+ };
3684
+ /** Sets the Docker entrypoint override for the given job. */
3685
+ declare class UpdateJobEntrypointoverrideEndpoint extends PostApiEndpoint<UpdateJobEntrypointoverrideRequest, UpdateJobEntrypointoverrideResult> {
3686
+ description: string;
3687
+ withAuth: boolean;
3688
+ requiredPermissions: string;
3689
+ endpointUrl: (opts: UpdateJobEntrypointoverrideRequest) => string;
3690
+ body: (payload: UpdateJobEntrypointoverrideRequest) => string;
3691
+ }
3692
+
2552
3693
  declare type GetJobBuildargumentsResult = {
2553
3694
  /** The build arguments, formatted as a JSON object. If the `show` parameter is set to `this`, this will only contain secrets saved to this entity. If the `show` parameter is set to `inherited`, this will only contain secrets inherited from linked secret groups. Otherwise, this will contain both. Example: {"ARGUMENT_1":"abcdef","ARGUMENT_2":"12345"} */
2554
3695
  'buildArguments': any;
@@ -2573,6 +3714,7 @@ declare type GetJobBuildargumentsOptions = {
2573
3714
  declare class GetJobBuildargumentsEndpoint extends GetApiEndpoint<GetJobBuildargumentsRequest, GetJobBuildargumentsResult> {
2574
3715
  description: string;
2575
3716
  withAuth: boolean;
3717
+ requiredPermissions: string;
2576
3718
  endpointUrl: (opts: GetJobBuildargumentsRequest) => string;
2577
3719
  body: () => undefined;
2578
3720
  }
@@ -2601,6 +3743,7 @@ declare type UpdateJobBuildargumentsData = {
2601
3743
  declare class UpdateJobBuildargumentsEndpoint extends PostApiEndpoint<UpdateJobBuildargumentsRequest, UpdateJobBuildargumentsResult> {
2602
3744
  description: string;
2603
3745
  withAuth: boolean;
3746
+ requiredPermissions: string;
2604
3747
  endpointUrl: (opts: UpdateJobBuildargumentsRequest) => string;
2605
3748
  body: (payload: UpdateJobBuildargumentsRequest) => string;
2606
3749
  }
@@ -2671,6 +3814,7 @@ declare type GetJobBuildargumentdetailsParameters = {
2671
3814
  declare class GetJobBuildargumentdetailsEndpoint extends GetApiEndpoint<GetJobBuildargumentdetailsRequest, GetJobBuildargumentdetailsResult> {
2672
3815
  description: string;
2673
3816
  withAuth: boolean;
3817
+ requiredPermissions: string;
2674
3818
  endpointUrl: (opts: GetJobBuildargumentdetailsRequest) => string;
2675
3819
  body: () => undefined;
2676
3820
  }
@@ -2699,6 +3843,7 @@ declare type GetJobRuntimeenvironmentOptions = {
2699
3843
  declare class GetJobRuntimeenvironmentEndpoint extends GetApiEndpoint<GetJobRuntimeenvironmentRequest, GetJobRuntimeenvironmentResult> {
2700
3844
  description: string;
2701
3845
  withAuth: boolean;
3846
+ requiredPermissions: string;
2702
3847
  endpointUrl: (opts: GetJobRuntimeenvironmentRequest) => string;
2703
3848
  body: () => undefined;
2704
3849
  }
@@ -2727,6 +3872,7 @@ declare type UpdateJobRuntimeenvironmentData = {
2727
3872
  declare class UpdateJobRuntimeenvironmentEndpoint extends PostApiEndpoint<UpdateJobRuntimeenvironmentRequest, UpdateJobRuntimeenvironmentResult> {
2728
3873
  description: string;
2729
3874
  withAuth: boolean;
3875
+ requiredPermissions: string;
2730
3876
  endpointUrl: (opts: UpdateJobRuntimeenvironmentRequest) => string;
2731
3877
  body: (payload: UpdateJobRuntimeenvironmentRequest) => string;
2732
3878
  }
@@ -2797,6 +3943,7 @@ declare type GetJobRuntimeenvironmentdetailsParameters = {
2797
3943
  declare class GetJobRuntimeenvironmentdetailsEndpoint extends GetApiEndpoint<GetJobRuntimeenvironmentdetailsRequest, GetJobRuntimeenvironmentdetailsResult> {
2798
3944
  description: string;
2799
3945
  withAuth: boolean;
3946
+ requiredPermissions: string;
2800
3947
  endpointUrl: (opts: GetJobRuntimeenvironmentdetailsRequest) => string;
2801
3948
  body: () => undefined;
2802
3949
  }
@@ -2815,8 +3962,12 @@ declare type GetJobDeploymentResult = {
2815
3962
  'repository': string;
2816
3963
  /** Branch of the repo being deployed Example: "master" */
2817
3964
  'branch': string;
2818
- /** Commit SHA being deployed. 'latest' means the latest commit is automatically being deployed. Example: "latest" */
3965
+ /** ID of the build currently deployed. Example: "incredible-land-3266" */
3966
+ 'buildId': string;
3967
+ /** Commit SHA being deployed. `latest` means the latest commit is automatically being deployed. Example: "latest" */
2819
3968
  'buildSHA': string;
3969
+ /** Currently deployed commit SHA. If buildSHA is set to `latest`, this will show the SHA of the latest commit. Example: "262ed9817b3cad5142fbceabe0c9e371e390d616" */
3970
+ 'deployedSHA'?: string;
2820
3971
  /** Type of deployed entity Example: "service" */
2821
3972
  'nfObjectType': 'service' | 'job';
2822
3973
  };
@@ -2847,6 +3998,7 @@ declare type GetJobDeploymentParameters = {
2847
3998
  declare class GetJobDeploymentEndpoint extends GetApiEndpoint<GetJobDeploymentRequest, GetJobDeploymentResult> {
2848
3999
  description: string;
2849
4000
  withAuth: boolean;
4001
+ requiredPermissions: string;
2850
4002
  endpointUrl: (opts: GetJobDeploymentRequest) => string;
2851
4003
  body: () => undefined;
2852
4004
  }
@@ -2876,7 +4028,7 @@ declare type UpdateJobDeploymentData = {
2876
4028
  /** Branch to deploy Example: "master" */
2877
4029
  'branch'?: string;
2878
4030
  /** Commit SHA to deploy, or 'latest' to deploy the most recent commit Example: "latest" */
2879
- 'buildSHA'?: any;
4031
+ 'buildSHA'?: string | 'latest';
2880
4032
  /** ID of the build that should be deployed Example: "premium-guide-6393" */
2881
4033
  'buildId'?: string;
2882
4034
  };
@@ -2885,6 +4037,7 @@ declare type UpdateJobDeploymentData = {
2885
4037
  declare class UpdateJobDeploymentEndpoint extends PostApiEndpoint<UpdateJobDeploymentRequest, UpdateJobDeploymentResult> {
2886
4038
  description: string;
2887
4039
  withAuth: boolean;
4040
+ requiredPermissions: string;
2888
4041
  endpointUrl: (opts: UpdateJobDeploymentRequest) => string;
2889
4042
  body: (payload: UpdateJobDeploymentRequest) => string;
2890
4043
  }
@@ -2924,6 +4077,7 @@ declare type GetJobContainersOptions = {
2924
4077
  declare class GetJobContainersEndpoint extends GetApiEndpoint<GetJobContainersRequest, GetJobContainersResult> {
2925
4078
  description: string;
2926
4079
  withAuth: boolean;
4080
+ requiredPermissions: string;
2927
4081
  endpointUrl: (opts: GetJobContainersRequest) => string;
2928
4082
  body: () => undefined;
2929
4083
  }
@@ -2972,6 +4126,7 @@ declare type GetJobBranchesOptions = {
2972
4126
  declare class GetJobBranchesEndpoint extends GetApiEndpoint<GetJobBranchesRequest, GetJobBranchesResult> {
2973
4127
  description: string;
2974
4128
  withAuth: boolean;
4129
+ requiredPermissions: string;
2975
4130
  endpointUrl: (opts: GetJobBranchesRequest) => string;
2976
4131
  body: () => undefined;
2977
4132
  }
@@ -3020,11 +4175,12 @@ declare type GetJobPullrequestsOptions = {
3020
4175
  declare class GetJobPullrequestsEndpoint extends GetApiEndpoint<GetJobPullrequestsRequest, GetJobPullrequestsResult> {
3021
4176
  description: string;
3022
4177
  withAuth: boolean;
4178
+ requiredPermissions: string;
3023
4179
  endpointUrl: (opts: GetJobPullrequestsRequest) => string;
3024
4180
  body: () => undefined;
3025
4181
  }
3026
4182
 
3027
- declare type ListRegistrycredentialsResult = {
4183
+ declare type ListRegistriesResult = {
3028
4184
  /** An array of credentials saved to this account. */
3029
4185
  'credentials': {
3030
4186
  /** Identifier for the credentials. Example: "example-credentials" */
@@ -3044,11 +4200,11 @@ declare type ListRegistrycredentialsResult = {
3044
4200
  'provider': 'dockerhub' | 'gcr' | 'gcr-eu' | 'gcr-us' | 'gitlab' | 'github' | 'custom';
3045
4201
  }[];
3046
4202
  };
3047
- declare type ListRegistrycredentialsCall = (opts: ListRegistrycredentialsRequest) => Promise<ApiCallResponse<ListRegistrycredentialsResult>>;
3048
- declare type ListRegistrycredentialsRequest = {
3049
- options?: ListRegistrycredentialsOptions;
4203
+ declare type ListRegistriesCall = (opts: ListRegistriesRequest) => Promise<ApiCallResponse<ListRegistriesResult>>;
4204
+ declare type ListRegistriesRequest = {
4205
+ options?: ListRegistriesOptions;
3050
4206
  };
3051
- declare type ListRegistrycredentialsOptions = {
4207
+ declare type ListRegistriesOptions = {
3052
4208
  /** The number of results to display per request. Maximum of 100 results per page. */
3053
4209
  'per_page'?: number;
3054
4210
  /** The page number to access. */
@@ -3057,14 +4213,15 @@ declare type ListRegistrycredentialsOptions = {
3057
4213
  'cursor'?: string;
3058
4214
  };
3059
4215
  /** Lists the container registry credentials saved to this account. Does not display secrets. */
3060
- declare class ListRegistrycredentialsEndpoint extends GetApiEndpoint<ListRegistrycredentialsRequest, ListRegistrycredentialsResult> {
4216
+ declare class ListRegistriesEndpoint extends GetApiEndpoint<ListRegistriesRequest, ListRegistriesResult> {
3061
4217
  description: string;
3062
4218
  withAuth: boolean;
3063
- endpointUrl: (opts: ListRegistrycredentialsRequest) => string;
4219
+ requiredPermissions: string;
4220
+ endpointUrl: (opts: ListRegistriesRequest) => string;
3064
4221
  body: () => undefined;
3065
4222
  }
3066
4223
 
3067
- declare type AddRegistrycredentialsResult = {
4224
+ declare type AddRegistryResult = {
3068
4225
  /** Identifier for the credentials. Example: "example-credentials" */
3069
4226
  'id': string;
3070
4227
  /** Name of the saved credentials. Example: "Example Credentials" */
@@ -3081,11 +4238,11 @@ declare type AddRegistrycredentialsResult = {
3081
4238
  /** The registry provider associated with this set of credentials. Example: "dockerhub" */
3082
4239
  'provider': 'dockerhub' | 'gcr' | 'gcr-eu' | 'gcr-us' | 'gitlab' | 'github' | 'custom';
3083
4240
  };
3084
- declare type AddRegistrycredentialsCall = (opts: AddRegistrycredentialsRequest) => Promise<ApiCallResponse<AddRegistrycredentialsResult>>;
3085
- declare type AddRegistrycredentialsRequest = {
3086
- data: AddRegistrycredentialsData;
4241
+ declare type AddRegistryCall = (opts: AddRegistryRequest) => Promise<ApiCallResponse<AddRegistryResult>>;
4242
+ declare type AddRegistryRequest = {
4243
+ data: AddRegistryData;
3087
4244
  };
3088
- declare type AddRegistrycredentialsData = {
4245
+ declare type AddRegistryData = {
3089
4246
  /** Name of the credentials. Example: "Example Credentials" */
3090
4247
  'name': string;
3091
4248
  /** Description of the credentials. Example: "This is a set of saved credentials." */
@@ -3103,14 +4260,15 @@ declare type AddRegistrycredentialsData = {
3103
4260
  'data': any;
3104
4261
  };
3105
4262
  /** Adds a new set of container registry credentials to this account. */
3106
- declare class AddRegistrycredentialsEndpoint extends PostApiEndpoint<AddRegistrycredentialsRequest, AddRegistrycredentialsResult> {
4263
+ declare class AddRegistryEndpoint extends PostApiEndpoint<AddRegistryRequest, AddRegistryResult> {
3107
4264
  description: string;
3108
4265
  withAuth: boolean;
3109
- endpointUrl: (opts: AddRegistrycredentialsRequest) => string;
3110
- body: (payload: AddRegistrycredentialsRequest) => string;
4266
+ requiredPermissions: string;
4267
+ endpointUrl: (opts: AddRegistryRequest) => string;
4268
+ body: (payload: AddRegistryRequest) => string;
3111
4269
  }
3112
4270
 
3113
- declare type GetRegistrycredentialsResult = {
4271
+ declare type GetRegistryResult = {
3114
4272
  /** Identifier for the credentials. Example: "example-credentials" */
3115
4273
  'id': string;
3116
4274
  /** Name of the saved credentials. Example: "Example Credentials" */
@@ -3128,47 +4286,49 @@ declare type GetRegistrycredentialsResult = {
3128
4286
  'provider': 'dockerhub' | 'gcr' | 'gcr-eu' | 'gcr-us' | 'gitlab' | 'github' | 'custom';
3129
4287
  'data'?: any;
3130
4288
  };
3131
- declare type GetRegistrycredentialsCall = (opts: GetRegistrycredentialsRequest) => Promise<ApiCallResponse<GetRegistrycredentialsResult>>;
3132
- declare type GetRegistrycredentialsRequest = {
3133
- parameters: GetRegistrycredentialsParameters;
4289
+ declare type GetRegistryCall = (opts: GetRegistryRequest) => Promise<ApiCallResponse<GetRegistryResult>>;
4290
+ declare type GetRegistryRequest = {
4291
+ parameters: GetRegistryParameters;
3134
4292
  };
3135
- declare type GetRegistrycredentialsParameters = {
4293
+ declare type GetRegistryParameters = {
3136
4294
  /** ID of the registry credential */ 'credentialId': string;
3137
4295
  };
3138
4296
  /** Views a set of registry credential data. */
3139
- declare class GetRegistrycredentialsEndpoint extends GetApiEndpoint<GetRegistrycredentialsRequest, GetRegistrycredentialsResult> {
4297
+ declare class GetRegistryEndpoint extends GetApiEndpoint<GetRegistryRequest, GetRegistryResult> {
3140
4298
  description: string;
3141
4299
  withAuth: boolean;
3142
- endpointUrl: (opts: GetRegistrycredentialsRequest) => string;
4300
+ requiredPermissions: string;
4301
+ endpointUrl: (opts: GetRegistryRequest) => string;
3143
4302
  body: () => undefined;
3144
4303
  }
3145
4304
 
3146
- declare type DeleteRegistrycredentialsResult = any;
3147
- declare type DeleteRegistrycredentialsCall = (opts: DeleteRegistrycredentialsRequest) => Promise<ApiCallResponse<DeleteRegistrycredentialsResult>>;
3148
- declare type DeleteRegistrycredentialsRequest = {
3149
- parameters: DeleteRegistrycredentialsParameters;
4305
+ declare type DeleteRegistryResult = any;
4306
+ declare type DeleteRegistryCall = (opts: DeleteRegistryRequest) => Promise<ApiCallResponse<DeleteRegistryResult>>;
4307
+ declare type DeleteRegistryRequest = {
4308
+ parameters: DeleteRegistryParameters;
3150
4309
  };
3151
- declare type DeleteRegistrycredentialsParameters = {
4310
+ declare type DeleteRegistryParameters = {
3152
4311
  /** ID of the registry credential */ 'credentialId': string;
3153
4312
  };
3154
4313
  /** Deletes a set of registry credential data. */
3155
- declare class DeleteRegistrycredentialsEndpoint extends DeleteApiEndpoint<DeleteRegistrycredentialsRequest, DeleteRegistrycredentialsResult> {
4314
+ declare class DeleteRegistryEndpoint extends DeleteApiEndpoint<DeleteRegistryRequest, DeleteRegistryResult> {
3156
4315
  description: string;
3157
4316
  withAuth: boolean;
3158
- endpointUrl: (opts: DeleteRegistrycredentialsRequest) => string;
4317
+ requiredPermissions: string;
4318
+ endpointUrl: (opts: DeleteRegistryRequest) => string;
3159
4319
  body: () => undefined;
3160
4320
  }
3161
4321
 
3162
- declare type UpdateRegistrycredentialsResult = any;
3163
- declare type UpdateRegistrycredentialsCall = (opts: UpdateRegistrycredentialsRequest) => Promise<ApiCallResponse<UpdateRegistrycredentialsResult>>;
3164
- declare type UpdateRegistrycredentialsRequest = {
3165
- parameters: UpdateRegistrycredentialsParameters;
3166
- data: UpdateRegistrycredentialsData;
4322
+ declare type UpdateRegistryResult = any;
4323
+ declare type UpdateRegistryCall = (opts: UpdateRegistryRequest) => Promise<ApiCallResponse<UpdateRegistryResult>>;
4324
+ declare type UpdateRegistryRequest = {
4325
+ parameters: UpdateRegistryParameters;
4326
+ data: UpdateRegistryData;
3167
4327
  };
3168
- declare type UpdateRegistrycredentialsParameters = {
4328
+ declare type UpdateRegistryParameters = {
3169
4329
  /** ID of the registry credential */ 'credentialId': string;
3170
4330
  };
3171
- declare type UpdateRegistrycredentialsData = {
4331
+ declare type UpdateRegistryData = {
3172
4332
  /** Description of the credentials. Example: "This is a set of saved credentials." */
3173
4333
  'description'?: string;
3174
4334
  /** Data about whether the credentials are restricted to certain projects. */
@@ -3182,11 +4342,12 @@ declare type UpdateRegistrycredentialsData = {
3182
4342
  'data'?: any;
3183
4343
  };
3184
4344
  /** Updates a set of registry credential data. */
3185
- declare class UpdateRegistrycredentialsEndpoint extends PostApiEndpoint<UpdateRegistrycredentialsRequest, UpdateRegistrycredentialsResult> {
4345
+ declare class UpdateRegistryEndpoint extends PostApiEndpoint<UpdateRegistryRequest, UpdateRegistryResult> {
3186
4346
  description: string;
3187
4347
  withAuth: boolean;
3188
- endpointUrl: (opts: UpdateRegistrycredentialsRequest) => string;
3189
- body: (payload: UpdateRegistrycredentialsRequest) => string;
4348
+ requiredPermissions: string;
4349
+ endpointUrl: (opts: UpdateRegistryRequest) => string;
4350
+ body: (payload: UpdateRegistryRequest) => string;
3190
4351
  }
3191
4352
 
3192
4353
  declare type ListDomainsResult = {
@@ -3218,6 +4379,7 @@ declare type ListDomainsOptions = {
3218
4379
  declare class ListDomainsEndpoint extends GetApiEndpoint<ListDomainsRequest, ListDomainsResult> {
3219
4380
  description: string;
3220
4381
  withAuth: boolean;
4382
+ requiredPermissions: string;
3221
4383
  endpointUrl: (opts: ListDomainsRequest) => string;
3222
4384
  body: () => undefined;
3223
4385
  }
@@ -3244,6 +4406,7 @@ declare type CreateDomainData = {
3244
4406
  declare class CreateDomainEndpoint extends PostApiEndpoint<CreateDomainRequest, CreateDomainResult> {
3245
4407
  description: string;
3246
4408
  withAuth: boolean;
4409
+ requiredPermissions: string;
3247
4410
  endpointUrl: (opts: CreateDomainRequest) => string;
3248
4411
  body: (payload: CreateDomainRequest) => string;
3249
4412
  }
@@ -3276,6 +4439,7 @@ declare type GetDomainParameters = {
3276
4439
  declare class GetDomainEndpoint extends GetApiEndpoint<GetDomainRequest, GetDomainResult> {
3277
4440
  description: string;
3278
4441
  withAuth: boolean;
4442
+ requiredPermissions: string;
3279
4443
  endpointUrl: (opts: GetDomainRequest) => string;
3280
4444
  body: () => undefined;
3281
4445
  }
@@ -3292,6 +4456,7 @@ declare type DeleteDomainParameters = {
3292
4456
  declare class DeleteDomainEndpoint extends DeleteApiEndpoint<DeleteDomainRequest, DeleteDomainResult> {
3293
4457
  description: string;
3294
4458
  withAuth: boolean;
4459
+ requiredPermissions: string;
3295
4460
  endpointUrl: (opts: DeleteDomainRequest) => string;
3296
4461
  body: () => undefined;
3297
4462
  }
@@ -3308,6 +4473,7 @@ declare type VerifyDomainParameters = {
3308
4473
  declare class VerifyDomainEndpoint extends PostApiEndpoint<VerifyDomainRequest, VerifyDomainResult> {
3309
4474
  description: string;
3310
4475
  withAuth: boolean;
4476
+ requiredPermissions: string;
3311
4477
  endpointUrl: (opts: VerifyDomainRequest) => string;
3312
4478
  body: () => undefined;
3313
4479
  }
@@ -3340,6 +4506,7 @@ declare type AddDomainSubdomainData = {
3340
4506
  declare class AddDomainSubdomainEndpoint extends PostApiEndpoint<AddDomainSubdomainRequest, AddDomainSubdomainResult> {
3341
4507
  description: string;
3342
4508
  withAuth: boolean;
4509
+ requiredPermissions: string;
3343
4510
  endpointUrl: (opts: AddDomainSubdomainRequest) => string;
3344
4511
  body: (payload: AddDomainSubdomainRequest) => string;
3345
4512
  }
@@ -3369,6 +4536,7 @@ declare type GetSubdomainParameters = {
3369
4536
  declare class GetSubdomainEndpoint extends GetApiEndpoint<GetSubdomainRequest, GetSubdomainResult> {
3370
4537
  description: string;
3371
4538
  withAuth: boolean;
4539
+ requiredPermissions: string;
3372
4540
  endpointUrl: (opts: GetSubdomainRequest) => string;
3373
4541
  body: () => undefined;
3374
4542
  }
@@ -3387,6 +4555,7 @@ declare type DeleteSubdomainParameters = {
3387
4555
  declare class DeleteSubdomainEndpoint extends DeleteApiEndpoint<DeleteSubdomainRequest, DeleteSubdomainResult> {
3388
4556
  description: string;
3389
4557
  withAuth: boolean;
4558
+ requiredPermissions: string;
3390
4559
  endpointUrl: (opts: DeleteSubdomainRequest) => string;
3391
4560
  body: () => undefined;
3392
4561
  }
@@ -3405,6 +4574,7 @@ declare type VerifySubdomainParameters = {
3405
4574
  declare class VerifySubdomainEndpoint extends PostApiEndpoint<VerifySubdomainRequest, VerifySubdomainResult> {
3406
4575
  description: string;
3407
4576
  withAuth: boolean;
4577
+ requiredPermissions: string;
3408
4578
  endpointUrl: (opts: VerifySubdomainRequest) => string;
3409
4579
  body: () => undefined;
3410
4580
  }
@@ -3432,6 +4602,7 @@ declare type AssignSubdomainServiceData = {
3432
4602
  declare class AssignSubdomainServiceEndpoint extends PostApiEndpoint<AssignSubdomainServiceRequest, AssignSubdomainServiceResult> {
3433
4603
  description: string;
3434
4604
  withAuth: boolean;
4605
+ requiredPermissions: string;
3435
4606
  endpointUrl: (opts: AssignSubdomainServiceRequest) => string;
3436
4607
  body: (payload: AssignSubdomainServiceRequest) => string;
3437
4608
  }
@@ -3450,6 +4621,7 @@ declare type UnassignSubdomainParameters = {
3450
4621
  declare class UnassignSubdomainEndpoint extends DeleteApiEndpoint<UnassignSubdomainRequest, UnassignSubdomainResult> {
3451
4622
  description: string;
3452
4623
  withAuth: boolean;
4624
+ requiredPermissions: string;
3453
4625
  endpointUrl: (opts: UnassignSubdomainRequest) => string;
3454
4626
  body: () => undefined;
3455
4627
  }
@@ -3479,6 +4651,7 @@ declare type ListPlansRequest = {};
3479
4651
  declare class ListPlansEndpoint extends GetApiEndpoint<ListPlansRequest, ListPlansResult> {
3480
4652
  description: string;
3481
4653
  withAuth: boolean;
4654
+ requiredPermissions: string;
3482
4655
  endpointUrl: (opts: ListPlansRequest) => string;
3483
4656
  body: () => undefined;
3484
4657
  }
@@ -3496,6 +4669,7 @@ declare type ListRegionsRequest = {};
3496
4669
  declare class ListRegionsEndpoint extends GetApiEndpoint<ListRegionsRequest, ListRegionsResult> {
3497
4670
  description: string;
3498
4671
  withAuth: boolean;
4672
+ requiredPermissions: string;
3499
4673
  endpointUrl: (opts: ListRegionsRequest) => string;
3500
4674
  body: () => undefined;
3501
4675
  }
@@ -3510,6 +4684,7 @@ declare type GetDnsidRequest = {};
3510
4684
  declare class GetDnsidEndpoint extends GetApiEndpoint<GetDnsidRequest, GetDnsidResult> {
3511
4685
  description: string;
3512
4686
  withAuth: boolean;
4687
+ requiredPermissions: string;
3513
4688
  endpointUrl: (opts: GetDnsidRequest) => string;
3514
4689
  body: () => undefined;
3515
4690
  }
@@ -3541,6 +4716,7 @@ declare type ListVcsRequest = {};
3541
4716
  declare class ListVcsEndpoint extends GetApiEndpoint<ListVcsRequest, ListVcsResult> {
3542
4717
  description: string;
3543
4718
  withAuth: boolean;
4719
+ requiredPermissions: string;
3544
4720
  endpointUrl: (opts: ListVcsRequest) => string;
3545
4721
  body: () => undefined;
3546
4722
  }
@@ -3594,6 +4770,7 @@ declare type ListSecretsOptions = {
3594
4770
  declare class ListSecretsEndpoint extends GetApiEndpoint<ListSecretsRequest, ListSecretsResult> {
3595
4771
  description: string;
3596
4772
  withAuth: boolean;
4773
+ requiredPermissions: string;
3597
4774
  endpointUrl: (opts: ListSecretsRequest) => string;
3598
4775
  body: () => undefined;
3599
4776
  }
@@ -3659,7 +4836,7 @@ declare type CreateSecretData = {
3659
4836
  'addonId': string;
3660
4837
  /** An array of objects containing details about the keys to link to this secret group. */
3661
4838
  'keys': {
3662
- /** The name of the key to link. Example: "username" */
4839
+ /** The name of the key to link. Example: "USERNAME" */
3663
4840
  'keyName': string;
3664
4841
  /** An array of aliases for the key. */
3665
4842
  'aliases'?: string[];
@@ -3676,6 +4853,7 @@ declare type CreateSecretData = {
3676
4853
  declare class CreateSecretEndpoint extends PostApiEndpoint<CreateSecretRequest, CreateSecretResult> {
3677
4854
  description: string;
3678
4855
  withAuth: boolean;
4856
+ requiredPermissions: string;
3679
4857
  endpointUrl: (opts: CreateSecretRequest) => string;
3680
4858
  body: (payload: CreateSecretRequest) => string;
3681
4859
  }
@@ -3730,6 +4908,7 @@ declare type GetSecretOptions = {
3730
4908
  declare class GetSecretEndpoint extends GetApiEndpoint<GetSecretRequest, GetSecretResult> {
3731
4909
  description: string;
3732
4910
  withAuth: boolean;
4911
+ requiredPermissions: string;
3733
4912
  endpointUrl: (opts: GetSecretRequest) => string;
3734
4913
  body: () => undefined;
3735
4914
  }
@@ -3748,6 +4927,7 @@ declare type DeleteSecretParameters = {
3748
4927
  declare class DeleteSecretEndpoint extends DeleteApiEndpoint<DeleteSecretRequest, DeleteSecretResult> {
3749
4928
  description: string;
3750
4929
  withAuth: boolean;
4930
+ requiredPermissions: string;
3751
4931
  endpointUrl: (opts: DeleteSecretRequest) => string;
3752
4932
  body: () => undefined;
3753
4933
  }
@@ -3786,7 +4966,7 @@ declare type UpdateSecretData = {
3786
4966
  'addonId': string;
3787
4967
  /** An array of objects containing details about the keys to link to this secret group. */
3788
4968
  'keys': {
3789
- /** The name of the key to link. Example: "username" */
4969
+ /** The name of the key to link. Example: "USERNAME" */
3790
4970
  'keyName': string;
3791
4971
  /** An array of aliases for the key. */
3792
4972
  'aliases'?: string[];
@@ -3805,6 +4985,7 @@ declare type UpdateSecretData = {
3805
4985
  declare class UpdateSecretEndpoint extends PostApiEndpoint<UpdateSecretRequest, UpdateSecretResult> {
3806
4986
  description: string;
3807
4987
  withAuth: boolean;
4988
+ requiredPermissions: string;
3808
4989
  endpointUrl: (opts: UpdateSecretRequest) => string;
3809
4990
  body: (payload: UpdateSecretRequest) => string;
3810
4991
  }
@@ -3867,6 +5048,7 @@ declare type GetSecretdetailsParameters = {
3867
5048
  declare class GetSecretdetailsEndpoint extends GetApiEndpoint<GetSecretdetailsRequest, GetSecretdetailsResult> {
3868
5049
  description: string;
3869
5050
  withAuth: boolean;
5051
+ requiredPermissions: string;
3870
5052
  endpointUrl: (opts: GetSecretdetailsRequest) => string;
3871
5053
  body: () => undefined;
3872
5054
  }
@@ -3874,7 +5056,7 @@ declare class GetSecretdetailsEndpoint extends GetApiEndpoint<GetSecretdetailsRe
3874
5056
  declare type UpdateSecretlinkResult = {
3875
5057
  /** An array of objects containing details about the keys linked to this secret group. */
3876
5058
  'keys': {
3877
- /** The name of the key to link. Example: "username" */
5059
+ /** The name of the key to link. Example: "USERNAME" */
3878
5060
  'keyName': string;
3879
5061
  /** An array of aliases for the key. */
3880
5062
  'aliases'?: string[];
@@ -3896,7 +5078,7 @@ declare type UpdateSecretlinkParameters = {
3896
5078
  declare type UpdateSecretlinkData = {
3897
5079
  /** An array of objects containing details about the keys to link to this secret group. */
3898
5080
  'keys': {
3899
- /** The name of the key to link. Example: "username" */
5081
+ /** The name of the key to link. Example: "USERNAME" */
3900
5082
  'keyName': string;
3901
5083
  /** An array of aliases for the key. */
3902
5084
  'aliases'?: string[];
@@ -3906,6 +5088,7 @@ declare type UpdateSecretlinkData = {
3906
5088
  declare class UpdateSecretlinkEndpoint extends PostApiEndpoint<UpdateSecretlinkRequest, UpdateSecretlinkResult> {
3907
5089
  description: string;
3908
5090
  withAuth: boolean;
5091
+ requiredPermissions: string;
3909
5092
  endpointUrl: (opts: UpdateSecretlinkRequest) => string;
3910
5093
  body: (payload: UpdateSecretlinkRequest) => string;
3911
5094
  }
@@ -3925,7 +5108,7 @@ declare type GetSecretlinkResult = {
3925
5108
  'linked': boolean;
3926
5109
  /** An array of objects containing details about the keys linked to this secret group. */
3927
5110
  'linkedKeys'?: {
3928
- /** The name of the key to link. Example: "username" */
5111
+ /** The name of the key to link. Example: "USERNAME" */
3929
5112
  'keyName': string;
3930
5113
  /** An array of aliases for the key. */
3931
5114
  'aliases'?: string[];
@@ -3949,6 +5132,7 @@ declare type GetSecretlinkParameters = {
3949
5132
  declare class GetSecretlinkEndpoint extends GetApiEndpoint<GetSecretlinkRequest, GetSecretlinkResult> {
3950
5133
  description: string;
3951
5134
  withAuth: boolean;
5135
+ requiredPermissions: string;
3952
5136
  endpointUrl: (opts: GetSecretlinkRequest) => string;
3953
5137
  body: () => undefined;
3954
5138
  }
@@ -3969,6 +5153,7 @@ declare type DeleteSecretlinkParameters = {
3969
5153
  declare class DeleteSecretlinkEndpoint extends DeleteApiEndpoint<DeleteSecretlinkRequest, DeleteSecretlinkResult> {
3970
5154
  description: string;
3971
5155
  withAuth: boolean;
5156
+ requiredPermissions: string;
3972
5157
  endpointUrl: (opts: DeleteSecretlinkRequest) => string;
3973
5158
  body: () => undefined;
3974
5159
  }
@@ -4039,7 +5224,7 @@ declare type CreateServiceCombinedResult = {
4039
5224
  /** Number of instances/replicas running Example: 1 */
4040
5225
  'instances'?: number;
4041
5226
  'internal'?: {
4042
- /** Database ID of deployed entity Example: "5f3bd676b84798d54472d1cc" */
5227
+ /** Database ID of deployed entity Example: "example-service" */
4043
5228
  'nfObjectId': string;
4044
5229
  /** Type of deployed entity Example: "service" */
4045
5230
  'nfObjectType': 'service';
@@ -4047,10 +5232,10 @@ declare type CreateServiceCombinedResult = {
4047
5232
  'repository': string;
4048
5233
  /** Branch of the repo being deployed Example: "master" */
4049
5234
  'branch': string;
4050
- /** Commit SHA to be deployed. 'latest' means the latest commit is automatically being deployed. Example: "latest" */
5235
+ /** Commit SHA to be deployed. `latest` means the latest commit is automatically being deployed. Example: "latest" */
4051
5236
  'buildSHA': string;
4052
- /** Currently deployed commit SHA. If buildSHA is set to 'latest', this will show the SHA of the latest commit. Example: "262ed9817b3cad5142fbceabe0c9e371e390d616" */
4053
- 'deployedSHA': string;
5237
+ /** Currently deployed commit SHA. If buildSHA is set to `latest`, this will show the SHA of the latest commit. Example: "262ed9817b3cad5142fbceabe0c9e371e390d616" */
5238
+ 'deployedSHA'?: string;
4054
5239
  };
4055
5240
  };
4056
5241
  'buildConfiguration': {
@@ -4066,6 +5251,13 @@ declare type CreateServiceCombinedResult = {
4066
5251
  'builder'?: 'HEROKU_20' | 'HEROKU_18' | 'GOOGLE_V1' | 'CNB_ALPINE' | 'CNB_BIONIC' | 'PAKETO_TINY' | 'PAKETO_BASE' | 'PAKETO_FULL';
4067
5252
  /** Array of custom Buildpacks used. */
4068
5253
  'buildpackLocators'?: string[];
5254
+ /** Should build dependencies be cached? */
5255
+ 'useCache'?: boolean;
5256
+ };
5257
+ /** Details about Buildkit settings. */
5258
+ 'buildkit'?: {
5259
+ /** Should intermediate image layers be cached? */
5260
+ 'useCache'?: boolean;
4069
5261
  };
4070
5262
  /** Details about Kaniko settings. */
4071
5263
  'kaniko'?: {
@@ -4100,6 +5292,14 @@ declare type CreateServiceCombinedData = {
4100
5292
  'instances': number;
4101
5293
  /** If set, the service runs a custom command rather than one defined in the Dockerfile. Example: "nginx -g" */
4102
5294
  'cmdOverride'?: string;
5295
+ /** If set, the service runs a custom entrypoint rather than one defined in the Dockerfile. Example: "/custom-entrypoint.sh" */
5296
+ 'entrypointOverride'?: string;
5297
+ 'storage'?: {
5298
+ 'ephemeralStorage'?: {
5299
+ /** Ephemeral storage per container in MB Example: 1024 */
5300
+ 'storageSize'?: number;
5301
+ };
5302
+ };
4103
5303
  };
4104
5304
  'ports'?: {
4105
5305
  /** The name used to identify the port. Example: "port-1" */
@@ -4128,6 +5328,8 @@ declare type CreateServiceCombinedData = {
4128
5328
  };
4129
5329
  /** An array of domains to redirect to this port. Each domain must first be verified and registered to your account. */
4130
5330
  'domains'?: string[];
5331
+ /** Disable routing on the default code.run domain for public HTTP ports with custom domains. */
5332
+ 'disableNfDomain'?: boolean;
4131
5333
  /** The protocol to use for the port. Example: "HTTP" */
4132
5334
  'protocol': 'HTTP' | 'HTTP/2' | 'TCP' | 'UDP';
4133
5335
  }[];
@@ -4147,7 +5349,7 @@ declare type CreateServiceCombinedData = {
4147
5349
  'dockerfile': {
4148
5350
  /** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
4149
5351
  'buildEngine'?: 'kaniko' | 'buildkit';
4150
- /** Should intermediate image layers be cached? Only supported by Kaniko. */
5352
+ /** Should intermediate image layers be cached? */
4151
5353
  'useCache'?: boolean;
4152
5354
  /** The file path of the Dockerfile. Example: "/Dockerfile" */
4153
5355
  'dockerFilePath': string;
@@ -4162,6 +5364,8 @@ declare type CreateServiceCombinedData = {
4162
5364
  'buildpackLocators'?: string[];
4163
5365
  /** The working directory to build in. Example: "/" */
4164
5366
  'buildContext'?: string;
5367
+ /** Should build dependencies be cached? */
5368
+ 'useCache'?: boolean;
4165
5369
  };
4166
5370
  };
4167
5371
  'buildConfiguration'?: {
@@ -4176,11 +5380,35 @@ declare type CreateServiceCombinedData = {
4176
5380
  'buildArguments'?: any;
4177
5381
  /** Secret files as JSON object, encrypted at rest. File path must be absolute Example: {"/dir/fileName":{"data":"VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=","encoding":"utf-8"}} */
4178
5382
  'buildFiles'?: any;
5383
+ /** An array of health checks. */
5384
+ 'healthChecks'?: {
5385
+ /** The protocol to access the health check with. Example: "HTTP" */
5386
+ 'protocol': 'HTTP' | 'CMD' | 'TCP';
5387
+ /** The type of health check. Example: "readinessProbe" */
5388
+ 'type': 'livenessProbe' | 'readinessProbe' | 'startupProbe';
5389
+ /** The path of the health check endpoint. Required when protocol is HTTP. Example: "/health-check" */
5390
+ 'path'?: string;
5391
+ /** The command to run for the health check. Required when protocol is CMD */
5392
+ 'cmd'?: string;
5393
+ /** Port number for the health check endpoint. Required when protocol is HTTP. Example: 8080 */
5394
+ 'port'?: number;
5395
+ /** Initial delay, in seconds, before the health check is first run. Example: 10 */
5396
+ 'initialDelaySeconds': number;
5397
+ /** The time between each check, in seconds. Example: 60 */
5398
+ 'periodSeconds': number;
5399
+ /** The time to wait for a response before marking the health check as a failure. Example: 1 */
5400
+ 'timeoutSeconds': number;
5401
+ /** The maximum number of allowed failures. Example: 3 */
5402
+ 'failureThreshold': number;
5403
+ /** The number of successes required to mark the health check as a success. Example: 1 */
5404
+ 'successThreshold'?: number;
5405
+ }[];
4179
5406
  };
4180
5407
  /** Creates a new combined service. */
4181
5408
  declare class CreateServiceCombinedEndpoint extends PostApiEndpoint<CreateServiceCombinedRequest, CreateServiceCombinedResult> {
4182
5409
  description: string;
4183
5410
  withAuth: boolean;
5411
+ requiredPermissions: string;
4184
5412
  endpointUrl: (opts: CreateServiceCombinedRequest) => string;
4185
5413
  body: (payload: CreateServiceCombinedRequest) => string;
4186
5414
  }
@@ -4244,7 +5472,7 @@ declare type CreateServiceDeploymentResult = {
4244
5472
  'privateImage': boolean;
4245
5473
  };
4246
5474
  'internal'?: {
4247
- /** Database ID of deployed entity Example: "5f3bd676b84798d54472d1cc" */
5475
+ /** Database ID of deployed entity Example: "example-service" */
4248
5476
  'nfObjectId': string;
4249
5477
  /** Type of deployed entity Example: "service" */
4250
5478
  'nfObjectType': 'service';
@@ -4252,10 +5480,35 @@ declare type CreateServiceDeploymentResult = {
4252
5480
  'repository': string;
4253
5481
  /** Branch of the repo being deployed Example: "master" */
4254
5482
  'branch': string;
4255
- /** Commit SHA to be deployed. 'latest' means the latest commit is automatically being deployed. Example: "latest" */
5483
+ /** Commit SHA to be deployed. `latest` means the latest commit is automatically being deployed. Example: "latest" */
4256
5484
  'buildSHA': string;
4257
- /** Currently deployed commit SHA. If buildSHA is set to 'latest', this will show the SHA of the latest commit. Example: "262ed9817b3cad5142fbceabe0c9e371e390d616" */
4258
- 'deployedSHA': string;
5485
+ /** Currently deployed commit SHA. If buildSHA is set to `latest`, this will show the SHA of the latest commit. Example: "262ed9817b3cad5142fbceabe0c9e371e390d616" */
5486
+ 'deployedSHA'?: string;
5487
+ };
5488
+ /** Details about the Docker overrides for this deployment. */
5489
+ 'docker'?: {
5490
+ /** Details about the CMD override for this deployment. */
5491
+ 'cmd': {
5492
+ /** Whether the CMD override is enabled. Example: true */
5493
+ 'enabled': boolean;
5494
+ /** The CMD to run instead of the default if CMD override is enabled. Example: "nginx -g" */
5495
+ 'value': string;
5496
+ };
5497
+ /** Details about the entrypoint override for this deployment. */
5498
+ 'entrypoint': {
5499
+ /** Whether the entrypoint override is enabled. Example: true */
5500
+ 'enabled': boolean;
5501
+ /** The CMD to run instead of the default if entrypoint override is enabled. Example: "/docker-entrypoint.sh" */
5502
+ 'value': string;
5503
+ };
5504
+ };
5505
+ /** Details about storage settings for this deployment. */
5506
+ 'storage'?: {
5507
+ /** Details about ephemeral storage settings for this deployment. */
5508
+ 'ephemeralStorage'?: {
5509
+ /** Ephemeral storage per container in MB Example: 1024 */
5510
+ 'storageSize': number;
5511
+ };
4259
5512
  };
4260
5513
  };
4261
5514
  } | any;
@@ -4282,28 +5535,34 @@ declare type CreateServiceDeploymentData = {
4282
5535
  'instances': number;
4283
5536
  /** If set, the service runs a custom command rather than one defined in the Dockerfile. Example: "nginx -g" */
4284
5537
  'cmdOverride'?: string;
5538
+ /** If set, the service runs a custom entrypoint rather than one defined in the Dockerfile. Example: "/custom-entrypoint.sh" */
5539
+ 'entrypointOverride'?: string;
4285
5540
  'storage'?: {
4286
5541
  'ephemeralStorage'?: {
4287
- /** Ephemeral storage per container in MB */
5542
+ /** Ephemeral storage per container in MB Example: 1024 */
4288
5543
  'storageSize'?: number;
4289
5544
  };
4290
5545
  };
4291
5546
  'internal': {
4292
- /** Internal ID of the build service to deploy Example: "example-build-service" */
4293
- 'id': string;
5547
+ /** ID of the build service to deploy Example: "example-build-service" */
5548
+ 'id'?: string;
4294
5549
  /** Branch to deploy Example: "master" */
4295
5550
  'branch'?: string;
4296
5551
  /** Commit SHA to deploy, or 'latest' to deploy the most recent commit Example: "latest" */
4297
- 'buildSHA'?: string;
5552
+ 'buildSHA'?: string | 'latest';
5553
+ /** ID of the build that should be deployed Example: "premium-guide-6393" */
5554
+ 'buildId'?: string;
4298
5555
  };
4299
5556
  } | {
4300
5557
  /** The number of instances to run the service on. Example: 1 */
4301
5558
  'instances': number;
4302
5559
  /** If set, the service runs a custom command rather than one defined in the Dockerfile. Example: "nginx -g" */
4303
5560
  'cmdOverride'?: string;
5561
+ /** If set, the service runs a custom entrypoint rather than one defined in the Dockerfile. Example: "/custom-entrypoint.sh" */
5562
+ 'entrypointOverride'?: string;
4304
5563
  'storage'?: {
4305
5564
  'ephemeralStorage'?: {
4306
- /** Ephemeral storage per container in MB */
5565
+ /** Ephemeral storage per container in MB Example: 1024 */
4307
5566
  'storageSize'?: number;
4308
5567
  };
4309
5568
  };
@@ -4318,9 +5577,11 @@ declare type CreateServiceDeploymentData = {
4318
5577
  'instances': number;
4319
5578
  /** If set, the service runs a custom command rather than one defined in the Dockerfile. Example: "nginx -g" */
4320
5579
  'cmdOverride'?: string;
5580
+ /** If set, the service runs a custom entrypoint rather than one defined in the Dockerfile. Example: "/custom-entrypoint.sh" */
5581
+ 'entrypointOverride'?: string;
4321
5582
  'storage'?: {
4322
5583
  'ephemeralStorage'?: {
4323
- /** Ephemeral storage per container in MB */
5584
+ /** Ephemeral storage per container in MB Example: 1024 */
4324
5585
  'storageSize'?: number;
4325
5586
  };
4326
5587
  };
@@ -4352,6 +5613,8 @@ declare type CreateServiceDeploymentData = {
4352
5613
  };
4353
5614
  /** An array of domains to redirect to this port. Each domain must first be verified and registered to your account. */
4354
5615
  'domains'?: string[];
5616
+ /** Disable routing on the default code.run domain for public HTTP ports with custom domains. */
5617
+ 'disableNfDomain'?: boolean;
4355
5618
  /** The protocol to use for the port. Example: "HTTP" */
4356
5619
  'protocol': 'HTTP' | 'HTTP/2' | 'TCP' | 'UDP';
4357
5620
  }[];
@@ -4359,11 +5622,35 @@ declare type CreateServiceDeploymentData = {
4359
5622
  'runtimeEnvironment'?: any;
4360
5623
  /** Secret files as JSON object, encrypted at rest. File path must be absolute Example: {"/dir/fileName":{"data":"VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=","encoding":"utf-8"}} */
4361
5624
  'runtimeFiles'?: any;
5625
+ /** An array of health checks. */
5626
+ 'healthChecks'?: {
5627
+ /** The protocol to access the health check with. Example: "HTTP" */
5628
+ 'protocol': 'HTTP' | 'CMD' | 'TCP';
5629
+ /** The type of health check. Example: "readinessProbe" */
5630
+ 'type': 'livenessProbe' | 'readinessProbe' | 'startupProbe';
5631
+ /** The path of the health check endpoint. Required when protocol is HTTP. Example: "/health-check" */
5632
+ 'path'?: string;
5633
+ /** The command to run for the health check. Required when protocol is CMD */
5634
+ 'cmd'?: string;
5635
+ /** Port number for the health check endpoint. Required when protocol is HTTP. Example: 8080 */
5636
+ 'port'?: number;
5637
+ /** Initial delay, in seconds, before the health check is first run. Example: 10 */
5638
+ 'initialDelaySeconds': number;
5639
+ /** The time between each check, in seconds. Example: 60 */
5640
+ 'periodSeconds': number;
5641
+ /** The time to wait for a response before marking the health check as a failure. Example: 1 */
5642
+ 'timeoutSeconds': number;
5643
+ /** The maximum number of allowed failures. Example: 3 */
5644
+ 'failureThreshold': number;
5645
+ /** The number of successes required to mark the health check as a success. Example: 1 */
5646
+ 'successThreshold'?: number;
5647
+ }[];
4362
5648
  };
4363
5649
  /** Creates a new deployment service. */
4364
5650
  declare class CreateServiceDeploymentEndpoint extends PostApiEndpoint<CreateServiceDeploymentRequest, CreateServiceDeploymentResult> {
4365
5651
  description: string;
4366
5652
  withAuth: boolean;
5653
+ requiredPermissions: string;
4367
5654
  endpointUrl: (opts: CreateServiceDeploymentRequest) => string;
4368
5655
  body: (payload: CreateServiceDeploymentRequest) => string;
4369
5656
  }
@@ -4442,6 +5729,13 @@ declare type CreateServiceBuildResult = {
4442
5729
  'builder'?: 'HEROKU_20' | 'HEROKU_18' | 'GOOGLE_V1' | 'CNB_ALPINE' | 'CNB_BIONIC' | 'PAKETO_TINY' | 'PAKETO_BASE' | 'PAKETO_FULL';
4443
5730
  /** Array of custom Buildpacks used. */
4444
5731
  'buildpackLocators'?: string[];
5732
+ /** Should build dependencies be cached? */
5733
+ 'useCache'?: boolean;
5734
+ };
5735
+ /** Details about Buildkit settings. */
5736
+ 'buildkit'?: {
5737
+ /** Should intermediate image layers be cached? */
5738
+ 'useCache'?: boolean;
4445
5739
  };
4446
5740
  /** Details about Kaniko settings. */
4447
5741
  'kaniko'?: {
@@ -4481,7 +5775,7 @@ declare type CreateServiceBuildData = {
4481
5775
  'dockerfile': {
4482
5776
  /** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
4483
5777
  'buildEngine'?: 'kaniko' | 'buildkit';
4484
- /** Should intermediate image layers be cached? Only supported by Kaniko. */
5778
+ /** Should intermediate image layers be cached? */
4485
5779
  'useCache'?: boolean;
4486
5780
  /** The file path of the Dockerfile. Example: "/Dockerfile" */
4487
5781
  'dockerFilePath': string;
@@ -4496,6 +5790,8 @@ declare type CreateServiceBuildData = {
4496
5790
  'buildpackLocators'?: string[];
4497
5791
  /** The working directory to build in. Example: "/" */
4498
5792
  'buildContext'?: string;
5793
+ /** Should build dependencies be cached? */
5794
+ 'useCache'?: boolean;
4499
5795
  };
4500
5796
  };
4501
5797
  'buildConfiguration'?: {
@@ -4515,6 +5811,7 @@ declare type CreateServiceBuildData = {
4515
5811
  declare class CreateServiceBuildEndpoint extends PostApiEndpoint<CreateServiceBuildRequest, CreateServiceBuildResult> {
4516
5812
  description: string;
4517
5813
  withAuth: boolean;
5814
+ requiredPermissions: string;
4518
5815
  endpointUrl: (opts: CreateServiceBuildRequest) => string;
4519
5816
  body: (payload: CreateServiceBuildRequest) => string;
4520
5817
  }
@@ -4594,7 +5891,7 @@ declare type GetServiceResult = {
4594
5891
  'privateImage': boolean;
4595
5892
  };
4596
5893
  'internal'?: {
4597
- /** Database ID of deployed entity Example: "5f3bd676b84798d54472d1cc" */
5894
+ /** Database ID of deployed entity Example: "example-service" */
4598
5895
  'nfObjectId': string;
4599
5896
  /** Type of deployed entity Example: "service" */
4600
5897
  'nfObjectType': 'service';
@@ -4602,10 +5899,35 @@ declare type GetServiceResult = {
4602
5899
  'repository': string;
4603
5900
  /** Branch of the repo being deployed Example: "master" */
4604
5901
  'branch': string;
4605
- /** Commit SHA to be deployed. 'latest' means the latest commit is automatically being deployed. Example: "latest" */
5902
+ /** Commit SHA to be deployed. `latest` means the latest commit is automatically being deployed. Example: "latest" */
4606
5903
  'buildSHA': string;
4607
- /** Currently deployed commit SHA. If buildSHA is set to 'latest', this will show the SHA of the latest commit. Example: "262ed9817b3cad5142fbceabe0c9e371e390d616" */
4608
- 'deployedSHA': string;
5904
+ /** Currently deployed commit SHA. If buildSHA is set to `latest`, this will show the SHA of the latest commit. Example: "262ed9817b3cad5142fbceabe0c9e371e390d616" */
5905
+ 'deployedSHA'?: string;
5906
+ };
5907
+ /** Details about the Docker overrides for this deployment. */
5908
+ 'docker'?: {
5909
+ /** Details about the CMD override for this deployment. */
5910
+ 'cmd': {
5911
+ /** Whether the CMD override is enabled. Example: true */
5912
+ 'enabled': boolean;
5913
+ /** The CMD to run instead of the default if CMD override is enabled. Example: "nginx -g" */
5914
+ 'value': string;
5915
+ };
5916
+ /** Details about the entrypoint override for this deployment. */
5917
+ 'entrypoint': {
5918
+ /** Whether the entrypoint override is enabled. Example: true */
5919
+ 'enabled': boolean;
5920
+ /** The CMD to run instead of the default if entrypoint override is enabled. Example: "/docker-entrypoint.sh" */
5921
+ 'value': string;
5922
+ };
5923
+ };
5924
+ /** Details about storage settings for this deployment. */
5925
+ 'storage'?: {
5926
+ /** Details about ephemeral storage settings for this deployment. */
5927
+ 'ephemeralStorage'?: {
5928
+ /** Ephemeral storage per container in MB Example: 1024 */
5929
+ 'storageSize': number;
5930
+ };
4609
5931
  };
4610
5932
  };
4611
5933
  'buildConfiguration'?: {
@@ -4622,6 +5944,13 @@ declare type GetServiceResult = {
4622
5944
  'builder'?: 'HEROKU_20' | 'HEROKU_18' | 'GOOGLE_V1' | 'CNB_ALPINE' | 'CNB_BIONIC' | 'PAKETO_TINY' | 'PAKETO_BASE' | 'PAKETO_FULL';
4623
5945
  /** Array of custom Buildpacks used. */
4624
5946
  'buildpackLocators'?: string[];
5947
+ /** Should build dependencies be cached? */
5948
+ 'useCache'?: boolean;
5949
+ };
5950
+ /** Details about Buildkit settings. */
5951
+ 'buildkit'?: {
5952
+ /** Should intermediate image layers be cached? */
5953
+ 'useCache'?: boolean;
4625
5954
  };
4626
5955
  /** Details about Kaniko settings. */
4627
5956
  'kaniko'?: {
@@ -4676,6 +6005,8 @@ declare type GetServiceResult = {
4676
6005
  'action': 'ALLOW' | 'DENY';
4677
6006
  }[];
4678
6007
  };
6008
+ /** Disable routing on the default code.run domain for public HTTP ports with custom domains. */
6009
+ 'disableNfDomain'?: boolean;
4679
6010
  }[];
4680
6011
  };
4681
6012
  declare type GetServiceCall = (opts: GetServiceRequest) => Promise<ApiCallResponse<GetServiceResult>>;
@@ -4691,6 +6022,7 @@ declare type GetServiceParameters = {
4691
6022
  declare class GetServiceEndpoint extends GetApiEndpoint<GetServiceRequest, GetServiceResult> {
4692
6023
  description: string;
4693
6024
  withAuth: boolean;
6025
+ requiredPermissions: string;
4694
6026
  endpointUrl: (opts: GetServiceRequest) => string;
4695
6027
  body: () => undefined;
4696
6028
  }
@@ -4709,6 +6041,7 @@ declare type DeleteServiceParameters = {
4709
6041
  declare class DeleteServiceEndpoint extends DeleteApiEndpoint<DeleteServiceRequest, DeleteServiceResult> {
4710
6042
  description: string;
4711
6043
  withAuth: boolean;
6044
+ requiredPermissions: string;
4712
6045
  endpointUrl: (opts: DeleteServiceRequest) => string;
4713
6046
  body: () => undefined;
4714
6047
  }
@@ -4731,7 +6064,7 @@ declare type ScaleServiceData = {
4731
6064
  'deploymentPlan'?: string;
4732
6065
  'storage'?: {
4733
6066
  'ephemeralStorage'?: {
4734
- /** Ephemeral storage per container in MB */
6067
+ /** Ephemeral storage per container in MB Example: 1024 */
4735
6068
  'storageSize'?: number;
4736
6069
  };
4737
6070
  };
@@ -4740,6 +6073,7 @@ declare type ScaleServiceData = {
4740
6073
  declare class ScaleServiceEndpoint extends PostApiEndpoint<ScaleServiceRequest, ScaleServiceResult> {
4741
6074
  description: string;
4742
6075
  withAuth: boolean;
6076
+ requiredPermissions: string;
4743
6077
  endpointUrl: (opts: ScaleServiceRequest) => string;
4744
6078
  body: (payload: ScaleServiceRequest) => string;
4745
6079
  }
@@ -4760,8 +6094,12 @@ declare type GetServiceDeploymentResult = {
4760
6094
  'repository': string;
4761
6095
  /** Branch of the repo being deployed Example: "master" */
4762
6096
  'branch': string;
4763
- /** Commit SHA being deployed. 'latest' means the latest commit is automatically being deployed. Example: "latest" */
6097
+ /** ID of the build currently deployed. Example: "incredible-land-3266" */
6098
+ 'buildId': string;
6099
+ /** Commit SHA being deployed. `latest` means the latest commit is automatically being deployed. Example: "latest" */
4764
6100
  'buildSHA': string;
6101
+ /** Currently deployed commit SHA. If buildSHA is set to `latest`, this will show the SHA of the latest commit. Example: "262ed9817b3cad5142fbceabe0c9e371e390d616" */
6102
+ 'deployedSHA'?: string;
4765
6103
  };
4766
6104
  } | {
4767
6105
  /** Region where this service is deployed and/or built Example: "europe-west" */
@@ -4790,6 +6128,7 @@ declare type GetServiceDeploymentParameters = {
4790
6128
  declare class GetServiceDeploymentEndpoint extends GetApiEndpoint<GetServiceDeploymentRequest, GetServiceDeploymentResult> {
4791
6129
  description: string;
4792
6130
  withAuth: boolean;
6131
+ requiredPermissions: string;
4793
6132
  endpointUrl: (opts: GetServiceDeploymentRequest) => string;
4794
6133
  body: () => undefined;
4795
6134
  }
@@ -4819,7 +6158,7 @@ declare type UpdateServiceDeploymentData = {
4819
6158
  /** Branch to deploy Example: "master" */
4820
6159
  'branch'?: string;
4821
6160
  /** Commit SHA to deploy, or 'latest' to deploy the most recent commit Example: "latest" */
4822
- 'buildSHA'?: any;
6161
+ 'buildSHA'?: string | 'latest';
4823
6162
  /** ID of the build that should be deployed Example: "premium-guide-6393" */
4824
6163
  'buildId'?: string;
4825
6164
  };
@@ -4828,6 +6167,7 @@ declare type UpdateServiceDeploymentData = {
4828
6167
  declare class UpdateServiceDeploymentEndpoint extends PostApiEndpoint<UpdateServiceDeploymentRequest, UpdateServiceDeploymentResult> {
4829
6168
  description: string;
4830
6169
  withAuth: boolean;
6170
+ requiredPermissions: string;
4831
6171
  endpointUrl: (opts: UpdateServiceDeploymentRequest) => string;
4832
6172
  body: (payload: UpdateServiceDeploymentRequest) => string;
4833
6173
  }
@@ -4846,6 +6186,7 @@ declare type RestartServiceParameters = {
4846
6186
  declare class RestartServiceEndpoint extends PostApiEndpoint<RestartServiceRequest, RestartServiceResult> {
4847
6187
  description: string;
4848
6188
  withAuth: boolean;
6189
+ requiredPermissions: string;
4849
6190
  endpointUrl: (opts: RestartServiceRequest) => string;
4850
6191
  body: () => undefined;
4851
6192
  }
@@ -4864,6 +6205,7 @@ declare type PauseServiceParameters = {
4864
6205
  declare class PauseServiceEndpoint extends PostApiEndpoint<PauseServiceRequest, PauseServiceResult> {
4865
6206
  description: string;
4866
6207
  withAuth: boolean;
6208
+ requiredPermissions: string;
4867
6209
  endpointUrl: (opts: PauseServiceRequest) => string;
4868
6210
  body: () => undefined;
4869
6211
  }
@@ -4882,11 +6224,16 @@ declare type ResumeServiceParameters = {
4882
6224
  declare type ResumeServiceData = {
4883
6225
  /** The number of instances to scale the service to upon resuming Example: 1 */
4884
6226
  'instances'?: number;
6227
+ /** Whether CI should be disabled */
6228
+ 'disabledCI'?: boolean;
6229
+ /** Whether CD should be disabled */
6230
+ 'disabledCD'?: boolean;
4885
6231
  };
4886
- /** Resumes the given service. Optionally takes `instances` to resume with a given number of instances. */
6232
+ /** Resumes the given service. Optionally takes several arguments to override resumed settings. */
4887
6233
  declare class ResumeServiceEndpoint extends PostApiEndpoint<ResumeServiceRequest, ResumeServiceResult> {
4888
6234
  description: string;
4889
6235
  withAuth: boolean;
6236
+ requiredPermissions: string;
4890
6237
  endpointUrl: (opts: ResumeServiceRequest) => string;
4891
6238
  body: (payload: ResumeServiceRequest) => string;
4892
6239
  }
@@ -4939,6 +6286,8 @@ declare type GetServicePortsResult = {
4939
6286
  'action': 'ALLOW' | 'DENY';
4940
6287
  }[];
4941
6288
  };
6289
+ /** Disable routing on the default code.run domain for public HTTP ports with custom domains. */
6290
+ 'disableNfDomain'?: boolean;
4942
6291
  }[];
4943
6292
  };
4944
6293
  declare type GetServicePortsCall = (opts: GetServicePortsRequest) => Promise<ApiCallResponse<GetServicePortsResult>>;
@@ -4954,6 +6303,7 @@ declare type GetServicePortsParameters = {
4954
6303
  declare class GetServicePortsEndpoint extends GetApiEndpoint<GetServicePortsRequest, GetServicePortsResult> {
4955
6304
  description: string;
4956
6305
  withAuth: boolean;
6306
+ requiredPermissions: string;
4957
6307
  endpointUrl: (opts: GetServicePortsRequest) => string;
4958
6308
  body: () => undefined;
4959
6309
  }
@@ -4972,7 +6322,7 @@ declare type UpdateServicePortsParameters = {
4972
6322
  declare type UpdateServicePortsData = {
4973
6323
  /** An array of ports to replace or update existing ports with. */
4974
6324
  'ports': {
4975
- /** The id of an existing port. Pass this when changing in order to keep security configurations. Example: "eonyui" */
6325
+ /** The id of an existing port. Pass this when changing in order to keep security configurations. Example: "p01" */
4976
6326
  'id'?: string;
4977
6327
  /** The name used to identify the port. Example: "port-1" */
4978
6328
  'name': string;
@@ -5002,12 +6352,15 @@ declare type UpdateServicePortsData = {
5002
6352
  'action': 'ALLOW' | 'DENY';
5003
6353
  }[];
5004
6354
  };
6355
+ /** Disable routing on the default code.run domain for public HTTP ports with custom domains. */
6356
+ 'disableNfDomain'?: boolean;
5005
6357
  }[];
5006
6358
  };
5007
6359
  /** Updates the list of ports for the given service. */
5008
6360
  declare class UpdateServicePortsEndpoint extends PostApiEndpoint<UpdateServicePortsRequest, UpdateServicePortsResult> {
5009
6361
  description: string;
5010
6362
  withAuth: boolean;
6363
+ requiredPermissions: string;
5011
6364
  endpointUrl: (opts: UpdateServicePortsRequest) => string;
5012
6365
  body: (payload: UpdateServicePortsRequest) => string;
5013
6366
  }
@@ -5027,7 +6380,7 @@ declare type UpdateServiceBuildoptionsData = {
5027
6380
  'dockerfile': {
5028
6381
  /** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
5029
6382
  'buildEngine'?: 'kaniko' | 'buildkit';
5030
- /** Should intermediate image layers be cached? Only supported by Kaniko. */
6383
+ /** Should intermediate image layers be cached? */
5031
6384
  'useCache'?: boolean;
5032
6385
  /** The file path of the Dockerfile. Example: "/Dockerfile" */
5033
6386
  'dockerFilePath'?: string;
@@ -5048,6 +6401,8 @@ declare type UpdateServiceBuildoptionsData = {
5048
6401
  'buildpackLocators'?: string[];
5049
6402
  /** The working directory to build in. Example: "/" */
5050
6403
  'buildContext'?: string;
6404
+ /** Should build dependencies be cached? */
6405
+ 'useCache'?: boolean;
5051
6406
  };
5052
6407
  /** An array of pull request build rules. Only supported for build services. Each commit belonging to a pull request on a branch that matches one of the provided build rules will be built automatically. */
5053
6408
  'prRestrictions'?: string[];
@@ -5067,6 +6422,7 @@ declare type UpdateServiceBuildoptionsData = {
5067
6422
  declare class UpdateServiceBuildoptionsEndpoint extends PostApiEndpoint<UpdateServiceBuildoptionsRequest, UpdateServiceBuildoptionsResult> {
5068
6423
  description: string;
5069
6424
  withAuth: boolean;
6425
+ requiredPermissions: string;
5070
6426
  endpointUrl: (opts: UpdateServiceBuildoptionsRequest) => string;
5071
6427
  body: (payload: UpdateServiceBuildoptionsRequest) => string;
5072
6428
  }
@@ -5098,6 +6454,7 @@ declare type UpdateServiceBuildsourceData = {
5098
6454
  declare class UpdateServiceBuildsourceEndpoint extends PostApiEndpoint<UpdateServiceBuildsourceRequest, UpdateServiceBuildsourceResult> {
5099
6455
  description: string;
5100
6456
  withAuth: boolean;
6457
+ requiredPermissions: string;
5101
6458
  endpointUrl: (opts: UpdateServiceBuildsourceRequest) => string;
5102
6459
  body: (payload: UpdateServiceBuildsourceRequest) => string;
5103
6460
  }
@@ -5121,10 +6478,35 @@ declare type UpdateServiceCmdoverrideData = {
5121
6478
  declare class UpdateServiceCmdoverrideEndpoint extends PostApiEndpoint<UpdateServiceCmdoverrideRequest, UpdateServiceCmdoverrideResult> {
5122
6479
  description: string;
5123
6480
  withAuth: boolean;
6481
+ requiredPermissions: string;
5124
6482
  endpointUrl: (opts: UpdateServiceCmdoverrideRequest) => string;
5125
6483
  body: (payload: UpdateServiceCmdoverrideRequest) => string;
5126
6484
  }
5127
6485
 
6486
+ declare type UpdateServiceEntrypointoverrideResult = any;
6487
+ declare type UpdateServiceEntrypointoverrideCall = (opts: UpdateServiceEntrypointoverrideRequest) => Promise<ApiCallResponse<UpdateServiceEntrypointoverrideResult>>;
6488
+ declare type UpdateServiceEntrypointoverrideRequest = {
6489
+ parameters: UpdateServiceEntrypointoverrideParameters;
6490
+ data: UpdateServiceEntrypointoverrideData;
6491
+ };
6492
+ declare type UpdateServiceEntrypointoverrideParameters = {
6493
+ /** ID of the project */ 'projectId': string;
6494
+ /** ID of the service */
6495
+ 'serviceId': string;
6496
+ };
6497
+ declare type UpdateServiceEntrypointoverrideData = {
6498
+ /** If set, the service runs a custom entrypoint rather than one defined in the Dockerfile. Example: "/custom-entrypoint.sh" */
6499
+ 'entrypointOverride'?: string;
6500
+ };
6501
+ /** Sets the Docker entrypoint override for the given service. */
6502
+ declare class UpdateServiceEntrypointoverrideEndpoint extends PostApiEndpoint<UpdateServiceEntrypointoverrideRequest, UpdateServiceEntrypointoverrideResult> {
6503
+ description: string;
6504
+ withAuth: boolean;
6505
+ requiredPermissions: string;
6506
+ endpointUrl: (opts: UpdateServiceEntrypointoverrideRequest) => string;
6507
+ body: (payload: UpdateServiceEntrypointoverrideRequest) => string;
6508
+ }
6509
+
5128
6510
  declare type GetServiceHealthchecksResult = {
5129
6511
  /** An array of health checks. */
5130
6512
  'healthChecks': {
@@ -5144,6 +6526,7 @@ declare type GetServiceHealthchecksResult = {
5144
6526
  'initialDelaySeconds': number;
5145
6527
  /** The time between each check, in seconds. Example: 60 */
5146
6528
  'periodSeconds': number;
6529
+ /** The time to wait for a response before marking the health check as a failure. Example: 1 */
5147
6530
  'timeoutSeconds': number;
5148
6531
  /** The maximum number of allowed failures. Example: 3 */
5149
6532
  'failureThreshold': number;
@@ -5164,6 +6547,7 @@ declare type GetServiceHealthchecksParameters = {
5164
6547
  declare class GetServiceHealthchecksEndpoint extends GetApiEndpoint<GetServiceHealthchecksRequest, GetServiceHealthchecksResult> {
5165
6548
  description: string;
5166
6549
  withAuth: boolean;
6550
+ requiredPermissions: string;
5167
6551
  endpointUrl: (opts: GetServiceHealthchecksRequest) => string;
5168
6552
  body: () => undefined;
5169
6553
  }
@@ -5180,7 +6564,7 @@ declare type UpdateServiceHealthchecksParameters = {
5180
6564
  'serviceId': string;
5181
6565
  };
5182
6566
  declare type UpdateServiceHealthchecksData = {
5183
- /** An array of health checks */
6567
+ /** An array of health checks. */
5184
6568
  'healthChecks': {
5185
6569
  /** The protocol to access the health check with. Example: "HTTP" */
5186
6570
  'protocol': 'HTTP' | 'CMD' | 'TCP';
@@ -5190,7 +6574,7 @@ declare type UpdateServiceHealthchecksData = {
5190
6574
  'path'?: string;
5191
6575
  /** The command to run for the health check. Required when protocol is CMD */
5192
6576
  'cmd'?: string;
5193
- /** Port number for the health check endpoint. Required when protocol is HTTP. Example: 3000 */
6577
+ /** Port number for the health check endpoint. Required when protocol is HTTP. Example: 8080 */
5194
6578
  'port'?: number;
5195
6579
  /** Initial delay, in seconds, before the health check is first run. Example: 10 */
5196
6580
  'initialDelaySeconds': number;
@@ -5208,6 +6592,7 @@ declare type UpdateServiceHealthchecksData = {
5208
6592
  declare class UpdateServiceHealthchecksEndpoint extends PostApiEndpoint<UpdateServiceHealthchecksRequest, UpdateServiceHealthchecksResult> {
5209
6593
  description: string;
5210
6594
  withAuth: boolean;
6595
+ requiredPermissions: string;
5211
6596
  endpointUrl: (opts: UpdateServiceHealthchecksRequest) => string;
5212
6597
  body: (payload: UpdateServiceHealthchecksRequest) => string;
5213
6598
  }
@@ -5259,6 +6644,7 @@ declare type GetServiceBuildsOptions = {
5259
6644
  declare class GetServiceBuildsEndpoint extends GetApiEndpoint<GetServiceBuildsRequest, GetServiceBuildsResult> {
5260
6645
  description: string;
5261
6646
  withAuth: boolean;
6647
+ requiredPermissions: string;
5262
6648
  endpointUrl: (opts: GetServiceBuildsRequest) => string;
5263
6649
  body: () => undefined;
5264
6650
  }
@@ -5313,6 +6699,7 @@ declare type StartServiceBuildData = {
5313
6699
  declare class StartServiceBuildEndpoint extends PostApiEndpoint<StartServiceBuildRequest, StartServiceBuildResult> {
5314
6700
  description: string;
5315
6701
  withAuth: boolean;
6702
+ requiredPermissions: string;
5316
6703
  endpointUrl: (opts: StartServiceBuildRequest) => string;
5317
6704
  body: (payload: StartServiceBuildRequest) => string;
5318
6705
  }
@@ -5354,6 +6741,7 @@ declare type GetServiceBuildParameters = {
5354
6741
  declare class GetServiceBuildEndpoint extends GetApiEndpoint<GetServiceBuildRequest, GetServiceBuildResult> {
5355
6742
  description: string;
5356
6743
  withAuth: boolean;
6744
+ requiredPermissions: string;
5357
6745
  endpointUrl: (opts: GetServiceBuildRequest) => string;
5358
6746
  body: () => undefined;
5359
6747
  }
@@ -5374,6 +6762,7 @@ declare type AbortServiceBuildParameters = {
5374
6762
  declare class AbortServiceBuildEndpoint extends DeleteApiEndpoint<AbortServiceBuildRequest, AbortServiceBuildResult> {
5375
6763
  description: string;
5376
6764
  withAuth: boolean;
6765
+ requiredPermissions: string;
5377
6766
  endpointUrl: (opts: AbortServiceBuildRequest) => string;
5378
6767
  body: () => undefined;
5379
6768
  }
@@ -5413,6 +6802,7 @@ declare type GetServiceContainersOptions = {
5413
6802
  declare class GetServiceContainersEndpoint extends GetApiEndpoint<GetServiceContainersRequest, GetServiceContainersResult> {
5414
6803
  description: string;
5415
6804
  withAuth: boolean;
6805
+ requiredPermissions: string;
5416
6806
  endpointUrl: (opts: GetServiceContainersRequest) => string;
5417
6807
  body: () => undefined;
5418
6808
  }
@@ -5461,6 +6851,7 @@ declare type GetServiceBranchesOptions = {
5461
6851
  declare class GetServiceBranchesEndpoint extends GetApiEndpoint<GetServiceBranchesRequest, GetServiceBranchesResult> {
5462
6852
  description: string;
5463
6853
  withAuth: boolean;
6854
+ requiredPermissions: string;
5464
6855
  endpointUrl: (opts: GetServiceBranchesRequest) => string;
5465
6856
  body: () => undefined;
5466
6857
  }
@@ -5509,10 +6900,532 @@ declare type GetServicePullrequestsOptions = {
5509
6900
  declare class GetServicePullrequestsEndpoint extends GetApiEndpoint<GetServicePullrequestsRequest, GetServicePullrequestsResult> {
5510
6901
  description: string;
5511
6902
  withAuth: boolean;
6903
+ requiredPermissions: string;
5512
6904
  endpointUrl: (opts: GetServicePullrequestsRequest) => string;
5513
6905
  body: () => undefined;
5514
6906
  }
5515
6907
 
6908
+ declare type ListTemplatesResult = {
6909
+ /** An array of template objects. */
6910
+ 'templates': {
6911
+ /** ID of the template. Example: "example-template" */
6912
+ 'id': string;
6913
+ /** Timestamp of when the template was created. Example: "2022-06-14 15:10:42.842Z" */
6914
+ 'createdAt': string;
6915
+ /** Timestamp of when the template was last updated. Example: "2022-06-14 15:10:42.842Z" */
6916
+ 'updatedAt': string;
6917
+ /** Details about the template. */
6918
+ 'content': {
6919
+ /** Name of the template. Example: "Example Template" */
6920
+ 'name': string;
6921
+ /** Description of the template. Example: "This is a sample template." */
6922
+ 'description'?: string;
6923
+ /** The version of the Northflank API to run the template against. Example: "v1" */
6924
+ 'apiVersion': 'v1';
6925
+ };
6926
+ }[];
6927
+ };
6928
+ declare type ListTemplatesCall = (opts: ListTemplatesRequest) => Promise<ApiCallResponse<ListTemplatesResult>>;
6929
+ declare type ListTemplatesRequest = {
6930
+ options?: ListTemplatesOptions;
6931
+ };
6932
+ declare type ListTemplatesOptions = {
6933
+ /** The number of results to display per request. Maximum of 100 results per page. */
6934
+ 'per_page'?: number;
6935
+ /** The page number to access. */
6936
+ 'page'?: number;
6937
+ /** The cursor returned from the previous page of results, used to request the next page. */
6938
+ 'cursor'?: string;
6939
+ };
6940
+ /** Get a list of templates */
6941
+ declare class ListTemplatesEndpoint extends GetApiEndpoint<ListTemplatesRequest, ListTemplatesResult> {
6942
+ description: string;
6943
+ withAuth: boolean;
6944
+ requiredPermissions: string;
6945
+ endpointUrl: (opts: ListTemplatesRequest) => string;
6946
+ body: () => undefined;
6947
+ }
6948
+
6949
+ declare type CreateTemplateResult = {
6950
+ /** Details about the newly created template. */
6951
+ 'template': {
6952
+ /** ID of the template. Example: "example-template" */
6953
+ 'id': string;
6954
+ /** Timestamp of when the template was created. Example: "2022-06-14 15:10:42.842Z" */
6955
+ 'createdAt': string;
6956
+ /** Timestamp of when the template was last updated. Example: "2022-06-14 15:10:42.842Z" */
6957
+ 'updatedAt': string;
6958
+ 'content'?: {
6959
+ /** Name of the template. Example: "Example Template" */
6960
+ 'name': string;
6961
+ /** Description of the template. Example: "This is a sample template." */
6962
+ 'description'?: string;
6963
+ /** The version of the Northflank API to run the template against. Example: "v1" */
6964
+ 'apiVersion': 'v1';
6965
+ /** Details of the project the template will run in. */
6966
+ 'project': {
6967
+ /** The ID of the project to use. */
6968
+ 'id': string;
6969
+ } | {
6970
+ /** Details about the project to create. */
6971
+ 'spec': {
6972
+ /** The name of the project. Example: "New Project" */
6973
+ 'name': string;
6974
+ /** The description of the project. Example: "This is a new project." */
6975
+ 'description'?: string;
6976
+ /** The region the project will be hosted in. Example: "europe-west" */
6977
+ 'region'?: string;
6978
+ /** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
6979
+ 'clusterId'?: string;
6980
+ /** The color of the project in the Northflank App. Example: "#EF233C" */
6981
+ 'color'?: string;
6982
+ };
6983
+ };
6984
+ 'spec': any;
6985
+ };
6986
+ };
6987
+ /** Details about the newly created template run. */
6988
+ 'templateRun'?: {
6989
+ /** ID of the template run. Example: "501c1e03-a021-4659-9048-85f8f6ee2bc7" */
6990
+ 'id': string;
6991
+ /** Timestamp of when the run was initiated. Example: "2022-06-14 15:10:42.842Z" */
6992
+ 'createdAt': string;
6993
+ /** Timestamp of when the run was last updated. Example: "2022-06-14 15:10:42.842Z" */
6994
+ 'updatedAt': string;
6995
+ /** Details about the template being run. */
6996
+ 'template': {
6997
+ /** ID of the template Example: "example-template" */
6998
+ 'id': string;
6999
+ /** The name of the template Example: "Example Template" */
7000
+ 'name': string;
7001
+ };
7002
+ /** Status of the template run. Example: "success" */
7003
+ 'status': 'waiting' | 'failure' | 'retrying' | 'success' | 'unknown';
7004
+ /** Details about the template run. */
7005
+ 'content': {
7006
+ /** Name of the template. Example: "Example Template" */
7007
+ 'name': string;
7008
+ /** Description of the template. Example: "This is a sample template." */
7009
+ 'description'?: string;
7010
+ /** The version of the Northflank API to run the template against. Example: "v1" */
7011
+ 'apiVersion': 'v1';
7012
+ /** Details of the project the template will run in. */
7013
+ 'project': {
7014
+ /** The ID of the project to use. */
7015
+ 'id': string;
7016
+ } | {
7017
+ /** Details about the project to create. */
7018
+ 'spec': {
7019
+ /** The name of the project. Example: "New Project" */
7020
+ 'name': string;
7021
+ /** The description of the project. Example: "This is a new project." */
7022
+ 'description'?: string;
7023
+ /** The region the project will be hosted in. Example: "europe-west" */
7024
+ 'region'?: string;
7025
+ /** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
7026
+ 'clusterId'?: string;
7027
+ /** The color of the project in the Northflank App. Example: "#EF233C" */
7028
+ 'color'?: string;
7029
+ };
7030
+ };
7031
+ 'spec': any;
7032
+ };
7033
+ };
7034
+ };
7035
+ declare type CreateTemplateCall = (opts: CreateTemplateRequest) => Promise<ApiCallResponse<CreateTemplateResult>>;
7036
+ declare type CreateTemplateRequest = {
7037
+ data: CreateTemplateData;
7038
+ };
7039
+ declare type CreateTemplateData = {
7040
+ /** Name of the template. Example: "Example Template" */
7041
+ 'name': string;
7042
+ /** Description of the template. Example: "This is a sample template." */
7043
+ 'description'?: string;
7044
+ /** The version of the Northflank API to run the template against. Example: "v1" */
7045
+ 'apiVersion': 'v1';
7046
+ /** Details of the project the template will run in. */
7047
+ 'project': {
7048
+ /** The ID of the project to use. */
7049
+ 'id': string;
7050
+ } | {
7051
+ /** Details about the project to create. */
7052
+ 'spec': {
7053
+ /** The name of the project. Example: "New Project" */
7054
+ 'name': string;
7055
+ /** The description of the project. Example: "This is a new project." */
7056
+ 'description'?: string;
7057
+ /** The region the project will be hosted in. Example: "europe-west" */
7058
+ 'region'?: string;
7059
+ /** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
7060
+ 'clusterId'?: string;
7061
+ /** The color of the project in the Northflank App. Example: "#EF233C" */
7062
+ 'color'?: string;
7063
+ };
7064
+ };
7065
+ 'spec': any;
7066
+ /** Additional options for the template creation. */
7067
+ 'options'?: {
7068
+ /** If true, the template will be ran immediately after creation. Example: true */
7069
+ 'runOnCreation'?: boolean;
7070
+ };
7071
+ };
7072
+ /** Create a template */
7073
+ declare class CreateTemplateEndpoint extends PostApiEndpoint<CreateTemplateRequest, CreateTemplateResult> {
7074
+ description: string;
7075
+ withAuth: boolean;
7076
+ requiredPermissions: string;
7077
+ endpointUrl: (opts: CreateTemplateRequest) => string;
7078
+ body: (payload: CreateTemplateRequest) => string;
7079
+ }
7080
+
7081
+ declare type GetTemplateResult = {
7082
+ /** ID of the template. Example: "example-template" */
7083
+ 'id': string;
7084
+ /** Timestamp of when the template was created. Example: "2022-06-14 15:10:42.842Z" */
7085
+ 'createdAt': string;
7086
+ /** Timestamp of when the template was last updated. Example: "2022-06-14 15:10:42.842Z" */
7087
+ 'updatedAt': string;
7088
+ 'content'?: {
7089
+ /** Name of the template. Example: "Example Template" */
7090
+ 'name': string;
7091
+ /** Description of the template. Example: "This is a sample template." */
7092
+ 'description'?: string;
7093
+ /** The version of the Northflank API to run the template against. Example: "v1" */
7094
+ 'apiVersion': 'v1';
7095
+ /** Details of the project the template will run in. */
7096
+ 'project': {
7097
+ /** The ID of the project to use. */
7098
+ 'id': string;
7099
+ } | {
7100
+ /** Details about the project to create. */
7101
+ 'spec': {
7102
+ /** The name of the project. Example: "New Project" */
7103
+ 'name': string;
7104
+ /** The description of the project. Example: "This is a new project." */
7105
+ 'description'?: string;
7106
+ /** The region the project will be hosted in. Example: "europe-west" */
7107
+ 'region'?: string;
7108
+ /** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
7109
+ 'clusterId'?: string;
7110
+ /** The color of the project in the Northflank App. Example: "#EF233C" */
7111
+ 'color'?: string;
7112
+ };
7113
+ };
7114
+ 'spec': any;
7115
+ };
7116
+ };
7117
+ declare type GetTemplateCall = (opts: GetTemplateRequest) => Promise<ApiCallResponse<GetTemplateResult>>;
7118
+ declare type GetTemplateRequest = {
7119
+ parameters: GetTemplateParameters;
7120
+ options?: GetTemplateOptions;
7121
+ };
7122
+ declare type GetTemplateParameters = {
7123
+ /** ID of the template */ 'templateId': string;
7124
+ };
7125
+ declare type GetTemplateOptions = {
7126
+ /** The number of results to display per request. Maximum of 100 results per page. */
7127
+ 'per_page'?: number;
7128
+ /** The page number to access. */
7129
+ 'page'?: number;
7130
+ /** The cursor returned from the previous page of results, used to request the next page. */
7131
+ 'cursor'?: string;
7132
+ };
7133
+ /** Get information about the given template. */
7134
+ declare class GetTemplateEndpoint extends GetApiEndpoint<GetTemplateRequest, GetTemplateResult> {
7135
+ description: string;
7136
+ withAuth: boolean;
7137
+ requiredPermissions: string;
7138
+ endpointUrl: (opts: GetTemplateRequest) => string;
7139
+ body: () => undefined;
7140
+ }
7141
+
7142
+ declare type UpdateTemplateResult = {
7143
+ /** ID of the template. Example: "example-template" */
7144
+ 'id': string;
7145
+ /** Timestamp of when the template was created. Example: "2022-06-14 15:10:42.842Z" */
7146
+ 'createdAt': string;
7147
+ /** Timestamp of when the template was last updated. Example: "2022-06-14 15:10:42.842Z" */
7148
+ 'updatedAt': string;
7149
+ 'content'?: {
7150
+ /** Name of the template. Example: "Example Template" */
7151
+ 'name': string;
7152
+ /** Description of the template. Example: "This is a sample template." */
7153
+ 'description'?: string;
7154
+ /** The version of the Northflank API to run the template against. Example: "v1" */
7155
+ 'apiVersion': 'v1';
7156
+ /** Details of the project the template will run in. */
7157
+ 'project': {
7158
+ /** The ID of the project to use. */
7159
+ 'id': string;
7160
+ } | {
7161
+ /** Details about the project to create. */
7162
+ 'spec': {
7163
+ /** The name of the project. Example: "New Project" */
7164
+ 'name': string;
7165
+ /** The description of the project. Example: "This is a new project." */
7166
+ 'description'?: string;
7167
+ /** The region the project will be hosted in. Example: "europe-west" */
7168
+ 'region'?: string;
7169
+ /** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
7170
+ 'clusterId'?: string;
7171
+ /** The color of the project in the Northflank App. Example: "#EF233C" */
7172
+ 'color'?: string;
7173
+ };
7174
+ };
7175
+ 'spec': any;
7176
+ };
7177
+ };
7178
+ declare type UpdateTemplateCall = (opts: UpdateTemplateRequest) => Promise<ApiCallResponse<UpdateTemplateResult>>;
7179
+ declare type UpdateTemplateRequest = {
7180
+ parameters: UpdateTemplateParameters;
7181
+ data: UpdateTemplateData;
7182
+ };
7183
+ declare type UpdateTemplateParameters = {
7184
+ /** ID of the template */ 'templateId': string;
7185
+ };
7186
+ declare type UpdateTemplateData = {
7187
+ /** Name of the template. Example: "Example Template" */
7188
+ 'name': string;
7189
+ /** Description of the template. Example: "This is a sample template." */
7190
+ 'description'?: string;
7191
+ /** The version of the Northflank API to run the template against. Example: "v1" */
7192
+ 'apiVersion': 'v1';
7193
+ /** Details of the project the template will run in. */
7194
+ 'project': {
7195
+ /** The ID of the project to use. */
7196
+ 'id': string;
7197
+ } | {
7198
+ /** Details about the project to create. */
7199
+ 'spec': {
7200
+ /** The name of the project. Example: "New Project" */
7201
+ 'name': string;
7202
+ /** The description of the project. Example: "This is a new project." */
7203
+ 'description'?: string;
7204
+ /** The region the project will be hosted in. Example: "europe-west" */
7205
+ 'region'?: string;
7206
+ /** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
7207
+ 'clusterId'?: string;
7208
+ /** The color of the project in the Northflank App. Example: "#EF233C" */
7209
+ 'color'?: string;
7210
+ };
7211
+ };
7212
+ 'spec': any;
7213
+ };
7214
+ /** Update a template */
7215
+ declare class UpdateTemplateEndpoint extends PostApiEndpoint<UpdateTemplateRequest, UpdateTemplateResult> {
7216
+ description: string;
7217
+ withAuth: boolean;
7218
+ requiredPermissions: string;
7219
+ endpointUrl: (opts: UpdateTemplateRequest) => string;
7220
+ body: (payload: UpdateTemplateRequest) => string;
7221
+ }
7222
+
7223
+ declare type DeleteTemplateResult = any;
7224
+ declare type DeleteTemplateCall = (opts: DeleteTemplateRequest) => Promise<ApiCallResponse<DeleteTemplateResult>>;
7225
+ declare type DeleteTemplateRequest = {
7226
+ parameters: DeleteTemplateParameters;
7227
+ };
7228
+ declare type DeleteTemplateParameters = {
7229
+ /** ID of the template */ 'templateId': string;
7230
+ };
7231
+ /** Delete a template */
7232
+ declare class DeleteTemplateEndpoint extends DeleteApiEndpoint<DeleteTemplateRequest, DeleteTemplateResult> {
7233
+ description: string;
7234
+ withAuth: boolean;
7235
+ requiredPermissions: string;
7236
+ endpointUrl: (opts: DeleteTemplateRequest) => string;
7237
+ body: () => undefined;
7238
+ }
7239
+
7240
+ declare type RunTemplateResult = {
7241
+ /** ID of the template run. Example: "501c1e03-a021-4659-9048-85f8f6ee2bc7" */
7242
+ 'id': string;
7243
+ /** Timestamp of when the run was initiated. Example: "2022-06-14 15:10:42.842Z" */
7244
+ 'createdAt': string;
7245
+ /** Timestamp of when the run was last updated. Example: "2022-06-14 15:10:42.842Z" */
7246
+ 'updatedAt': string;
7247
+ /** Details about the template being run. */
7248
+ 'template': {
7249
+ /** ID of the template Example: "example-template" */
7250
+ 'id': string;
7251
+ /** The name of the template Example: "Example Template" */
7252
+ 'name': string;
7253
+ };
7254
+ /** Status of the template run. Example: "success" */
7255
+ 'status': 'waiting' | 'failure' | 'retrying' | 'success' | 'unknown';
7256
+ /** Details about the template run. */
7257
+ 'content': {
7258
+ /** Name of the template. Example: "Example Template" */
7259
+ 'name': string;
7260
+ /** Description of the template. Example: "This is a sample template." */
7261
+ 'description'?: string;
7262
+ /** The version of the Northflank API to run the template against. Example: "v1" */
7263
+ 'apiVersion': 'v1';
7264
+ /** Details of the project the template will run in. */
7265
+ 'project': {
7266
+ /** The ID of the project to use. */
7267
+ 'id': string;
7268
+ } | {
7269
+ /** Details about the project to create. */
7270
+ 'spec': {
7271
+ /** The name of the project. Example: "New Project" */
7272
+ 'name': string;
7273
+ /** The description of the project. Example: "This is a new project." */
7274
+ 'description'?: string;
7275
+ /** The region the project will be hosted in. Example: "europe-west" */
7276
+ 'region'?: string;
7277
+ /** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
7278
+ 'clusterId'?: string;
7279
+ /** The color of the project in the Northflank App. Example: "#EF233C" */
7280
+ 'color'?: string;
7281
+ };
7282
+ };
7283
+ 'spec': any;
7284
+ };
7285
+ };
7286
+ declare type RunTemplateCall = (opts: RunTemplateRequest) => Promise<ApiCallResponse<RunTemplateResult>>;
7287
+ declare type RunTemplateRequest = {
7288
+ parameters: RunTemplateParameters;
7289
+ };
7290
+ declare type RunTemplateParameters = {
7291
+ /** ID of the template */ 'templateId': string;
7292
+ };
7293
+ /** Run a template */
7294
+ declare class RunTemplateEndpoint extends PostApiEndpoint<RunTemplateRequest, RunTemplateResult> {
7295
+ description: string;
7296
+ withAuth: boolean;
7297
+ requiredPermissions: string;
7298
+ endpointUrl: (opts: RunTemplateRequest) => string;
7299
+ body: () => undefined;
7300
+ }
7301
+
7302
+ declare type ListTemplaterunsResult = {
7303
+ /** An array of template run objects. */
7304
+ 'templateRuns': {
7305
+ /** ID of the template run. Example: "501c1e03-a021-4659-9048-85f8f6ee2bc7" */
7306
+ 'id': string;
7307
+ /** Timestamp of when the run was initiated. Example: "2022-06-14 15:10:42.842Z" */
7308
+ 'createdAt': string;
7309
+ /** Timestamp of when the run was last updated. Example: "2022-06-14 15:10:42.842Z" */
7310
+ 'updatedAt': string;
7311
+ /** Details about the template being run. */
7312
+ 'template': {
7313
+ /** ID of the template Example: "example-template" */
7314
+ 'id': string;
7315
+ /** The name of the template Example: "Example Template" */
7316
+ 'name': string;
7317
+ };
7318
+ /** Details about the template run. */
7319
+ 'content': {
7320
+ /** Name of the template. Example: "Example Template" */
7321
+ 'name': string;
7322
+ /** Description of the template. Example: "This is a sample template." */
7323
+ 'description'?: string;
7324
+ /** The version of the Northflank API to run the template against. Example: "v1" */
7325
+ 'apiVersion': 'v1';
7326
+ };
7327
+ /** Status of the template run. Example: "success" */
7328
+ 'status': 'waiting' | 'failure' | 'retrying' | 'success' | 'unknown';
7329
+ }[];
7330
+ };
7331
+ declare type ListTemplaterunsCall = (opts: ListTemplaterunsRequest) => Promise<ApiCallResponse<ListTemplaterunsResult>>;
7332
+ declare type ListTemplaterunsRequest = {
7333
+ parameters: ListTemplaterunsParameters;
7334
+ options?: ListTemplaterunsOptions;
7335
+ };
7336
+ declare type ListTemplaterunsParameters = {
7337
+ /** ID of the template */ 'templateId': string;
7338
+ };
7339
+ declare type ListTemplaterunsOptions = {
7340
+ /** The number of results to display per request. Maximum of 100 results per page. */
7341
+ 'per_page'?: number;
7342
+ /** The page number to access. */
7343
+ 'page'?: number;
7344
+ /** The cursor returned from the previous page of results, used to request the next page. */
7345
+ 'cursor'?: string;
7346
+ };
7347
+ /** Get a list of template runs */
7348
+ declare class ListTemplaterunsEndpoint extends GetApiEndpoint<ListTemplaterunsRequest, ListTemplaterunsResult> {
7349
+ description: string;
7350
+ withAuth: boolean;
7351
+ requiredPermissions: string;
7352
+ endpointUrl: (opts: ListTemplaterunsRequest) => string;
7353
+ body: () => undefined;
7354
+ }
7355
+
7356
+ declare type GetTemplaterunResult = {
7357
+ /** ID of the template run. Example: "501c1e03-a021-4659-9048-85f8f6ee2bc7" */
7358
+ 'id': string;
7359
+ /** Timestamp of when the run was initiated. Example: "2022-06-14 15:10:42.842Z" */
7360
+ 'createdAt': string;
7361
+ /** Timestamp of when the run was last updated. Example: "2022-06-14 15:10:42.842Z" */
7362
+ 'updatedAt': string;
7363
+ /** Details about the template being run. */
7364
+ 'template': {
7365
+ /** ID of the template Example: "example-template" */
7366
+ 'id': string;
7367
+ /** The name of the template Example: "Example Template" */
7368
+ 'name': string;
7369
+ };
7370
+ /** Status of the template run. Example: "success" */
7371
+ 'status': 'waiting' | 'failure' | 'retrying' | 'success' | 'unknown';
7372
+ /** Details about the template run. */
7373
+ 'content': {
7374
+ /** Name of the template. Example: "Example Template" */
7375
+ 'name': string;
7376
+ /** Description of the template. Example: "This is a sample template." */
7377
+ 'description'?: string;
7378
+ /** The version of the Northflank API to run the template against. Example: "v1" */
7379
+ 'apiVersion': 'v1';
7380
+ /** Details of the project the template will run in. */
7381
+ 'project': {
7382
+ /** The ID of the project to use. */
7383
+ 'id': string;
7384
+ } | {
7385
+ /** Details about the project to create. */
7386
+ 'spec': {
7387
+ /** The name of the project. Example: "New Project" */
7388
+ 'name': string;
7389
+ /** The description of the project. Example: "This is a new project." */
7390
+ 'description'?: string;
7391
+ /** The region the project will be hosted in. Example: "europe-west" */
7392
+ 'region'?: string;
7393
+ /** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
7394
+ 'clusterId'?: string;
7395
+ /** The color of the project in the Northflank App. Example: "#EF233C" */
7396
+ 'color'?: string;
7397
+ };
7398
+ };
7399
+ 'spec': any;
7400
+ };
7401
+ };
7402
+ declare type GetTemplaterunCall = (opts: GetTemplaterunRequest) => Promise<ApiCallResponse<GetTemplaterunResult>>;
7403
+ declare type GetTemplaterunRequest = {
7404
+ parameters: GetTemplaterunParameters;
7405
+ options?: GetTemplaterunOptions;
7406
+ };
7407
+ declare type GetTemplaterunParameters = {
7408
+ /** ID of the template */ 'templateId': string;
7409
+ /** ID of the template run */
7410
+ 'templateRunId': string;
7411
+ };
7412
+ declare type GetTemplaterunOptions = {
7413
+ /** The number of results to display per request. Maximum of 100 results per page. */
7414
+ 'per_page'?: number;
7415
+ /** The page number to access. */
7416
+ 'page'?: number;
7417
+ /** The cursor returned from the previous page of results, used to request the next page. */
7418
+ 'cursor'?: string;
7419
+ };
7420
+ /** Get information about the given template run. */
7421
+ declare class GetTemplaterunEndpoint extends GetApiEndpoint<GetTemplaterunRequest, GetTemplaterunResult> {
7422
+ description: string;
7423
+ withAuth: boolean;
7424
+ requiredPermissions: string;
7425
+ endpointUrl: (opts: GetTemplaterunRequest) => string;
7426
+ body: () => undefined;
7427
+ }
7428
+
5516
7429
  declare type ListReposResult = {
5517
7430
  /** A list of accessible repositories. */
5518
7431
  'repos'?: {
@@ -5559,6 +7472,7 @@ declare type ListReposOptions = {
5559
7472
  declare class ListReposEndpoint extends GetApiEndpoint<ListReposRequest, ListReposResult> {
5560
7473
  description: string;
5561
7474
  withAuth: boolean;
7475
+ requiredPermissions: string;
5562
7476
  endpointUrl: (opts: ListReposRequest) => string;
5563
7477
  body: () => undefined;
5564
7478
  }
@@ -5609,6 +7523,7 @@ declare type ListBranchesOptions = {
5609
7523
  declare class ListBranchesEndpoint extends GetApiEndpoint<ListBranchesRequest, ListBranchesResult> {
5610
7524
  description: string;
5611
7525
  withAuth: boolean;
7526
+ requiredPermissions: string;
5612
7527
  endpointUrl: (opts: ListBranchesRequest) => string;
5613
7528
  body: () => undefined;
5614
7529
  }
@@ -5618,9 +7533,16 @@ declare type ListVolumesResult = {
5618
7533
  'id': string;
5619
7534
  /** Volume name Example: "Example Volume" */
5620
7535
  'name': string;
5621
- /** Information about the desired size and type of the volume. Storage class is only configurable with the relevant feature flag enabled for your account, */
7536
+ /** Information about the desired size and type of the volume. Storage class is only configurable with the relevant feature flag enabled for your account. */
5622
7537
  'spec': {
5623
- 'storageClassName'?: 'ssd' | 'hdd';
7538
+ /** The type of the storage. Example: "ssd" */
7539
+ 'storageClassName'?: 'ssd';
7540
+ /** Storage size of the SSD. Example: 4096 */
7541
+ 'storageSize': number;
7542
+ } | {
7543
+ /** The type of the storage. Example: "hdd" */
7544
+ 'storageClassName': 'hdd';
7545
+ /** Storage size of the HDD. Example: 40960 */
5624
7546
  'storageSize': number;
5625
7547
  };
5626
7548
  /** The object to attach this volume to. */
@@ -5648,6 +7570,7 @@ declare type ListVolumesParameters = {
5648
7570
  declare class ListVolumesEndpoint extends GetApiEndpoint<ListVolumesRequest, ListVolumesResult> {
5649
7571
  description: string;
5650
7572
  withAuth: boolean;
7573
+ requiredPermissions: string;
5651
7574
  endpointUrl: (opts: ListVolumesRequest) => string;
5652
7575
  body: () => undefined;
5653
7576
  }
@@ -5657,9 +7580,16 @@ declare type CreateVolumeResult = {
5657
7580
  'id': string;
5658
7581
  /** Volume name Example: "Example Volume" */
5659
7582
  'name': string;
5660
- /** Information about the desired size and type of the volume. Storage class is only configurable with the relevant feature flag enabled for your account, */
7583
+ /** Information about the desired size and type of the volume. Storage class is only configurable with the relevant feature flag enabled for your account. */
5661
7584
  'spec': {
5662
- 'storageClassName'?: 'ssd' | 'hdd';
7585
+ /** The type of the storage. Example: "ssd" */
7586
+ 'storageClassName'?: 'ssd';
7587
+ /** Storage size of the SSD. Example: 4096 */
7588
+ 'storageSize': number;
7589
+ } | {
7590
+ /** The type of the storage. Example: "hdd" */
7591
+ 'storageClassName': 'hdd';
7592
+ /** Storage size of the HDD. Example: 40960 */
5663
7593
  'storageSize': number;
5664
7594
  };
5665
7595
  /** The object to attach this volume to. */
@@ -5694,9 +7624,16 @@ declare type CreateVolumeData = {
5694
7624
  /** Specify the path into which the volume should be mounted Example: "/container" */
5695
7625
  'containerMountPath': string;
5696
7626
  }[];
5697
- /** Information about the desired size and type of the volume. Storage class is only configurable with the relevant feature flag enabled for your account, */
7627
+ /** Information about the desired size and type of the volume. Storage class is only configurable with the relevant feature flag enabled for your account. */
5698
7628
  'spec': {
5699
- 'storageClassName'?: 'ssd' | 'hdd';
7629
+ /** The type of the storage. Example: "ssd" */
7630
+ 'storageClassName'?: 'ssd';
7631
+ /** Storage size of the SSD. Example: 4096 */
7632
+ 'storageSize': number;
7633
+ } | {
7634
+ /** The type of the storage. Example: "hdd" */
7635
+ 'storageClassName': 'hdd';
7636
+ /** Storage size of the HDD. Example: 40960 */
5700
7637
  'storageSize': number;
5701
7638
  };
5702
7639
  /** The object to attach this volume to. */
@@ -5711,6 +7648,7 @@ declare type CreateVolumeData = {
5711
7648
  declare class CreateVolumeEndpoint extends PostApiEndpoint<CreateVolumeRequest, CreateVolumeResult> {
5712
7649
  description: string;
5713
7650
  withAuth: boolean;
7651
+ requiredPermissions: string;
5714
7652
  endpointUrl: (opts: CreateVolumeRequest) => string;
5715
7653
  body: (payload: CreateVolumeRequest) => string;
5716
7654
  }
@@ -5720,9 +7658,16 @@ declare type GetVolumeResult = {
5720
7658
  'id': string;
5721
7659
  /** Volume name Example: "Example Volume" */
5722
7660
  'name': string;
5723
- /** Information about the desired size and type of the volume. Storage class is only configurable with the relevant feature flag enabled for your account, */
7661
+ /** Information about the desired size and type of the volume. Storage class is only configurable with the relevant feature flag enabled for your account. */
5724
7662
  'spec': {
5725
- 'storageClassName'?: 'ssd' | 'hdd';
7663
+ /** The type of the storage. Example: "ssd" */
7664
+ 'storageClassName'?: 'ssd';
7665
+ /** Storage size of the SSD. Example: 4096 */
7666
+ 'storageSize': number;
7667
+ } | {
7668
+ /** The type of the storage. Example: "hdd" */
7669
+ 'storageClassName': 'hdd';
7670
+ /** Storage size of the HDD. Example: 40960 */
5726
7671
  'storageSize': number;
5727
7672
  };
5728
7673
  /** The object to attach this volume to. */
@@ -5752,6 +7697,7 @@ declare type GetVolumeParameters = {
5752
7697
  declare class GetVolumeEndpoint extends GetApiEndpoint<GetVolumeRequest, GetVolumeResult> {
5753
7698
  description: string;
5754
7699
  withAuth: boolean;
7700
+ requiredPermissions: string;
5755
7701
  endpointUrl: (opts: GetVolumeRequest) => string;
5756
7702
  body: () => undefined;
5757
7703
  }
@@ -5784,6 +7730,7 @@ declare type UpdateVolumeData = {
5784
7730
  declare class UpdateVolumeEndpoint extends PostApiEndpoint<UpdateVolumeRequest, UpdateVolumeResult> {
5785
7731
  description: string;
5786
7732
  withAuth: boolean;
7733
+ requiredPermissions: string;
5787
7734
  endpointUrl: (opts: UpdateVolumeRequest) => string;
5788
7735
  body: (payload: UpdateVolumeRequest) => string;
5789
7736
  }
@@ -5802,6 +7749,7 @@ declare type DeleteVolumeParameters = {
5802
7749
  declare class DeleteVolumeEndpoint extends DeleteApiEndpoint<DeleteVolumeRequest, DeleteVolumeResult> {
5803
7750
  description: string;
5804
7751
  withAuth: boolean;
7752
+ requiredPermissions: string;
5805
7753
  endpointUrl: (opts: DeleteVolumeRequest) => string;
5806
7754
  body: () => undefined;
5807
7755
  }
@@ -5830,6 +7778,7 @@ declare type AttachVolumeData = {
5830
7778
  declare class AttachVolumeEndpoint extends PostApiEndpoint<AttachVolumeRequest, AttachVolumeResult> {
5831
7779
  description: string;
5832
7780
  withAuth: boolean;
7781
+ requiredPermissions: string;
5833
7782
  endpointUrl: (opts: AttachVolumeRequest) => string;
5834
7783
  body: (payload: AttachVolumeRequest) => string;
5835
7784
  }
@@ -5850,6 +7799,7 @@ declare type DetachVolumeData = any;
5850
7799
  declare class DetachVolumeEndpoint extends PostApiEndpoint<DetachVolumeRequest, DetachVolumeResult> {
5851
7800
  description: string;
5852
7801
  withAuth: boolean;
7802
+ requiredPermissions: string;
5853
7803
  endpointUrl: (opts: DetachVolumeRequest) => string;
5854
7804
  body: (payload: DetachVolumeRequest) => string;
5855
7805
  }
@@ -5878,6 +7828,7 @@ declare type GetServiceBuildargumentsOptions = {
5878
7828
  declare class GetServiceBuildargumentsEndpoint extends GetApiEndpoint<GetServiceBuildargumentsRequest, GetServiceBuildargumentsResult> {
5879
7829
  description: string;
5880
7830
  withAuth: boolean;
7831
+ requiredPermissions: string;
5881
7832
  endpointUrl: (opts: GetServiceBuildargumentsRequest) => string;
5882
7833
  body: () => undefined;
5883
7834
  }
@@ -5906,6 +7857,7 @@ declare type UpdateServiceBuildargumentsData = {
5906
7857
  declare class UpdateServiceBuildargumentsEndpoint extends PostApiEndpoint<UpdateServiceBuildargumentsRequest, UpdateServiceBuildargumentsResult> {
5907
7858
  description: string;
5908
7859
  withAuth: boolean;
7860
+ requiredPermissions: string;
5909
7861
  endpointUrl: (opts: UpdateServiceBuildargumentsRequest) => string;
5910
7862
  body: (payload: UpdateServiceBuildargumentsRequest) => string;
5911
7863
  }
@@ -5976,6 +7928,7 @@ declare type GetServiceBuildargumentdetailsParameters = {
5976
7928
  declare class GetServiceBuildargumentdetailsEndpoint extends GetApiEndpoint<GetServiceBuildargumentdetailsRequest, GetServiceBuildargumentdetailsResult> {
5977
7929
  description: string;
5978
7930
  withAuth: boolean;
7931
+ requiredPermissions: string;
5979
7932
  endpointUrl: (opts: GetServiceBuildargumentdetailsRequest) => string;
5980
7933
  body: () => undefined;
5981
7934
  }
@@ -6004,6 +7957,7 @@ declare type GetServiceRuntimeenvironmentOptions = {
6004
7957
  declare class GetServiceRuntimeenvironmentEndpoint extends GetApiEndpoint<GetServiceRuntimeenvironmentRequest, GetServiceRuntimeenvironmentResult> {
6005
7958
  description: string;
6006
7959
  withAuth: boolean;
7960
+ requiredPermissions: string;
6007
7961
  endpointUrl: (opts: GetServiceRuntimeenvironmentRequest) => string;
6008
7962
  body: () => undefined;
6009
7963
  }
@@ -6037,6 +7991,7 @@ declare type UpdateServiceRuntimeenvironmentData = {
6037
7991
  declare class UpdateServiceRuntimeenvironmentEndpoint extends PostApiEndpoint<UpdateServiceRuntimeenvironmentRequest, UpdateServiceRuntimeenvironmentResult> {
6038
7992
  description: string;
6039
7993
  withAuth: boolean;
7994
+ requiredPermissions: string;
6040
7995
  endpointUrl: (opts: UpdateServiceRuntimeenvironmentRequest) => string;
6041
7996
  body: (payload: UpdateServiceRuntimeenvironmentRequest) => string;
6042
7997
  }
@@ -6107,6 +8062,7 @@ declare type GetServiceRuntimeenvironmentdetailsParameters = {
6107
8062
  declare class GetServiceRuntimeenvironmentdetailsEndpoint extends GetApiEndpoint<GetServiceRuntimeenvironmentdetailsRequest, GetServiceRuntimeenvironmentdetailsResult> {
6108
8063
  description: string;
6109
8064
  withAuth: boolean;
8065
+ requiredPermissions: string;
6110
8066
  endpointUrl: (opts: GetServiceRuntimeenvironmentdetailsRequest) => string;
6111
8067
  body: () => undefined;
6112
8068
  }
@@ -6120,21 +8076,31 @@ declare class ApiClient {
6120
8076
  list: {
6121
8077
  projects: ListProjectsCall;
6122
8078
  addons: ListAddonsCall;
8079
+ invoices: ListInvoicesCall;
8080
+ providers: ListProvidersCall;
8081
+ integrations: ListIntegrationsCall;
8082
+ clusters: ListClustersCall;
6123
8083
  jobs: ListJobsCall;
6124
- registryCredentials: ListRegistrycredentialsCall;
8084
+ registries: ListRegistriesCall;
6125
8085
  domains: ListDomainsCall;
6126
8086
  plans: ListPlansCall;
6127
8087
  regions: ListRegionsCall;
6128
8088
  vcs: ListVcsCall;
6129
8089
  secrets: ListSecretsCall;
6130
8090
  services: ListServicesCall;
8091
+ templates: ListTemplatesCall;
8092
+ templateRuns: ListTemplaterunsCall;
6131
8093
  repos: ListReposCall;
6132
8094
  branches: ListBranchesCall;
6133
8095
  volumes: ListVolumesCall;
6134
8096
  };
6135
8097
  create: {
6136
8098
  project: CreateProjectCall;
6137
- addon: CreateAddonCall;
8099
+ addon: CreateAddonCall & {
8100
+ backupSchedule: CreateAddonBackupscheduleCall;
8101
+ };
8102
+ integration: CreateIntegrationCall;
8103
+ cluster: CreateClusterCall;
6138
8104
  job: {
6139
8105
  manual: CreateJobManualCall;
6140
8106
  cron: CreateJobCronCall;
@@ -6146,6 +8112,7 @@ declare class ApiClient {
6146
8112
  deployment: CreateServiceDeploymentCall;
6147
8113
  build: CreateServiceBuildCall;
6148
8114
  };
8115
+ template: CreateTemplateCall;
6149
8116
  volume: CreateVolumeCall;
6150
8117
  };
6151
8118
  get: {
@@ -6159,7 +8126,13 @@ declare class ApiClient {
6159
8126
  download: GetAddonBackupDownloadCall;
6160
8127
  };
6161
8128
  containers: GetAddonContainersCall;
8129
+ backupSchedules: GetAddonBackupschedulesCall;
8130
+ };
8131
+ invoice: {
8132
+ details: GetInvoiceDetailsCall;
6162
8133
  };
8134
+ integration: GetIntegrationCall;
8135
+ cluster: GetClusterCall;
6163
8136
  job: GetJobCall & {
6164
8137
  runs: GetJobRunsCall;
6165
8138
  run: GetJobRunCall;
@@ -6175,7 +8148,7 @@ declare class ApiClient {
6175
8148
  branches: GetJobBranchesCall;
6176
8149
  pullRequests: GetJobPullrequestsCall;
6177
8150
  };
6178
- registryCredentials: GetRegistrycredentialsCall;
8151
+ registry: GetRegistryCall;
6179
8152
  domain: GetDomainCall;
6180
8153
  subdomain: GetSubdomainCall;
6181
8154
  dnsId: GetDnsidCall;
@@ -6196,19 +8169,26 @@ declare class ApiClient {
6196
8169
  runtimeEnvironment: GetServiceRuntimeenvironmentCall;
6197
8170
  runtimeEnvironmentDetails: GetServiceRuntimeenvironmentdetailsCall;
6198
8171
  };
8172
+ template: GetTemplateCall;
8173
+ templateRun: GetTemplaterunCall;
6199
8174
  volume: GetVolumeCall;
6200
8175
  };
6201
8176
  delete: {
6202
8177
  project: DeleteProjectCall;
6203
- addon: DeleteAddonCall;
8178
+ addon: DeleteAddonCall & {
8179
+ backupSchedule: DeleteAddonBackupscheduleCall;
8180
+ };
6204
8181
  backup: DeleteBackupCall;
8182
+ integration: DeleteIntegrationCall;
8183
+ cluster: DeleteClusterCall;
6205
8184
  job: DeleteJobCall;
6206
- registryCredentials: DeleteRegistrycredentialsCall;
8185
+ registry: DeleteRegistryCall;
6207
8186
  domain: DeleteDomainCall;
6208
8187
  subdomain: DeleteSubdomainCall;
6209
8188
  secret: DeleteSecretCall;
6210
8189
  secretLink: DeleteSecretlinkCall;
6211
8190
  service: DeleteServiceCall;
8191
+ template: DeleteTemplateCall;
6212
8192
  volume: DeleteVolumeCall;
6213
8193
  };
6214
8194
  scale: {
@@ -6222,17 +8202,20 @@ declare class ApiClient {
6222
8202
  networkSettings: UpdateAddonNetworksettingsCall;
6223
8203
  security: UpdateAddonSecurityCall;
6224
8204
  };
8205
+ integration: UpdateIntegrationCall;
8206
+ cluster: UpdateClusterCall;
6225
8207
  job: {
6226
8208
  settings: UpdateJobSettingsCall;
6227
8209
  healthChecks: UpdateJobHealthchecksCall;
6228
8210
  buildOptions: UpdateJobBuildoptionsCall;
6229
8211
  buildSource: UpdateJobBuildsourceCall;
6230
8212
  cmdOverride: UpdateJobCmdoverrideCall;
8213
+ entrypointOverride: UpdateJobEntrypointoverrideCall;
6231
8214
  buildArguments: UpdateJobBuildargumentsCall;
6232
8215
  runtimeEnvironment: UpdateJobRuntimeenvironmentCall;
6233
8216
  deployment: UpdateJobDeploymentCall;
6234
8217
  };
6235
- registryCredentials: UpdateRegistrycredentialsCall;
8218
+ registry: UpdateRegistryCall;
6236
8219
  secret: UpdateSecretCall;
6237
8220
  secretLink: UpdateSecretlinkCall;
6238
8221
  service: {
@@ -6241,10 +8224,12 @@ declare class ApiClient {
6241
8224
  buildOptions: UpdateServiceBuildoptionsCall;
6242
8225
  buildSource: UpdateServiceBuildsourceCall;
6243
8226
  cmdOverride: UpdateServiceCmdoverrideCall;
8227
+ entrypointOverride: UpdateServiceEntrypointoverrideCall;
6244
8228
  healthChecks: UpdateServiceHealthchecksCall;
6245
8229
  buildArguments: UpdateServiceBuildargumentsCall;
6246
8230
  runtimeEnvironment: UpdateServiceRuntimeenvironmentCall;
6247
8231
  };
8232
+ template: UpdateTemplateCall;
6248
8233
  volume: UpdateVolumeCall;
6249
8234
  };
6250
8235
  backup: {
@@ -6262,10 +8247,12 @@ declare class ApiClient {
6262
8247
  };
6263
8248
  pause: {
6264
8249
  addon: PauseAddonCall;
8250
+ job: PauseJobCall;
6265
8251
  service: PauseServiceCall;
6266
8252
  };
6267
8253
  resume: {
6268
8254
  addon: ResumeAddonCall;
8255
+ job: ResumeJobCall;
6269
8256
  service: ResumeServiceCall;
6270
8257
  };
6271
8258
  restart: {
@@ -6285,6 +8272,14 @@ declare class ApiClient {
6285
8272
  build: AbortServiceBuildCall;
6286
8273
  };
6287
8274
  };
8275
+ retain: {
8276
+ addon: {
8277
+ backup: RetainAddonBackupCall;
8278
+ };
8279
+ };
8280
+ suspend: {
8281
+ job: SuspendJobCall;
8282
+ };
6288
8283
  start: {
6289
8284
  job: {
6290
8285
  run: StartJobRunCall;
@@ -6295,7 +8290,7 @@ declare class ApiClient {
6295
8290
  };
6296
8291
  };
6297
8292
  add: {
6298
- registryCredentials: AddRegistrycredentialsCall;
8293
+ registry: AddRegistryCall;
6299
8294
  domain: {
6300
8295
  subdomain: AddDomainSubdomainCall;
6301
8296
  };
@@ -6312,6 +8307,9 @@ declare class ApiClient {
6312
8307
  unassign: {
6313
8308
  subdomain: UnassignSubdomainCall;
6314
8309
  };
8310
+ run: {
8311
+ template: RunTemplateCall;
8312
+ };
6315
8313
  attach: {
6316
8314
  volume: AttachVolumeCall;
6317
8315
  };
@@ -6322,21 +8320,31 @@ declare class ApiClient {
6322
8320
  list: {
6323
8321
  projects: ListProjectsEndpoint;
6324
8322
  addons: ListAddonsEndpoint;
8323
+ invoices: ListInvoicesEndpoint;
8324
+ providers: ListProvidersEndpoint;
8325
+ integrations: ListIntegrationsEndpoint;
8326
+ clusters: ListClustersEndpoint;
6325
8327
  jobs: ListJobsEndpoint;
6326
- registryCredentials: ListRegistrycredentialsEndpoint;
8328
+ registries: ListRegistriesEndpoint;
6327
8329
  domains: ListDomainsEndpoint;
6328
8330
  plans: ListPlansEndpoint;
6329
8331
  regions: ListRegionsEndpoint;
6330
8332
  vcs: ListVcsEndpoint;
6331
8333
  secrets: ListSecretsEndpoint;
6332
8334
  services: ListServicesEndpoint;
8335
+ templates: ListTemplatesEndpoint;
8336
+ templateRuns: ListTemplaterunsEndpoint;
6333
8337
  repos: ListReposEndpoint;
6334
8338
  branches: ListBranchesEndpoint;
6335
8339
  volumes: ListVolumesEndpoint;
6336
8340
  };
6337
8341
  create: {
6338
8342
  project: CreateProjectEndpoint;
6339
- addon: CreateAddonEndpoint;
8343
+ addon: CreateAddonEndpoint & {
8344
+ backupSchedule: CreateAddonBackupscheduleEndpoint;
8345
+ };
8346
+ integration: CreateIntegrationEndpoint;
8347
+ cluster: CreateClusterEndpoint;
6340
8348
  job: {
6341
8349
  manual: CreateJobManualEndpoint;
6342
8350
  cron: CreateJobCronEndpoint;
@@ -6348,6 +8356,7 @@ declare class ApiClient {
6348
8356
  deployment: CreateServiceDeploymentEndpoint;
6349
8357
  build: CreateServiceBuildEndpoint;
6350
8358
  };
8359
+ template: CreateTemplateEndpoint;
6351
8360
  volume: CreateVolumeEndpoint;
6352
8361
  };
6353
8362
  get: {
@@ -6361,7 +8370,13 @@ declare class ApiClient {
6361
8370
  download: GetAddonBackupDownloadEndpoint;
6362
8371
  };
6363
8372
  containers: GetAddonContainersEndpoint;
8373
+ backupSchedules: GetAddonBackupschedulesEndpoint;
8374
+ };
8375
+ invoice: {
8376
+ details: GetInvoiceDetailsEndpoint;
6364
8377
  };
8378
+ integration: GetIntegrationEndpoint;
8379
+ cluster: GetClusterEndpoint;
6365
8380
  job: GetJobEndpoint & {
6366
8381
  runs: GetJobRunsEndpoint;
6367
8382
  run: GetJobRunEndpoint;
@@ -6377,7 +8392,7 @@ declare class ApiClient {
6377
8392
  branches: GetJobBranchesEndpoint;
6378
8393
  pullRequests: GetJobPullrequestsEndpoint;
6379
8394
  };
6380
- registryCredentials: GetRegistrycredentialsEndpoint;
8395
+ registry: GetRegistryEndpoint;
6381
8396
  domain: GetDomainEndpoint;
6382
8397
  subdomain: GetSubdomainEndpoint;
6383
8398
  dnsId: GetDnsidEndpoint;
@@ -6398,19 +8413,26 @@ declare class ApiClient {
6398
8413
  runtimeEnvironment: GetServiceRuntimeenvironmentEndpoint;
6399
8414
  runtimeEnvironmentDetails: GetServiceRuntimeenvironmentdetailsEndpoint;
6400
8415
  };
8416
+ template: GetTemplateEndpoint;
8417
+ templateRun: GetTemplaterunEndpoint;
6401
8418
  volume: GetVolumeEndpoint;
6402
8419
  };
6403
8420
  delete: {
6404
8421
  project: DeleteProjectEndpoint;
6405
- addon: DeleteAddonEndpoint;
8422
+ addon: DeleteAddonEndpoint & {
8423
+ backupSchedule: DeleteAddonBackupscheduleEndpoint;
8424
+ };
6406
8425
  backup: DeleteBackupEndpoint;
8426
+ integration: DeleteIntegrationEndpoint;
8427
+ cluster: DeleteClusterEndpoint;
6407
8428
  job: DeleteJobEndpoint;
6408
- registryCredentials: DeleteRegistrycredentialsEndpoint;
8429
+ registry: DeleteRegistryEndpoint;
6409
8430
  domain: DeleteDomainEndpoint;
6410
8431
  subdomain: DeleteSubdomainEndpoint;
6411
8432
  secret: DeleteSecretEndpoint;
6412
8433
  secretLink: DeleteSecretlinkEndpoint;
6413
8434
  service: DeleteServiceEndpoint;
8435
+ template: DeleteTemplateEndpoint;
6414
8436
  volume: DeleteVolumeEndpoint;
6415
8437
  };
6416
8438
  scale: {
@@ -6424,17 +8446,20 @@ declare class ApiClient {
6424
8446
  networkSettings: UpdateAddonNetworksettingsEndpoint;
6425
8447
  security: UpdateAddonSecurityEndpoint;
6426
8448
  };
8449
+ integration: UpdateIntegrationEndpoint;
8450
+ cluster: UpdateClusterEndpoint;
6427
8451
  job: {
6428
8452
  settings: UpdateJobSettingsEndpoint;
6429
8453
  healthChecks: UpdateJobHealthchecksEndpoint;
6430
8454
  buildOptions: UpdateJobBuildoptionsEndpoint;
6431
8455
  buildSource: UpdateJobBuildsourceEndpoint;
6432
8456
  cmdOverride: UpdateJobCmdoverrideEndpoint;
8457
+ entrypointOverride: UpdateJobEntrypointoverrideEndpoint;
6433
8458
  buildArguments: UpdateJobBuildargumentsEndpoint;
6434
8459
  runtimeEnvironment: UpdateJobRuntimeenvironmentEndpoint;
6435
8460
  deployment: UpdateJobDeploymentEndpoint;
6436
8461
  };
6437
- registryCredentials: UpdateRegistrycredentialsEndpoint;
8462
+ registry: UpdateRegistryEndpoint;
6438
8463
  secret: UpdateSecretEndpoint;
6439
8464
  secretLink: UpdateSecretlinkEndpoint;
6440
8465
  service: {
@@ -6443,10 +8468,12 @@ declare class ApiClient {
6443
8468
  buildOptions: UpdateServiceBuildoptionsEndpoint;
6444
8469
  buildSource: UpdateServiceBuildsourceEndpoint;
6445
8470
  cmdOverride: UpdateServiceCmdoverrideEndpoint;
8471
+ entrypointOverride: UpdateServiceEntrypointoverrideEndpoint;
6446
8472
  healthChecks: UpdateServiceHealthchecksEndpoint;
6447
8473
  buildArguments: UpdateServiceBuildargumentsEndpoint;
6448
8474
  runtimeEnvironment: UpdateServiceRuntimeenvironmentEndpoint;
6449
8475
  };
8476
+ template: UpdateTemplateEndpoint;
6450
8477
  volume: UpdateVolumeEndpoint;
6451
8478
  };
6452
8479
  backup: {
@@ -6464,10 +8491,12 @@ declare class ApiClient {
6464
8491
  };
6465
8492
  pause: {
6466
8493
  addon: PauseAddonEndpoint;
8494
+ job: PauseJobEndpoint;
6467
8495
  service: PauseServiceEndpoint;
6468
8496
  };
6469
8497
  resume: {
6470
8498
  addon: ResumeAddonEndpoint;
8499
+ job: ResumeJobEndpoint;
6471
8500
  service: ResumeServiceEndpoint;
6472
8501
  };
6473
8502
  restart: {
@@ -6487,6 +8516,14 @@ declare class ApiClient {
6487
8516
  build: AbortServiceBuildEndpoint;
6488
8517
  };
6489
8518
  };
8519
+ retain: {
8520
+ addon: {
8521
+ backup: RetainAddonBackupEndpoint;
8522
+ };
8523
+ };
8524
+ suspend: {
8525
+ job: SuspendJobEndpoint;
8526
+ };
6490
8527
  start: {
6491
8528
  job: {
6492
8529
  run: StartJobRunEndpoint;
@@ -6497,7 +8534,7 @@ declare class ApiClient {
6497
8534
  };
6498
8535
  };
6499
8536
  add: {
6500
- registryCredentials: AddRegistrycredentialsEndpoint;
8537
+ registry: AddRegistryEndpoint;
6501
8538
  domain: {
6502
8539
  subdomain: AddDomainSubdomainEndpoint;
6503
8540
  };
@@ -6514,6 +8551,9 @@ declare class ApiClient {
6514
8551
  unassign: {
6515
8552
  subdomain: UnassignSubdomainEndpoint;
6516
8553
  };
8554
+ run: {
8555
+ template: RunTemplateEndpoint;
8556
+ };
6517
8557
  attach: {
6518
8558
  volume: AttachVolumeEndpoint;
6519
8559
  };
@@ -6529,4 +8569,4 @@ declare type ApiClientOpts = {
6529
8569
  customUserAgent?: string;
6530
8570
  };
6531
8571
 
6532
- export { AbortAddonBackupCall, AbortAddonBackupEndpoint, AbortAddonBackupParameters, AbortAddonBackupRequest, AbortAddonBackupResult, AbortAddonRestoreCall, AbortAddonRestoreData, AbortAddonRestoreEndpoint, AbortAddonRestoreParameters, AbortAddonRestoreRequest, AbortAddonRestoreResult, AbortJobBuildCall, AbortJobBuildEndpoint, AbortJobBuildParameters, AbortJobBuildRequest, AbortJobBuildResult, AbortJobRunCall, AbortJobRunEndpoint, AbortJobRunParameters, AbortJobRunRequest, AbortJobRunResult, AbortServiceBuildCall, AbortServiceBuildEndpoint, AbortServiceBuildParameters, AbortServiceBuildRequest, AbortServiceBuildResult, AddDomainSubdomainCall, AddDomainSubdomainData, AddDomainSubdomainEndpoint, AddDomainSubdomainParameters, AddDomainSubdomainRequest, AddDomainSubdomainResult, AddRegistrycredentialsCall, AddRegistrycredentialsData, AddRegistrycredentialsEndpoint, AddRegistrycredentialsRequest, AddRegistrycredentialsResult, ApiCallError, ApiCallResponse, ApiClient, ApiClientContext, ApiClientContextProvider, ApiClientContextWrapper, ApiClientFileContextProvider, ApiClientInMemoryContextProvider, ApiClientOpts, ApiEndpoint, AssignSubdomainServiceCall, AssignSubdomainServiceData, AssignSubdomainServiceEndpoint, AssignSubdomainServiceParameters, AssignSubdomainServiceRequest, AssignSubdomainServiceResult, AttachVolumeCall, AttachVolumeData, AttachVolumeEndpoint, AttachVolumeParameters, AttachVolumeRequest, AttachVolumeResult, BackupAddonCall, BackupAddonData, BackupAddonEndpoint, BackupAddonParameters, BackupAddonRequest, BackupAddonResult, CommandResult, CreateAddonCall, CreateAddonData, CreateAddonEndpoint, CreateAddonParameters, CreateAddonRequest, CreateAddonResult, CreateDomainCall, CreateDomainData, CreateDomainEndpoint, CreateDomainRequest, CreateDomainResult, CreateJobCronCall, CreateJobCronData, CreateJobCronEndpoint, CreateJobCronParameters, CreateJobCronRequest, CreateJobCronResult, CreateJobManualCall, CreateJobManualData, CreateJobManualEndpoint, CreateJobManualParameters, CreateJobManualRequest, CreateJobManualResult, CreateProjectCall, CreateProjectData, CreateProjectEndpoint, CreateProjectRequest, CreateProjectResult, CreateSecretCall, CreateSecretData, CreateSecretEndpoint, CreateSecretParameters, CreateSecretRequest, CreateSecretResult, CreateServiceBuildCall, CreateServiceBuildData, CreateServiceBuildEndpoint, CreateServiceBuildParameters, CreateServiceBuildRequest, CreateServiceBuildResult, CreateServiceCombinedCall, CreateServiceCombinedData, CreateServiceCombinedEndpoint, CreateServiceCombinedParameters, CreateServiceCombinedRequest, CreateServiceCombinedResult, CreateServiceDeploymentCall, CreateServiceDeploymentData, CreateServiceDeploymentEndpoint, CreateServiceDeploymentParameters, CreateServiceDeploymentRequest, CreateServiceDeploymentResult, CreateVolumeCall, CreateVolumeData, CreateVolumeEndpoint, CreateVolumeParameters, CreateVolumeRequest, CreateVolumeResult, DeleteAddonCall, DeleteAddonEndpoint, DeleteAddonParameters, DeleteAddonRequest, DeleteAddonResult, DeleteApiEndpoint, DeleteBackupCall, DeleteBackupEndpoint, DeleteBackupParameters, DeleteBackupRequest, DeleteBackupResult, DeleteDomainCall, DeleteDomainEndpoint, DeleteDomainParameters, DeleteDomainRequest, DeleteDomainResult, DeleteJobCall, DeleteJobEndpoint, DeleteJobParameters, DeleteJobRequest, DeleteJobResult, DeleteProjectCall, DeleteProjectEndpoint, DeleteProjectParameters, DeleteProjectRequest, DeleteProjectResult, DeleteRegistrycredentialsCall, DeleteRegistrycredentialsEndpoint, DeleteRegistrycredentialsParameters, DeleteRegistrycredentialsRequest, DeleteRegistrycredentialsResult, DeleteSecretCall, DeleteSecretEndpoint, DeleteSecretParameters, DeleteSecretRequest, DeleteSecretResult, DeleteSecretlinkCall, DeleteSecretlinkEndpoint, DeleteSecretlinkParameters, DeleteSecretlinkRequest, DeleteSecretlinkResult, DeleteServiceCall, DeleteServiceEndpoint, DeleteServiceParameters, DeleteServiceRequest, DeleteServiceResult, DeleteSubdomainCall, DeleteSubdomainEndpoint, DeleteSubdomainParameters, DeleteSubdomainRequest, DeleteSubdomainResult, DeleteVolumeCall, DeleteVolumeEndpoint, DeleteVolumeParameters, DeleteVolumeRequest, DeleteVolumeResult, DetachVolumeCall, DetachVolumeData, DetachVolumeEndpoint, DetachVolumeParameters, DetachVolumeRequest, DetachVolumeResult, ExecCommand, ExecCommandData, ExecCommandStandard, ExecSessionData, GetAddonBackupCall, GetAddonBackupDownloadCall, GetAddonBackupDownloadEndpoint, GetAddonBackupDownloadParameters, GetAddonBackupDownloadRequest, GetAddonBackupDownloadResult, GetAddonBackupEndpoint, GetAddonBackupParameters, GetAddonBackupRequest, GetAddonBackupResult, GetAddonBackupsCall, GetAddonBackupsEndpoint, GetAddonBackupsOptions, GetAddonBackupsParameters, GetAddonBackupsRequest, GetAddonBackupsResult, GetAddonCall, GetAddonContainersCall, GetAddonContainersEndpoint, GetAddonContainersOptions, GetAddonContainersParameters, GetAddonContainersRequest, GetAddonContainersResult, GetAddonCredentialsCall, GetAddonCredentialsEndpoint, GetAddonCredentialsParameters, GetAddonCredentialsRequest, GetAddonCredentialsResult, GetAddonEndpoint, GetAddonParameters, GetAddonRequest, GetAddonResult, GetAddonTypesCall, GetAddonTypesEndpoint, GetAddonTypesRequest, GetAddonTypesResult, GetAddonVersionCall, GetAddonVersionEndpoint, GetAddonVersionParameters, GetAddonVersionRequest, GetAddonVersionResult, GetApiEndpoint, GetDnsidCall, GetDnsidEndpoint, GetDnsidRequest, GetDnsidResult, GetDomainCall, GetDomainEndpoint, GetDomainParameters, GetDomainRequest, GetDomainResult, GetJobBranchesCall, GetJobBranchesEndpoint, GetJobBranchesOptions, GetJobBranchesParameters, GetJobBranchesRequest, GetJobBranchesResult, GetJobBuildCall, GetJobBuildEndpoint, GetJobBuildParameters, GetJobBuildRequest, GetJobBuildResult, GetJobBuildargumentdetailsCall, GetJobBuildargumentdetailsEndpoint, GetJobBuildargumentdetailsParameters, GetJobBuildargumentdetailsRequest, GetJobBuildargumentdetailsResult, GetJobBuildargumentsCall, GetJobBuildargumentsEndpoint, GetJobBuildargumentsOptions, GetJobBuildargumentsParameters, GetJobBuildargumentsRequest, GetJobBuildargumentsResult, GetJobBuildsCall, GetJobBuildsEndpoint, GetJobBuildsOptions, GetJobBuildsParameters, GetJobBuildsRequest, GetJobBuildsResult, GetJobCall, GetJobContainersCall, GetJobContainersEndpoint, GetJobContainersOptions, GetJobContainersParameters, GetJobContainersRequest, GetJobContainersResult, GetJobDeploymentCall, GetJobDeploymentEndpoint, GetJobDeploymentParameters, GetJobDeploymentRequest, GetJobDeploymentResult, GetJobEndpoint, GetJobHealthchecksCall, GetJobHealthchecksEndpoint, GetJobHealthchecksParameters, GetJobHealthchecksRequest, GetJobHealthchecksResult, GetJobParameters, GetJobPullrequestsCall, GetJobPullrequestsEndpoint, GetJobPullrequestsOptions, GetJobPullrequestsParameters, GetJobPullrequestsRequest, GetJobPullrequestsResult, GetJobRequest, GetJobResult, GetJobRunCall, GetJobRunEndpoint, GetJobRunParameters, GetJobRunRequest, GetJobRunResult, GetJobRunsCall, GetJobRunsEndpoint, GetJobRunsOptions, GetJobRunsParameters, GetJobRunsRequest, GetJobRunsResult, GetJobRuntimeenvironmentCall, GetJobRuntimeenvironmentEndpoint, GetJobRuntimeenvironmentOptions, GetJobRuntimeenvironmentParameters, GetJobRuntimeenvironmentRequest, GetJobRuntimeenvironmentResult, GetJobRuntimeenvironmentdetailsCall, GetJobRuntimeenvironmentdetailsEndpoint, GetJobRuntimeenvironmentdetailsParameters, GetJobRuntimeenvironmentdetailsRequest, GetJobRuntimeenvironmentdetailsResult, GetProjectCall, GetProjectEndpoint, GetProjectParameters, GetProjectRequest, GetProjectResult, GetRegistrycredentialsCall, GetRegistrycredentialsEndpoint, GetRegistrycredentialsParameters, GetRegistrycredentialsRequest, GetRegistrycredentialsResult, GetSecretCall, GetSecretEndpoint, GetSecretOptions, GetSecretParameters, GetSecretRequest, GetSecretResult, GetSecretdetailsCall, GetSecretdetailsEndpoint, GetSecretdetailsParameters, GetSecretdetailsRequest, GetSecretdetailsResult, GetSecretlinkCall, GetSecretlinkEndpoint, GetSecretlinkParameters, GetSecretlinkRequest, GetSecretlinkResult, GetServiceBranchesCall, GetServiceBranchesEndpoint, GetServiceBranchesOptions, GetServiceBranchesParameters, GetServiceBranchesRequest, GetServiceBranchesResult, GetServiceBuildCall, GetServiceBuildEndpoint, GetServiceBuildParameters, GetServiceBuildRequest, GetServiceBuildResult, GetServiceBuildargumentdetailsCall, GetServiceBuildargumentdetailsEndpoint, GetServiceBuildargumentdetailsParameters, GetServiceBuildargumentdetailsRequest, GetServiceBuildargumentdetailsResult, GetServiceBuildargumentsCall, GetServiceBuildargumentsEndpoint, GetServiceBuildargumentsOptions, GetServiceBuildargumentsParameters, GetServiceBuildargumentsRequest, GetServiceBuildargumentsResult, GetServiceBuildsCall, GetServiceBuildsEndpoint, GetServiceBuildsOptions, GetServiceBuildsParameters, GetServiceBuildsRequest, GetServiceBuildsResult, GetServiceCall, GetServiceContainersCall, GetServiceContainersEndpoint, GetServiceContainersOptions, GetServiceContainersParameters, GetServiceContainersRequest, GetServiceContainersResult, GetServiceDeploymentCall, GetServiceDeploymentEndpoint, GetServiceDeploymentParameters, GetServiceDeploymentRequest, GetServiceDeploymentResult, GetServiceEndpoint, GetServiceHealthchecksCall, GetServiceHealthchecksEndpoint, GetServiceHealthchecksParameters, GetServiceHealthchecksRequest, GetServiceHealthchecksResult, GetServiceParameters, GetServicePortsCall, GetServicePortsEndpoint, GetServicePortsParameters, GetServicePortsRequest, GetServicePortsResult, GetServicePullrequestsCall, GetServicePullrequestsEndpoint, GetServicePullrequestsOptions, GetServicePullrequestsParameters, GetServicePullrequestsRequest, GetServicePullrequestsResult, GetServiceRequest, GetServiceResult, GetServiceRuntimeenvironmentCall, GetServiceRuntimeenvironmentEndpoint, GetServiceRuntimeenvironmentOptions, GetServiceRuntimeenvironmentParameters, GetServiceRuntimeenvironmentRequest, GetServiceRuntimeenvironmentResult, GetServiceRuntimeenvironmentdetailsCall, GetServiceRuntimeenvironmentdetailsEndpoint, GetServiceRuntimeenvironmentdetailsParameters, GetServiceRuntimeenvironmentdetailsRequest, GetServiceRuntimeenvironmentdetailsResult, GetSubdomainCall, GetSubdomainEndpoint, GetSubdomainParameters, GetSubdomainRequest, GetSubdomainResult, GetVolumeCall, GetVolumeEndpoint, GetVolumeParameters, GetVolumeRequest, GetVolumeResult, ImportAddonBackupCall, ImportAddonBackupData, ImportAddonBackupEndpoint, ImportAddonBackupParameters, ImportAddonBackupRequest, ImportAddonBackupResult, ListAddonsCall, ListAddonsEndpoint, ListAddonsOptions, ListAddonsParameters, ListAddonsRequest, ListAddonsResult, ListBranchesCall, ListBranchesEndpoint, ListBranchesOptions, ListBranchesParameters, ListBranchesRequest, ListBranchesResult, ListDomainsCall, ListDomainsEndpoint, ListDomainsOptions, ListDomainsRequest, ListDomainsResult, ListJobsCall, ListJobsEndpoint, ListJobsOptions, ListJobsParameters, ListJobsRequest, ListJobsResult, ListPlansCall, ListPlansEndpoint, ListPlansRequest, ListPlansResult, ListProjectsCall, ListProjectsEndpoint, ListProjectsOptions, ListProjectsRequest, ListProjectsResult, ListRegionsCall, ListRegionsEndpoint, ListRegionsRequest, ListRegionsResult, ListRegistrycredentialsCall, ListRegistrycredentialsEndpoint, ListRegistrycredentialsOptions, ListRegistrycredentialsRequest, ListRegistrycredentialsResult, ListReposCall, ListReposEndpoint, ListReposOptions, ListReposRequest, ListReposResult, ListSecretsCall, ListSecretsEndpoint, ListSecretsOptions, ListSecretsParameters, ListSecretsRequest, ListSecretsResult, ListServicesCall, ListServicesEndpoint, ListServicesOptions, ListServicesParameters, ListServicesRequest, ListServicesResult, ListVcsCall, ListVcsEndpoint, ListVcsRequest, ListVcsResult, ListVolumesCall, ListVolumesEndpoint, ListVolumesParameters, ListVolumesRequest, ListVolumesResult, NorthflankExecCommand, NorthflankPortForwarder, PauseAddonCall, PauseAddonEndpoint, PauseAddonParameters, PauseAddonRequest, PauseAddonResult, PauseServiceCall, PauseServiceEndpoint, PauseServiceParameters, PauseServiceRequest, PauseServiceResult, PortForwardingInfo, PortForwardingResult, PostApiEndpoint, RestartAddonCall, RestartAddonEndpoint, RestartAddonParameters, RestartAddonRequest, RestartAddonResult, RestartServiceCall, RestartServiceEndpoint, RestartServiceParameters, RestartServiceRequest, RestartServiceResult, RestoreAddonBackupCall, RestoreAddonBackupEndpoint, RestoreAddonBackupParameters, RestoreAddonBackupRequest, RestoreAddonBackupResult, ResumeAddonCall, ResumeAddonEndpoint, ResumeAddonParameters, ResumeAddonRequest, ResumeAddonResult, ResumeServiceCall, ResumeServiceData, ResumeServiceEndpoint, ResumeServiceParameters, ResumeServiceRequest, ResumeServiceResult, ScaleAddonCall, ScaleAddonData, ScaleAddonEndpoint, ScaleAddonParameters, ScaleAddonRequest, ScaleAddonResult, ScaleJobCall, ScaleJobData, ScaleJobEndpoint, ScaleJobParameters, ScaleJobRequest, ScaleJobResult, ScaleServiceCall, ScaleServiceData, ScaleServiceEndpoint, ScaleServiceParameters, ScaleServiceRequest, ScaleServiceResult, StartJobBuildCall, StartJobBuildData, StartJobBuildEndpoint, StartJobBuildParameters, StartJobBuildRequest, StartJobBuildResult, StartJobRunCall, StartJobRunData, StartJobRunEndpoint, StartJobRunParameters, StartJobRunRequest, StartJobRunResult, StartServiceBuildCall, StartServiceBuildData, StartServiceBuildEndpoint, StartServiceBuildParameters, StartServiceBuildRequest, StartServiceBuildResult, UnassignSubdomainCall, UnassignSubdomainEndpoint, UnassignSubdomainParameters, UnassignSubdomainRequest, UnassignSubdomainResult, UpdateAddonNetworksettingsCall, UpdateAddonNetworksettingsData, UpdateAddonNetworksettingsEndpoint, UpdateAddonNetworksettingsParameters, UpdateAddonNetworksettingsRequest, UpdateAddonNetworksettingsResult, UpdateAddonSecurityCall, UpdateAddonSecurityData, UpdateAddonSecurityEndpoint, UpdateAddonSecurityParameters, UpdateAddonSecurityRequest, UpdateAddonSecurityResult, UpdateAddonVersionCall, UpdateAddonVersionData, UpdateAddonVersionEndpoint, UpdateAddonVersionParameters, UpdateAddonVersionRequest, UpdateAddonVersionResult, UpdateJobBuildargumentsCall, UpdateJobBuildargumentsData, UpdateJobBuildargumentsEndpoint, UpdateJobBuildargumentsParameters, UpdateJobBuildargumentsRequest, UpdateJobBuildargumentsResult, UpdateJobBuildoptionsCall, UpdateJobBuildoptionsData, UpdateJobBuildoptionsEndpoint, UpdateJobBuildoptionsParameters, UpdateJobBuildoptionsRequest, UpdateJobBuildoptionsResult, UpdateJobBuildsourceCall, UpdateJobBuildsourceData, UpdateJobBuildsourceEndpoint, UpdateJobBuildsourceParameters, UpdateJobBuildsourceRequest, UpdateJobBuildsourceResult, UpdateJobCmdoverrideCall, UpdateJobCmdoverrideData, UpdateJobCmdoverrideEndpoint, UpdateJobCmdoverrideParameters, UpdateJobCmdoverrideRequest, UpdateJobCmdoverrideResult, UpdateJobDeploymentCall, UpdateJobDeploymentData, UpdateJobDeploymentEndpoint, UpdateJobDeploymentParameters, UpdateJobDeploymentRequest, UpdateJobDeploymentResult, UpdateJobHealthchecksCall, UpdateJobHealthchecksData, UpdateJobHealthchecksEndpoint, UpdateJobHealthchecksParameters, UpdateJobHealthchecksRequest, UpdateJobHealthchecksResult, UpdateJobRuntimeenvironmentCall, UpdateJobRuntimeenvironmentData, UpdateJobRuntimeenvironmentEndpoint, UpdateJobRuntimeenvironmentParameters, UpdateJobRuntimeenvironmentRequest, UpdateJobRuntimeenvironmentResult, UpdateJobSettingsCall, UpdateJobSettingsData, UpdateJobSettingsEndpoint, UpdateJobSettingsParameters, UpdateJobSettingsRequest, UpdateJobSettingsResult, UpdateRegistrycredentialsCall, UpdateRegistrycredentialsData, UpdateRegistrycredentialsEndpoint, UpdateRegistrycredentialsParameters, UpdateRegistrycredentialsRequest, UpdateRegistrycredentialsResult, UpdateSecretCall, UpdateSecretData, UpdateSecretEndpoint, UpdateSecretParameters, UpdateSecretRequest, UpdateSecretResult, UpdateSecretlinkCall, UpdateSecretlinkData, UpdateSecretlinkEndpoint, UpdateSecretlinkParameters, UpdateSecretlinkRequest, UpdateSecretlinkResult, UpdateServiceBuildargumentsCall, UpdateServiceBuildargumentsData, UpdateServiceBuildargumentsEndpoint, UpdateServiceBuildargumentsParameters, UpdateServiceBuildargumentsRequest, UpdateServiceBuildargumentsResult, UpdateServiceBuildoptionsCall, UpdateServiceBuildoptionsData, UpdateServiceBuildoptionsEndpoint, UpdateServiceBuildoptionsParameters, UpdateServiceBuildoptionsRequest, UpdateServiceBuildoptionsResult, UpdateServiceBuildsourceCall, UpdateServiceBuildsourceData, UpdateServiceBuildsourceEndpoint, UpdateServiceBuildsourceParameters, UpdateServiceBuildsourceRequest, UpdateServiceBuildsourceResult, UpdateServiceCmdoverrideCall, UpdateServiceCmdoverrideData, UpdateServiceCmdoverrideEndpoint, UpdateServiceCmdoverrideParameters, UpdateServiceCmdoverrideRequest, UpdateServiceCmdoverrideResult, UpdateServiceDeploymentCall, UpdateServiceDeploymentData, UpdateServiceDeploymentEndpoint, UpdateServiceDeploymentParameters, UpdateServiceDeploymentRequest, UpdateServiceDeploymentResult, UpdateServiceHealthchecksCall, UpdateServiceHealthchecksData, UpdateServiceHealthchecksEndpoint, UpdateServiceHealthchecksParameters, UpdateServiceHealthchecksRequest, UpdateServiceHealthchecksResult, UpdateServicePortsCall, UpdateServicePortsData, UpdateServicePortsEndpoint, UpdateServicePortsParameters, UpdateServicePortsRequest, UpdateServicePortsResult, UpdateServiceRuntimeenvironmentCall, UpdateServiceRuntimeenvironmentData, UpdateServiceRuntimeenvironmentEndpoint, UpdateServiceRuntimeenvironmentParameters, UpdateServiceRuntimeenvironmentRequest, UpdateServiceRuntimeenvironmentResult, UpdateVolumeCall, UpdateVolumeData, UpdateVolumeEndpoint, UpdateVolumeParameters, UpdateVolumeRequest, UpdateVolumeResult, VerifyDomainCall, VerifyDomainEndpoint, VerifyDomainParameters, VerifyDomainRequest, VerifyDomainResult, VerifySubdomainCall, VerifySubdomainEndpoint, VerifySubdomainParameters, VerifySubdomainRequest, VerifySubdomainResult };
8572
+ export { AbortAddonBackupCall, AbortAddonBackupEndpoint, AbortAddonBackupParameters, AbortAddonBackupRequest, AbortAddonBackupResult, AbortAddonRestoreCall, AbortAddonRestoreData, AbortAddonRestoreEndpoint, AbortAddonRestoreParameters, AbortAddonRestoreRequest, AbortAddonRestoreResult, AbortJobBuildCall, AbortJobBuildEndpoint, AbortJobBuildParameters, AbortJobBuildRequest, AbortJobBuildResult, AbortJobRunCall, AbortJobRunEndpoint, AbortJobRunParameters, AbortJobRunRequest, AbortJobRunResult, AbortServiceBuildCall, AbortServiceBuildEndpoint, AbortServiceBuildParameters, AbortServiceBuildRequest, AbortServiceBuildResult, AddDomainSubdomainCall, AddDomainSubdomainData, AddDomainSubdomainEndpoint, AddDomainSubdomainParameters, AddDomainSubdomainRequest, AddDomainSubdomainResult, AddRegistryCall, AddRegistryData, AddRegistryEndpoint, AddRegistryRequest, AddRegistryResult, ApiCallError, ApiCallResponse, ApiClient, ApiClientContext, ApiClientContextProvider, ApiClientContextWrapper, ApiClientFileContextProvider, ApiClientInMemoryContextProvider, ApiClientOpts, ApiEndpoint, AssignSubdomainServiceCall, AssignSubdomainServiceData, AssignSubdomainServiceEndpoint, AssignSubdomainServiceParameters, AssignSubdomainServiceRequest, AssignSubdomainServiceResult, AttachVolumeCall, AttachVolumeData, AttachVolumeEndpoint, AttachVolumeParameters, AttachVolumeRequest, AttachVolumeResult, BackupAddonCall, BackupAddonData, BackupAddonEndpoint, BackupAddonParameters, BackupAddonRequest, BackupAddonResult, CommandResult, CreateAddonBackupscheduleCall, CreateAddonBackupscheduleData, CreateAddonBackupscheduleEndpoint, CreateAddonBackupscheduleParameters, CreateAddonBackupscheduleRequest, CreateAddonBackupscheduleResult, CreateAddonCall, CreateAddonData, CreateAddonEndpoint, CreateAddonParameters, CreateAddonRequest, CreateAddonResult, CreateClusterCall, CreateClusterData, CreateClusterEndpoint, CreateClusterRequest, CreateClusterResult, CreateDomainCall, CreateDomainData, CreateDomainEndpoint, CreateDomainRequest, CreateDomainResult, CreateIntegrationCall, CreateIntegrationData, CreateIntegrationEndpoint, CreateIntegrationRequest, CreateIntegrationResult, CreateJobCronCall, CreateJobCronData, CreateJobCronEndpoint, CreateJobCronParameters, CreateJobCronRequest, CreateJobCronResult, CreateJobManualCall, CreateJobManualData, CreateJobManualEndpoint, CreateJobManualParameters, CreateJobManualRequest, CreateJobManualResult, CreateProjectCall, CreateProjectData, CreateProjectEndpoint, CreateProjectRequest, CreateProjectResult, CreateSecretCall, CreateSecretData, CreateSecretEndpoint, CreateSecretParameters, CreateSecretRequest, CreateSecretResult, CreateServiceBuildCall, CreateServiceBuildData, CreateServiceBuildEndpoint, CreateServiceBuildParameters, CreateServiceBuildRequest, CreateServiceBuildResult, CreateServiceCombinedCall, CreateServiceCombinedData, CreateServiceCombinedEndpoint, CreateServiceCombinedParameters, CreateServiceCombinedRequest, CreateServiceCombinedResult, CreateServiceDeploymentCall, CreateServiceDeploymentData, CreateServiceDeploymentEndpoint, CreateServiceDeploymentParameters, CreateServiceDeploymentRequest, CreateServiceDeploymentResult, CreateTemplateCall, CreateTemplateData, CreateTemplateEndpoint, CreateTemplateRequest, CreateTemplateResult, CreateVolumeCall, CreateVolumeData, CreateVolumeEndpoint, CreateVolumeParameters, CreateVolumeRequest, CreateVolumeResult, DeleteAddonBackupscheduleCall, DeleteAddonBackupscheduleEndpoint, DeleteAddonBackupscheduleParameters, DeleteAddonBackupscheduleRequest, DeleteAddonBackupscheduleResult, DeleteAddonCall, DeleteAddonEndpoint, DeleteAddonParameters, DeleteAddonRequest, DeleteAddonResult, DeleteApiEndpoint, DeleteBackupCall, DeleteBackupEndpoint, DeleteBackupParameters, DeleteBackupRequest, DeleteBackupResult, DeleteClusterCall, DeleteClusterEndpoint, DeleteClusterParameters, DeleteClusterRequest, DeleteClusterResult, DeleteDomainCall, DeleteDomainEndpoint, DeleteDomainParameters, DeleteDomainRequest, DeleteDomainResult, DeleteIntegrationCall, DeleteIntegrationEndpoint, DeleteIntegrationParameters, DeleteIntegrationRequest, DeleteIntegrationResult, DeleteJobCall, DeleteJobEndpoint, DeleteJobParameters, DeleteJobRequest, DeleteJobResult, DeleteProjectCall, DeleteProjectEndpoint, DeleteProjectParameters, DeleteProjectRequest, DeleteProjectResult, DeleteRegistryCall, DeleteRegistryEndpoint, DeleteRegistryParameters, DeleteRegistryRequest, DeleteRegistryResult, DeleteSecretCall, DeleteSecretEndpoint, DeleteSecretParameters, DeleteSecretRequest, DeleteSecretResult, DeleteSecretlinkCall, DeleteSecretlinkEndpoint, DeleteSecretlinkParameters, DeleteSecretlinkRequest, DeleteSecretlinkResult, DeleteServiceCall, DeleteServiceEndpoint, DeleteServiceParameters, DeleteServiceRequest, DeleteServiceResult, DeleteSubdomainCall, DeleteSubdomainEndpoint, DeleteSubdomainParameters, DeleteSubdomainRequest, DeleteSubdomainResult, DeleteTemplateCall, DeleteTemplateEndpoint, DeleteTemplateParameters, DeleteTemplateRequest, DeleteTemplateResult, DeleteVolumeCall, DeleteVolumeEndpoint, DeleteVolumeParameters, DeleteVolumeRequest, DeleteVolumeResult, DetachVolumeCall, DetachVolumeData, DetachVolumeEndpoint, DetachVolumeParameters, DetachVolumeRequest, DetachVolumeResult, ExecCommand, ExecCommandData, ExecCommandStandard, ExecSessionData, GetAddonBackupCall, GetAddonBackupDownloadCall, GetAddonBackupDownloadEndpoint, GetAddonBackupDownloadParameters, GetAddonBackupDownloadRequest, GetAddonBackupDownloadResult, GetAddonBackupEndpoint, GetAddonBackupParameters, GetAddonBackupRequest, GetAddonBackupResult, GetAddonBackupsCall, GetAddonBackupsEndpoint, GetAddonBackupsOptions, GetAddonBackupsParameters, GetAddonBackupsRequest, GetAddonBackupsResult, GetAddonBackupschedulesCall, GetAddonBackupschedulesEndpoint, GetAddonBackupschedulesOptions, GetAddonBackupschedulesParameters, GetAddonBackupschedulesRequest, GetAddonBackupschedulesResult, GetAddonCall, GetAddonContainersCall, GetAddonContainersEndpoint, GetAddonContainersOptions, GetAddonContainersParameters, GetAddonContainersRequest, GetAddonContainersResult, GetAddonCredentialsCall, GetAddonCredentialsEndpoint, GetAddonCredentialsParameters, GetAddonCredentialsRequest, GetAddonCredentialsResult, GetAddonEndpoint, GetAddonParameters, GetAddonRequest, GetAddonResult, GetAddonTypesCall, GetAddonTypesEndpoint, GetAddonTypesRequest, GetAddonTypesResult, GetAddonVersionCall, GetAddonVersionEndpoint, GetAddonVersionParameters, GetAddonVersionRequest, GetAddonVersionResult, GetApiEndpoint, GetClusterCall, GetClusterEndpoint, GetClusterParameters, GetClusterRequest, GetClusterResult, GetDnsidCall, GetDnsidEndpoint, GetDnsidRequest, GetDnsidResult, GetDomainCall, GetDomainEndpoint, GetDomainParameters, GetDomainRequest, GetDomainResult, GetIntegrationCall, GetIntegrationEndpoint, GetIntegrationParameters, GetIntegrationRequest, GetIntegrationResult, GetInvoiceDetailsCall, GetInvoiceDetailsEndpoint, GetInvoiceDetailsOptions, GetInvoiceDetailsRequest, GetInvoiceDetailsResult, GetJobBranchesCall, GetJobBranchesEndpoint, GetJobBranchesOptions, GetJobBranchesParameters, GetJobBranchesRequest, GetJobBranchesResult, GetJobBuildCall, GetJobBuildEndpoint, GetJobBuildParameters, GetJobBuildRequest, GetJobBuildResult, GetJobBuildargumentdetailsCall, GetJobBuildargumentdetailsEndpoint, GetJobBuildargumentdetailsParameters, GetJobBuildargumentdetailsRequest, GetJobBuildargumentdetailsResult, GetJobBuildargumentsCall, GetJobBuildargumentsEndpoint, GetJobBuildargumentsOptions, GetJobBuildargumentsParameters, GetJobBuildargumentsRequest, GetJobBuildargumentsResult, GetJobBuildsCall, GetJobBuildsEndpoint, GetJobBuildsOptions, GetJobBuildsParameters, GetJobBuildsRequest, GetJobBuildsResult, GetJobCall, GetJobContainersCall, GetJobContainersEndpoint, GetJobContainersOptions, GetJobContainersParameters, GetJobContainersRequest, GetJobContainersResult, GetJobDeploymentCall, GetJobDeploymentEndpoint, GetJobDeploymentParameters, GetJobDeploymentRequest, GetJobDeploymentResult, GetJobEndpoint, GetJobHealthchecksCall, GetJobHealthchecksEndpoint, GetJobHealthchecksParameters, GetJobHealthchecksRequest, GetJobHealthchecksResult, GetJobParameters, GetJobPullrequestsCall, GetJobPullrequestsEndpoint, GetJobPullrequestsOptions, GetJobPullrequestsParameters, GetJobPullrequestsRequest, GetJobPullrequestsResult, GetJobRequest, GetJobResult, GetJobRunCall, GetJobRunEndpoint, GetJobRunParameters, GetJobRunRequest, GetJobRunResult, GetJobRunsCall, GetJobRunsEndpoint, GetJobRunsOptions, GetJobRunsParameters, GetJobRunsRequest, GetJobRunsResult, GetJobRuntimeenvironmentCall, GetJobRuntimeenvironmentEndpoint, GetJobRuntimeenvironmentOptions, GetJobRuntimeenvironmentParameters, GetJobRuntimeenvironmentRequest, GetJobRuntimeenvironmentResult, GetJobRuntimeenvironmentdetailsCall, GetJobRuntimeenvironmentdetailsEndpoint, GetJobRuntimeenvironmentdetailsParameters, GetJobRuntimeenvironmentdetailsRequest, GetJobRuntimeenvironmentdetailsResult, GetProjectCall, GetProjectEndpoint, GetProjectParameters, GetProjectRequest, GetProjectResult, GetRegistryCall, GetRegistryEndpoint, GetRegistryParameters, GetRegistryRequest, GetRegistryResult, GetSecretCall, GetSecretEndpoint, GetSecretOptions, GetSecretParameters, GetSecretRequest, GetSecretResult, GetSecretdetailsCall, GetSecretdetailsEndpoint, GetSecretdetailsParameters, GetSecretdetailsRequest, GetSecretdetailsResult, GetSecretlinkCall, GetSecretlinkEndpoint, GetSecretlinkParameters, GetSecretlinkRequest, GetSecretlinkResult, GetServiceBranchesCall, GetServiceBranchesEndpoint, GetServiceBranchesOptions, GetServiceBranchesParameters, GetServiceBranchesRequest, GetServiceBranchesResult, GetServiceBuildCall, GetServiceBuildEndpoint, GetServiceBuildParameters, GetServiceBuildRequest, GetServiceBuildResult, GetServiceBuildargumentdetailsCall, GetServiceBuildargumentdetailsEndpoint, GetServiceBuildargumentdetailsParameters, GetServiceBuildargumentdetailsRequest, GetServiceBuildargumentdetailsResult, GetServiceBuildargumentsCall, GetServiceBuildargumentsEndpoint, GetServiceBuildargumentsOptions, GetServiceBuildargumentsParameters, GetServiceBuildargumentsRequest, GetServiceBuildargumentsResult, GetServiceBuildsCall, GetServiceBuildsEndpoint, GetServiceBuildsOptions, GetServiceBuildsParameters, GetServiceBuildsRequest, GetServiceBuildsResult, GetServiceCall, GetServiceContainersCall, GetServiceContainersEndpoint, GetServiceContainersOptions, GetServiceContainersParameters, GetServiceContainersRequest, GetServiceContainersResult, GetServiceDeploymentCall, GetServiceDeploymentEndpoint, GetServiceDeploymentParameters, GetServiceDeploymentRequest, GetServiceDeploymentResult, GetServiceEndpoint, GetServiceHealthchecksCall, GetServiceHealthchecksEndpoint, GetServiceHealthchecksParameters, GetServiceHealthchecksRequest, GetServiceHealthchecksResult, GetServiceParameters, GetServicePortsCall, GetServicePortsEndpoint, GetServicePortsParameters, GetServicePortsRequest, GetServicePortsResult, GetServicePullrequestsCall, GetServicePullrequestsEndpoint, GetServicePullrequestsOptions, GetServicePullrequestsParameters, GetServicePullrequestsRequest, GetServicePullrequestsResult, GetServiceRequest, GetServiceResult, GetServiceRuntimeenvironmentCall, GetServiceRuntimeenvironmentEndpoint, GetServiceRuntimeenvironmentOptions, GetServiceRuntimeenvironmentParameters, GetServiceRuntimeenvironmentRequest, GetServiceRuntimeenvironmentResult, GetServiceRuntimeenvironmentdetailsCall, GetServiceRuntimeenvironmentdetailsEndpoint, GetServiceRuntimeenvironmentdetailsParameters, GetServiceRuntimeenvironmentdetailsRequest, GetServiceRuntimeenvironmentdetailsResult, GetSubdomainCall, GetSubdomainEndpoint, GetSubdomainParameters, GetSubdomainRequest, GetSubdomainResult, GetTemplateCall, GetTemplateEndpoint, GetTemplateOptions, GetTemplateParameters, GetTemplateRequest, GetTemplateResult, GetTemplaterunCall, GetTemplaterunEndpoint, GetTemplaterunOptions, GetTemplaterunParameters, GetTemplaterunRequest, GetTemplaterunResult, GetVolumeCall, GetVolumeEndpoint, GetVolumeParameters, GetVolumeRequest, GetVolumeResult, ImportAddonBackupCall, ImportAddonBackupData, ImportAddonBackupEndpoint, ImportAddonBackupParameters, ImportAddonBackupRequest, ImportAddonBackupResult, ListAddonsCall, ListAddonsEndpoint, ListAddonsOptions, ListAddonsParameters, ListAddonsRequest, ListAddonsResult, ListBranchesCall, ListBranchesEndpoint, ListBranchesOptions, ListBranchesParameters, ListBranchesRequest, ListBranchesResult, ListClustersCall, ListClustersEndpoint, ListClustersOptions, ListClustersRequest, ListClustersResult, ListDomainsCall, ListDomainsEndpoint, ListDomainsOptions, ListDomainsRequest, ListDomainsResult, ListIntegrationsCall, ListIntegrationsEndpoint, ListIntegrationsOptions, ListIntegrationsRequest, ListIntegrationsResult, ListInvoicesCall, ListInvoicesEndpoint, ListInvoicesOptions, ListInvoicesRequest, ListInvoicesResult, ListJobsCall, ListJobsEndpoint, ListJobsOptions, ListJobsParameters, ListJobsRequest, ListJobsResult, ListPlansCall, ListPlansEndpoint, ListPlansRequest, ListPlansResult, ListProjectsCall, ListProjectsEndpoint, ListProjectsOptions, ListProjectsRequest, ListProjectsResult, ListProvidersCall, ListProvidersEndpoint, ListProvidersRequest, ListProvidersResult, ListRegionsCall, ListRegionsEndpoint, ListRegionsRequest, ListRegionsResult, ListRegistriesCall, ListRegistriesEndpoint, ListRegistriesOptions, ListRegistriesRequest, ListRegistriesResult, ListReposCall, ListReposEndpoint, ListReposOptions, ListReposRequest, ListReposResult, ListSecretsCall, ListSecretsEndpoint, ListSecretsOptions, ListSecretsParameters, ListSecretsRequest, ListSecretsResult, ListServicesCall, ListServicesEndpoint, ListServicesOptions, ListServicesParameters, ListServicesRequest, ListServicesResult, ListTemplaterunsCall, ListTemplaterunsEndpoint, ListTemplaterunsOptions, ListTemplaterunsParameters, ListTemplaterunsRequest, ListTemplaterunsResult, ListTemplatesCall, ListTemplatesEndpoint, ListTemplatesOptions, ListTemplatesRequest, ListTemplatesResult, ListVcsCall, ListVcsEndpoint, ListVcsRequest, ListVcsResult, ListVolumesCall, ListVolumesEndpoint, ListVolumesParameters, ListVolumesRequest, ListVolumesResult, NorthflankApiCallError, NorthflankExecCommand, NorthflankPortForwarder, PauseAddonCall, PauseAddonEndpoint, PauseAddonParameters, PauseAddonRequest, PauseAddonResult, PauseJobCall, PauseJobEndpoint, PauseJobParameters, PauseJobRequest, PauseJobResult, PauseServiceCall, PauseServiceEndpoint, PauseServiceParameters, PauseServiceRequest, PauseServiceResult, PortForwardingInfo, PortForwardingResult, PostApiEndpoint, RestartAddonCall, RestartAddonEndpoint, RestartAddonParameters, RestartAddonRequest, RestartAddonResult, RestartServiceCall, RestartServiceEndpoint, RestartServiceParameters, RestartServiceRequest, RestartServiceResult, RestoreAddonBackupCall, RestoreAddonBackupEndpoint, RestoreAddonBackupParameters, RestoreAddonBackupRequest, RestoreAddonBackupResult, ResumeAddonCall, ResumeAddonEndpoint, ResumeAddonParameters, ResumeAddonRequest, ResumeAddonResult, ResumeJobCall, ResumeJobData, ResumeJobEndpoint, ResumeJobParameters, ResumeJobRequest, ResumeJobResult, ResumeServiceCall, ResumeServiceData, ResumeServiceEndpoint, ResumeServiceParameters, ResumeServiceRequest, ResumeServiceResult, RetainAddonBackupCall, RetainAddonBackupEndpoint, RetainAddonBackupParameters, RetainAddonBackupRequest, RetainAddonBackupResult, RunTemplateCall, RunTemplateEndpoint, RunTemplateParameters, RunTemplateRequest, RunTemplateResult, ScaleAddonCall, ScaleAddonData, ScaleAddonEndpoint, ScaleAddonParameters, ScaleAddonRequest, ScaleAddonResult, ScaleJobCall, ScaleJobData, ScaleJobEndpoint, ScaleJobParameters, ScaleJobRequest, ScaleJobResult, ScaleServiceCall, ScaleServiceData, ScaleServiceEndpoint, ScaleServiceParameters, ScaleServiceRequest, ScaleServiceResult, StartJobBuildCall, StartJobBuildData, StartJobBuildEndpoint, StartJobBuildParameters, StartJobBuildRequest, StartJobBuildResult, StartJobRunCall, StartJobRunData, StartJobRunEndpoint, StartJobRunParameters, StartJobRunRequest, StartJobRunResult, StartServiceBuildCall, StartServiceBuildData, StartServiceBuildEndpoint, StartServiceBuildParameters, StartServiceBuildRequest, StartServiceBuildResult, SuspendJobCall, SuspendJobData, SuspendJobEndpoint, SuspendJobParameters, SuspendJobRequest, SuspendJobResult, UnassignSubdomainCall, UnassignSubdomainEndpoint, UnassignSubdomainParameters, UnassignSubdomainRequest, UnassignSubdomainResult, UpdateAddonNetworksettingsCall, UpdateAddonNetworksettingsData, UpdateAddonNetworksettingsEndpoint, UpdateAddonNetworksettingsParameters, UpdateAddonNetworksettingsRequest, UpdateAddonNetworksettingsResult, UpdateAddonSecurityCall, UpdateAddonSecurityData, UpdateAddonSecurityEndpoint, UpdateAddonSecurityParameters, UpdateAddonSecurityRequest, UpdateAddonSecurityResult, UpdateAddonVersionCall, UpdateAddonVersionData, UpdateAddonVersionEndpoint, UpdateAddonVersionParameters, UpdateAddonVersionRequest, UpdateAddonVersionResult, UpdateClusterCall, UpdateClusterData, UpdateClusterEndpoint, UpdateClusterParameters, UpdateClusterRequest, UpdateClusterResult, UpdateIntegrationCall, UpdateIntegrationData, UpdateIntegrationEndpoint, UpdateIntegrationParameters, UpdateIntegrationRequest, UpdateIntegrationResult, UpdateJobBuildargumentsCall, UpdateJobBuildargumentsData, UpdateJobBuildargumentsEndpoint, UpdateJobBuildargumentsParameters, UpdateJobBuildargumentsRequest, UpdateJobBuildargumentsResult, UpdateJobBuildoptionsCall, UpdateJobBuildoptionsData, UpdateJobBuildoptionsEndpoint, UpdateJobBuildoptionsParameters, UpdateJobBuildoptionsRequest, UpdateJobBuildoptionsResult, UpdateJobBuildsourceCall, UpdateJobBuildsourceData, UpdateJobBuildsourceEndpoint, UpdateJobBuildsourceParameters, UpdateJobBuildsourceRequest, UpdateJobBuildsourceResult, UpdateJobCmdoverrideCall, UpdateJobCmdoverrideData, UpdateJobCmdoverrideEndpoint, UpdateJobCmdoverrideParameters, UpdateJobCmdoverrideRequest, UpdateJobCmdoverrideResult, UpdateJobDeploymentCall, UpdateJobDeploymentData, UpdateJobDeploymentEndpoint, UpdateJobDeploymentParameters, UpdateJobDeploymentRequest, UpdateJobDeploymentResult, UpdateJobEntrypointoverrideCall, UpdateJobEntrypointoverrideData, UpdateJobEntrypointoverrideEndpoint, UpdateJobEntrypointoverrideParameters, UpdateJobEntrypointoverrideRequest, UpdateJobEntrypointoverrideResult, UpdateJobHealthchecksCall, UpdateJobHealthchecksData, UpdateJobHealthchecksEndpoint, UpdateJobHealthchecksParameters, UpdateJobHealthchecksRequest, UpdateJobHealthchecksResult, UpdateJobRuntimeenvironmentCall, UpdateJobRuntimeenvironmentData, UpdateJobRuntimeenvironmentEndpoint, UpdateJobRuntimeenvironmentParameters, UpdateJobRuntimeenvironmentRequest, UpdateJobRuntimeenvironmentResult, UpdateJobSettingsCall, UpdateJobSettingsData, UpdateJobSettingsEndpoint, UpdateJobSettingsParameters, UpdateJobSettingsRequest, UpdateJobSettingsResult, UpdateRegistryCall, UpdateRegistryData, UpdateRegistryEndpoint, UpdateRegistryParameters, UpdateRegistryRequest, UpdateRegistryResult, UpdateSecretCall, UpdateSecretData, UpdateSecretEndpoint, UpdateSecretParameters, UpdateSecretRequest, UpdateSecretResult, UpdateSecretlinkCall, UpdateSecretlinkData, UpdateSecretlinkEndpoint, UpdateSecretlinkParameters, UpdateSecretlinkRequest, UpdateSecretlinkResult, UpdateServiceBuildargumentsCall, UpdateServiceBuildargumentsData, UpdateServiceBuildargumentsEndpoint, UpdateServiceBuildargumentsParameters, UpdateServiceBuildargumentsRequest, UpdateServiceBuildargumentsResult, UpdateServiceBuildoptionsCall, UpdateServiceBuildoptionsData, UpdateServiceBuildoptionsEndpoint, UpdateServiceBuildoptionsParameters, UpdateServiceBuildoptionsRequest, UpdateServiceBuildoptionsResult, UpdateServiceBuildsourceCall, UpdateServiceBuildsourceData, UpdateServiceBuildsourceEndpoint, UpdateServiceBuildsourceParameters, UpdateServiceBuildsourceRequest, UpdateServiceBuildsourceResult, UpdateServiceCmdoverrideCall, UpdateServiceCmdoverrideData, UpdateServiceCmdoverrideEndpoint, UpdateServiceCmdoverrideParameters, UpdateServiceCmdoverrideRequest, UpdateServiceCmdoverrideResult, UpdateServiceDeploymentCall, UpdateServiceDeploymentData, UpdateServiceDeploymentEndpoint, UpdateServiceDeploymentParameters, UpdateServiceDeploymentRequest, UpdateServiceDeploymentResult, UpdateServiceEntrypointoverrideCall, UpdateServiceEntrypointoverrideData, UpdateServiceEntrypointoverrideEndpoint, UpdateServiceEntrypointoverrideParameters, UpdateServiceEntrypointoverrideRequest, UpdateServiceEntrypointoverrideResult, UpdateServiceHealthchecksCall, UpdateServiceHealthchecksData, UpdateServiceHealthchecksEndpoint, UpdateServiceHealthchecksParameters, UpdateServiceHealthchecksRequest, UpdateServiceHealthchecksResult, UpdateServicePortsCall, UpdateServicePortsData, UpdateServicePortsEndpoint, UpdateServicePortsParameters, UpdateServicePortsRequest, UpdateServicePortsResult, UpdateServiceRuntimeenvironmentCall, UpdateServiceRuntimeenvironmentData, UpdateServiceRuntimeenvironmentEndpoint, UpdateServiceRuntimeenvironmentParameters, UpdateServiceRuntimeenvironmentRequest, UpdateServiceRuntimeenvironmentResult, UpdateTemplateCall, UpdateTemplateData, UpdateTemplateEndpoint, UpdateTemplateParameters, UpdateTemplateRequest, UpdateTemplateResult, UpdateVolumeCall, UpdateVolumeData, UpdateVolumeEndpoint, UpdateVolumeParameters, UpdateVolumeRequest, UpdateVolumeResult, VerifyDomainCall, VerifyDomainEndpoint, VerifyDomainParameters, VerifyDomainRequest, VerifyDomainResult, VerifySubdomainCall, VerifySubdomainEndpoint, VerifySubdomainParameters, VerifySubdomainRequest, VerifySubdomainResult };