@northflank/js-client 0.7.0 → 0.7.1-beta.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 +7267 -2476
  2. package/dist/cjs/api-client.js +1 -1
  3. package/dist/esm/api-client.d.ts +7267 -2476
  4. package/dist/esm/api-client.js +1 -15
  5. package/package.json +1 -1
  6. package/dist/cjs/api-endpoint.d.ts +0 -57
  7. package/dist/cjs/api-error.d.ts +0 -16
  8. package/dist/cjs/context/api-client-context-provider.d.ts +0 -47
  9. package/dist/cjs/context/api-client-file-context-provider.d.ts +0 -11
  10. package/dist/cjs/context/api-client-in-memory-context-provider.d.ts +0 -6
  11. package/dist/cjs/context/index.d.ts +0 -3
  12. package/dist/cjs/endpoints/abort/addon/backup.d.ts +0 -21
  13. package/dist/cjs/endpoints/abort/addon/restore.d.ts +0 -26
  14. package/dist/cjs/endpoints/abort/job/build.d.ts +0 -21
  15. package/dist/cjs/endpoints/abort/job/run.d.ts +0 -21
  16. package/dist/cjs/endpoints/abort/service/build.d.ts +0 -21
  17. package/dist/cjs/endpoints/add/domain/subdomain.d.ts +0 -33
  18. package/dist/cjs/endpoints/add/registry.d.ts +0 -47
  19. package/dist/cjs/endpoints/assign/subdomain/service.d.ts +0 -28
  20. package/dist/cjs/endpoints/attach/volume.d.ts +0 -29
  21. package/dist/cjs/endpoints/backup/addon.d.ts +0 -51
  22. package/dist/cjs/endpoints/create/addon/backupSchedule.d.ts +0 -40
  23. package/dist/cjs/endpoints/create/addon.d.ts +0 -101
  24. package/dist/cjs/endpoints/create/cluster.d.ts +0 -97
  25. package/dist/cjs/endpoints/create/domain.d.ts +0 -27
  26. package/dist/cjs/endpoints/create/integration.d.ts +0 -58
  27. package/dist/cjs/endpoints/create/job/cron.d.ts +0 -247
  28. package/dist/cjs/endpoints/create/job/manual.d.ts +0 -237
  29. package/dist/cjs/endpoints/create/project.d.ts +0 -31
  30. package/dist/cjs/endpoints/create/secret.d.ts +0 -83
  31. package/dist/cjs/endpoints/create/service/build.d.ts +0 -161
  32. package/dist/cjs/endpoints/create/service/combined.d.ts +0 -255
  33. package/dist/cjs/endpoints/create/service/deployment.d.ts +0 -242
  34. package/dist/cjs/endpoints/create/template.d.ts +0 -132
  35. package/dist/cjs/endpoints/create/volume.d.ts +0 -78
  36. package/dist/cjs/endpoints/delete/addon/backupSchedule.d.ts +0 -21
  37. package/dist/cjs/endpoints/delete/addon.d.ts +0 -19
  38. package/dist/cjs/endpoints/delete/backup.d.ts +0 -21
  39. package/dist/cjs/endpoints/delete/cluster.d.ts +0 -17
  40. package/dist/cjs/endpoints/delete/domain.d.ts +0 -17
  41. package/dist/cjs/endpoints/delete/integration.d.ts +0 -17
  42. package/dist/cjs/endpoints/delete/job.d.ts +0 -19
  43. package/dist/cjs/endpoints/delete/project.d.ts +0 -17
  44. package/dist/cjs/endpoints/delete/registry.d.ts +0 -17
  45. package/dist/cjs/endpoints/delete/secret.d.ts +0 -19
  46. package/dist/cjs/endpoints/delete/secretLink.d.ts +0 -21
  47. package/dist/cjs/endpoints/delete/service.d.ts +0 -19
  48. package/dist/cjs/endpoints/delete/subdomain.d.ts +0 -19
  49. package/dist/cjs/endpoints/delete/template.d.ts +0 -17
  50. package/dist/cjs/endpoints/delete/volume.d.ts +0 -19
  51. package/dist/cjs/endpoints/detach/volume.d.ts +0 -21
  52. package/dist/cjs/endpoints/get/addon/backup/download.d.ts +0 -24
  53. package/dist/cjs/endpoints/get/addon/backup.d.ts +0 -46
  54. package/dist/cjs/endpoints/get/addon/backupSchedules.d.ts +0 -52
  55. package/dist/cjs/endpoints/get/addon/backups.d.ts +0 -54
  56. package/dist/cjs/endpoints/get/addon/containers.d.ts +0 -40
  57. package/dist/cjs/endpoints/get/addon/credentials.d.ts +0 -24
  58. package/dist/cjs/endpoints/get/addon/types.d.ts +0 -48
  59. package/dist/cjs/endpoints/get/addon/version.d.ts +0 -53
  60. package/dist/cjs/endpoints/get/addon.d.ts +0 -71
  61. package/dist/cjs/endpoints/get/cluster.d.ts +0 -55
  62. package/dist/cjs/endpoints/get/dnsId.d.ts +0 -15
  63. package/dist/cjs/endpoints/get/domain.d.ts +0 -33
  64. package/dist/cjs/endpoints/get/integration.d.ts +0 -37
  65. package/dist/cjs/endpoints/get/invoice/details.d.ts +0 -139
  66. package/dist/cjs/endpoints/get/job/branches.d.ts +0 -49
  67. package/dist/cjs/endpoints/get/job/build.d.ts +0 -42
  68. package/dist/cjs/endpoints/get/job/buildArgumentDetails.d.ts +0 -71
  69. package/dist/cjs/endpoints/get/job/buildArguments.d.ts +0 -29
  70. package/dist/cjs/endpoints/get/job/builds.d.ts +0 -52
  71. package/dist/cjs/endpoints/get/job/containers.d.ts +0 -40
  72. package/dist/cjs/endpoints/get/job/deployment.d.ts +0 -55
  73. package/dist/cjs/endpoints/get/job/healthChecks.d.ts +0 -45
  74. package/dist/cjs/endpoints/get/job/pullRequests.d.ts +0 -49
  75. package/dist/cjs/endpoints/get/job/run.d.ts +0 -44
  76. package/dist/cjs/endpoints/get/job/runs.d.ts +0 -54
  77. package/dist/cjs/endpoints/get/job/runtimeEnvironment.d.ts +0 -29
  78. package/dist/cjs/endpoints/get/job/runtimeEnvironmentDetails.d.ts +0 -71
  79. package/dist/cjs/endpoints/get/job.d.ts +0 -128
  80. package/dist/cjs/endpoints/get/project.d.ts +0 -72
  81. package/dist/cjs/endpoints/get/registry.d.ts +0 -34
  82. package/dist/cjs/endpoints/get/secret.d.ts +0 -55
  83. package/dist/cjs/endpoints/get/secretDetails.d.ts +0 -63
  84. package/dist/cjs/endpoints/get/secretLink.d.ts +0 -44
  85. package/dist/cjs/endpoints/get/service/branches.d.ts +0 -49
  86. package/dist/cjs/endpoints/get/service/build.d.ts +0 -42
  87. package/dist/cjs/endpoints/get/service/buildArgumentDetails.d.ts +0 -71
  88. package/dist/cjs/endpoints/get/service/buildArguments.d.ts +0 -29
  89. package/dist/cjs/endpoints/get/service/builds.d.ts +0 -52
  90. package/dist/cjs/endpoints/get/service/containers.d.ts +0 -40
  91. package/dist/cjs/endpoints/get/service/deployment.d.ts +0 -55
  92. package/dist/cjs/endpoints/get/service/healthChecks.d.ts +0 -45
  93. package/dist/cjs/endpoints/get/service/ports.d.ts +0 -70
  94. package/dist/cjs/endpoints/get/service/pullRequests.d.ts +0 -49
  95. package/dist/cjs/endpoints/get/service/runtimeEnvironment.d.ts +0 -29
  96. package/dist/cjs/endpoints/get/service/runtimeEnvironmentDetails.d.ts +0 -71
  97. package/dist/cjs/endpoints/get/service.d.ts +0 -211
  98. package/dist/cjs/endpoints/get/subdomain.d.ts +0 -30
  99. package/dist/cjs/endpoints/get/template.d.ts +0 -61
  100. package/dist/cjs/endpoints/get/templateRun.d.ts +0 -73
  101. package/dist/cjs/endpoints/get/volume.d.ts +0 -49
  102. package/dist/cjs/endpoints/import/addon/backup.d.ts +0 -31
  103. package/dist/cjs/endpoints/list/addons.d.ts +0 -45
  104. package/dist/cjs/endpoints/list/branches.d.ts +0 -51
  105. package/dist/cjs/endpoints/list/clusters.d.ts +0 -63
  106. package/dist/cjs/endpoints/list/domains.d.ts +0 -34
  107. package/dist/cjs/endpoints/list/integrations.d.ts +0 -36
  108. package/dist/cjs/endpoints/list/invoices.d.ts +0 -40
  109. package/dist/cjs/endpoints/list/jobs.d.ts +0 -46
  110. package/dist/cjs/endpoints/list/plans.d.ts +0 -30
  111. package/dist/cjs/endpoints/list/projects.d.ts +0 -32
  112. package/dist/cjs/endpoints/list/providers.d.ts +0 -37
  113. package/dist/cjs/endpoints/list/regions.d.ts +0 -18
  114. package/dist/cjs/endpoints/list/registries.d.ts +0 -41
  115. package/dist/cjs/endpoints/list/repos.d.ts +0 -51
  116. package/dist/cjs/endpoints/list/secrets.d.ts +0 -54
  117. package/dist/cjs/endpoints/list/services.d.ts +0 -65
  118. package/dist/cjs/endpoints/list/templateRuns.d.ts +0 -54
  119. package/dist/cjs/endpoints/list/templates.d.ts +0 -41
  120. package/dist/cjs/endpoints/list/vcs.d.ts +0 -32
  121. package/dist/cjs/endpoints/list/volumes.d.ts +0 -47
  122. package/dist/cjs/endpoints/pause/addon.d.ts +0 -19
  123. package/dist/cjs/endpoints/pause/job.d.ts +0 -19
  124. package/dist/cjs/endpoints/pause/service.d.ts +0 -19
  125. package/dist/cjs/endpoints/restart/addon.d.ts +0 -19
  126. package/dist/cjs/endpoints/restart/service.d.ts +0 -19
  127. package/dist/cjs/endpoints/restore/addon/backup.d.ts +0 -24
  128. package/dist/cjs/endpoints/resume/addon.d.ts +0 -19
  129. package/dist/cjs/endpoints/resume/job.d.ts +0 -28
  130. package/dist/cjs/endpoints/resume/service.d.ts +0 -28
  131. package/dist/cjs/endpoints/retain/addon/backup.d.ts +0 -21
  132. package/dist/cjs/endpoints/run/template.d.ts +0 -62
  133. package/dist/cjs/endpoints/scale/addon.d.ts +0 -28
  134. package/dist/cjs/endpoints/scale/job.d.ts +0 -30
  135. package/dist/cjs/endpoints/scale/service.d.ts +0 -32
  136. package/dist/cjs/endpoints/start/job/build.d.ts +0 -47
  137. package/dist/cjs/endpoints/start/job/run.d.ts +0 -74
  138. package/dist/cjs/endpoints/start/service/build.d.ts +0 -55
  139. package/dist/cjs/endpoints/suspend/job.d.ts +0 -24
  140. package/dist/cjs/endpoints/unassign/subdomain.d.ts +0 -19
  141. package/dist/cjs/endpoints/update/addon/networkSettings.d.ts +0 -26
  142. package/dist/cjs/endpoints/update/addon/security.d.ts +0 -29
  143. package/dist/cjs/endpoints/update/addon/version.d.ts +0 -24
  144. package/dist/cjs/endpoints/update/cluster.d.ts +0 -76
  145. package/dist/cjs/endpoints/update/integration.d.ts +0 -53
  146. package/dist/cjs/endpoints/update/job/buildArguments.d.ts +0 -29
  147. package/dist/cjs/endpoints/update/job/buildOptions.d.ts +0 -50
  148. package/dist/cjs/endpoints/update/job/buildSource.d.ts +0 -32
  149. package/dist/cjs/endpoints/update/job/cmdOverride.d.ts +0 -24
  150. package/dist/cjs/endpoints/update/job/deployment.d.ts +0 -39
  151. package/dist/cjs/endpoints/update/job/entrypointOverride.d.ts +0 -24
  152. package/dist/cjs/endpoints/update/job/healthChecks.d.ts +0 -45
  153. package/dist/cjs/endpoints/update/job/runtimeEnvironment.d.ts +0 -29
  154. package/dist/cjs/endpoints/update/job/settings.d.ts +0 -32
  155. package/dist/cjs/endpoints/update/registry.d.ts +0 -31
  156. package/dist/cjs/endpoints/update/secret.d.ts +0 -58
  157. package/dist/cjs/endpoints/update/secretLink.d.ts +0 -40
  158. package/dist/cjs/endpoints/update/service/buildArguments.d.ts +0 -29
  159. package/dist/cjs/endpoints/update/service/buildOptions.d.ts +0 -62
  160. package/dist/cjs/endpoints/update/service/buildSource.d.ts +0 -32
  161. package/dist/cjs/endpoints/update/service/cmdOverride.d.ts +0 -24
  162. package/dist/cjs/endpoints/update/service/deployment.d.ts +0 -39
  163. package/dist/cjs/endpoints/update/service/entrypointOverride.d.ts +0 -24
  164. package/dist/cjs/endpoints/update/service/healthChecks.d.ts +0 -45
  165. package/dist/cjs/endpoints/update/service/ports.d.ts +0 -57
  166. package/dist/cjs/endpoints/update/service/runtimeEnvironment.d.ts +0 -34
  167. package/dist/cjs/endpoints/update/template.d.ts +0 -81
  168. package/dist/cjs/endpoints/update/volume.d.ts +0 -33
  169. package/dist/cjs/endpoints/verify/domain.d.ts +0 -17
  170. package/dist/cjs/endpoints/verify/subdomain.d.ts +0 -19
  171. package/dist/cjs/exec-command/client/exec-command-runner.d.ts +0 -70
  172. package/dist/cjs/exec-command/client/exec-command-standard.d.ts +0 -42
  173. package/dist/cjs/port-forward/client/api-helper.d.ts +0 -30
  174. package/dist/cjs/port-forward/client/atomic-write.d.ts +0 -2
  175. package/dist/cjs/port-forward/client/host-file-ast.d.ts +0 -52
  176. package/dist/cjs/port-forward/client/host-file.d.ts +0 -26
  177. package/dist/cjs/port-forward/client/loopback.d.ts +0 -4
  178. package/dist/cjs/port-forward/client/port-forwarder.d.ts +0 -87
  179. package/dist/cjs/port-forward/client/port-tunnel-tcp.d.ts +0 -36
  180. package/dist/cjs/port-forward/client/port-tunnel-udp.d.ts +0 -27
  181. package/dist/cjs/port-forward/client/promise-mutex.d.ts +0 -4
  182. package/dist/cjs/utils.d.ts +0 -21
  183. package/dist/esm/api-endpoint.d.ts +0 -57
  184. package/dist/esm/api-error.d.ts +0 -16
  185. package/dist/esm/context/api-client-context-provider.d.ts +0 -47
  186. package/dist/esm/context/api-client-file-context-provider.d.ts +0 -11
  187. package/dist/esm/context/api-client-in-memory-context-provider.d.ts +0 -6
  188. package/dist/esm/context/index.d.ts +0 -3
  189. package/dist/esm/endpoints/abort/addon/backup.d.ts +0 -21
  190. package/dist/esm/endpoints/abort/addon/restore.d.ts +0 -26
  191. package/dist/esm/endpoints/abort/job/build.d.ts +0 -21
  192. package/dist/esm/endpoints/abort/job/run.d.ts +0 -21
  193. package/dist/esm/endpoints/abort/service/build.d.ts +0 -21
  194. package/dist/esm/endpoints/add/domain/subdomain.d.ts +0 -33
  195. package/dist/esm/endpoints/add/registry.d.ts +0 -47
  196. package/dist/esm/endpoints/assign/subdomain/service.d.ts +0 -28
  197. package/dist/esm/endpoints/attach/volume.d.ts +0 -29
  198. package/dist/esm/endpoints/backup/addon.d.ts +0 -51
  199. package/dist/esm/endpoints/create/addon/backupSchedule.d.ts +0 -40
  200. package/dist/esm/endpoints/create/addon.d.ts +0 -101
  201. package/dist/esm/endpoints/create/cluster.d.ts +0 -97
  202. package/dist/esm/endpoints/create/domain.d.ts +0 -27
  203. package/dist/esm/endpoints/create/integration.d.ts +0 -58
  204. package/dist/esm/endpoints/create/job/cron.d.ts +0 -247
  205. package/dist/esm/endpoints/create/job/manual.d.ts +0 -237
  206. package/dist/esm/endpoints/create/project.d.ts +0 -31
  207. package/dist/esm/endpoints/create/secret.d.ts +0 -83
  208. package/dist/esm/endpoints/create/service/build.d.ts +0 -161
  209. package/dist/esm/endpoints/create/service/combined.d.ts +0 -255
  210. package/dist/esm/endpoints/create/service/deployment.d.ts +0 -242
  211. package/dist/esm/endpoints/create/template.d.ts +0 -132
  212. package/dist/esm/endpoints/create/volume.d.ts +0 -78
  213. package/dist/esm/endpoints/delete/addon/backupSchedule.d.ts +0 -21
  214. package/dist/esm/endpoints/delete/addon.d.ts +0 -19
  215. package/dist/esm/endpoints/delete/backup.d.ts +0 -21
  216. package/dist/esm/endpoints/delete/cluster.d.ts +0 -17
  217. package/dist/esm/endpoints/delete/domain.d.ts +0 -17
  218. package/dist/esm/endpoints/delete/integration.d.ts +0 -17
  219. package/dist/esm/endpoints/delete/job.d.ts +0 -19
  220. package/dist/esm/endpoints/delete/project.d.ts +0 -17
  221. package/dist/esm/endpoints/delete/registry.d.ts +0 -17
  222. package/dist/esm/endpoints/delete/secret.d.ts +0 -19
  223. package/dist/esm/endpoints/delete/secretLink.d.ts +0 -21
  224. package/dist/esm/endpoints/delete/service.d.ts +0 -19
  225. package/dist/esm/endpoints/delete/subdomain.d.ts +0 -19
  226. package/dist/esm/endpoints/delete/template.d.ts +0 -17
  227. package/dist/esm/endpoints/delete/volume.d.ts +0 -19
  228. package/dist/esm/endpoints/detach/volume.d.ts +0 -21
  229. package/dist/esm/endpoints/get/addon/backup/download.d.ts +0 -24
  230. package/dist/esm/endpoints/get/addon/backup.d.ts +0 -46
  231. package/dist/esm/endpoints/get/addon/backupSchedules.d.ts +0 -52
  232. package/dist/esm/endpoints/get/addon/backups.d.ts +0 -54
  233. package/dist/esm/endpoints/get/addon/containers.d.ts +0 -40
  234. package/dist/esm/endpoints/get/addon/credentials.d.ts +0 -24
  235. package/dist/esm/endpoints/get/addon/types.d.ts +0 -48
  236. package/dist/esm/endpoints/get/addon/version.d.ts +0 -53
  237. package/dist/esm/endpoints/get/addon.d.ts +0 -71
  238. package/dist/esm/endpoints/get/cluster.d.ts +0 -55
  239. package/dist/esm/endpoints/get/dnsId.d.ts +0 -15
  240. package/dist/esm/endpoints/get/domain.d.ts +0 -33
  241. package/dist/esm/endpoints/get/integration.d.ts +0 -37
  242. package/dist/esm/endpoints/get/invoice/details.d.ts +0 -139
  243. package/dist/esm/endpoints/get/job/branches.d.ts +0 -49
  244. package/dist/esm/endpoints/get/job/build.d.ts +0 -42
  245. package/dist/esm/endpoints/get/job/buildArgumentDetails.d.ts +0 -71
  246. package/dist/esm/endpoints/get/job/buildArguments.d.ts +0 -29
  247. package/dist/esm/endpoints/get/job/builds.d.ts +0 -52
  248. package/dist/esm/endpoints/get/job/containers.d.ts +0 -40
  249. package/dist/esm/endpoints/get/job/deployment.d.ts +0 -55
  250. package/dist/esm/endpoints/get/job/healthChecks.d.ts +0 -45
  251. package/dist/esm/endpoints/get/job/pullRequests.d.ts +0 -49
  252. package/dist/esm/endpoints/get/job/run.d.ts +0 -44
  253. package/dist/esm/endpoints/get/job/runs.d.ts +0 -54
  254. package/dist/esm/endpoints/get/job/runtimeEnvironment.d.ts +0 -29
  255. package/dist/esm/endpoints/get/job/runtimeEnvironmentDetails.d.ts +0 -71
  256. package/dist/esm/endpoints/get/job.d.ts +0 -128
  257. package/dist/esm/endpoints/get/project.d.ts +0 -72
  258. package/dist/esm/endpoints/get/registry.d.ts +0 -34
  259. package/dist/esm/endpoints/get/secret.d.ts +0 -55
  260. package/dist/esm/endpoints/get/secretDetails.d.ts +0 -63
  261. package/dist/esm/endpoints/get/secretLink.d.ts +0 -44
  262. package/dist/esm/endpoints/get/service/branches.d.ts +0 -49
  263. package/dist/esm/endpoints/get/service/build.d.ts +0 -42
  264. package/dist/esm/endpoints/get/service/buildArgumentDetails.d.ts +0 -71
  265. package/dist/esm/endpoints/get/service/buildArguments.d.ts +0 -29
  266. package/dist/esm/endpoints/get/service/builds.d.ts +0 -52
  267. package/dist/esm/endpoints/get/service/containers.d.ts +0 -40
  268. package/dist/esm/endpoints/get/service/deployment.d.ts +0 -55
  269. package/dist/esm/endpoints/get/service/healthChecks.d.ts +0 -45
  270. package/dist/esm/endpoints/get/service/ports.d.ts +0 -70
  271. package/dist/esm/endpoints/get/service/pullRequests.d.ts +0 -49
  272. package/dist/esm/endpoints/get/service/runtimeEnvironment.d.ts +0 -29
  273. package/dist/esm/endpoints/get/service/runtimeEnvironmentDetails.d.ts +0 -71
  274. package/dist/esm/endpoints/get/service.d.ts +0 -211
  275. package/dist/esm/endpoints/get/subdomain.d.ts +0 -30
  276. package/dist/esm/endpoints/get/template.d.ts +0 -61
  277. package/dist/esm/endpoints/get/templateRun.d.ts +0 -73
  278. package/dist/esm/endpoints/get/volume.d.ts +0 -49
  279. package/dist/esm/endpoints/import/addon/backup.d.ts +0 -31
  280. package/dist/esm/endpoints/list/addons.d.ts +0 -45
  281. package/dist/esm/endpoints/list/branches.d.ts +0 -51
  282. package/dist/esm/endpoints/list/clusters.d.ts +0 -63
  283. package/dist/esm/endpoints/list/domains.d.ts +0 -34
  284. package/dist/esm/endpoints/list/integrations.d.ts +0 -36
  285. package/dist/esm/endpoints/list/invoices.d.ts +0 -40
  286. package/dist/esm/endpoints/list/jobs.d.ts +0 -46
  287. package/dist/esm/endpoints/list/plans.d.ts +0 -30
  288. package/dist/esm/endpoints/list/projects.d.ts +0 -32
  289. package/dist/esm/endpoints/list/providers.d.ts +0 -37
  290. package/dist/esm/endpoints/list/regions.d.ts +0 -18
  291. package/dist/esm/endpoints/list/registries.d.ts +0 -41
  292. package/dist/esm/endpoints/list/repos.d.ts +0 -51
  293. package/dist/esm/endpoints/list/secrets.d.ts +0 -54
  294. package/dist/esm/endpoints/list/services.d.ts +0 -65
  295. package/dist/esm/endpoints/list/templateRuns.d.ts +0 -54
  296. package/dist/esm/endpoints/list/templates.d.ts +0 -41
  297. package/dist/esm/endpoints/list/vcs.d.ts +0 -32
  298. package/dist/esm/endpoints/list/volumes.d.ts +0 -47
  299. package/dist/esm/endpoints/pause/addon.d.ts +0 -19
  300. package/dist/esm/endpoints/pause/job.d.ts +0 -19
  301. package/dist/esm/endpoints/pause/service.d.ts +0 -19
  302. package/dist/esm/endpoints/restart/addon.d.ts +0 -19
  303. package/dist/esm/endpoints/restart/service.d.ts +0 -19
  304. package/dist/esm/endpoints/restore/addon/backup.d.ts +0 -24
  305. package/dist/esm/endpoints/resume/addon.d.ts +0 -19
  306. package/dist/esm/endpoints/resume/job.d.ts +0 -28
  307. package/dist/esm/endpoints/resume/service.d.ts +0 -28
  308. package/dist/esm/endpoints/retain/addon/backup.d.ts +0 -21
  309. package/dist/esm/endpoints/run/template.d.ts +0 -62
  310. package/dist/esm/endpoints/scale/addon.d.ts +0 -28
  311. package/dist/esm/endpoints/scale/job.d.ts +0 -30
  312. package/dist/esm/endpoints/scale/service.d.ts +0 -32
  313. package/dist/esm/endpoints/start/job/build.d.ts +0 -47
  314. package/dist/esm/endpoints/start/job/run.d.ts +0 -74
  315. package/dist/esm/endpoints/start/service/build.d.ts +0 -55
  316. package/dist/esm/endpoints/suspend/job.d.ts +0 -24
  317. package/dist/esm/endpoints/unassign/subdomain.d.ts +0 -19
  318. package/dist/esm/endpoints/update/addon/networkSettings.d.ts +0 -26
  319. package/dist/esm/endpoints/update/addon/security.d.ts +0 -29
  320. package/dist/esm/endpoints/update/addon/version.d.ts +0 -24
  321. package/dist/esm/endpoints/update/cluster.d.ts +0 -76
  322. package/dist/esm/endpoints/update/integration.d.ts +0 -53
  323. package/dist/esm/endpoints/update/job/buildArguments.d.ts +0 -29
  324. package/dist/esm/endpoints/update/job/buildOptions.d.ts +0 -50
  325. package/dist/esm/endpoints/update/job/buildSource.d.ts +0 -32
  326. package/dist/esm/endpoints/update/job/cmdOverride.d.ts +0 -24
  327. package/dist/esm/endpoints/update/job/deployment.d.ts +0 -39
  328. package/dist/esm/endpoints/update/job/entrypointOverride.d.ts +0 -24
  329. package/dist/esm/endpoints/update/job/healthChecks.d.ts +0 -45
  330. package/dist/esm/endpoints/update/job/runtimeEnvironment.d.ts +0 -29
  331. package/dist/esm/endpoints/update/job/settings.d.ts +0 -32
  332. package/dist/esm/endpoints/update/registry.d.ts +0 -31
  333. package/dist/esm/endpoints/update/secret.d.ts +0 -58
  334. package/dist/esm/endpoints/update/secretLink.d.ts +0 -40
  335. package/dist/esm/endpoints/update/service/buildArguments.d.ts +0 -29
  336. package/dist/esm/endpoints/update/service/buildOptions.d.ts +0 -62
  337. package/dist/esm/endpoints/update/service/buildSource.d.ts +0 -32
  338. package/dist/esm/endpoints/update/service/cmdOverride.d.ts +0 -24
  339. package/dist/esm/endpoints/update/service/deployment.d.ts +0 -39
  340. package/dist/esm/endpoints/update/service/entrypointOverride.d.ts +0 -24
  341. package/dist/esm/endpoints/update/service/healthChecks.d.ts +0 -45
  342. package/dist/esm/endpoints/update/service/ports.d.ts +0 -57
  343. package/dist/esm/endpoints/update/service/runtimeEnvironment.d.ts +0 -34
  344. package/dist/esm/endpoints/update/template.d.ts +0 -81
  345. package/dist/esm/endpoints/update/volume.d.ts +0 -33
  346. package/dist/esm/endpoints/verify/domain.d.ts +0 -17
  347. package/dist/esm/endpoints/verify/subdomain.d.ts +0 -19
  348. package/dist/esm/exec-command/client/exec-command-runner.d.ts +0 -70
  349. package/dist/esm/exec-command/client/exec-command-standard.d.ts +0 -42
  350. package/dist/esm/port-forward/client/api-helper.d.ts +0 -30
  351. package/dist/esm/port-forward/client/atomic-write.d.ts +0 -2
  352. package/dist/esm/port-forward/client/host-file-ast.d.ts +0 -52
  353. package/dist/esm/port-forward/client/host-file.d.ts +0 -26
  354. package/dist/esm/port-forward/client/loopback.d.ts +0 -4
  355. package/dist/esm/port-forward/client/port-forwarder.d.ts +0 -87
  356. package/dist/esm/port-forward/client/port-tunnel-tcp.d.ts +0 -36
  357. package/dist/esm/port-forward/client/port-tunnel-udp.d.ts +0 -27
  358. package/dist/esm/port-forward/client/promise-mutex.d.ts +0 -4
  359. package/dist/esm/utils.d.ts +0 -21
@@ -1,47 +0,0 @@
1
- declare type Optional<T, K extends keyof T> = Omit<T, K> & Partial<T>;
2
- export declare abstract class ApiClientContextProvider {
3
- private contextWrapper;
4
- constructor();
5
- protected loadContext(): void;
6
- getInfo(): string;
7
- storeContext(contextWrapper: ApiClientContextWrapper): Promise<void>;
8
- addContext(context: Optional<ApiClientContext, 'host'>, override?: boolean): Promise<void>;
9
- removeContext(name: string): Promise<void>;
10
- protected abstract writeContext(context: ApiClientContextWrapper): Promise<void>;
11
- abstract loadContextWrapper(): ApiClientContextWrapper;
12
- getCurrentContext(): ApiClientContext | undefined;
13
- private findContext;
14
- getCurrentBaseUrl(throwIfNotPresent?: boolean): string | undefined;
15
- getCurrentProjectName(): string | undefined;
16
- getCurrentName(): string | undefined;
17
- getCurrentToken(): string | undefined;
18
- getCurrentServiceName(): string | undefined;
19
- getCurrentJobName(): string | undefined;
20
- getCurrentPlanId(): string | undefined;
21
- getCurrentRegion(): string | undefined;
22
- useContext(name: string): Promise<void>;
23
- updateToken(token: string, name?: string): Promise<void>;
24
- useProjectId(id: string): Promise<void>;
25
- useServiceId(id: string): Promise<void>;
26
- useJobId(id: string): Promise<void>;
27
- usePlanId(id: string): Promise<void>;
28
- useRegion(region: string): Promise<void>;
29
- getLastUpdateCheck(): Date;
30
- setLastUpdateCheck(check: Date): Promise<any>;
31
- }
32
- export interface ApiClientContextWrapper {
33
- current?: string;
34
- contexts: ApiClientContext[];
35
- lastUpdateCheck?: Date;
36
- }
37
- export interface ApiClientContext {
38
- name: string;
39
- token: string;
40
- host: string;
41
- project?: string;
42
- service?: string;
43
- job?: string;
44
- plan?: string;
45
- region?: string;
46
- }
47
- export {};
@@ -1,11 +0,0 @@
1
- import { ApiClientContextProvider, ApiClientContextWrapper } from './api-client-context-provider';
2
- export declare class ApiClientFileContextProvider extends ApiClientContextProvider {
3
- configPath: string;
4
- configFile: string;
5
- constructor(configPath?: string);
6
- loadContextWrapper(): ApiClientContextWrapper;
7
- protected writeContext(context: ApiClientContextWrapper): Promise<void>;
8
- assertDir: (path: string) => Promise<string | undefined>;
9
- assertConfigDir(): Promise<void>;
10
- getInfo(): string;
11
- }
@@ -1,6 +0,0 @@
1
- import { ApiClientContextProvider, ApiClientContextWrapper } from './api-client-context-provider';
2
- export declare class ApiClientInMemoryContextProvider extends ApiClientContextProvider {
3
- private inMemoryContextWrapper;
4
- loadContextWrapper(): ApiClientContextWrapper;
5
- protected writeContext(context: ApiClientContextWrapper): Promise<void>;
6
- }
@@ -1,3 +0,0 @@
1
- export * from './api-client-context-provider';
2
- export * from './api-client-file-context-provider';
3
- export * from './api-client-in-memory-context-provider';
@@ -1,21 +0,0 @@
1
- import { ApiCallResponse, PostApiEndpoint } from '../../../api-endpoint';
2
- export declare type AbortAddonBackupResult = any;
3
- export declare type AbortAddonBackupCall = (opts: AbortAddonBackupRequest) => Promise<ApiCallResponse<AbortAddonBackupResult>>;
4
- export declare type AbortAddonBackupRequest = {
5
- parameters: AbortAddonBackupParameters;
6
- };
7
- export declare type AbortAddonBackupParameters = {
8
- /** ID of the project */ 'projectId': string;
9
- /** ID of the addon */
10
- 'addonId': string;
11
- /** ID of the backup */
12
- 'backupId': string;
13
- };
14
- /** Aborts the in progress backup. */
15
- export declare class AbortAddonBackupEndpoint extends PostApiEndpoint<AbortAddonBackupRequest, AbortAddonBackupResult> {
16
- description: string;
17
- withAuth: boolean;
18
- requiredPermissions: string;
19
- endpointUrl: (opts: AbortAddonBackupRequest) => string;
20
- body: () => undefined;
21
- }
@@ -1,26 +0,0 @@
1
- import { ApiCallResponse, PostApiEndpoint } from '../../../api-endpoint';
2
- export declare type AbortAddonRestoreResult = any;
3
- export declare type AbortAddonRestoreCall = (opts: AbortAddonRestoreRequest) => Promise<ApiCallResponse<AbortAddonRestoreResult>>;
4
- export declare type AbortAddonRestoreRequest = {
5
- parameters: AbortAddonRestoreParameters;
6
- data: AbortAddonRestoreData;
7
- };
8
- export declare type AbortAddonRestoreParameters = {
9
- /** ID of the project */ 'projectId': string;
10
- /** ID of the addon */
11
- 'addonId': string;
12
- /** ID of the backup */
13
- 'backupId': string;
14
- };
15
- export declare type AbortAddonRestoreData = {
16
- /** ID of the restore to abort. Example: 1611305397038 */
17
- 'restoreId': number;
18
- };
19
- /** Aborts an in-progress backup restore. */
20
- export declare class AbortAddonRestoreEndpoint extends PostApiEndpoint<AbortAddonRestoreRequest, AbortAddonRestoreResult> {
21
- description: string;
22
- withAuth: boolean;
23
- requiredPermissions: string;
24
- endpointUrl: (opts: AbortAddonRestoreRequest) => string;
25
- body: (payload: AbortAddonRestoreRequest) => string;
26
- }
@@ -1,21 +0,0 @@
1
- import { ApiCallResponse, DeleteApiEndpoint } from '../../../api-endpoint';
2
- export declare type AbortJobBuildResult = any;
3
- export declare type AbortJobBuildCall = (opts: AbortJobBuildRequest) => Promise<ApiCallResponse<AbortJobBuildResult>>;
4
- export declare type AbortJobBuildRequest = {
5
- parameters: AbortJobBuildParameters;
6
- };
7
- export declare type AbortJobBuildParameters = {
8
- /** ID of the project */ 'projectId': string;
9
- /** ID of the job */
10
- 'jobId': string;
11
- /** ID of the job build */
12
- 'buildId': string;
13
- };
14
- /** Aborts the given job build */
15
- export declare class AbortJobBuildEndpoint extends DeleteApiEndpoint<AbortJobBuildRequest, AbortJobBuildResult> {
16
- description: string;
17
- withAuth: boolean;
18
- requiredPermissions: string;
19
- endpointUrl: (opts: AbortJobBuildRequest) => string;
20
- body: () => undefined;
21
- }
@@ -1,21 +0,0 @@
1
- import { ApiCallResponse, DeleteApiEndpoint } from '../../../api-endpoint';
2
- export declare type AbortJobRunResult = any;
3
- export declare type AbortJobRunCall = (opts: AbortJobRunRequest) => Promise<ApiCallResponse<AbortJobRunResult>>;
4
- export declare type AbortJobRunRequest = {
5
- parameters: AbortJobRunParameters;
6
- };
7
- export declare type AbortJobRunParameters = {
8
- /** ID of the project */ 'projectId': string;
9
- /** ID of the job */
10
- 'jobId': string;
11
- /** ID of the job run */
12
- 'runId': string;
13
- };
14
- /** Aborts the given job run */
15
- export declare class AbortJobRunEndpoint extends DeleteApiEndpoint<AbortJobRunRequest, AbortJobRunResult> {
16
- description: string;
17
- withAuth: boolean;
18
- requiredPermissions: string;
19
- endpointUrl: (opts: AbortJobRunRequest) => string;
20
- body: () => undefined;
21
- }
@@ -1,21 +0,0 @@
1
- import { ApiCallResponse, DeleteApiEndpoint } from '../../../api-endpoint';
2
- export declare type AbortServiceBuildResult = any;
3
- export declare type AbortServiceBuildCall = (opts: AbortServiceBuildRequest) => Promise<ApiCallResponse<AbortServiceBuildResult>>;
4
- export declare type AbortServiceBuildRequest = {
5
- parameters: AbortServiceBuildParameters;
6
- };
7
- export declare type AbortServiceBuildParameters = {
8
- /** ID of the project */ 'projectId': string;
9
- /** ID of the service */
10
- 'serviceId': string;
11
- /** ID of the service build */
12
- 'buildId': string;
13
- };
14
- /** Aborts the given service build */
15
- export declare class AbortServiceBuildEndpoint extends DeleteApiEndpoint<AbortServiceBuildRequest, AbortServiceBuildResult> {
16
- description: string;
17
- withAuth: boolean;
18
- requiredPermissions: string;
19
- endpointUrl: (opts: AbortServiceBuildRequest) => string;
20
- body: () => undefined;
21
- }
@@ -1,33 +0,0 @@
1
- import { ApiCallResponse, PostApiEndpoint } from '../../../api-endpoint';
2
- export declare type AddDomainSubdomainResult = {
3
- /** The record type to use for the DNS record to verify the subdomain - always CNAME for subdomains. Example: "CNAME" */
4
- 'recordType': string;
5
- /** The subdomain. Example: "site" */
6
- 'name': string;
7
- /** The full domain name with subdomain Example: "site.example.com" */
8
- 'fullName': string;
9
- /** The content to set the DNS record to Example: "site.example.com.user-1234.dns.northflank.app" */
10
- 'content': string;
11
- /** Whether the subdomain has been verified successfully and can be used. */
12
- 'verified': boolean;
13
- } | any;
14
- export declare type AddDomainSubdomainCall = (opts: AddDomainSubdomainRequest) => Promise<ApiCallResponse<AddDomainSubdomainResult>>;
15
- export declare type AddDomainSubdomainRequest = {
16
- parameters: AddDomainSubdomainParameters;
17
- data: AddDomainSubdomainData;
18
- };
19
- export declare type AddDomainSubdomainParameters = {
20
- /** Name of the domain */ 'domain': string;
21
- };
22
- export declare type AddDomainSubdomainData = {
23
- /** A subdomain to be added. Example: "site" */
24
- 'subdomain': string;
25
- };
26
- /** Adds a new subdomain to the domain. */
27
- export declare class AddDomainSubdomainEndpoint extends PostApiEndpoint<AddDomainSubdomainRequest, AddDomainSubdomainResult> {
28
- description: string;
29
- withAuth: boolean;
30
- requiredPermissions: string;
31
- endpointUrl: (opts: AddDomainSubdomainRequest) => string;
32
- body: (payload: AddDomainSubdomainRequest) => string;
33
- }
@@ -1,47 +0,0 @@
1
- import { ApiCallResponse, PostApiEndpoint } from '../../api-endpoint';
2
- export declare type AddRegistryResult = {
3
- /** Identifier for the credentials. Example: "example-credentials" */
4
- 'id': string;
5
- /** Name of the saved credentials. Example: "Example Credentials" */
6
- 'name': string;
7
- /** Description of the saved credentials. Example: "This is a set of saved credentials." */
8
- 'description': string;
9
- /** Data about whether the credentials are restricted to certain projects. */
10
- 'restrictions': {
11
- /** Whether the credentials are restricted to specific projects. Example: true */
12
- 'restricted': boolean;
13
- /** An array of projects the credentials are restricted to, if applicable. */
14
- 'projects': string[];
15
- };
16
- /** The registry provider associated with this set of credentials. Example: "dockerhub" */
17
- 'provider': 'dockerhub' | 'gcr' | 'gcr-eu' | 'gcr-us' | 'gitlab' | 'github' | 'custom';
18
- };
19
- export declare type AddRegistryCall = (opts: AddRegistryRequest) => Promise<ApiCallResponse<AddRegistryResult>>;
20
- export declare type AddRegistryRequest = {
21
- data: AddRegistryData;
22
- };
23
- export declare type AddRegistryData = {
24
- /** Name of the credentials. Example: "Example Credentials" */
25
- 'name': string;
26
- /** Description of the credentials. Example: "This is a set of saved credentials." */
27
- 'description': string;
28
- /** The registry provider associated with this set of credentials. Example: "dockerhub" */
29
- 'provider': 'dockerhub' | 'gcr' | 'gcr-eu' | 'gcr-us' | 'gitlab' | 'github' | 'custom';
30
- /** Data about whether the credentials are restricted to certain projects. */
31
- 'restrictions'?: {
32
- /** Whether the credentials are restricted to specific projects. Example: true */
33
- 'restricted'?: boolean;
34
- /** An array of projects the credentials are restricted to, if applicable. */
35
- 'projects'?: string[];
36
- };
37
- /** The registry credential data to save. Example: {"auths":{"https://index.docker.io/v1/":{"auth":"[YOUR AUTH KEY]"}}} */
38
- 'data': any;
39
- };
40
- /** Adds a new set of container registry credentials to this account. */
41
- export declare class AddRegistryEndpoint extends PostApiEndpoint<AddRegistryRequest, AddRegistryResult> {
42
- description: string;
43
- withAuth: boolean;
44
- requiredPermissions: string;
45
- endpointUrl: (opts: AddRegistryRequest) => string;
46
- body: (payload: AddRegistryRequest) => string;
47
- }
@@ -1,28 +0,0 @@
1
- import { ApiCallResponse, PostApiEndpoint } from '../../../api-endpoint';
2
- export declare type AssignSubdomainServiceResult = any;
3
- export declare type AssignSubdomainServiceCall = (opts: AssignSubdomainServiceRequest) => Promise<ApiCallResponse<AssignSubdomainServiceResult>>;
4
- export declare type AssignSubdomainServiceRequest = {
5
- parameters: AssignSubdomainServiceParameters;
6
- data: AssignSubdomainServiceData;
7
- };
8
- export declare type AssignSubdomainServiceParameters = {
9
- /** Name of the domain */ 'domain': string;
10
- /** Name of the subdomain */
11
- 'subdomain': string;
12
- };
13
- export declare type AssignSubdomainServiceData = {
14
- /** The ID of the service to assign the subdomain to. Example: "example-service" */
15
- 'serviceId': string;
16
- /** The ID of the project the service belongs to. Example: "default-project" */
17
- 'projectId': string;
18
- /** The name of the port that will be assigned to the subdomain. Example: "port-1" */
19
- 'portName': string;
20
- };
21
- /** Assigns a service port to the given subdomain */
22
- export declare class AssignSubdomainServiceEndpoint extends PostApiEndpoint<AssignSubdomainServiceRequest, AssignSubdomainServiceResult> {
23
- description: string;
24
- withAuth: boolean;
25
- requiredPermissions: string;
26
- endpointUrl: (opts: AssignSubdomainServiceRequest) => string;
27
- body: (payload: AssignSubdomainServiceRequest) => string;
28
- }
@@ -1,29 +0,0 @@
1
- import { ApiCallResponse, PostApiEndpoint } from '../../api-endpoint';
2
- export declare type AttachVolumeResult = any;
3
- export declare type AttachVolumeCall = (opts: AttachVolumeRequest) => Promise<ApiCallResponse<AttachVolumeResult>>;
4
- export declare type AttachVolumeRequest = {
5
- parameters: AttachVolumeParameters;
6
- data: AttachVolumeData;
7
- };
8
- export declare type AttachVolumeParameters = {
9
- /** ID of the project */ 'projectId': string;
10
- /** ID of the volume */
11
- 'volumeId': string;
12
- };
13
- export declare type AttachVolumeData = {
14
- /** The object to attach this volume to. */
15
- 'owningObject': {
16
- /** The internal id of object to attach this volume to. Example: "example-service" */
17
- 'id': string;
18
- /** The type of the object to attach this volume to. Example: "service" */
19
- 'type': 'service';
20
- };
21
- };
22
- /** Attach a volume */
23
- export declare class AttachVolumeEndpoint extends PostApiEndpoint<AttachVolumeRequest, AttachVolumeResult> {
24
- description: string;
25
- withAuth: boolean;
26
- requiredPermissions: string;
27
- endpointUrl: (opts: AttachVolumeRequest) => string;
28
- body: (payload: AttachVolumeRequest) => string;
29
- }
@@ -1,51 +0,0 @@
1
- import { ApiCallResponse, PostApiEndpoint } from '../../api-endpoint';
2
- export declare type BackupAddonResult = {
3
- /** The identifier for the backup. Example: "example-backup" */
4
- 'id': string;
5
- /** The name of the backup. Example: "Example Backup" */
6
- 'name': string;
7
- /** The current status of the backup. Example: "completed" */
8
- 'status': 'scheduled' | 'in-progress' | 'completed' | 'aborting' | 'aborted' | 'failed' | 'not-supported';
9
- /** The time the backup was initiated. Example: "2021-01-20T11:19:53.175Z" */
10
- 'createdAt': string;
11
- /** The time the backup was completed. Example: "2021-01-20T11:19:54.494Z" */
12
- 'completedAt': string;
13
- /** Data about the backup configuration. */
14
- 'config': {
15
- /** Data about the source of the backup. */
16
- 'source'?: {
17
- /** The type of backup. Example: "snapshot" */
18
- 'type'?: 'fileUpload' | 'liveInstance' | 'snapshot' | 'externalDump' | 'sameAddon';
19
- };
20
- /** The size of the backup, in bytes Example: "1234" */
21
- 'size': string;
22
- /** The version of the addon at the time of the backup. If the backup type is `snapshot`, the addon will be restored to this version when the backup is restored. Example: "4.4.8" */
23
- 'addonVersion'?: string;
24
- };
25
- /** An object containing the restore history for the given backup. Example: {"1611305397038":{"restoreTimestamp":"2021-01-22T08:49:57.038Z","status":"completed","completedAt":"2021-01-22T08:50:30.749Z"}} */
26
- 'restores': any;
27
- };
28
- export declare type BackupAddonCall = (opts: BackupAddonRequest) => Promise<ApiCallResponse<BackupAddonResult>>;
29
- export declare type BackupAddonRequest = {
30
- parameters: BackupAddonParameters;
31
- data: BackupAddonData;
32
- };
33
- export declare type BackupAddonParameters = {
34
- /** ID of the project */ 'projectId': string;
35
- /** ID of the addon */
36
- 'addonId': string;
37
- };
38
- export declare type BackupAddonData = {
39
- /** The name of the backup. If not provided, a default name will be generated containing the current date. Example: "Example Backup" */
40
- 'name'?: string;
41
- /** The type of backup to perform. Defaults to `snapshot`. Example: "snapshot" */
42
- 'backupType'?: 'dump' | 'snapshot';
43
- };
44
- /** Initiates a backup for the given addon */
45
- export declare class BackupAddonEndpoint extends PostApiEndpoint<BackupAddonRequest, BackupAddonResult> {
46
- description: string;
47
- withAuth: boolean;
48
- requiredPermissions: string;
49
- endpointUrl: (opts: BackupAddonRequest) => string;
50
- body: (payload: BackupAddonRequest) => string;
51
- }
@@ -1,40 +0,0 @@
1
- import { ApiCallResponse, PostApiEndpoint } from '../../../api-endpoint';
2
- export declare type CreateAddonBackupscheduleResult = {
3
- /** ID of the schedule. Example: "62cc20b90956ab62a58e8474" */
4
- 'id': string;
5
- };
6
- export declare type CreateAddonBackupscheduleCall = (opts: CreateAddonBackupscheduleRequest) => Promise<ApiCallResponse<CreateAddonBackupscheduleResult>>;
7
- export declare type CreateAddonBackupscheduleRequest = {
8
- parameters: CreateAddonBackupscheduleParameters;
9
- data: CreateAddonBackupscheduleData;
10
- };
11
- export declare type CreateAddonBackupscheduleParameters = {
12
- /** ID of the project */ 'projectId': string;
13
- /** ID of the addon */
14
- 'addonId': string;
15
- };
16
- export declare type CreateAddonBackupscheduleData = {
17
- /** Schedule for the backup. */
18
- 'scheduling': {
19
- /** The interval between backups. Each addon can only have one backup schedule of each interval for each backup type. Example: "weekly" */
20
- 'interval': 'hourly' | 'daily' | 'weekly';
21
- /** An array of minutes when the backup should be performed. */
22
- 'minute': number[];
23
- /** 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. */
24
- 'hour'?: number[];
25
- /** 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. */
26
- 'day'?: number[];
27
- };
28
- /** The type of the backup to be performed. Example: "snapshot" */
29
- 'backupType': 'dump' | 'snapshot';
30
- /** 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 */
31
- 'retentionTime': number;
32
- };
33
- /** Create a new backup schedule for an addon. */
34
- export declare class CreateAddonBackupscheduleEndpoint extends PostApiEndpoint<CreateAddonBackupscheduleRequest, CreateAddonBackupscheduleResult> {
35
- description: string;
36
- withAuth: boolean;
37
- requiredPermissions: string;
38
- endpointUrl: (opts: CreateAddonBackupscheduleRequest) => string;
39
- body: (payload: CreateAddonBackupscheduleRequest) => string;
40
- }
@@ -1,101 +0,0 @@
1
- import { ApiCallResponse, PostApiEndpoint } from '../../api-endpoint';
2
- export declare type CreateAddonResult = {
3
- /** Identifier for the addon. Example: "example-addon" */
4
- 'id': string;
5
- /** Addon name. Example: "Example Addon" */
6
- 'name': string;
7
- /** Full identifier for the addon. Example: "/example-user/default-project/example-addon" */
8
- 'appId': string;
9
- /** A short description of the addon. Example: "This is the addon description" */
10
- 'description'?: string;
11
- /** The time the addon was created. Example: "2021-01-20T11:19:53.175Z" */
12
- 'createdAt': string;
13
- /** Details about the addon's specifications. */
14
- 'spec': {
15
- /** The type of the addon Example: "mongodb" */
16
- 'type': string;
17
- /** Details about the addon configuration. */
18
- 'config': {
19
- /** The version of the addon running. Example: "4.2.14" */
20
- 'versionTag': string;
21
- /** The support status of the current addon version. Example: "active" */
22
- 'lifecycleStatus': 'active' | 'deprecated' | 'discontinued';
23
- /** Details about the addon deployment. */
24
- 'deployment': {
25
- /** The number of replicas running for this addon. Example: 1 */
26
- 'replicas': number;
27
- /** The type of storage used by the addon. Example: "ssd" */
28
- 'storageClass': string;
29
- /** The size of the addon storage, in MB. Example: 4096 */
30
- 'storageSize': number;
31
- /** The deployment plan used by the addon. Example: "nf-compute-20" */
32
- 'planId': string;
33
- /** The region where the addon is deployed. Example: "europe-west" */
34
- 'region': string;
35
- };
36
- /** Details about the addon networking settings. */
37
- 'networking': {
38
- /** Whether this addon is provisioned with a TLS certificate. Example: true */
39
- 'tlsEnabled': boolean;
40
- /** Whether this addon is publicly accessible via the internet. Example: true */
41
- 'externalAccessEnabled': boolean;
42
- /** An array of IP policy rules. */
43
- 'ipPolicies'?: {
44
- /** An IP address used by this rule. Example: "127.0.0.1" */
45
- 'address': string;
46
- /** The action for this rule. Example: "ALLOW" */
47
- 'action': 'DENY' | 'ALLOW';
48
- }[];
49
- };
50
- };
51
- };
52
- /** The current state of the addon. Example: "preDeployment" */
53
- 'status': 'preDeployment' | 'triggerAllocation' | 'allocating' | 'postDeployment' | 'running' | 'paused' | 'scaling' | 'upgrading' | 'backup' | 'restore' | 'failed' | 'deleting' | 'deleted';
54
- };
55
- export declare type CreateAddonCall = (opts: CreateAddonRequest) => Promise<ApiCallResponse<CreateAddonResult>>;
56
- export declare type CreateAddonRequest = {
57
- parameters: CreateAddonParameters;
58
- data: CreateAddonData;
59
- };
60
- export declare type CreateAddonParameters = {
61
- /** ID of the project */ 'projectId': string;
62
- };
63
- export declare type CreateAddonData = {
64
- /** The name of the addon. Example: "Example Addon" */
65
- 'name': string;
66
- /** A description of the addon. Example: "An addon description" */
67
- 'description'?: string;
68
- /** The identifier for the type of addon. Addon types can be found at the Get Addon Types endpoint. Example: "postgres" */
69
- 'type': string;
70
- /** The version of the addon type to use. Example: "12.4.0" */
71
- 'version': string;
72
- 'billing': {
73
- /** The ID of the deployment plan to use. Example: "nf-compute-20" */
74
- 'deploymentPlan': string;
75
- /** The type of storage. Only configurable if the relevant feature flag is enabled for you account Example: "ssd" */
76
- 'storageClass'?: 'ssd' | 'hdd';
77
- /** The size of the addon storage, in megabytes. Example: 4096 */
78
- 'storage': number;
79
- /** The number of addon replicas to run. Example: 1 */
80
- 'replicas': number;
81
- };
82
- /** Optional object containing data about an existing addon to fork. If provided, the addon will be created from that existing addon backup. */
83
- 'source'?: {
84
- /** ID of the addon to fork. Example: "existing-addon" */
85
- 'addonId': string;
86
- /** ID of a backup belonging to that addon to use for the fork. Example: "existing-backup" */
87
- 'backupId': string;
88
- };
89
- /** Enables access to the addon via TLS (if supported by the addon type). */
90
- 'tlsEnabled'?: boolean;
91
- /** Enables external access to the addon via TLS (if supported by the addon type). */
92
- 'externalAccessEnabled'?: boolean;
93
- };
94
- /** Creates a new addon */
95
- export declare class CreateAddonEndpoint extends PostApiEndpoint<CreateAddonRequest, CreateAddonResult> {
96
- description: string;
97
- withAuth: boolean;
98
- requiredPermissions: string;
99
- endpointUrl: (opts: CreateAddonRequest) => string;
100
- body: (payload: CreateAddonRequest) => string;
101
- }
@@ -1,97 +0,0 @@
1
- import { ApiCallResponse, PostApiEndpoint } from '../../api-endpoint';
2
- export declare type CreateClusterResult = {
3
- /** Identifier for the cluster. Example: "gcp-cluster-1" */
4
- 'id': string;
5
- /** The name of the cluster. Example: "GCP Cluster 1" */
6
- 'name': string;
7
- /** A short description of the cluster. Example: "The cluster description" */
8
- 'description'?: string;
9
- /** The cloud provider to which this cluster belongs to. Example: "gcp" */
10
- 'provider'?: string;
11
- /** ID of the provider integration used by this cluster. Example: "gcp-integration" */
12
- 'integrationId': string;
13
- 'nodePools': {
14
- 'availabilityZones'?: string[];
15
- 'nodeTypes': string[];
16
- 'nodeCount': number;
17
- 'autoscaling'?: {
18
- 'enabled'?: boolean;
19
- 'min'?: number;
20
- 'max'?: number;
21
- };
22
- /** Configures node pool with preemptible / spot instances if enabled. */
23
- 'preemptible'?: boolean;
24
- 'diskType'?: string;
25
- 'diskSize': number;
26
- /** 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" */
27
- 'id'?: string;
28
- };
29
- 'status'?: {
30
- 'state'?: {
31
- 'state'?: string;
32
- 'transitionTime'?: string;
33
- };
34
- 'nextUpdateAfter'?: string;
35
- };
36
- /** The time the cluster was created. Example: "2021-01-20T11:19:53.175Z" */
37
- 'createdAt': string;
38
- /** Indicates if provider resource deletion has been requested by the user. */
39
- 'deletionRequested': boolean;
40
- };
41
- export declare type CreateClusterCall = (opts: CreateClusterRequest) => Promise<ApiCallResponse<CreateClusterResult>>;
42
- export declare type CreateClusterRequest = {
43
- data: CreateClusterData;
44
- };
45
- export declare type CreateClusterData = {
46
- /** The name of the cluster. Example: "GCP Cluster 1" */
47
- 'name': string;
48
- /** The description of the cluster. Example: "This is a new cluster." */
49
- 'description'?: string;
50
- /** Cloud provider to be used for the selected resource Example: "gcp" */
51
- 'provider': 'gcp' | 'aws' | 'azure' | 'do';
52
- /** Region of the cluster. */
53
- 'region': string;
54
- /** Kubernetes version of the cluster. */
55
- 'kubernetesVersion': string;
56
- /** Existing integration to use for this cluster. Example: "gcp-integration" */
57
- 'integrationId'?: string;
58
- /** Cloud provider credential input, required fields dependent on which provider is chosen. */
59
- 'integration'?: {
60
- /** Contents of a GCP key file. */
61
- 'keyfileJson'?: string;
62
- /** AWS access key. */
63
- 'accessKey'?: string;
64
- /** AWS secret key. */
65
- 'secretKey'?: string;
66
- /** DO API key. */
67
- 'apiKey'?: string;
68
- };
69
- /** An array of node pools. */
70
- 'nodePools': {
71
- 'availabilityZones'?: string[];
72
- 'nodeTypes': string[];
73
- 'nodeCount': number;
74
- 'autoscaling'?: {
75
- 'enabled'?: boolean;
76
- 'min'?: number;
77
- 'max'?: number;
78
- };
79
- /** Configures node pool with preemptible / spot instances if enabled. */
80
- 'preemptible'?: boolean;
81
- 'diskType'?: string;
82
- 'diskSize': number;
83
- }[];
84
- /** GCP specific data. Required when `provider` is `gcp`. */
85
- 'gcp'?: {
86
- /** Project ID */
87
- 'projectId': string;
88
- };
89
- };
90
- /** Creates a new cluster. */
91
- export declare class CreateClusterEndpoint extends PostApiEndpoint<CreateClusterRequest, CreateClusterResult> {
92
- description: string;
93
- withAuth: boolean;
94
- requiredPermissions: string;
95
- endpointUrl: (opts: CreateClusterRequest) => string;
96
- body: (payload: CreateClusterRequest) => string;
97
- }
@@ -1,27 +0,0 @@
1
- import { ApiCallResponse, PostApiEndpoint } from '../../api-endpoint';
2
- export declare type CreateDomainResult = {
3
- /** The domain name. Example: "example.com" */
4
- 'name': string;
5
- /** The status of the domain verification. Example: "pending" */
6
- 'status': 'pending' | 'verified';
7
- /** The hostname to add to your domain's DNS records as a TXT record to verify the domain. Example: "nfverify1608026055" */
8
- 'hostname': string;
9
- /** The token to add as the content of the TXT record to verify the domain. Example: "e596987b52855a4a773ef580ce2985d7746b37ce8b2a443d20fa27b913d8f57" */
10
- 'token': string;
11
- } | any;
12
- export declare type CreateDomainCall = (opts: CreateDomainRequest) => Promise<ApiCallResponse<CreateDomainResult>>;
13
- export declare type CreateDomainRequest = {
14
- data: CreateDomainData;
15
- };
16
- export declare type CreateDomainData = {
17
- /** The domain name to register. Example: "example.com" */
18
- 'domain': string;
19
- };
20
- /** Registers a new domain */
21
- export declare class CreateDomainEndpoint extends PostApiEndpoint<CreateDomainRequest, CreateDomainResult> {
22
- description: string;
23
- withAuth: boolean;
24
- requiredPermissions: string;
25
- endpointUrl: (opts: CreateDomainRequest) => string;
26
- body: (payload: CreateDomainRequest) => string;
27
- }