@northflank/js-client 0.6.0 → 0.6.3-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.
- package/dist/cjs/api-client.d.ts +2144 -142
- package/dist/cjs/api-client.js +1 -1
- package/dist/cjs/api-endpoint.d.ts +57 -0
- package/dist/cjs/api-error.d.ts +16 -0
- package/dist/cjs/context/api-client-context-provider.d.ts +47 -0
- package/dist/cjs/context/api-client-file-context-provider.d.ts +11 -0
- package/dist/cjs/context/api-client-in-memory-context-provider.d.ts +6 -0
- package/dist/cjs/context/index.d.ts +3 -0
- package/dist/cjs/endpoints/abort/addon/backup.d.ts +21 -0
- package/dist/cjs/endpoints/abort/addon/restore.d.ts +26 -0
- package/dist/cjs/endpoints/abort/job/build.d.ts +21 -0
- package/dist/cjs/endpoints/abort/job/run.d.ts +21 -0
- package/dist/cjs/endpoints/abort/service/build.d.ts +21 -0
- package/dist/cjs/endpoints/add/domain/subdomain.d.ts +33 -0
- package/dist/cjs/endpoints/add/registry.d.ts +47 -0
- package/dist/cjs/endpoints/assign/subdomain/service.d.ts +28 -0
- package/dist/cjs/endpoints/attach/volume.d.ts +29 -0
- package/dist/cjs/endpoints/backup/addon.d.ts +51 -0
- package/dist/cjs/endpoints/create/addon/backupSchedule.d.ts +40 -0
- package/dist/cjs/endpoints/create/addon.d.ts +101 -0
- package/dist/cjs/endpoints/create/cluster.d.ts +97 -0
- package/dist/cjs/endpoints/create/domain.d.ts +27 -0
- package/dist/cjs/endpoints/create/integration.d.ts +58 -0
- package/dist/cjs/endpoints/create/job/cron.d.ts +247 -0
- package/dist/cjs/endpoints/create/job/manual.d.ts +237 -0
- package/dist/cjs/endpoints/create/project.d.ts +31 -0
- package/dist/cjs/endpoints/create/secret.d.ts +83 -0
- package/dist/cjs/endpoints/create/service/build.d.ts +161 -0
- package/dist/cjs/endpoints/create/service/combined.d.ts +232 -0
- package/dist/cjs/endpoints/create/service/deployment.d.ts +219 -0
- package/dist/cjs/endpoints/create/template.d.ts +132 -0
- package/dist/cjs/endpoints/create/volume.d.ts +78 -0
- package/dist/cjs/endpoints/delete/addon/backupSchedule.d.ts +21 -0
- package/dist/cjs/endpoints/delete/addon.d.ts +19 -0
- package/dist/cjs/endpoints/delete/backup.d.ts +21 -0
- package/dist/cjs/endpoints/delete/cluster.d.ts +17 -0
- package/dist/cjs/endpoints/delete/domain.d.ts +17 -0
- package/dist/cjs/endpoints/delete/integration.d.ts +17 -0
- package/dist/cjs/endpoints/delete/job.d.ts +19 -0
- package/dist/cjs/endpoints/delete/project.d.ts +17 -0
- package/dist/cjs/endpoints/delete/registry.d.ts +17 -0
- package/dist/cjs/endpoints/delete/secret.d.ts +19 -0
- package/dist/cjs/endpoints/delete/secretLink.d.ts +21 -0
- package/dist/cjs/endpoints/delete/service.d.ts +19 -0
- package/dist/cjs/endpoints/delete/subdomain.d.ts +19 -0
- package/dist/cjs/endpoints/delete/template.d.ts +17 -0
- package/dist/cjs/endpoints/delete/volume.d.ts +19 -0
- package/dist/cjs/endpoints/detach/volume.d.ts +21 -0
- package/dist/cjs/endpoints/get/addon/backup/download.d.ts +24 -0
- package/dist/cjs/endpoints/get/addon/backup.d.ts +46 -0
- package/dist/cjs/endpoints/get/addon/backupSchedules.d.ts +52 -0
- package/dist/cjs/endpoints/get/addon/backups.d.ts +54 -0
- package/dist/cjs/endpoints/get/addon/containers.d.ts +40 -0
- package/dist/cjs/endpoints/get/addon/credentials.d.ts +24 -0
- package/dist/cjs/endpoints/get/addon/types.d.ts +48 -0
- package/dist/cjs/endpoints/get/addon/version.d.ts +53 -0
- package/dist/cjs/endpoints/get/addon.d.ts +71 -0
- package/dist/cjs/endpoints/get/cluster.d.ts +55 -0
- package/dist/cjs/endpoints/get/dnsId.d.ts +15 -0
- package/dist/cjs/endpoints/get/domain.d.ts +33 -0
- package/dist/cjs/endpoints/get/integration.d.ts +37 -0
- package/dist/cjs/endpoints/get/invoice/details.d.ts +139 -0
- package/dist/cjs/endpoints/get/job/branches.d.ts +49 -0
- package/dist/cjs/endpoints/get/job/build.d.ts +42 -0
- package/dist/cjs/endpoints/get/job/buildArgumentDetails.d.ts +71 -0
- package/dist/cjs/endpoints/get/job/buildArguments.d.ts +29 -0
- package/dist/cjs/endpoints/get/job/builds.d.ts +52 -0
- package/dist/cjs/endpoints/get/job/containers.d.ts +40 -0
- package/dist/cjs/endpoints/get/job/deployment.d.ts +55 -0
- package/dist/cjs/endpoints/get/job/healthChecks.d.ts +45 -0
- package/dist/cjs/endpoints/get/job/pullRequests.d.ts +49 -0
- package/dist/cjs/endpoints/get/job/run.d.ts +44 -0
- package/dist/cjs/endpoints/get/job/runs.d.ts +54 -0
- package/dist/cjs/endpoints/get/job/runtimeEnvironment.d.ts +29 -0
- package/dist/cjs/endpoints/get/job/runtimeEnvironmentDetails.d.ts +71 -0
- package/dist/cjs/endpoints/get/job.d.ts +128 -0
- package/dist/cjs/endpoints/get/project.d.ts +72 -0
- package/dist/cjs/endpoints/get/registry.d.ts +34 -0
- package/dist/cjs/endpoints/get/secret.d.ts +55 -0
- package/dist/cjs/endpoints/get/secretDetails.d.ts +63 -0
- package/dist/cjs/endpoints/get/secretLink.d.ts +44 -0
- package/dist/cjs/endpoints/get/service/branches.d.ts +49 -0
- package/dist/cjs/endpoints/get/service/build.d.ts +42 -0
- package/dist/cjs/endpoints/get/service/buildArgumentDetails.d.ts +71 -0
- package/dist/cjs/endpoints/get/service/buildArguments.d.ts +29 -0
- package/dist/cjs/endpoints/get/service/builds.d.ts +52 -0
- package/dist/cjs/endpoints/get/service/containers.d.ts +40 -0
- package/dist/cjs/endpoints/get/service/deployment.d.ts +55 -0
- package/dist/cjs/endpoints/get/service/healthChecks.d.ts +45 -0
- package/dist/cjs/endpoints/get/service/ports.d.ts +70 -0
- package/dist/cjs/endpoints/get/service/pullRequests.d.ts +49 -0
- package/dist/cjs/endpoints/get/service/runtimeEnvironment.d.ts +29 -0
- package/dist/cjs/endpoints/get/service/runtimeEnvironmentDetails.d.ts +71 -0
- package/dist/cjs/endpoints/get/service.d.ts +211 -0
- package/dist/cjs/endpoints/get/subdomain.d.ts +30 -0
- package/dist/cjs/endpoints/get/template.d.ts +61 -0
- package/dist/cjs/endpoints/get/templateRun.d.ts +73 -0
- package/dist/cjs/endpoints/get/volume.d.ts +49 -0
- package/dist/cjs/endpoints/import/addon/backup.d.ts +31 -0
- package/dist/cjs/endpoints/list/addons.d.ts +45 -0
- package/dist/cjs/endpoints/list/branches.d.ts +51 -0
- package/dist/cjs/endpoints/list/clusters.d.ts +63 -0
- package/dist/cjs/endpoints/list/domains.d.ts +34 -0
- package/dist/cjs/endpoints/list/integrations.d.ts +36 -0
- package/dist/cjs/endpoints/list/invoices.d.ts +40 -0
- package/dist/cjs/endpoints/list/jobs.d.ts +46 -0
- package/dist/cjs/endpoints/list/plans.d.ts +30 -0
- package/dist/cjs/endpoints/list/projects.d.ts +32 -0
- package/dist/cjs/endpoints/list/providers.d.ts +37 -0
- package/dist/cjs/endpoints/list/regions.d.ts +18 -0
- package/dist/cjs/endpoints/list/registries.d.ts +41 -0
- package/dist/cjs/endpoints/list/repos.d.ts +51 -0
- package/dist/cjs/endpoints/list/secrets.d.ts +54 -0
- package/dist/cjs/endpoints/list/services.d.ts +65 -0
- package/dist/cjs/endpoints/list/templateRuns.d.ts +54 -0
- package/dist/cjs/endpoints/list/templates.d.ts +41 -0
- package/dist/cjs/endpoints/list/vcs.d.ts +32 -0
- package/dist/cjs/endpoints/list/volumes.d.ts +47 -0
- package/dist/cjs/endpoints/pause/addon.d.ts +19 -0
- package/dist/cjs/endpoints/pause/job.d.ts +19 -0
- package/dist/cjs/endpoints/pause/service.d.ts +19 -0
- package/dist/cjs/endpoints/restart/addon.d.ts +19 -0
- package/dist/cjs/endpoints/restart/service.d.ts +19 -0
- package/dist/cjs/endpoints/restore/addon/backup.d.ts +24 -0
- package/dist/cjs/endpoints/resume/addon.d.ts +19 -0
- package/dist/cjs/endpoints/resume/job.d.ts +28 -0
- package/dist/cjs/endpoints/resume/service.d.ts +28 -0
- package/dist/cjs/endpoints/retain/addon/backup.d.ts +21 -0
- package/dist/cjs/endpoints/run/template.d.ts +62 -0
- package/dist/cjs/endpoints/scale/addon.d.ts +28 -0
- package/dist/cjs/endpoints/scale/job.d.ts +30 -0
- package/dist/cjs/endpoints/scale/service.d.ts +32 -0
- package/dist/cjs/endpoints/start/job/build.d.ts +47 -0
- package/dist/cjs/endpoints/start/job/run.d.ts +74 -0
- package/dist/cjs/endpoints/start/service/build.d.ts +55 -0
- package/dist/cjs/endpoints/suspend/job.d.ts +24 -0
- package/dist/cjs/endpoints/unassign/subdomain.d.ts +19 -0
- package/dist/cjs/endpoints/update/addon/networkSettings.d.ts +26 -0
- package/dist/cjs/endpoints/update/addon/security.d.ts +29 -0
- package/dist/cjs/endpoints/update/addon/version.d.ts +24 -0
- package/dist/cjs/endpoints/update/cluster.d.ts +76 -0
- package/dist/cjs/endpoints/update/integration.d.ts +53 -0
- package/dist/cjs/endpoints/update/job/buildArguments.d.ts +29 -0
- package/dist/cjs/endpoints/update/job/buildOptions.d.ts +50 -0
- package/dist/cjs/endpoints/update/job/buildSource.d.ts +32 -0
- package/dist/cjs/endpoints/update/job/cmdOverride.d.ts +24 -0
- package/dist/cjs/endpoints/update/job/deployment.d.ts +39 -0
- package/dist/cjs/endpoints/update/job/entrypointOverride.d.ts +24 -0
- package/dist/cjs/endpoints/update/job/healthChecks.d.ts +45 -0
- package/dist/cjs/endpoints/update/job/runtimeEnvironment.d.ts +29 -0
- package/dist/cjs/endpoints/update/job/settings.d.ts +32 -0
- package/dist/cjs/endpoints/update/registry.d.ts +31 -0
- package/dist/cjs/endpoints/update/secret.d.ts +58 -0
- package/dist/cjs/endpoints/update/secretLink.d.ts +40 -0
- package/dist/cjs/endpoints/update/service/buildArguments.d.ts +29 -0
- package/dist/cjs/endpoints/update/service/buildOptions.d.ts +62 -0
- package/dist/cjs/endpoints/update/service/buildSource.d.ts +32 -0
- package/dist/cjs/endpoints/update/service/cmdOverride.d.ts +24 -0
- package/dist/cjs/endpoints/update/service/deployment.d.ts +39 -0
- package/dist/cjs/endpoints/update/service/entrypointOverride.d.ts +24 -0
- package/dist/cjs/endpoints/update/service/healthChecks.d.ts +45 -0
- package/dist/cjs/endpoints/update/service/ports.d.ts +57 -0
- package/dist/cjs/endpoints/update/service/runtimeEnvironment.d.ts +34 -0
- package/dist/cjs/endpoints/update/template.d.ts +81 -0
- package/dist/cjs/endpoints/update/volume.d.ts +33 -0
- package/dist/cjs/endpoints/verify/domain.d.ts +17 -0
- package/dist/cjs/endpoints/verify/subdomain.d.ts +19 -0
- package/dist/cjs/exec-command/client/exec-command-runner.d.ts +70 -0
- package/dist/cjs/exec-command/client/exec-command-standard.d.ts +42 -0
- package/dist/cjs/port-forward/client/api-helper.d.ts +30 -0
- package/dist/cjs/port-forward/client/atomic-write.d.ts +2 -0
- package/dist/cjs/port-forward/client/host-file-ast.d.ts +52 -0
- package/dist/cjs/port-forward/client/host-file.d.ts +26 -0
- package/dist/cjs/port-forward/client/loopback.d.ts +4 -0
- package/dist/cjs/port-forward/client/port-forwarder.d.ts +87 -0
- package/dist/cjs/port-forward/client/port-tunnel-tcp.d.ts +36 -0
- package/dist/cjs/port-forward/client/port-tunnel-udp.d.ts +27 -0
- package/dist/cjs/port-forward/client/promise-mutex.d.ts +4 -0
- package/dist/cjs/utils.d.ts +21 -0
- package/dist/esm/api-client.d.ts +2144 -142
- package/dist/esm/api-client.js +2 -2
- package/dist/esm/api-endpoint.d.ts +57 -0
- package/dist/esm/api-error.d.ts +16 -0
- package/dist/esm/context/api-client-context-provider.d.ts +47 -0
- package/dist/esm/context/api-client-file-context-provider.d.ts +11 -0
- package/dist/esm/context/api-client-in-memory-context-provider.d.ts +6 -0
- package/dist/esm/context/index.d.ts +3 -0
- package/dist/esm/endpoints/abort/addon/backup.d.ts +21 -0
- package/dist/esm/endpoints/abort/addon/restore.d.ts +26 -0
- package/dist/esm/endpoints/abort/job/build.d.ts +21 -0
- package/dist/esm/endpoints/abort/job/run.d.ts +21 -0
- package/dist/esm/endpoints/abort/service/build.d.ts +21 -0
- package/dist/esm/endpoints/add/domain/subdomain.d.ts +33 -0
- package/dist/esm/endpoints/add/registry.d.ts +47 -0
- package/dist/esm/endpoints/assign/subdomain/service.d.ts +28 -0
- package/dist/esm/endpoints/attach/volume.d.ts +29 -0
- package/dist/esm/endpoints/backup/addon.d.ts +51 -0
- package/dist/esm/endpoints/create/addon/backupSchedule.d.ts +40 -0
- package/dist/esm/endpoints/create/addon.d.ts +101 -0
- package/dist/esm/endpoints/create/cluster.d.ts +97 -0
- package/dist/esm/endpoints/create/domain.d.ts +27 -0
- package/dist/esm/endpoints/create/integration.d.ts +58 -0
- package/dist/esm/endpoints/create/job/cron.d.ts +247 -0
- package/dist/esm/endpoints/create/job/manual.d.ts +237 -0
- package/dist/esm/endpoints/create/project.d.ts +31 -0
- package/dist/esm/endpoints/create/secret.d.ts +83 -0
- package/dist/esm/endpoints/create/service/build.d.ts +161 -0
- package/dist/esm/endpoints/create/service/combined.d.ts +232 -0
- package/dist/esm/endpoints/create/service/deployment.d.ts +219 -0
- package/dist/esm/endpoints/create/template.d.ts +132 -0
- package/dist/esm/endpoints/create/volume.d.ts +78 -0
- package/dist/esm/endpoints/delete/addon/backupSchedule.d.ts +21 -0
- package/dist/esm/endpoints/delete/addon.d.ts +19 -0
- package/dist/esm/endpoints/delete/backup.d.ts +21 -0
- package/dist/esm/endpoints/delete/cluster.d.ts +17 -0
- package/dist/esm/endpoints/delete/domain.d.ts +17 -0
- package/dist/esm/endpoints/delete/integration.d.ts +17 -0
- package/dist/esm/endpoints/delete/job.d.ts +19 -0
- package/dist/esm/endpoints/delete/project.d.ts +17 -0
- package/dist/esm/endpoints/delete/registry.d.ts +17 -0
- package/dist/esm/endpoints/delete/secret.d.ts +19 -0
- package/dist/esm/endpoints/delete/secretLink.d.ts +21 -0
- package/dist/esm/endpoints/delete/service.d.ts +19 -0
- package/dist/esm/endpoints/delete/subdomain.d.ts +19 -0
- package/dist/esm/endpoints/delete/template.d.ts +17 -0
- package/dist/esm/endpoints/delete/volume.d.ts +19 -0
- package/dist/esm/endpoints/detach/volume.d.ts +21 -0
- package/dist/esm/endpoints/get/addon/backup/download.d.ts +24 -0
- package/dist/esm/endpoints/get/addon/backup.d.ts +46 -0
- package/dist/esm/endpoints/get/addon/backupSchedules.d.ts +52 -0
- package/dist/esm/endpoints/get/addon/backups.d.ts +54 -0
- package/dist/esm/endpoints/get/addon/containers.d.ts +40 -0
- package/dist/esm/endpoints/get/addon/credentials.d.ts +24 -0
- package/dist/esm/endpoints/get/addon/types.d.ts +48 -0
- package/dist/esm/endpoints/get/addon/version.d.ts +53 -0
- package/dist/esm/endpoints/get/addon.d.ts +71 -0
- package/dist/esm/endpoints/get/cluster.d.ts +55 -0
- package/dist/esm/endpoints/get/dnsId.d.ts +15 -0
- package/dist/esm/endpoints/get/domain.d.ts +33 -0
- package/dist/esm/endpoints/get/integration.d.ts +37 -0
- package/dist/esm/endpoints/get/invoice/details.d.ts +139 -0
- package/dist/esm/endpoints/get/job/branches.d.ts +49 -0
- package/dist/esm/endpoints/get/job/build.d.ts +42 -0
- package/dist/esm/endpoints/get/job/buildArgumentDetails.d.ts +71 -0
- package/dist/esm/endpoints/get/job/buildArguments.d.ts +29 -0
- package/dist/esm/endpoints/get/job/builds.d.ts +52 -0
- package/dist/esm/endpoints/get/job/containers.d.ts +40 -0
- package/dist/esm/endpoints/get/job/deployment.d.ts +55 -0
- package/dist/esm/endpoints/get/job/healthChecks.d.ts +45 -0
- package/dist/esm/endpoints/get/job/pullRequests.d.ts +49 -0
- package/dist/esm/endpoints/get/job/run.d.ts +44 -0
- package/dist/esm/endpoints/get/job/runs.d.ts +54 -0
- package/dist/esm/endpoints/get/job/runtimeEnvironment.d.ts +29 -0
- package/dist/esm/endpoints/get/job/runtimeEnvironmentDetails.d.ts +71 -0
- package/dist/esm/endpoints/get/job.d.ts +128 -0
- package/dist/esm/endpoints/get/project.d.ts +72 -0
- package/dist/esm/endpoints/get/registry.d.ts +34 -0
- package/dist/esm/endpoints/get/secret.d.ts +55 -0
- package/dist/esm/endpoints/get/secretDetails.d.ts +63 -0
- package/dist/esm/endpoints/get/secretLink.d.ts +44 -0
- package/dist/esm/endpoints/get/service/branches.d.ts +49 -0
- package/dist/esm/endpoints/get/service/build.d.ts +42 -0
- package/dist/esm/endpoints/get/service/buildArgumentDetails.d.ts +71 -0
- package/dist/esm/endpoints/get/service/buildArguments.d.ts +29 -0
- package/dist/esm/endpoints/get/service/builds.d.ts +52 -0
- package/dist/esm/endpoints/get/service/containers.d.ts +40 -0
- package/dist/esm/endpoints/get/service/deployment.d.ts +55 -0
- package/dist/esm/endpoints/get/service/healthChecks.d.ts +45 -0
- package/dist/esm/endpoints/get/service/ports.d.ts +70 -0
- package/dist/esm/endpoints/get/service/pullRequests.d.ts +49 -0
- package/dist/esm/endpoints/get/service/runtimeEnvironment.d.ts +29 -0
- package/dist/esm/endpoints/get/service/runtimeEnvironmentDetails.d.ts +71 -0
- package/dist/esm/endpoints/get/service.d.ts +211 -0
- package/dist/esm/endpoints/get/subdomain.d.ts +30 -0
- package/dist/esm/endpoints/get/template.d.ts +61 -0
- package/dist/esm/endpoints/get/templateRun.d.ts +73 -0
- package/dist/esm/endpoints/get/volume.d.ts +49 -0
- package/dist/esm/endpoints/import/addon/backup.d.ts +31 -0
- package/dist/esm/endpoints/list/addons.d.ts +45 -0
- package/dist/esm/endpoints/list/branches.d.ts +51 -0
- package/dist/esm/endpoints/list/clusters.d.ts +63 -0
- package/dist/esm/endpoints/list/domains.d.ts +34 -0
- package/dist/esm/endpoints/list/integrations.d.ts +36 -0
- package/dist/esm/endpoints/list/invoices.d.ts +40 -0
- package/dist/esm/endpoints/list/jobs.d.ts +46 -0
- package/dist/esm/endpoints/list/plans.d.ts +30 -0
- package/dist/esm/endpoints/list/projects.d.ts +32 -0
- package/dist/esm/endpoints/list/providers.d.ts +37 -0
- package/dist/esm/endpoints/list/regions.d.ts +18 -0
- package/dist/esm/endpoints/list/registries.d.ts +41 -0
- package/dist/esm/endpoints/list/repos.d.ts +51 -0
- package/dist/esm/endpoints/list/secrets.d.ts +54 -0
- package/dist/esm/endpoints/list/services.d.ts +65 -0
- package/dist/esm/endpoints/list/templateRuns.d.ts +54 -0
- package/dist/esm/endpoints/list/templates.d.ts +41 -0
- package/dist/esm/endpoints/list/vcs.d.ts +32 -0
- package/dist/esm/endpoints/list/volumes.d.ts +47 -0
- package/dist/esm/endpoints/pause/addon.d.ts +19 -0
- package/dist/esm/endpoints/pause/job.d.ts +19 -0
- package/dist/esm/endpoints/pause/service.d.ts +19 -0
- package/dist/esm/endpoints/restart/addon.d.ts +19 -0
- package/dist/esm/endpoints/restart/service.d.ts +19 -0
- package/dist/esm/endpoints/restore/addon/backup.d.ts +24 -0
- package/dist/esm/endpoints/resume/addon.d.ts +19 -0
- package/dist/esm/endpoints/resume/job.d.ts +28 -0
- package/dist/esm/endpoints/resume/service.d.ts +28 -0
- package/dist/esm/endpoints/retain/addon/backup.d.ts +21 -0
- package/dist/esm/endpoints/run/template.d.ts +62 -0
- package/dist/esm/endpoints/scale/addon.d.ts +28 -0
- package/dist/esm/endpoints/scale/job.d.ts +30 -0
- package/dist/esm/endpoints/scale/service.d.ts +32 -0
- package/dist/esm/endpoints/start/job/build.d.ts +47 -0
- package/dist/esm/endpoints/start/job/run.d.ts +74 -0
- package/dist/esm/endpoints/start/service/build.d.ts +55 -0
- package/dist/esm/endpoints/suspend/job.d.ts +24 -0
- package/dist/esm/endpoints/unassign/subdomain.d.ts +19 -0
- package/dist/esm/endpoints/update/addon/networkSettings.d.ts +26 -0
- package/dist/esm/endpoints/update/addon/security.d.ts +29 -0
- package/dist/esm/endpoints/update/addon/version.d.ts +24 -0
- package/dist/esm/endpoints/update/cluster.d.ts +76 -0
- package/dist/esm/endpoints/update/integration.d.ts +53 -0
- package/dist/esm/endpoints/update/job/buildArguments.d.ts +29 -0
- package/dist/esm/endpoints/update/job/buildOptions.d.ts +50 -0
- package/dist/esm/endpoints/update/job/buildSource.d.ts +32 -0
- package/dist/esm/endpoints/update/job/cmdOverride.d.ts +24 -0
- package/dist/esm/endpoints/update/job/deployment.d.ts +39 -0
- package/dist/esm/endpoints/update/job/entrypointOverride.d.ts +24 -0
- package/dist/esm/endpoints/update/job/healthChecks.d.ts +45 -0
- package/dist/esm/endpoints/update/job/runtimeEnvironment.d.ts +29 -0
- package/dist/esm/endpoints/update/job/settings.d.ts +32 -0
- package/dist/esm/endpoints/update/registry.d.ts +31 -0
- package/dist/esm/endpoints/update/secret.d.ts +58 -0
- package/dist/esm/endpoints/update/secretLink.d.ts +40 -0
- package/dist/esm/endpoints/update/service/buildArguments.d.ts +29 -0
- package/dist/esm/endpoints/update/service/buildOptions.d.ts +62 -0
- package/dist/esm/endpoints/update/service/buildSource.d.ts +32 -0
- package/dist/esm/endpoints/update/service/cmdOverride.d.ts +24 -0
- package/dist/esm/endpoints/update/service/deployment.d.ts +39 -0
- package/dist/esm/endpoints/update/service/entrypointOverride.d.ts +24 -0
- package/dist/esm/endpoints/update/service/healthChecks.d.ts +45 -0
- package/dist/esm/endpoints/update/service/ports.d.ts +57 -0
- package/dist/esm/endpoints/update/service/runtimeEnvironment.d.ts +34 -0
- package/dist/esm/endpoints/update/template.d.ts +81 -0
- package/dist/esm/endpoints/update/volume.d.ts +33 -0
- package/dist/esm/endpoints/verify/domain.d.ts +17 -0
- package/dist/esm/endpoints/verify/subdomain.d.ts +19 -0
- package/dist/esm/exec-command/client/exec-command-runner.d.ts +70 -0
- package/dist/esm/exec-command/client/exec-command-standard.d.ts +42 -0
- package/dist/esm/port-forward/client/api-helper.d.ts +30 -0
- package/dist/esm/port-forward/client/atomic-write.d.ts +2 -0
- package/dist/esm/port-forward/client/host-file-ast.d.ts +52 -0
- package/dist/esm/port-forward/client/host-file.d.ts +26 -0
- package/dist/esm/port-forward/client/loopback.d.ts +4 -0
- package/dist/esm/port-forward/client/port-forwarder.d.ts +87 -0
- package/dist/esm/port-forward/client/port-tunnel-tcp.d.ts +36 -0
- package/dist/esm/port-forward/client/port-tunnel-udp.d.ts +27 -0
- package/dist/esm/port-forward/client/promise-mutex.d.ts +4 -0
- package/dist/esm/utils.d.ts +21 -0
- package/package.json +1 -1
package/dist/esm/api-client.d.ts
CHANGED
|
@@ -98,7 +98,13 @@ declare class ApiClientInMemoryContextProvider extends ApiClientContextProvider
|
|
|
98
98
|
protected writeContext(context: ApiClientContextWrapper): Promise<void>;
|
|
99
99
|
}
|
|
100
100
|
|
|
101
|
-
declare
|
|
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'
|
|
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,20 +1273,21 @@ 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
|
}
|
|
1239
1280
|
|
|
1240
1281
|
declare type GetAddonContainersResult = {
|
|
1241
1282
|
/** An array of containers. */
|
|
1242
|
-
'
|
|
1243
|
-
/** The
|
|
1283
|
+
'containers': {
|
|
1284
|
+
/** The name of the container. Example: "example-service-78b4d4459d-sbtn8" */
|
|
1285
|
+
'name': string;
|
|
1286
|
+
/** The timestamp the container was created. Example: 1611241087 */
|
|
1244
1287
|
'createdAt': number;
|
|
1245
|
-
/** The
|
|
1246
|
-
'podName': string;
|
|
1247
|
-
/** The current status of the pod. Example: "TASK_RUNNING" */
|
|
1288
|
+
/** The current status of the container. Example: "TASK_RUNNING" */
|
|
1248
1289
|
'status': 'TASK_RUNNING' | 'TASK_STARTING' | 'TASK_STAGING' | 'TASK_KILLING' | 'TASK_KILLED' | 'TASK_FAILED' | 'TASK_FINISHED';
|
|
1249
|
-
/** The timestamp the
|
|
1290
|
+
/** The timestamp the container was last updated. Example: 1611241087 */
|
|
1250
1291
|
'updatedAt': number;
|
|
1251
1292
|
}[];
|
|
1252
1293
|
};
|
|
@@ -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': '
|
|
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': '
|
|
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': '
|
|
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
|
|
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
|
|
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
|
|
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'?:
|
|
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?
|
|
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': '
|
|
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
|
|
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
|
|
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
|
|
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'?:
|
|
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?
|
|
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': {
|
|
@@ -2010,6 +3106,8 @@ declare type GetJobRunsResult = {
|
|
|
2010
3106
|
'succeeded': number;
|
|
2011
3107
|
/** The timestamp when the job run started. Example: "2020-12-08T11:47:08Z" */
|
|
2012
3108
|
'startedAt': string;
|
|
3109
|
+
/** The timestamp when the job run concluded. Example: "2020-12-08T11:52:08Z" */
|
|
3110
|
+
'concludedAt': string;
|
|
2013
3111
|
}[];
|
|
2014
3112
|
};
|
|
2015
3113
|
declare type GetJobRunsCall = (opts: GetJobRunsRequest) => Promise<ApiCallResponse<GetJobRunsResult>>;
|
|
@@ -2034,6 +3132,7 @@ declare type GetJobRunsOptions = {
|
|
|
2034
3132
|
declare class GetJobRunsEndpoint extends GetApiEndpoint<GetJobRunsRequest, GetJobRunsResult> {
|
|
2035
3133
|
description: string;
|
|
2036
3134
|
withAuth: boolean;
|
|
3135
|
+
requiredPermissions: string;
|
|
2037
3136
|
endpointUrl: (opts: GetJobRunsRequest) => string;
|
|
2038
3137
|
body: () => undefined;
|
|
2039
3138
|
}
|
|
@@ -2057,12 +3156,18 @@ declare type StartJobRunParameters = {
|
|
|
2057
3156
|
declare type StartJobRunData = {
|
|
2058
3157
|
/** An object containing the environment variables overrides to use when running the job. Keys must only contain letters and numbers separated with underscores, may not start with a number Example: {"VARIABLE_1":"abcdef","VARIABLE_2":"12345"} */
|
|
2059
3158
|
'runtimeEnvironment'?: any;
|
|
3159
|
+
'billing'?: {
|
|
3160
|
+
/** The ID of the deployment plan override to use. Example: "nf-compute-20" */
|
|
3161
|
+
'deploymentPlan'?: string;
|
|
3162
|
+
};
|
|
2060
3163
|
'deployment'?: {
|
|
2061
3164
|
/** The CMD override to use when running the job. Example: "nginx -g" */
|
|
2062
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;
|
|
2063
3168
|
'storage'?: {
|
|
2064
3169
|
'ephemeralStorage'?: {
|
|
2065
|
-
/** Ephemeral storage per container in MB */
|
|
3170
|
+
/** Ephemeral storage per container in MB Example: 1024 */
|
|
2066
3171
|
'storageSize'?: number;
|
|
2067
3172
|
};
|
|
2068
3173
|
};
|
|
@@ -2073,16 +3178,18 @@ declare type StartJobRunData = {
|
|
|
2073
3178
|
/** Branch to deploy Example: "master" */
|
|
2074
3179
|
'branch'?: string;
|
|
2075
3180
|
/** Commit SHA to deploy, or 'latest' to deploy the most recent commit Example: "latest" */
|
|
2076
|
-
'buildSHA'?:
|
|
3181
|
+
'buildSHA'?: string | 'latest';
|
|
2077
3182
|
/** ID of the build that should be deployed Example: "premium-guide-6393" */
|
|
2078
3183
|
'buildId'?: string;
|
|
2079
3184
|
};
|
|
2080
3185
|
} | {
|
|
2081
3186
|
/** The CMD override to use when running the job. Example: "nginx -g" */
|
|
2082
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;
|
|
2083
3190
|
'storage'?: {
|
|
2084
3191
|
'ephemeralStorage'?: {
|
|
2085
|
-
/** Ephemeral storage per container in MB */
|
|
3192
|
+
/** Ephemeral storage per container in MB Example: 1024 */
|
|
2086
3193
|
'storageSize'?: number;
|
|
2087
3194
|
};
|
|
2088
3195
|
};
|
|
@@ -2099,6 +3206,7 @@ declare type StartJobRunData = {
|
|
|
2099
3206
|
declare class StartJobRunEndpoint extends PostApiEndpoint<StartJobRunRequest, StartJobRunResult> {
|
|
2100
3207
|
description: string;
|
|
2101
3208
|
withAuth: boolean;
|
|
3209
|
+
requiredPermissions: string;
|
|
2102
3210
|
endpointUrl: (opts: StartJobRunRequest) => string;
|
|
2103
3211
|
body: (payload: StartJobRunRequest) => string;
|
|
2104
3212
|
}
|
|
@@ -2124,6 +3232,8 @@ declare type GetJobRunResult = {
|
|
|
2124
3232
|
'succeeded': number;
|
|
2125
3233
|
/** The timestamp when the job run started. Example: "2020-12-08T11:47:08Z" */
|
|
2126
3234
|
'startedAt': string;
|
|
3235
|
+
/** The timestamp when the job run concluded. Example: "2020-12-08T11:52:08Z" */
|
|
3236
|
+
'concludedAt': string;
|
|
2127
3237
|
};
|
|
2128
3238
|
declare type GetJobRunCall = (opts: GetJobRunRequest) => Promise<ApiCallResponse<GetJobRunResult>>;
|
|
2129
3239
|
declare type GetJobRunRequest = {
|
|
@@ -2140,6 +3250,7 @@ declare type GetJobRunParameters = {
|
|
|
2140
3250
|
declare class GetJobRunEndpoint extends GetApiEndpoint<GetJobRunRequest, GetJobRunResult> {
|
|
2141
3251
|
description: string;
|
|
2142
3252
|
withAuth: boolean;
|
|
3253
|
+
requiredPermissions: string;
|
|
2143
3254
|
endpointUrl: (opts: GetJobRunRequest) => string;
|
|
2144
3255
|
body: () => undefined;
|
|
2145
3256
|
}
|
|
@@ -2160,6 +3271,7 @@ declare type AbortJobRunParameters = {
|
|
|
2160
3271
|
declare class AbortJobRunEndpoint extends DeleteApiEndpoint<AbortJobRunRequest, AbortJobRunResult> {
|
|
2161
3272
|
description: string;
|
|
2162
3273
|
withAuth: boolean;
|
|
3274
|
+
requiredPermissions: string;
|
|
2163
3275
|
endpointUrl: (opts: AbortJobRunRequest) => string;
|
|
2164
3276
|
body: () => undefined;
|
|
2165
3277
|
}
|
|
@@ -2191,6 +3303,7 @@ declare type UpdateJobSettingsData = {
|
|
|
2191
3303
|
declare class UpdateJobSettingsEndpoint extends PostApiEndpoint<UpdateJobSettingsRequest, UpdateJobSettingsResult> {
|
|
2192
3304
|
description: string;
|
|
2193
3305
|
withAuth: boolean;
|
|
3306
|
+
requiredPermissions: string;
|
|
2194
3307
|
endpointUrl: (opts: UpdateJobSettingsRequest) => string;
|
|
2195
3308
|
body: (payload: UpdateJobSettingsRequest) => string;
|
|
2196
3309
|
}
|
|
@@ -2214,6 +3327,7 @@ declare type GetJobHealthchecksResult = {
|
|
|
2214
3327
|
'initialDelaySeconds': number;
|
|
2215
3328
|
/** The time between each check, in seconds. Example: 60 */
|
|
2216
3329
|
'periodSeconds': number;
|
|
3330
|
+
/** The time to wait for a response before marking the health check as a failure. Example: 1 */
|
|
2217
3331
|
'timeoutSeconds': number;
|
|
2218
3332
|
/** The maximum number of allowed failures. Example: 3 */
|
|
2219
3333
|
'failureThreshold': number;
|
|
@@ -2234,6 +3348,7 @@ declare type GetJobHealthchecksParameters = {
|
|
|
2234
3348
|
declare class GetJobHealthchecksEndpoint extends GetApiEndpoint<GetJobHealthchecksRequest, GetJobHealthchecksResult> {
|
|
2235
3349
|
description: string;
|
|
2236
3350
|
withAuth: boolean;
|
|
3351
|
+
requiredPermissions: string;
|
|
2237
3352
|
endpointUrl: (opts: GetJobHealthchecksRequest) => string;
|
|
2238
3353
|
body: () => undefined;
|
|
2239
3354
|
}
|
|
@@ -2278,6 +3393,7 @@ declare type UpdateJobHealthchecksData = {
|
|
|
2278
3393
|
declare class UpdateJobHealthchecksEndpoint extends PostApiEndpoint<UpdateJobHealthchecksRequest, UpdateJobHealthchecksResult> {
|
|
2279
3394
|
description: string;
|
|
2280
3395
|
withAuth: boolean;
|
|
3396
|
+
requiredPermissions: string;
|
|
2281
3397
|
endpointUrl: (opts: UpdateJobHealthchecksRequest) => string;
|
|
2282
3398
|
body: (payload: UpdateJobHealthchecksRequest) => string;
|
|
2283
3399
|
}
|
|
@@ -2329,6 +3445,7 @@ declare type GetJobBuildsOptions = {
|
|
|
2329
3445
|
declare class GetJobBuildsEndpoint extends GetApiEndpoint<GetJobBuildsRequest, GetJobBuildsResult> {
|
|
2330
3446
|
description: string;
|
|
2331
3447
|
withAuth: boolean;
|
|
3448
|
+
requiredPermissions: string;
|
|
2332
3449
|
endpointUrl: (opts: GetJobBuildsRequest) => string;
|
|
2333
3450
|
body: () => undefined;
|
|
2334
3451
|
}
|
|
@@ -2375,6 +3492,7 @@ declare type StartJobBuildData = {
|
|
|
2375
3492
|
declare class StartJobBuildEndpoint extends PostApiEndpoint<StartJobBuildRequest, StartJobBuildResult> {
|
|
2376
3493
|
description: string;
|
|
2377
3494
|
withAuth: boolean;
|
|
3495
|
+
requiredPermissions: string;
|
|
2378
3496
|
endpointUrl: (opts: StartJobBuildRequest) => string;
|
|
2379
3497
|
body: (payload: StartJobBuildRequest) => string;
|
|
2380
3498
|
}
|
|
@@ -2416,6 +3534,7 @@ declare type GetJobBuildParameters = {
|
|
|
2416
3534
|
declare class GetJobBuildEndpoint extends GetApiEndpoint<GetJobBuildRequest, GetJobBuildResult> {
|
|
2417
3535
|
description: string;
|
|
2418
3536
|
withAuth: boolean;
|
|
3537
|
+
requiredPermissions: string;
|
|
2419
3538
|
endpointUrl: (opts: GetJobBuildRequest) => string;
|
|
2420
3539
|
body: () => undefined;
|
|
2421
3540
|
}
|
|
@@ -2436,6 +3555,7 @@ declare type AbortJobBuildParameters = {
|
|
|
2436
3555
|
declare class AbortJobBuildEndpoint extends DeleteApiEndpoint<AbortJobBuildRequest, AbortJobBuildResult> {
|
|
2437
3556
|
description: string;
|
|
2438
3557
|
withAuth: boolean;
|
|
3558
|
+
requiredPermissions: string;
|
|
2439
3559
|
endpointUrl: (opts: AbortJobBuildRequest) => string;
|
|
2440
3560
|
body: () => undefined;
|
|
2441
3561
|
}
|
|
@@ -2455,7 +3575,7 @@ declare type UpdateJobBuildoptionsData = {
|
|
|
2455
3575
|
'dockerfile': {
|
|
2456
3576
|
/** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
|
|
2457
3577
|
'buildEngine'?: 'kaniko' | 'buildkit';
|
|
2458
|
-
/** Should intermediate image layers be cached?
|
|
3578
|
+
/** Should intermediate image layers be cached? */
|
|
2459
3579
|
'useCache'?: boolean;
|
|
2460
3580
|
/** The file path of the Dockerfile. Example: "/Dockerfile" */
|
|
2461
3581
|
'dockerFilePath'?: string;
|
|
@@ -2472,6 +3592,8 @@ declare type UpdateJobBuildoptionsData = {
|
|
|
2472
3592
|
'buildpackLocators'?: string[];
|
|
2473
3593
|
/** The working directory to build in. Example: "/" */
|
|
2474
3594
|
'buildContext'?: string;
|
|
3595
|
+
/** Should build dependencies be cached? */
|
|
3596
|
+
'useCache'?: boolean;
|
|
2475
3597
|
};
|
|
2476
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. */
|
|
2477
3599
|
'pathIgnoreRules'?: string[];
|
|
@@ -2483,6 +3605,7 @@ declare type UpdateJobBuildoptionsData = {
|
|
|
2483
3605
|
declare class UpdateJobBuildoptionsEndpoint extends PostApiEndpoint<UpdateJobBuildoptionsRequest, UpdateJobBuildoptionsResult> {
|
|
2484
3606
|
description: string;
|
|
2485
3607
|
withAuth: boolean;
|
|
3608
|
+
requiredPermissions: string;
|
|
2486
3609
|
endpointUrl: (opts: UpdateJobBuildoptionsRequest) => string;
|
|
2487
3610
|
body: (payload: UpdateJobBuildoptionsRequest) => string;
|
|
2488
3611
|
}
|
|
@@ -2514,6 +3637,7 @@ declare type UpdateJobBuildsourceData = {
|
|
|
2514
3637
|
declare class UpdateJobBuildsourceEndpoint extends PostApiEndpoint<UpdateJobBuildsourceRequest, UpdateJobBuildsourceResult> {
|
|
2515
3638
|
description: string;
|
|
2516
3639
|
withAuth: boolean;
|
|
3640
|
+
requiredPermissions: string;
|
|
2517
3641
|
endpointUrl: (opts: UpdateJobBuildsourceRequest) => string;
|
|
2518
3642
|
body: (payload: UpdateJobBuildsourceRequest) => string;
|
|
2519
3643
|
}
|
|
@@ -2537,10 +3661,35 @@ declare type UpdateJobCmdoverrideData = {
|
|
|
2537
3661
|
declare class UpdateJobCmdoverrideEndpoint extends PostApiEndpoint<UpdateJobCmdoverrideRequest, UpdateJobCmdoverrideResult> {
|
|
2538
3662
|
description: string;
|
|
2539
3663
|
withAuth: boolean;
|
|
3664
|
+
requiredPermissions: string;
|
|
2540
3665
|
endpointUrl: (opts: UpdateJobCmdoverrideRequest) => string;
|
|
2541
3666
|
body: (payload: UpdateJobCmdoverrideRequest) => string;
|
|
2542
3667
|
}
|
|
2543
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
|
+
|
|
2544
3693
|
declare type GetJobBuildargumentsResult = {
|
|
2545
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"} */
|
|
2546
3695
|
'buildArguments': any;
|
|
@@ -2565,6 +3714,7 @@ declare type GetJobBuildargumentsOptions = {
|
|
|
2565
3714
|
declare class GetJobBuildargumentsEndpoint extends GetApiEndpoint<GetJobBuildargumentsRequest, GetJobBuildargumentsResult> {
|
|
2566
3715
|
description: string;
|
|
2567
3716
|
withAuth: boolean;
|
|
3717
|
+
requiredPermissions: string;
|
|
2568
3718
|
endpointUrl: (opts: GetJobBuildargumentsRequest) => string;
|
|
2569
3719
|
body: () => undefined;
|
|
2570
3720
|
}
|
|
@@ -2593,6 +3743,7 @@ declare type UpdateJobBuildargumentsData = {
|
|
|
2593
3743
|
declare class UpdateJobBuildargumentsEndpoint extends PostApiEndpoint<UpdateJobBuildargumentsRequest, UpdateJobBuildargumentsResult> {
|
|
2594
3744
|
description: string;
|
|
2595
3745
|
withAuth: boolean;
|
|
3746
|
+
requiredPermissions: string;
|
|
2596
3747
|
endpointUrl: (opts: UpdateJobBuildargumentsRequest) => string;
|
|
2597
3748
|
body: (payload: UpdateJobBuildargumentsRequest) => string;
|
|
2598
3749
|
}
|
|
@@ -2663,6 +3814,7 @@ declare type GetJobBuildargumentdetailsParameters = {
|
|
|
2663
3814
|
declare class GetJobBuildargumentdetailsEndpoint extends GetApiEndpoint<GetJobBuildargumentdetailsRequest, GetJobBuildargumentdetailsResult> {
|
|
2664
3815
|
description: string;
|
|
2665
3816
|
withAuth: boolean;
|
|
3817
|
+
requiredPermissions: string;
|
|
2666
3818
|
endpointUrl: (opts: GetJobBuildargumentdetailsRequest) => string;
|
|
2667
3819
|
body: () => undefined;
|
|
2668
3820
|
}
|
|
@@ -2691,6 +3843,7 @@ declare type GetJobRuntimeenvironmentOptions = {
|
|
|
2691
3843
|
declare class GetJobRuntimeenvironmentEndpoint extends GetApiEndpoint<GetJobRuntimeenvironmentRequest, GetJobRuntimeenvironmentResult> {
|
|
2692
3844
|
description: string;
|
|
2693
3845
|
withAuth: boolean;
|
|
3846
|
+
requiredPermissions: string;
|
|
2694
3847
|
endpointUrl: (opts: GetJobRuntimeenvironmentRequest) => string;
|
|
2695
3848
|
body: () => undefined;
|
|
2696
3849
|
}
|
|
@@ -2719,6 +3872,7 @@ declare type UpdateJobRuntimeenvironmentData = {
|
|
|
2719
3872
|
declare class UpdateJobRuntimeenvironmentEndpoint extends PostApiEndpoint<UpdateJobRuntimeenvironmentRequest, UpdateJobRuntimeenvironmentResult> {
|
|
2720
3873
|
description: string;
|
|
2721
3874
|
withAuth: boolean;
|
|
3875
|
+
requiredPermissions: string;
|
|
2722
3876
|
endpointUrl: (opts: UpdateJobRuntimeenvironmentRequest) => string;
|
|
2723
3877
|
body: (payload: UpdateJobRuntimeenvironmentRequest) => string;
|
|
2724
3878
|
}
|
|
@@ -2789,6 +3943,7 @@ declare type GetJobRuntimeenvironmentdetailsParameters = {
|
|
|
2789
3943
|
declare class GetJobRuntimeenvironmentdetailsEndpoint extends GetApiEndpoint<GetJobRuntimeenvironmentdetailsRequest, GetJobRuntimeenvironmentdetailsResult> {
|
|
2790
3944
|
description: string;
|
|
2791
3945
|
withAuth: boolean;
|
|
3946
|
+
requiredPermissions: string;
|
|
2792
3947
|
endpointUrl: (opts: GetJobRuntimeenvironmentdetailsRequest) => string;
|
|
2793
3948
|
body: () => undefined;
|
|
2794
3949
|
}
|
|
@@ -2807,8 +3962,12 @@ declare type GetJobDeploymentResult = {
|
|
|
2807
3962
|
'repository': string;
|
|
2808
3963
|
/** Branch of the repo being deployed Example: "master" */
|
|
2809
3964
|
'branch': string;
|
|
2810
|
-
/**
|
|
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" */
|
|
2811
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;
|
|
2812
3971
|
/** Type of deployed entity Example: "service" */
|
|
2813
3972
|
'nfObjectType': 'service' | 'job';
|
|
2814
3973
|
};
|
|
@@ -2839,6 +3998,7 @@ declare type GetJobDeploymentParameters = {
|
|
|
2839
3998
|
declare class GetJobDeploymentEndpoint extends GetApiEndpoint<GetJobDeploymentRequest, GetJobDeploymentResult> {
|
|
2840
3999
|
description: string;
|
|
2841
4000
|
withAuth: boolean;
|
|
4001
|
+
requiredPermissions: string;
|
|
2842
4002
|
endpointUrl: (opts: GetJobDeploymentRequest) => string;
|
|
2843
4003
|
body: () => undefined;
|
|
2844
4004
|
}
|
|
@@ -2868,7 +4028,7 @@ declare type UpdateJobDeploymentData = {
|
|
|
2868
4028
|
/** Branch to deploy Example: "master" */
|
|
2869
4029
|
'branch'?: string;
|
|
2870
4030
|
/** Commit SHA to deploy, or 'latest' to deploy the most recent commit Example: "latest" */
|
|
2871
|
-
'buildSHA'?:
|
|
4031
|
+
'buildSHA'?: string | 'latest';
|
|
2872
4032
|
/** ID of the build that should be deployed Example: "premium-guide-6393" */
|
|
2873
4033
|
'buildId'?: string;
|
|
2874
4034
|
};
|
|
@@ -2877,20 +4037,21 @@ declare type UpdateJobDeploymentData = {
|
|
|
2877
4037
|
declare class UpdateJobDeploymentEndpoint extends PostApiEndpoint<UpdateJobDeploymentRequest, UpdateJobDeploymentResult> {
|
|
2878
4038
|
description: string;
|
|
2879
4039
|
withAuth: boolean;
|
|
4040
|
+
requiredPermissions: string;
|
|
2880
4041
|
endpointUrl: (opts: UpdateJobDeploymentRequest) => string;
|
|
2881
4042
|
body: (payload: UpdateJobDeploymentRequest) => string;
|
|
2882
4043
|
}
|
|
2883
4044
|
|
|
2884
4045
|
declare type GetJobContainersResult = {
|
|
2885
4046
|
/** An array of containers. */
|
|
2886
|
-
'
|
|
2887
|
-
/** The
|
|
4047
|
+
'containers': {
|
|
4048
|
+
/** The name of the container. Example: "example-service-78b4d4459d-sbtn8" */
|
|
4049
|
+
'name': string;
|
|
4050
|
+
/** The timestamp the container was created. Example: 1611241087 */
|
|
2888
4051
|
'createdAt': number;
|
|
2889
|
-
/** The
|
|
2890
|
-
'podName': string;
|
|
2891
|
-
/** The current status of the pod. Example: "TASK_RUNNING" */
|
|
4052
|
+
/** The current status of the container. Example: "TASK_RUNNING" */
|
|
2892
4053
|
'status': 'TASK_RUNNING' | 'TASK_STARTING' | 'TASK_STAGING' | 'TASK_KILLING' | 'TASK_KILLED' | 'TASK_FAILED' | 'TASK_FINISHED';
|
|
2893
|
-
/** The timestamp the
|
|
4054
|
+
/** The timestamp the container was last updated. Example: 1611241087 */
|
|
2894
4055
|
'updatedAt': number;
|
|
2895
4056
|
}[];
|
|
2896
4057
|
};
|
|
@@ -2916,6 +4077,7 @@ declare type GetJobContainersOptions = {
|
|
|
2916
4077
|
declare class GetJobContainersEndpoint extends GetApiEndpoint<GetJobContainersRequest, GetJobContainersResult> {
|
|
2917
4078
|
description: string;
|
|
2918
4079
|
withAuth: boolean;
|
|
4080
|
+
requiredPermissions: string;
|
|
2919
4081
|
endpointUrl: (opts: GetJobContainersRequest) => string;
|
|
2920
4082
|
body: () => undefined;
|
|
2921
4083
|
}
|
|
@@ -2964,6 +4126,7 @@ declare type GetJobBranchesOptions = {
|
|
|
2964
4126
|
declare class GetJobBranchesEndpoint extends GetApiEndpoint<GetJobBranchesRequest, GetJobBranchesResult> {
|
|
2965
4127
|
description: string;
|
|
2966
4128
|
withAuth: boolean;
|
|
4129
|
+
requiredPermissions: string;
|
|
2967
4130
|
endpointUrl: (opts: GetJobBranchesRequest) => string;
|
|
2968
4131
|
body: () => undefined;
|
|
2969
4132
|
}
|
|
@@ -3012,11 +4175,12 @@ declare type GetJobPullrequestsOptions = {
|
|
|
3012
4175
|
declare class GetJobPullrequestsEndpoint extends GetApiEndpoint<GetJobPullrequestsRequest, GetJobPullrequestsResult> {
|
|
3013
4176
|
description: string;
|
|
3014
4177
|
withAuth: boolean;
|
|
4178
|
+
requiredPermissions: string;
|
|
3015
4179
|
endpointUrl: (opts: GetJobPullrequestsRequest) => string;
|
|
3016
4180
|
body: () => undefined;
|
|
3017
4181
|
}
|
|
3018
4182
|
|
|
3019
|
-
declare type
|
|
4183
|
+
declare type ListRegistriesResult = {
|
|
3020
4184
|
/** An array of credentials saved to this account. */
|
|
3021
4185
|
'credentials': {
|
|
3022
4186
|
/** Identifier for the credentials. Example: "example-credentials" */
|
|
@@ -3036,11 +4200,11 @@ declare type ListRegistrycredentialsResult = {
|
|
|
3036
4200
|
'provider': 'dockerhub' | 'gcr' | 'gcr-eu' | 'gcr-us' | 'gitlab' | 'github' | 'custom';
|
|
3037
4201
|
}[];
|
|
3038
4202
|
};
|
|
3039
|
-
declare type
|
|
3040
|
-
declare type
|
|
3041
|
-
options?:
|
|
4203
|
+
declare type ListRegistriesCall = (opts: ListRegistriesRequest) => Promise<ApiCallResponse<ListRegistriesResult>>;
|
|
4204
|
+
declare type ListRegistriesRequest = {
|
|
4205
|
+
options?: ListRegistriesOptions;
|
|
3042
4206
|
};
|
|
3043
|
-
declare type
|
|
4207
|
+
declare type ListRegistriesOptions = {
|
|
3044
4208
|
/** The number of results to display per request. Maximum of 100 results per page. */
|
|
3045
4209
|
'per_page'?: number;
|
|
3046
4210
|
/** The page number to access. */
|
|
@@ -3049,14 +4213,15 @@ declare type ListRegistrycredentialsOptions = {
|
|
|
3049
4213
|
'cursor'?: string;
|
|
3050
4214
|
};
|
|
3051
4215
|
/** Lists the container registry credentials saved to this account. Does not display secrets. */
|
|
3052
|
-
declare class
|
|
4216
|
+
declare class ListRegistriesEndpoint extends GetApiEndpoint<ListRegistriesRequest, ListRegistriesResult> {
|
|
3053
4217
|
description: string;
|
|
3054
4218
|
withAuth: boolean;
|
|
3055
|
-
|
|
4219
|
+
requiredPermissions: string;
|
|
4220
|
+
endpointUrl: (opts: ListRegistriesRequest) => string;
|
|
3056
4221
|
body: () => undefined;
|
|
3057
4222
|
}
|
|
3058
4223
|
|
|
3059
|
-
declare type
|
|
4224
|
+
declare type AddRegistryResult = {
|
|
3060
4225
|
/** Identifier for the credentials. Example: "example-credentials" */
|
|
3061
4226
|
'id': string;
|
|
3062
4227
|
/** Name of the saved credentials. Example: "Example Credentials" */
|
|
@@ -3073,11 +4238,11 @@ declare type AddRegistrycredentialsResult = {
|
|
|
3073
4238
|
/** The registry provider associated with this set of credentials. Example: "dockerhub" */
|
|
3074
4239
|
'provider': 'dockerhub' | 'gcr' | 'gcr-eu' | 'gcr-us' | 'gitlab' | 'github' | 'custom';
|
|
3075
4240
|
};
|
|
3076
|
-
declare type
|
|
3077
|
-
declare type
|
|
3078
|
-
data:
|
|
4241
|
+
declare type AddRegistryCall = (opts: AddRegistryRequest) => Promise<ApiCallResponse<AddRegistryResult>>;
|
|
4242
|
+
declare type AddRegistryRequest = {
|
|
4243
|
+
data: AddRegistryData;
|
|
3079
4244
|
};
|
|
3080
|
-
declare type
|
|
4245
|
+
declare type AddRegistryData = {
|
|
3081
4246
|
/** Name of the credentials. Example: "Example Credentials" */
|
|
3082
4247
|
'name': string;
|
|
3083
4248
|
/** Description of the credentials. Example: "This is a set of saved credentials." */
|
|
@@ -3095,14 +4260,15 @@ declare type AddRegistrycredentialsData = {
|
|
|
3095
4260
|
'data': any;
|
|
3096
4261
|
};
|
|
3097
4262
|
/** Adds a new set of container registry credentials to this account. */
|
|
3098
|
-
declare class
|
|
4263
|
+
declare class AddRegistryEndpoint extends PostApiEndpoint<AddRegistryRequest, AddRegistryResult> {
|
|
3099
4264
|
description: string;
|
|
3100
4265
|
withAuth: boolean;
|
|
3101
|
-
|
|
3102
|
-
|
|
4266
|
+
requiredPermissions: string;
|
|
4267
|
+
endpointUrl: (opts: AddRegistryRequest) => string;
|
|
4268
|
+
body: (payload: AddRegistryRequest) => string;
|
|
3103
4269
|
}
|
|
3104
4270
|
|
|
3105
|
-
declare type
|
|
4271
|
+
declare type GetRegistryResult = {
|
|
3106
4272
|
/** Identifier for the credentials. Example: "example-credentials" */
|
|
3107
4273
|
'id': string;
|
|
3108
4274
|
/** Name of the saved credentials. Example: "Example Credentials" */
|
|
@@ -3120,47 +4286,49 @@ declare type GetRegistrycredentialsResult = {
|
|
|
3120
4286
|
'provider': 'dockerhub' | 'gcr' | 'gcr-eu' | 'gcr-us' | 'gitlab' | 'github' | 'custom';
|
|
3121
4287
|
'data'?: any;
|
|
3122
4288
|
};
|
|
3123
|
-
declare type
|
|
3124
|
-
declare type
|
|
3125
|
-
parameters:
|
|
4289
|
+
declare type GetRegistryCall = (opts: GetRegistryRequest) => Promise<ApiCallResponse<GetRegistryResult>>;
|
|
4290
|
+
declare type GetRegistryRequest = {
|
|
4291
|
+
parameters: GetRegistryParameters;
|
|
3126
4292
|
};
|
|
3127
|
-
declare type
|
|
4293
|
+
declare type GetRegistryParameters = {
|
|
3128
4294
|
/** ID of the registry credential */ 'credentialId': string;
|
|
3129
4295
|
};
|
|
3130
4296
|
/** Views a set of registry credential data. */
|
|
3131
|
-
declare class
|
|
4297
|
+
declare class GetRegistryEndpoint extends GetApiEndpoint<GetRegistryRequest, GetRegistryResult> {
|
|
3132
4298
|
description: string;
|
|
3133
4299
|
withAuth: boolean;
|
|
3134
|
-
|
|
4300
|
+
requiredPermissions: string;
|
|
4301
|
+
endpointUrl: (opts: GetRegistryRequest) => string;
|
|
3135
4302
|
body: () => undefined;
|
|
3136
4303
|
}
|
|
3137
4304
|
|
|
3138
|
-
declare type
|
|
3139
|
-
declare type
|
|
3140
|
-
declare type
|
|
3141
|
-
parameters:
|
|
4305
|
+
declare type DeleteRegistryResult = any;
|
|
4306
|
+
declare type DeleteRegistryCall = (opts: DeleteRegistryRequest) => Promise<ApiCallResponse<DeleteRegistryResult>>;
|
|
4307
|
+
declare type DeleteRegistryRequest = {
|
|
4308
|
+
parameters: DeleteRegistryParameters;
|
|
3142
4309
|
};
|
|
3143
|
-
declare type
|
|
4310
|
+
declare type DeleteRegistryParameters = {
|
|
3144
4311
|
/** ID of the registry credential */ 'credentialId': string;
|
|
3145
4312
|
};
|
|
3146
4313
|
/** Deletes a set of registry credential data. */
|
|
3147
|
-
declare class
|
|
4314
|
+
declare class DeleteRegistryEndpoint extends DeleteApiEndpoint<DeleteRegistryRequest, DeleteRegistryResult> {
|
|
3148
4315
|
description: string;
|
|
3149
4316
|
withAuth: boolean;
|
|
3150
|
-
|
|
4317
|
+
requiredPermissions: string;
|
|
4318
|
+
endpointUrl: (opts: DeleteRegistryRequest) => string;
|
|
3151
4319
|
body: () => undefined;
|
|
3152
4320
|
}
|
|
3153
4321
|
|
|
3154
|
-
declare type
|
|
3155
|
-
declare type
|
|
3156
|
-
declare type
|
|
3157
|
-
parameters:
|
|
3158
|
-
data:
|
|
4322
|
+
declare type UpdateRegistryResult = any;
|
|
4323
|
+
declare type UpdateRegistryCall = (opts: UpdateRegistryRequest) => Promise<ApiCallResponse<UpdateRegistryResult>>;
|
|
4324
|
+
declare type UpdateRegistryRequest = {
|
|
4325
|
+
parameters: UpdateRegistryParameters;
|
|
4326
|
+
data: UpdateRegistryData;
|
|
3159
4327
|
};
|
|
3160
|
-
declare type
|
|
4328
|
+
declare type UpdateRegistryParameters = {
|
|
3161
4329
|
/** ID of the registry credential */ 'credentialId': string;
|
|
3162
4330
|
};
|
|
3163
|
-
declare type
|
|
4331
|
+
declare type UpdateRegistryData = {
|
|
3164
4332
|
/** Description of the credentials. Example: "This is a set of saved credentials." */
|
|
3165
4333
|
'description'?: string;
|
|
3166
4334
|
/** Data about whether the credentials are restricted to certain projects. */
|
|
@@ -3174,11 +4342,12 @@ declare type UpdateRegistrycredentialsData = {
|
|
|
3174
4342
|
'data'?: any;
|
|
3175
4343
|
};
|
|
3176
4344
|
/** Updates a set of registry credential data. */
|
|
3177
|
-
declare class
|
|
4345
|
+
declare class UpdateRegistryEndpoint extends PostApiEndpoint<UpdateRegistryRequest, UpdateRegistryResult> {
|
|
3178
4346
|
description: string;
|
|
3179
4347
|
withAuth: boolean;
|
|
3180
|
-
|
|
3181
|
-
|
|
4348
|
+
requiredPermissions: string;
|
|
4349
|
+
endpointUrl: (opts: UpdateRegistryRequest) => string;
|
|
4350
|
+
body: (payload: UpdateRegistryRequest) => string;
|
|
3182
4351
|
}
|
|
3183
4352
|
|
|
3184
4353
|
declare type ListDomainsResult = {
|
|
@@ -3210,6 +4379,7 @@ declare type ListDomainsOptions = {
|
|
|
3210
4379
|
declare class ListDomainsEndpoint extends GetApiEndpoint<ListDomainsRequest, ListDomainsResult> {
|
|
3211
4380
|
description: string;
|
|
3212
4381
|
withAuth: boolean;
|
|
4382
|
+
requiredPermissions: string;
|
|
3213
4383
|
endpointUrl: (opts: ListDomainsRequest) => string;
|
|
3214
4384
|
body: () => undefined;
|
|
3215
4385
|
}
|
|
@@ -3236,6 +4406,7 @@ declare type CreateDomainData = {
|
|
|
3236
4406
|
declare class CreateDomainEndpoint extends PostApiEndpoint<CreateDomainRequest, CreateDomainResult> {
|
|
3237
4407
|
description: string;
|
|
3238
4408
|
withAuth: boolean;
|
|
4409
|
+
requiredPermissions: string;
|
|
3239
4410
|
endpointUrl: (opts: CreateDomainRequest) => string;
|
|
3240
4411
|
body: (payload: CreateDomainRequest) => string;
|
|
3241
4412
|
}
|
|
@@ -3268,6 +4439,7 @@ declare type GetDomainParameters = {
|
|
|
3268
4439
|
declare class GetDomainEndpoint extends GetApiEndpoint<GetDomainRequest, GetDomainResult> {
|
|
3269
4440
|
description: string;
|
|
3270
4441
|
withAuth: boolean;
|
|
4442
|
+
requiredPermissions: string;
|
|
3271
4443
|
endpointUrl: (opts: GetDomainRequest) => string;
|
|
3272
4444
|
body: () => undefined;
|
|
3273
4445
|
}
|
|
@@ -3284,6 +4456,7 @@ declare type DeleteDomainParameters = {
|
|
|
3284
4456
|
declare class DeleteDomainEndpoint extends DeleteApiEndpoint<DeleteDomainRequest, DeleteDomainResult> {
|
|
3285
4457
|
description: string;
|
|
3286
4458
|
withAuth: boolean;
|
|
4459
|
+
requiredPermissions: string;
|
|
3287
4460
|
endpointUrl: (opts: DeleteDomainRequest) => string;
|
|
3288
4461
|
body: () => undefined;
|
|
3289
4462
|
}
|
|
@@ -3300,6 +4473,7 @@ declare type VerifyDomainParameters = {
|
|
|
3300
4473
|
declare class VerifyDomainEndpoint extends PostApiEndpoint<VerifyDomainRequest, VerifyDomainResult> {
|
|
3301
4474
|
description: string;
|
|
3302
4475
|
withAuth: boolean;
|
|
4476
|
+
requiredPermissions: string;
|
|
3303
4477
|
endpointUrl: (opts: VerifyDomainRequest) => string;
|
|
3304
4478
|
body: () => undefined;
|
|
3305
4479
|
}
|
|
@@ -3332,6 +4506,7 @@ declare type AddDomainSubdomainData = {
|
|
|
3332
4506
|
declare class AddDomainSubdomainEndpoint extends PostApiEndpoint<AddDomainSubdomainRequest, AddDomainSubdomainResult> {
|
|
3333
4507
|
description: string;
|
|
3334
4508
|
withAuth: boolean;
|
|
4509
|
+
requiredPermissions: string;
|
|
3335
4510
|
endpointUrl: (opts: AddDomainSubdomainRequest) => string;
|
|
3336
4511
|
body: (payload: AddDomainSubdomainRequest) => string;
|
|
3337
4512
|
}
|
|
@@ -3361,6 +4536,7 @@ declare type GetSubdomainParameters = {
|
|
|
3361
4536
|
declare class GetSubdomainEndpoint extends GetApiEndpoint<GetSubdomainRequest, GetSubdomainResult> {
|
|
3362
4537
|
description: string;
|
|
3363
4538
|
withAuth: boolean;
|
|
4539
|
+
requiredPermissions: string;
|
|
3364
4540
|
endpointUrl: (opts: GetSubdomainRequest) => string;
|
|
3365
4541
|
body: () => undefined;
|
|
3366
4542
|
}
|
|
@@ -3379,6 +4555,7 @@ declare type DeleteSubdomainParameters = {
|
|
|
3379
4555
|
declare class DeleteSubdomainEndpoint extends DeleteApiEndpoint<DeleteSubdomainRequest, DeleteSubdomainResult> {
|
|
3380
4556
|
description: string;
|
|
3381
4557
|
withAuth: boolean;
|
|
4558
|
+
requiredPermissions: string;
|
|
3382
4559
|
endpointUrl: (opts: DeleteSubdomainRequest) => string;
|
|
3383
4560
|
body: () => undefined;
|
|
3384
4561
|
}
|
|
@@ -3397,6 +4574,7 @@ declare type VerifySubdomainParameters = {
|
|
|
3397
4574
|
declare class VerifySubdomainEndpoint extends PostApiEndpoint<VerifySubdomainRequest, VerifySubdomainResult> {
|
|
3398
4575
|
description: string;
|
|
3399
4576
|
withAuth: boolean;
|
|
4577
|
+
requiredPermissions: string;
|
|
3400
4578
|
endpointUrl: (opts: VerifySubdomainRequest) => string;
|
|
3401
4579
|
body: () => undefined;
|
|
3402
4580
|
}
|
|
@@ -3424,6 +4602,7 @@ declare type AssignSubdomainServiceData = {
|
|
|
3424
4602
|
declare class AssignSubdomainServiceEndpoint extends PostApiEndpoint<AssignSubdomainServiceRequest, AssignSubdomainServiceResult> {
|
|
3425
4603
|
description: string;
|
|
3426
4604
|
withAuth: boolean;
|
|
4605
|
+
requiredPermissions: string;
|
|
3427
4606
|
endpointUrl: (opts: AssignSubdomainServiceRequest) => string;
|
|
3428
4607
|
body: (payload: AssignSubdomainServiceRequest) => string;
|
|
3429
4608
|
}
|
|
@@ -3442,6 +4621,7 @@ declare type UnassignSubdomainParameters = {
|
|
|
3442
4621
|
declare class UnassignSubdomainEndpoint extends DeleteApiEndpoint<UnassignSubdomainRequest, UnassignSubdomainResult> {
|
|
3443
4622
|
description: string;
|
|
3444
4623
|
withAuth: boolean;
|
|
4624
|
+
requiredPermissions: string;
|
|
3445
4625
|
endpointUrl: (opts: UnassignSubdomainRequest) => string;
|
|
3446
4626
|
body: () => undefined;
|
|
3447
4627
|
}
|
|
@@ -3471,6 +4651,7 @@ declare type ListPlansRequest = {};
|
|
|
3471
4651
|
declare class ListPlansEndpoint extends GetApiEndpoint<ListPlansRequest, ListPlansResult> {
|
|
3472
4652
|
description: string;
|
|
3473
4653
|
withAuth: boolean;
|
|
4654
|
+
requiredPermissions: string;
|
|
3474
4655
|
endpointUrl: (opts: ListPlansRequest) => string;
|
|
3475
4656
|
body: () => undefined;
|
|
3476
4657
|
}
|
|
@@ -3488,6 +4669,7 @@ declare type ListRegionsRequest = {};
|
|
|
3488
4669
|
declare class ListRegionsEndpoint extends GetApiEndpoint<ListRegionsRequest, ListRegionsResult> {
|
|
3489
4670
|
description: string;
|
|
3490
4671
|
withAuth: boolean;
|
|
4672
|
+
requiredPermissions: string;
|
|
3491
4673
|
endpointUrl: (opts: ListRegionsRequest) => string;
|
|
3492
4674
|
body: () => undefined;
|
|
3493
4675
|
}
|
|
@@ -3502,6 +4684,7 @@ declare type GetDnsidRequest = {};
|
|
|
3502
4684
|
declare class GetDnsidEndpoint extends GetApiEndpoint<GetDnsidRequest, GetDnsidResult> {
|
|
3503
4685
|
description: string;
|
|
3504
4686
|
withAuth: boolean;
|
|
4687
|
+
requiredPermissions: string;
|
|
3505
4688
|
endpointUrl: (opts: GetDnsidRequest) => string;
|
|
3506
4689
|
body: () => undefined;
|
|
3507
4690
|
}
|
|
@@ -3533,6 +4716,7 @@ declare type ListVcsRequest = {};
|
|
|
3533
4716
|
declare class ListVcsEndpoint extends GetApiEndpoint<ListVcsRequest, ListVcsResult> {
|
|
3534
4717
|
description: string;
|
|
3535
4718
|
withAuth: boolean;
|
|
4719
|
+
requiredPermissions: string;
|
|
3536
4720
|
endpointUrl: (opts: ListVcsRequest) => string;
|
|
3537
4721
|
body: () => undefined;
|
|
3538
4722
|
}
|
|
@@ -3586,6 +4770,7 @@ declare type ListSecretsOptions = {
|
|
|
3586
4770
|
declare class ListSecretsEndpoint extends GetApiEndpoint<ListSecretsRequest, ListSecretsResult> {
|
|
3587
4771
|
description: string;
|
|
3588
4772
|
withAuth: boolean;
|
|
4773
|
+
requiredPermissions: string;
|
|
3589
4774
|
endpointUrl: (opts: ListSecretsRequest) => string;
|
|
3590
4775
|
body: () => undefined;
|
|
3591
4776
|
}
|
|
@@ -3651,7 +4836,7 @@ declare type CreateSecretData = {
|
|
|
3651
4836
|
'addonId': string;
|
|
3652
4837
|
/** An array of objects containing details about the keys to link to this secret group. */
|
|
3653
4838
|
'keys': {
|
|
3654
|
-
/** The name of the key to link. Example: "
|
|
4839
|
+
/** The name of the key to link. Example: "USERNAME" */
|
|
3655
4840
|
'keyName': string;
|
|
3656
4841
|
/** An array of aliases for the key. */
|
|
3657
4842
|
'aliases'?: string[];
|
|
@@ -3668,6 +4853,7 @@ declare type CreateSecretData = {
|
|
|
3668
4853
|
declare class CreateSecretEndpoint extends PostApiEndpoint<CreateSecretRequest, CreateSecretResult> {
|
|
3669
4854
|
description: string;
|
|
3670
4855
|
withAuth: boolean;
|
|
4856
|
+
requiredPermissions: string;
|
|
3671
4857
|
endpointUrl: (opts: CreateSecretRequest) => string;
|
|
3672
4858
|
body: (payload: CreateSecretRequest) => string;
|
|
3673
4859
|
}
|
|
@@ -3722,6 +4908,7 @@ declare type GetSecretOptions = {
|
|
|
3722
4908
|
declare class GetSecretEndpoint extends GetApiEndpoint<GetSecretRequest, GetSecretResult> {
|
|
3723
4909
|
description: string;
|
|
3724
4910
|
withAuth: boolean;
|
|
4911
|
+
requiredPermissions: string;
|
|
3725
4912
|
endpointUrl: (opts: GetSecretRequest) => string;
|
|
3726
4913
|
body: () => undefined;
|
|
3727
4914
|
}
|
|
@@ -3740,6 +4927,7 @@ declare type DeleteSecretParameters = {
|
|
|
3740
4927
|
declare class DeleteSecretEndpoint extends DeleteApiEndpoint<DeleteSecretRequest, DeleteSecretResult> {
|
|
3741
4928
|
description: string;
|
|
3742
4929
|
withAuth: boolean;
|
|
4930
|
+
requiredPermissions: string;
|
|
3743
4931
|
endpointUrl: (opts: DeleteSecretRequest) => string;
|
|
3744
4932
|
body: () => undefined;
|
|
3745
4933
|
}
|
|
@@ -3778,7 +4966,7 @@ declare type UpdateSecretData = {
|
|
|
3778
4966
|
'addonId': string;
|
|
3779
4967
|
/** An array of objects containing details about the keys to link to this secret group. */
|
|
3780
4968
|
'keys': {
|
|
3781
|
-
/** The name of the key to link. Example: "
|
|
4969
|
+
/** The name of the key to link. Example: "USERNAME" */
|
|
3782
4970
|
'keyName': string;
|
|
3783
4971
|
/** An array of aliases for the key. */
|
|
3784
4972
|
'aliases'?: string[];
|
|
@@ -3797,6 +4985,7 @@ declare type UpdateSecretData = {
|
|
|
3797
4985
|
declare class UpdateSecretEndpoint extends PostApiEndpoint<UpdateSecretRequest, UpdateSecretResult> {
|
|
3798
4986
|
description: string;
|
|
3799
4987
|
withAuth: boolean;
|
|
4988
|
+
requiredPermissions: string;
|
|
3800
4989
|
endpointUrl: (opts: UpdateSecretRequest) => string;
|
|
3801
4990
|
body: (payload: UpdateSecretRequest) => string;
|
|
3802
4991
|
}
|
|
@@ -3859,6 +5048,7 @@ declare type GetSecretdetailsParameters = {
|
|
|
3859
5048
|
declare class GetSecretdetailsEndpoint extends GetApiEndpoint<GetSecretdetailsRequest, GetSecretdetailsResult> {
|
|
3860
5049
|
description: string;
|
|
3861
5050
|
withAuth: boolean;
|
|
5051
|
+
requiredPermissions: string;
|
|
3862
5052
|
endpointUrl: (opts: GetSecretdetailsRequest) => string;
|
|
3863
5053
|
body: () => undefined;
|
|
3864
5054
|
}
|
|
@@ -3866,7 +5056,7 @@ declare class GetSecretdetailsEndpoint extends GetApiEndpoint<GetSecretdetailsRe
|
|
|
3866
5056
|
declare type UpdateSecretlinkResult = {
|
|
3867
5057
|
/** An array of objects containing details about the keys linked to this secret group. */
|
|
3868
5058
|
'keys': {
|
|
3869
|
-
/** The name of the key to link. Example: "
|
|
5059
|
+
/** The name of the key to link. Example: "USERNAME" */
|
|
3870
5060
|
'keyName': string;
|
|
3871
5061
|
/** An array of aliases for the key. */
|
|
3872
5062
|
'aliases'?: string[];
|
|
@@ -3888,7 +5078,7 @@ declare type UpdateSecretlinkParameters = {
|
|
|
3888
5078
|
declare type UpdateSecretlinkData = {
|
|
3889
5079
|
/** An array of objects containing details about the keys to link to this secret group. */
|
|
3890
5080
|
'keys': {
|
|
3891
|
-
/** The name of the key to link. Example: "
|
|
5081
|
+
/** The name of the key to link. Example: "USERNAME" */
|
|
3892
5082
|
'keyName': string;
|
|
3893
5083
|
/** An array of aliases for the key. */
|
|
3894
5084
|
'aliases'?: string[];
|
|
@@ -3898,6 +5088,7 @@ declare type UpdateSecretlinkData = {
|
|
|
3898
5088
|
declare class UpdateSecretlinkEndpoint extends PostApiEndpoint<UpdateSecretlinkRequest, UpdateSecretlinkResult> {
|
|
3899
5089
|
description: string;
|
|
3900
5090
|
withAuth: boolean;
|
|
5091
|
+
requiredPermissions: string;
|
|
3901
5092
|
endpointUrl: (opts: UpdateSecretlinkRequest) => string;
|
|
3902
5093
|
body: (payload: UpdateSecretlinkRequest) => string;
|
|
3903
5094
|
}
|
|
@@ -3917,7 +5108,7 @@ declare type GetSecretlinkResult = {
|
|
|
3917
5108
|
'linked': boolean;
|
|
3918
5109
|
/** An array of objects containing details about the keys linked to this secret group. */
|
|
3919
5110
|
'linkedKeys'?: {
|
|
3920
|
-
/** The name of the key to link. Example: "
|
|
5111
|
+
/** The name of the key to link. Example: "USERNAME" */
|
|
3921
5112
|
'keyName': string;
|
|
3922
5113
|
/** An array of aliases for the key. */
|
|
3923
5114
|
'aliases'?: string[];
|
|
@@ -3941,6 +5132,7 @@ declare type GetSecretlinkParameters = {
|
|
|
3941
5132
|
declare class GetSecretlinkEndpoint extends GetApiEndpoint<GetSecretlinkRequest, GetSecretlinkResult> {
|
|
3942
5133
|
description: string;
|
|
3943
5134
|
withAuth: boolean;
|
|
5135
|
+
requiredPermissions: string;
|
|
3944
5136
|
endpointUrl: (opts: GetSecretlinkRequest) => string;
|
|
3945
5137
|
body: () => undefined;
|
|
3946
5138
|
}
|
|
@@ -3961,6 +5153,7 @@ declare type DeleteSecretlinkParameters = {
|
|
|
3961
5153
|
declare class DeleteSecretlinkEndpoint extends DeleteApiEndpoint<DeleteSecretlinkRequest, DeleteSecretlinkResult> {
|
|
3962
5154
|
description: string;
|
|
3963
5155
|
withAuth: boolean;
|
|
5156
|
+
requiredPermissions: string;
|
|
3964
5157
|
endpointUrl: (opts: DeleteSecretlinkRequest) => string;
|
|
3965
5158
|
body: () => undefined;
|
|
3966
5159
|
}
|
|
@@ -4031,7 +5224,7 @@ declare type CreateServiceCombinedResult = {
|
|
|
4031
5224
|
/** Number of instances/replicas running Example: 1 */
|
|
4032
5225
|
'instances'?: number;
|
|
4033
5226
|
'internal'?: {
|
|
4034
|
-
/** Database ID of deployed entity Example: "
|
|
5227
|
+
/** Database ID of deployed entity Example: "example-service" */
|
|
4035
5228
|
'nfObjectId': string;
|
|
4036
5229
|
/** Type of deployed entity Example: "service" */
|
|
4037
5230
|
'nfObjectType': 'service';
|
|
@@ -4039,10 +5232,10 @@ declare type CreateServiceCombinedResult = {
|
|
|
4039
5232
|
'repository': string;
|
|
4040
5233
|
/** Branch of the repo being deployed Example: "master" */
|
|
4041
5234
|
'branch': string;
|
|
4042
|
-
/** Commit SHA to be deployed.
|
|
5235
|
+
/** Commit SHA to be deployed. `latest` means the latest commit is automatically being deployed. Example: "latest" */
|
|
4043
5236
|
'buildSHA': string;
|
|
4044
|
-
/** Currently deployed commit SHA. If buildSHA is set to
|
|
4045
|
-
'deployedSHA'
|
|
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;
|
|
4046
5239
|
};
|
|
4047
5240
|
};
|
|
4048
5241
|
'buildConfiguration': {
|
|
@@ -4058,6 +5251,13 @@ declare type CreateServiceCombinedResult = {
|
|
|
4058
5251
|
'builder'?: 'HEROKU_20' | 'HEROKU_18' | 'GOOGLE_V1' | 'CNB_ALPINE' | 'CNB_BIONIC' | 'PAKETO_TINY' | 'PAKETO_BASE' | 'PAKETO_FULL';
|
|
4059
5252
|
/** Array of custom Buildpacks used. */
|
|
4060
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;
|
|
4061
5261
|
};
|
|
4062
5262
|
/** Details about Kaniko settings. */
|
|
4063
5263
|
'kaniko'?: {
|
|
@@ -4092,6 +5292,14 @@ declare type CreateServiceCombinedData = {
|
|
|
4092
5292
|
'instances': number;
|
|
4093
5293
|
/** If set, the service runs a custom command rather than one defined in the Dockerfile. Example: "nginx -g" */
|
|
4094
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
|
+
};
|
|
4095
5303
|
};
|
|
4096
5304
|
'ports'?: {
|
|
4097
5305
|
/** The name used to identify the port. Example: "port-1" */
|
|
@@ -4120,6 +5328,8 @@ declare type CreateServiceCombinedData = {
|
|
|
4120
5328
|
};
|
|
4121
5329
|
/** An array of domains to redirect to this port. Each domain must first be verified and registered to your account. */
|
|
4122
5330
|
'domains'?: string[];
|
|
5331
|
+
/** Disable routing on the default code.run domain for public HTTP ports with custom domains. */
|
|
5332
|
+
'disableNfDomain'?: boolean;
|
|
4123
5333
|
/** The protocol to use for the port. Example: "HTTP" */
|
|
4124
5334
|
'protocol': 'HTTP' | 'HTTP/2' | 'TCP' | 'UDP';
|
|
4125
5335
|
}[];
|
|
@@ -4139,7 +5349,7 @@ declare type CreateServiceCombinedData = {
|
|
|
4139
5349
|
'dockerfile': {
|
|
4140
5350
|
/** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
|
|
4141
5351
|
'buildEngine'?: 'kaniko' | 'buildkit';
|
|
4142
|
-
/** Should intermediate image layers be cached?
|
|
5352
|
+
/** Should intermediate image layers be cached? */
|
|
4143
5353
|
'useCache'?: boolean;
|
|
4144
5354
|
/** The file path of the Dockerfile. Example: "/Dockerfile" */
|
|
4145
5355
|
'dockerFilePath': string;
|
|
@@ -4154,6 +5364,8 @@ declare type CreateServiceCombinedData = {
|
|
|
4154
5364
|
'buildpackLocators'?: string[];
|
|
4155
5365
|
/** The working directory to build in. Example: "/" */
|
|
4156
5366
|
'buildContext'?: string;
|
|
5367
|
+
/** Should build dependencies be cached? */
|
|
5368
|
+
'useCache'?: boolean;
|
|
4157
5369
|
};
|
|
4158
5370
|
};
|
|
4159
5371
|
'buildConfiguration'?: {
|
|
@@ -4173,6 +5385,7 @@ declare type CreateServiceCombinedData = {
|
|
|
4173
5385
|
declare class CreateServiceCombinedEndpoint extends PostApiEndpoint<CreateServiceCombinedRequest, CreateServiceCombinedResult> {
|
|
4174
5386
|
description: string;
|
|
4175
5387
|
withAuth: boolean;
|
|
5388
|
+
requiredPermissions: string;
|
|
4176
5389
|
endpointUrl: (opts: CreateServiceCombinedRequest) => string;
|
|
4177
5390
|
body: (payload: CreateServiceCombinedRequest) => string;
|
|
4178
5391
|
}
|
|
@@ -4236,7 +5449,7 @@ declare type CreateServiceDeploymentResult = {
|
|
|
4236
5449
|
'privateImage': boolean;
|
|
4237
5450
|
};
|
|
4238
5451
|
'internal'?: {
|
|
4239
|
-
/** Database ID of deployed entity Example: "
|
|
5452
|
+
/** Database ID of deployed entity Example: "example-service" */
|
|
4240
5453
|
'nfObjectId': string;
|
|
4241
5454
|
/** Type of deployed entity Example: "service" */
|
|
4242
5455
|
'nfObjectType': 'service';
|
|
@@ -4244,10 +5457,35 @@ declare type CreateServiceDeploymentResult = {
|
|
|
4244
5457
|
'repository': string;
|
|
4245
5458
|
/** Branch of the repo being deployed Example: "master" */
|
|
4246
5459
|
'branch': string;
|
|
4247
|
-
/** Commit SHA to be deployed.
|
|
5460
|
+
/** Commit SHA to be deployed. `latest` means the latest commit is automatically being deployed. Example: "latest" */
|
|
4248
5461
|
'buildSHA': string;
|
|
4249
|
-
/** Currently deployed commit SHA. If buildSHA is set to
|
|
4250
|
-
'deployedSHA'
|
|
5462
|
+
/** Currently deployed commit SHA. If buildSHA is set to `latest`, this will show the SHA of the latest commit. Example: "262ed9817b3cad5142fbceabe0c9e371e390d616" */
|
|
5463
|
+
'deployedSHA'?: string;
|
|
5464
|
+
};
|
|
5465
|
+
/** Details about the Docker overrides for this deployment. */
|
|
5466
|
+
'docker'?: {
|
|
5467
|
+
/** Details about the CMD override for this deployment. */
|
|
5468
|
+
'cmd': {
|
|
5469
|
+
/** Whether the CMD override is enabled. Example: true */
|
|
5470
|
+
'enabled': boolean;
|
|
5471
|
+
/** The CMD to run instead of the default if CMD override is enabled. Example: "nginx -g" */
|
|
5472
|
+
'value': string;
|
|
5473
|
+
};
|
|
5474
|
+
/** Details about the entrypoint override for this deployment. */
|
|
5475
|
+
'entrypoint': {
|
|
5476
|
+
/** Whether the entrypoint override is enabled. Example: true */
|
|
5477
|
+
'enabled': boolean;
|
|
5478
|
+
/** The CMD to run instead of the default if entrypoint override is enabled. Example: "/docker-entrypoint.sh" */
|
|
5479
|
+
'value': string;
|
|
5480
|
+
};
|
|
5481
|
+
};
|
|
5482
|
+
/** Details about storage settings for this deployment. */
|
|
5483
|
+
'storage'?: {
|
|
5484
|
+
/** Details about ephemeral storage settings for this deployment. */
|
|
5485
|
+
'ephemeralStorage'?: {
|
|
5486
|
+
/** Ephemeral storage per container in MB Example: 1024 */
|
|
5487
|
+
'storageSize': number;
|
|
5488
|
+
};
|
|
4251
5489
|
};
|
|
4252
5490
|
};
|
|
4253
5491
|
} | any;
|
|
@@ -4274,28 +5512,34 @@ declare type CreateServiceDeploymentData = {
|
|
|
4274
5512
|
'instances': number;
|
|
4275
5513
|
/** If set, the service runs a custom command rather than one defined in the Dockerfile. Example: "nginx -g" */
|
|
4276
5514
|
'cmdOverride'?: string;
|
|
5515
|
+
/** If set, the service runs a custom entrypoint rather than one defined in the Dockerfile. Example: "/custom-entrypoint.sh" */
|
|
5516
|
+
'entrypointOverride'?: string;
|
|
4277
5517
|
'storage'?: {
|
|
4278
5518
|
'ephemeralStorage'?: {
|
|
4279
|
-
/** Ephemeral storage per container in MB */
|
|
5519
|
+
/** Ephemeral storage per container in MB Example: 1024 */
|
|
4280
5520
|
'storageSize'?: number;
|
|
4281
5521
|
};
|
|
4282
5522
|
};
|
|
4283
5523
|
'internal': {
|
|
4284
|
-
/**
|
|
4285
|
-
'id'
|
|
5524
|
+
/** ID of the build service to deploy Example: "example-build-service" */
|
|
5525
|
+
'id'?: string;
|
|
4286
5526
|
/** Branch to deploy Example: "master" */
|
|
4287
5527
|
'branch'?: string;
|
|
4288
5528
|
/** Commit SHA to deploy, or 'latest' to deploy the most recent commit Example: "latest" */
|
|
4289
|
-
'buildSHA'?: string;
|
|
5529
|
+
'buildSHA'?: string | 'latest';
|
|
5530
|
+
/** ID of the build that should be deployed Example: "premium-guide-6393" */
|
|
5531
|
+
'buildId'?: string;
|
|
4290
5532
|
};
|
|
4291
5533
|
} | {
|
|
4292
5534
|
/** The number of instances to run the service on. Example: 1 */
|
|
4293
5535
|
'instances': number;
|
|
4294
5536
|
/** If set, the service runs a custom command rather than one defined in the Dockerfile. Example: "nginx -g" */
|
|
4295
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;
|
|
4296
5540
|
'storage'?: {
|
|
4297
5541
|
'ephemeralStorage'?: {
|
|
4298
|
-
/** Ephemeral storage per container in MB */
|
|
5542
|
+
/** Ephemeral storage per container in MB Example: 1024 */
|
|
4299
5543
|
'storageSize'?: number;
|
|
4300
5544
|
};
|
|
4301
5545
|
};
|
|
@@ -4310,9 +5554,11 @@ declare type CreateServiceDeploymentData = {
|
|
|
4310
5554
|
'instances': number;
|
|
4311
5555
|
/** If set, the service runs a custom command rather than one defined in the Dockerfile. Example: "nginx -g" */
|
|
4312
5556
|
'cmdOverride'?: string;
|
|
5557
|
+
/** If set, the service runs a custom entrypoint rather than one defined in the Dockerfile. Example: "/custom-entrypoint.sh" */
|
|
5558
|
+
'entrypointOverride'?: string;
|
|
4313
5559
|
'storage'?: {
|
|
4314
5560
|
'ephemeralStorage'?: {
|
|
4315
|
-
/** Ephemeral storage per container in MB */
|
|
5561
|
+
/** Ephemeral storage per container in MB Example: 1024 */
|
|
4316
5562
|
'storageSize'?: number;
|
|
4317
5563
|
};
|
|
4318
5564
|
};
|
|
@@ -4344,6 +5590,8 @@ declare type CreateServiceDeploymentData = {
|
|
|
4344
5590
|
};
|
|
4345
5591
|
/** An array of domains to redirect to this port. Each domain must first be verified and registered to your account. */
|
|
4346
5592
|
'domains'?: string[];
|
|
5593
|
+
/** Disable routing on the default code.run domain for public HTTP ports with custom domains. */
|
|
5594
|
+
'disableNfDomain'?: boolean;
|
|
4347
5595
|
/** The protocol to use for the port. Example: "HTTP" */
|
|
4348
5596
|
'protocol': 'HTTP' | 'HTTP/2' | 'TCP' | 'UDP';
|
|
4349
5597
|
}[];
|
|
@@ -4356,6 +5604,7 @@ declare type CreateServiceDeploymentData = {
|
|
|
4356
5604
|
declare class CreateServiceDeploymentEndpoint extends PostApiEndpoint<CreateServiceDeploymentRequest, CreateServiceDeploymentResult> {
|
|
4357
5605
|
description: string;
|
|
4358
5606
|
withAuth: boolean;
|
|
5607
|
+
requiredPermissions: string;
|
|
4359
5608
|
endpointUrl: (opts: CreateServiceDeploymentRequest) => string;
|
|
4360
5609
|
body: (payload: CreateServiceDeploymentRequest) => string;
|
|
4361
5610
|
}
|
|
@@ -4434,6 +5683,13 @@ declare type CreateServiceBuildResult = {
|
|
|
4434
5683
|
'builder'?: 'HEROKU_20' | 'HEROKU_18' | 'GOOGLE_V1' | 'CNB_ALPINE' | 'CNB_BIONIC' | 'PAKETO_TINY' | 'PAKETO_BASE' | 'PAKETO_FULL';
|
|
4435
5684
|
/** Array of custom Buildpacks used. */
|
|
4436
5685
|
'buildpackLocators'?: string[];
|
|
5686
|
+
/** Should build dependencies be cached? */
|
|
5687
|
+
'useCache'?: boolean;
|
|
5688
|
+
};
|
|
5689
|
+
/** Details about Buildkit settings. */
|
|
5690
|
+
'buildkit'?: {
|
|
5691
|
+
/** Should intermediate image layers be cached? */
|
|
5692
|
+
'useCache'?: boolean;
|
|
4437
5693
|
};
|
|
4438
5694
|
/** Details about Kaniko settings. */
|
|
4439
5695
|
'kaniko'?: {
|
|
@@ -4473,7 +5729,7 @@ declare type CreateServiceBuildData = {
|
|
|
4473
5729
|
'dockerfile': {
|
|
4474
5730
|
/** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
|
|
4475
5731
|
'buildEngine'?: 'kaniko' | 'buildkit';
|
|
4476
|
-
/** Should intermediate image layers be cached?
|
|
5732
|
+
/** Should intermediate image layers be cached? */
|
|
4477
5733
|
'useCache'?: boolean;
|
|
4478
5734
|
/** The file path of the Dockerfile. Example: "/Dockerfile" */
|
|
4479
5735
|
'dockerFilePath': string;
|
|
@@ -4488,6 +5744,8 @@ declare type CreateServiceBuildData = {
|
|
|
4488
5744
|
'buildpackLocators'?: string[];
|
|
4489
5745
|
/** The working directory to build in. Example: "/" */
|
|
4490
5746
|
'buildContext'?: string;
|
|
5747
|
+
/** Should build dependencies be cached? */
|
|
5748
|
+
'useCache'?: boolean;
|
|
4491
5749
|
};
|
|
4492
5750
|
};
|
|
4493
5751
|
'buildConfiguration'?: {
|
|
@@ -4507,6 +5765,7 @@ declare type CreateServiceBuildData = {
|
|
|
4507
5765
|
declare class CreateServiceBuildEndpoint extends PostApiEndpoint<CreateServiceBuildRequest, CreateServiceBuildResult> {
|
|
4508
5766
|
description: string;
|
|
4509
5767
|
withAuth: boolean;
|
|
5768
|
+
requiredPermissions: string;
|
|
4510
5769
|
endpointUrl: (opts: CreateServiceBuildRequest) => string;
|
|
4511
5770
|
body: (payload: CreateServiceBuildRequest) => string;
|
|
4512
5771
|
}
|
|
@@ -4586,7 +5845,7 @@ declare type GetServiceResult = {
|
|
|
4586
5845
|
'privateImage': boolean;
|
|
4587
5846
|
};
|
|
4588
5847
|
'internal'?: {
|
|
4589
|
-
/** Database ID of deployed entity Example: "
|
|
5848
|
+
/** Database ID of deployed entity Example: "example-service" */
|
|
4590
5849
|
'nfObjectId': string;
|
|
4591
5850
|
/** Type of deployed entity Example: "service" */
|
|
4592
5851
|
'nfObjectType': 'service';
|
|
@@ -4594,10 +5853,35 @@ declare type GetServiceResult = {
|
|
|
4594
5853
|
'repository': string;
|
|
4595
5854
|
/** Branch of the repo being deployed Example: "master" */
|
|
4596
5855
|
'branch': string;
|
|
4597
|
-
/** Commit SHA to be deployed.
|
|
5856
|
+
/** Commit SHA to be deployed. `latest` means the latest commit is automatically being deployed. Example: "latest" */
|
|
4598
5857
|
'buildSHA': string;
|
|
4599
|
-
/** Currently deployed commit SHA. If buildSHA is set to
|
|
4600
|
-
'deployedSHA'
|
|
5858
|
+
/** Currently deployed commit SHA. If buildSHA is set to `latest`, this will show the SHA of the latest commit. Example: "262ed9817b3cad5142fbceabe0c9e371e390d616" */
|
|
5859
|
+
'deployedSHA'?: string;
|
|
5860
|
+
};
|
|
5861
|
+
/** Details about the Docker overrides for this deployment. */
|
|
5862
|
+
'docker'?: {
|
|
5863
|
+
/** Details about the CMD override for this deployment. */
|
|
5864
|
+
'cmd': {
|
|
5865
|
+
/** Whether the CMD override is enabled. Example: true */
|
|
5866
|
+
'enabled': boolean;
|
|
5867
|
+
/** The CMD to run instead of the default if CMD override is enabled. Example: "nginx -g" */
|
|
5868
|
+
'value': string;
|
|
5869
|
+
};
|
|
5870
|
+
/** Details about the entrypoint override for this deployment. */
|
|
5871
|
+
'entrypoint': {
|
|
5872
|
+
/** Whether the entrypoint override is enabled. Example: true */
|
|
5873
|
+
'enabled': boolean;
|
|
5874
|
+
/** The CMD to run instead of the default if entrypoint override is enabled. Example: "/docker-entrypoint.sh" */
|
|
5875
|
+
'value': string;
|
|
5876
|
+
};
|
|
5877
|
+
};
|
|
5878
|
+
/** Details about storage settings for this deployment. */
|
|
5879
|
+
'storage'?: {
|
|
5880
|
+
/** Details about ephemeral storage settings for this deployment. */
|
|
5881
|
+
'ephemeralStorage'?: {
|
|
5882
|
+
/** Ephemeral storage per container in MB Example: 1024 */
|
|
5883
|
+
'storageSize': number;
|
|
5884
|
+
};
|
|
4601
5885
|
};
|
|
4602
5886
|
};
|
|
4603
5887
|
'buildConfiguration'?: {
|
|
@@ -4614,6 +5898,13 @@ declare type GetServiceResult = {
|
|
|
4614
5898
|
'builder'?: 'HEROKU_20' | 'HEROKU_18' | 'GOOGLE_V1' | 'CNB_ALPINE' | 'CNB_BIONIC' | 'PAKETO_TINY' | 'PAKETO_BASE' | 'PAKETO_FULL';
|
|
4615
5899
|
/** Array of custom Buildpacks used. */
|
|
4616
5900
|
'buildpackLocators'?: string[];
|
|
5901
|
+
/** Should build dependencies be cached? */
|
|
5902
|
+
'useCache'?: boolean;
|
|
5903
|
+
};
|
|
5904
|
+
/** Details about Buildkit settings. */
|
|
5905
|
+
'buildkit'?: {
|
|
5906
|
+
/** Should intermediate image layers be cached? */
|
|
5907
|
+
'useCache'?: boolean;
|
|
4617
5908
|
};
|
|
4618
5909
|
/** Details about Kaniko settings. */
|
|
4619
5910
|
'kaniko'?: {
|
|
@@ -4668,6 +5959,8 @@ declare type GetServiceResult = {
|
|
|
4668
5959
|
'action': 'ALLOW' | 'DENY';
|
|
4669
5960
|
}[];
|
|
4670
5961
|
};
|
|
5962
|
+
/** Disable routing on the default code.run domain for public HTTP ports with custom domains. */
|
|
5963
|
+
'disableNfDomain'?: boolean;
|
|
4671
5964
|
}[];
|
|
4672
5965
|
};
|
|
4673
5966
|
declare type GetServiceCall = (opts: GetServiceRequest) => Promise<ApiCallResponse<GetServiceResult>>;
|
|
@@ -4683,6 +5976,7 @@ declare type GetServiceParameters = {
|
|
|
4683
5976
|
declare class GetServiceEndpoint extends GetApiEndpoint<GetServiceRequest, GetServiceResult> {
|
|
4684
5977
|
description: string;
|
|
4685
5978
|
withAuth: boolean;
|
|
5979
|
+
requiredPermissions: string;
|
|
4686
5980
|
endpointUrl: (opts: GetServiceRequest) => string;
|
|
4687
5981
|
body: () => undefined;
|
|
4688
5982
|
}
|
|
@@ -4701,6 +5995,7 @@ declare type DeleteServiceParameters = {
|
|
|
4701
5995
|
declare class DeleteServiceEndpoint extends DeleteApiEndpoint<DeleteServiceRequest, DeleteServiceResult> {
|
|
4702
5996
|
description: string;
|
|
4703
5997
|
withAuth: boolean;
|
|
5998
|
+
requiredPermissions: string;
|
|
4704
5999
|
endpointUrl: (opts: DeleteServiceRequest) => string;
|
|
4705
6000
|
body: () => undefined;
|
|
4706
6001
|
}
|
|
@@ -4723,7 +6018,7 @@ declare type ScaleServiceData = {
|
|
|
4723
6018
|
'deploymentPlan'?: string;
|
|
4724
6019
|
'storage'?: {
|
|
4725
6020
|
'ephemeralStorage'?: {
|
|
4726
|
-
/** Ephemeral storage per container in MB */
|
|
6021
|
+
/** Ephemeral storage per container in MB Example: 1024 */
|
|
4727
6022
|
'storageSize'?: number;
|
|
4728
6023
|
};
|
|
4729
6024
|
};
|
|
@@ -4732,6 +6027,7 @@ declare type ScaleServiceData = {
|
|
|
4732
6027
|
declare class ScaleServiceEndpoint extends PostApiEndpoint<ScaleServiceRequest, ScaleServiceResult> {
|
|
4733
6028
|
description: string;
|
|
4734
6029
|
withAuth: boolean;
|
|
6030
|
+
requiredPermissions: string;
|
|
4735
6031
|
endpointUrl: (opts: ScaleServiceRequest) => string;
|
|
4736
6032
|
body: (payload: ScaleServiceRequest) => string;
|
|
4737
6033
|
}
|
|
@@ -4752,8 +6048,12 @@ declare type GetServiceDeploymentResult = {
|
|
|
4752
6048
|
'repository': string;
|
|
4753
6049
|
/** Branch of the repo being deployed Example: "master" */
|
|
4754
6050
|
'branch': string;
|
|
4755
|
-
/**
|
|
6051
|
+
/** ID of the build currently deployed. Example: "incredible-land-3266" */
|
|
6052
|
+
'buildId': string;
|
|
6053
|
+
/** Commit SHA being deployed. `latest` means the latest commit is automatically being deployed. Example: "latest" */
|
|
4756
6054
|
'buildSHA': string;
|
|
6055
|
+
/** Currently deployed commit SHA. If buildSHA is set to `latest`, this will show the SHA of the latest commit. Example: "262ed9817b3cad5142fbceabe0c9e371e390d616" */
|
|
6056
|
+
'deployedSHA'?: string;
|
|
4757
6057
|
};
|
|
4758
6058
|
} | {
|
|
4759
6059
|
/** Region where this service is deployed and/or built Example: "europe-west" */
|
|
@@ -4782,6 +6082,7 @@ declare type GetServiceDeploymentParameters = {
|
|
|
4782
6082
|
declare class GetServiceDeploymentEndpoint extends GetApiEndpoint<GetServiceDeploymentRequest, GetServiceDeploymentResult> {
|
|
4783
6083
|
description: string;
|
|
4784
6084
|
withAuth: boolean;
|
|
6085
|
+
requiredPermissions: string;
|
|
4785
6086
|
endpointUrl: (opts: GetServiceDeploymentRequest) => string;
|
|
4786
6087
|
body: () => undefined;
|
|
4787
6088
|
}
|
|
@@ -4811,7 +6112,7 @@ declare type UpdateServiceDeploymentData = {
|
|
|
4811
6112
|
/** Branch to deploy Example: "master" */
|
|
4812
6113
|
'branch'?: string;
|
|
4813
6114
|
/** Commit SHA to deploy, or 'latest' to deploy the most recent commit Example: "latest" */
|
|
4814
|
-
'buildSHA'?:
|
|
6115
|
+
'buildSHA'?: string | 'latest';
|
|
4815
6116
|
/** ID of the build that should be deployed Example: "premium-guide-6393" */
|
|
4816
6117
|
'buildId'?: string;
|
|
4817
6118
|
};
|
|
@@ -4820,6 +6121,7 @@ declare type UpdateServiceDeploymentData = {
|
|
|
4820
6121
|
declare class UpdateServiceDeploymentEndpoint extends PostApiEndpoint<UpdateServiceDeploymentRequest, UpdateServiceDeploymentResult> {
|
|
4821
6122
|
description: string;
|
|
4822
6123
|
withAuth: boolean;
|
|
6124
|
+
requiredPermissions: string;
|
|
4823
6125
|
endpointUrl: (opts: UpdateServiceDeploymentRequest) => string;
|
|
4824
6126
|
body: (payload: UpdateServiceDeploymentRequest) => string;
|
|
4825
6127
|
}
|
|
@@ -4838,6 +6140,7 @@ declare type RestartServiceParameters = {
|
|
|
4838
6140
|
declare class RestartServiceEndpoint extends PostApiEndpoint<RestartServiceRequest, RestartServiceResult> {
|
|
4839
6141
|
description: string;
|
|
4840
6142
|
withAuth: boolean;
|
|
6143
|
+
requiredPermissions: string;
|
|
4841
6144
|
endpointUrl: (opts: RestartServiceRequest) => string;
|
|
4842
6145
|
body: () => undefined;
|
|
4843
6146
|
}
|
|
@@ -4856,6 +6159,7 @@ declare type PauseServiceParameters = {
|
|
|
4856
6159
|
declare class PauseServiceEndpoint extends PostApiEndpoint<PauseServiceRequest, PauseServiceResult> {
|
|
4857
6160
|
description: string;
|
|
4858
6161
|
withAuth: boolean;
|
|
6162
|
+
requiredPermissions: string;
|
|
4859
6163
|
endpointUrl: (opts: PauseServiceRequest) => string;
|
|
4860
6164
|
body: () => undefined;
|
|
4861
6165
|
}
|
|
@@ -4874,11 +6178,16 @@ declare type ResumeServiceParameters = {
|
|
|
4874
6178
|
declare type ResumeServiceData = {
|
|
4875
6179
|
/** The number of instances to scale the service to upon resuming Example: 1 */
|
|
4876
6180
|
'instances'?: number;
|
|
6181
|
+
/** Whether CI should be disabled */
|
|
6182
|
+
'disabledCI'?: boolean;
|
|
6183
|
+
/** Whether CD should be disabled */
|
|
6184
|
+
'disabledCD'?: boolean;
|
|
4877
6185
|
};
|
|
4878
|
-
/** Resumes the given service. Optionally takes
|
|
6186
|
+
/** Resumes the given service. Optionally takes several arguments to override resumed settings. */
|
|
4879
6187
|
declare class ResumeServiceEndpoint extends PostApiEndpoint<ResumeServiceRequest, ResumeServiceResult> {
|
|
4880
6188
|
description: string;
|
|
4881
6189
|
withAuth: boolean;
|
|
6190
|
+
requiredPermissions: string;
|
|
4882
6191
|
endpointUrl: (opts: ResumeServiceRequest) => string;
|
|
4883
6192
|
body: (payload: ResumeServiceRequest) => string;
|
|
4884
6193
|
}
|
|
@@ -4931,6 +6240,8 @@ declare type GetServicePortsResult = {
|
|
|
4931
6240
|
'action': 'ALLOW' | 'DENY';
|
|
4932
6241
|
}[];
|
|
4933
6242
|
};
|
|
6243
|
+
/** Disable routing on the default code.run domain for public HTTP ports with custom domains. */
|
|
6244
|
+
'disableNfDomain'?: boolean;
|
|
4934
6245
|
}[];
|
|
4935
6246
|
};
|
|
4936
6247
|
declare type GetServicePortsCall = (opts: GetServicePortsRequest) => Promise<ApiCallResponse<GetServicePortsResult>>;
|
|
@@ -4946,6 +6257,7 @@ declare type GetServicePortsParameters = {
|
|
|
4946
6257
|
declare class GetServicePortsEndpoint extends GetApiEndpoint<GetServicePortsRequest, GetServicePortsResult> {
|
|
4947
6258
|
description: string;
|
|
4948
6259
|
withAuth: boolean;
|
|
6260
|
+
requiredPermissions: string;
|
|
4949
6261
|
endpointUrl: (opts: GetServicePortsRequest) => string;
|
|
4950
6262
|
body: () => undefined;
|
|
4951
6263
|
}
|
|
@@ -4964,7 +6276,7 @@ declare type UpdateServicePortsParameters = {
|
|
|
4964
6276
|
declare type UpdateServicePortsData = {
|
|
4965
6277
|
/** An array of ports to replace or update existing ports with. */
|
|
4966
6278
|
'ports': {
|
|
4967
|
-
/** The id of an existing port. Pass this when changing in order to keep security configurations. Example: "
|
|
6279
|
+
/** The id of an existing port. Pass this when changing in order to keep security configurations. Example: "p01" */
|
|
4968
6280
|
'id'?: string;
|
|
4969
6281
|
/** The name used to identify the port. Example: "port-1" */
|
|
4970
6282
|
'name': string;
|
|
@@ -4994,12 +6306,15 @@ declare type UpdateServicePortsData = {
|
|
|
4994
6306
|
'action': 'ALLOW' | 'DENY';
|
|
4995
6307
|
}[];
|
|
4996
6308
|
};
|
|
6309
|
+
/** Disable routing on the default code.run domain for public HTTP ports with custom domains. */
|
|
6310
|
+
'disableNfDomain'?: boolean;
|
|
4997
6311
|
}[];
|
|
4998
6312
|
};
|
|
4999
6313
|
/** Updates the list of ports for the given service. */
|
|
5000
6314
|
declare class UpdateServicePortsEndpoint extends PostApiEndpoint<UpdateServicePortsRequest, UpdateServicePortsResult> {
|
|
5001
6315
|
description: string;
|
|
5002
6316
|
withAuth: boolean;
|
|
6317
|
+
requiredPermissions: string;
|
|
5003
6318
|
endpointUrl: (opts: UpdateServicePortsRequest) => string;
|
|
5004
6319
|
body: (payload: UpdateServicePortsRequest) => string;
|
|
5005
6320
|
}
|
|
@@ -5019,7 +6334,7 @@ declare type UpdateServiceBuildoptionsData = {
|
|
|
5019
6334
|
'dockerfile': {
|
|
5020
6335
|
/** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
|
|
5021
6336
|
'buildEngine'?: 'kaniko' | 'buildkit';
|
|
5022
|
-
/** Should intermediate image layers be cached?
|
|
6337
|
+
/** Should intermediate image layers be cached? */
|
|
5023
6338
|
'useCache'?: boolean;
|
|
5024
6339
|
/** The file path of the Dockerfile. Example: "/Dockerfile" */
|
|
5025
6340
|
'dockerFilePath'?: string;
|
|
@@ -5040,6 +6355,8 @@ declare type UpdateServiceBuildoptionsData = {
|
|
|
5040
6355
|
'buildpackLocators'?: string[];
|
|
5041
6356
|
/** The working directory to build in. Example: "/" */
|
|
5042
6357
|
'buildContext'?: string;
|
|
6358
|
+
/** Should build dependencies be cached? */
|
|
6359
|
+
'useCache'?: boolean;
|
|
5043
6360
|
};
|
|
5044
6361
|
/** 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. */
|
|
5045
6362
|
'prRestrictions'?: string[];
|
|
@@ -5059,6 +6376,7 @@ declare type UpdateServiceBuildoptionsData = {
|
|
|
5059
6376
|
declare class UpdateServiceBuildoptionsEndpoint extends PostApiEndpoint<UpdateServiceBuildoptionsRequest, UpdateServiceBuildoptionsResult> {
|
|
5060
6377
|
description: string;
|
|
5061
6378
|
withAuth: boolean;
|
|
6379
|
+
requiredPermissions: string;
|
|
5062
6380
|
endpointUrl: (opts: UpdateServiceBuildoptionsRequest) => string;
|
|
5063
6381
|
body: (payload: UpdateServiceBuildoptionsRequest) => string;
|
|
5064
6382
|
}
|
|
@@ -5090,6 +6408,7 @@ declare type UpdateServiceBuildsourceData = {
|
|
|
5090
6408
|
declare class UpdateServiceBuildsourceEndpoint extends PostApiEndpoint<UpdateServiceBuildsourceRequest, UpdateServiceBuildsourceResult> {
|
|
5091
6409
|
description: string;
|
|
5092
6410
|
withAuth: boolean;
|
|
6411
|
+
requiredPermissions: string;
|
|
5093
6412
|
endpointUrl: (opts: UpdateServiceBuildsourceRequest) => string;
|
|
5094
6413
|
body: (payload: UpdateServiceBuildsourceRequest) => string;
|
|
5095
6414
|
}
|
|
@@ -5113,10 +6432,35 @@ declare type UpdateServiceCmdoverrideData = {
|
|
|
5113
6432
|
declare class UpdateServiceCmdoverrideEndpoint extends PostApiEndpoint<UpdateServiceCmdoverrideRequest, UpdateServiceCmdoverrideResult> {
|
|
5114
6433
|
description: string;
|
|
5115
6434
|
withAuth: boolean;
|
|
6435
|
+
requiredPermissions: string;
|
|
5116
6436
|
endpointUrl: (opts: UpdateServiceCmdoverrideRequest) => string;
|
|
5117
6437
|
body: (payload: UpdateServiceCmdoverrideRequest) => string;
|
|
5118
6438
|
}
|
|
5119
6439
|
|
|
6440
|
+
declare type UpdateServiceEntrypointoverrideResult = any;
|
|
6441
|
+
declare type UpdateServiceEntrypointoverrideCall = (opts: UpdateServiceEntrypointoverrideRequest) => Promise<ApiCallResponse<UpdateServiceEntrypointoverrideResult>>;
|
|
6442
|
+
declare type UpdateServiceEntrypointoverrideRequest = {
|
|
6443
|
+
parameters: UpdateServiceEntrypointoverrideParameters;
|
|
6444
|
+
data: UpdateServiceEntrypointoverrideData;
|
|
6445
|
+
};
|
|
6446
|
+
declare type UpdateServiceEntrypointoverrideParameters = {
|
|
6447
|
+
/** ID of the project */ 'projectId': string;
|
|
6448
|
+
/** ID of the service */
|
|
6449
|
+
'serviceId': string;
|
|
6450
|
+
};
|
|
6451
|
+
declare type UpdateServiceEntrypointoverrideData = {
|
|
6452
|
+
/** If set, the service runs a custom entrypoint rather than one defined in the Dockerfile. Example: "/custom-entrypoint.sh" */
|
|
6453
|
+
'entrypointOverride'?: string;
|
|
6454
|
+
};
|
|
6455
|
+
/** Sets the Docker entrypoint override for the given service. */
|
|
6456
|
+
declare class UpdateServiceEntrypointoverrideEndpoint extends PostApiEndpoint<UpdateServiceEntrypointoverrideRequest, UpdateServiceEntrypointoverrideResult> {
|
|
6457
|
+
description: string;
|
|
6458
|
+
withAuth: boolean;
|
|
6459
|
+
requiredPermissions: string;
|
|
6460
|
+
endpointUrl: (opts: UpdateServiceEntrypointoverrideRequest) => string;
|
|
6461
|
+
body: (payload: UpdateServiceEntrypointoverrideRequest) => string;
|
|
6462
|
+
}
|
|
6463
|
+
|
|
5120
6464
|
declare type GetServiceHealthchecksResult = {
|
|
5121
6465
|
/** An array of health checks. */
|
|
5122
6466
|
'healthChecks': {
|
|
@@ -5136,6 +6480,7 @@ declare type GetServiceHealthchecksResult = {
|
|
|
5136
6480
|
'initialDelaySeconds': number;
|
|
5137
6481
|
/** The time between each check, in seconds. Example: 60 */
|
|
5138
6482
|
'periodSeconds': number;
|
|
6483
|
+
/** The time to wait for a response before marking the health check as a failure. Example: 1 */
|
|
5139
6484
|
'timeoutSeconds': number;
|
|
5140
6485
|
/** The maximum number of allowed failures. Example: 3 */
|
|
5141
6486
|
'failureThreshold': number;
|
|
@@ -5156,6 +6501,7 @@ declare type GetServiceHealthchecksParameters = {
|
|
|
5156
6501
|
declare class GetServiceHealthchecksEndpoint extends GetApiEndpoint<GetServiceHealthchecksRequest, GetServiceHealthchecksResult> {
|
|
5157
6502
|
description: string;
|
|
5158
6503
|
withAuth: boolean;
|
|
6504
|
+
requiredPermissions: string;
|
|
5159
6505
|
endpointUrl: (opts: GetServiceHealthchecksRequest) => string;
|
|
5160
6506
|
body: () => undefined;
|
|
5161
6507
|
}
|
|
@@ -5200,6 +6546,7 @@ declare type UpdateServiceHealthchecksData = {
|
|
|
5200
6546
|
declare class UpdateServiceHealthchecksEndpoint extends PostApiEndpoint<UpdateServiceHealthchecksRequest, UpdateServiceHealthchecksResult> {
|
|
5201
6547
|
description: string;
|
|
5202
6548
|
withAuth: boolean;
|
|
6549
|
+
requiredPermissions: string;
|
|
5203
6550
|
endpointUrl: (opts: UpdateServiceHealthchecksRequest) => string;
|
|
5204
6551
|
body: (payload: UpdateServiceHealthchecksRequest) => string;
|
|
5205
6552
|
}
|
|
@@ -5251,6 +6598,7 @@ declare type GetServiceBuildsOptions = {
|
|
|
5251
6598
|
declare class GetServiceBuildsEndpoint extends GetApiEndpoint<GetServiceBuildsRequest, GetServiceBuildsResult> {
|
|
5252
6599
|
description: string;
|
|
5253
6600
|
withAuth: boolean;
|
|
6601
|
+
requiredPermissions: string;
|
|
5254
6602
|
endpointUrl: (opts: GetServiceBuildsRequest) => string;
|
|
5255
6603
|
body: () => undefined;
|
|
5256
6604
|
}
|
|
@@ -5305,6 +6653,7 @@ declare type StartServiceBuildData = {
|
|
|
5305
6653
|
declare class StartServiceBuildEndpoint extends PostApiEndpoint<StartServiceBuildRequest, StartServiceBuildResult> {
|
|
5306
6654
|
description: string;
|
|
5307
6655
|
withAuth: boolean;
|
|
6656
|
+
requiredPermissions: string;
|
|
5308
6657
|
endpointUrl: (opts: StartServiceBuildRequest) => string;
|
|
5309
6658
|
body: (payload: StartServiceBuildRequest) => string;
|
|
5310
6659
|
}
|
|
@@ -5346,6 +6695,7 @@ declare type GetServiceBuildParameters = {
|
|
|
5346
6695
|
declare class GetServiceBuildEndpoint extends GetApiEndpoint<GetServiceBuildRequest, GetServiceBuildResult> {
|
|
5347
6696
|
description: string;
|
|
5348
6697
|
withAuth: boolean;
|
|
6698
|
+
requiredPermissions: string;
|
|
5349
6699
|
endpointUrl: (opts: GetServiceBuildRequest) => string;
|
|
5350
6700
|
body: () => undefined;
|
|
5351
6701
|
}
|
|
@@ -5366,20 +6716,21 @@ declare type AbortServiceBuildParameters = {
|
|
|
5366
6716
|
declare class AbortServiceBuildEndpoint extends DeleteApiEndpoint<AbortServiceBuildRequest, AbortServiceBuildResult> {
|
|
5367
6717
|
description: string;
|
|
5368
6718
|
withAuth: boolean;
|
|
6719
|
+
requiredPermissions: string;
|
|
5369
6720
|
endpointUrl: (opts: AbortServiceBuildRequest) => string;
|
|
5370
6721
|
body: () => undefined;
|
|
5371
6722
|
}
|
|
5372
6723
|
|
|
5373
6724
|
declare type GetServiceContainersResult = {
|
|
5374
6725
|
/** An array of containers. */
|
|
5375
|
-
'
|
|
5376
|
-
/** The
|
|
6726
|
+
'containers': {
|
|
6727
|
+
/** The name of the container. Example: "example-service-78b4d4459d-sbtn8" */
|
|
6728
|
+
'name': string;
|
|
6729
|
+
/** The timestamp the container was created. Example: 1611241087 */
|
|
5377
6730
|
'createdAt': number;
|
|
5378
|
-
/** The
|
|
5379
|
-
'podName': string;
|
|
5380
|
-
/** The current status of the pod. Example: "TASK_RUNNING" */
|
|
6731
|
+
/** The current status of the container. Example: "TASK_RUNNING" */
|
|
5381
6732
|
'status': 'TASK_RUNNING' | 'TASK_STARTING' | 'TASK_STAGING' | 'TASK_KILLING' | 'TASK_KILLED' | 'TASK_FAILED' | 'TASK_FINISHED';
|
|
5382
|
-
/** The timestamp the
|
|
6733
|
+
/** The timestamp the container was last updated. Example: 1611241087 */
|
|
5383
6734
|
'updatedAt': number;
|
|
5384
6735
|
}[];
|
|
5385
6736
|
};
|
|
@@ -5405,6 +6756,7 @@ declare type GetServiceContainersOptions = {
|
|
|
5405
6756
|
declare class GetServiceContainersEndpoint extends GetApiEndpoint<GetServiceContainersRequest, GetServiceContainersResult> {
|
|
5406
6757
|
description: string;
|
|
5407
6758
|
withAuth: boolean;
|
|
6759
|
+
requiredPermissions: string;
|
|
5408
6760
|
endpointUrl: (opts: GetServiceContainersRequest) => string;
|
|
5409
6761
|
body: () => undefined;
|
|
5410
6762
|
}
|
|
@@ -5453,6 +6805,7 @@ declare type GetServiceBranchesOptions = {
|
|
|
5453
6805
|
declare class GetServiceBranchesEndpoint extends GetApiEndpoint<GetServiceBranchesRequest, GetServiceBranchesResult> {
|
|
5454
6806
|
description: string;
|
|
5455
6807
|
withAuth: boolean;
|
|
6808
|
+
requiredPermissions: string;
|
|
5456
6809
|
endpointUrl: (opts: GetServiceBranchesRequest) => string;
|
|
5457
6810
|
body: () => undefined;
|
|
5458
6811
|
}
|
|
@@ -5501,10 +6854,532 @@ declare type GetServicePullrequestsOptions = {
|
|
|
5501
6854
|
declare class GetServicePullrequestsEndpoint extends GetApiEndpoint<GetServicePullrequestsRequest, GetServicePullrequestsResult> {
|
|
5502
6855
|
description: string;
|
|
5503
6856
|
withAuth: boolean;
|
|
6857
|
+
requiredPermissions: string;
|
|
5504
6858
|
endpointUrl: (opts: GetServicePullrequestsRequest) => string;
|
|
5505
6859
|
body: () => undefined;
|
|
5506
6860
|
}
|
|
5507
6861
|
|
|
6862
|
+
declare type ListTemplatesResult = {
|
|
6863
|
+
/** An array of template objects. */
|
|
6864
|
+
'templates': {
|
|
6865
|
+
/** ID of the template. Example: "example-template" */
|
|
6866
|
+
'id': string;
|
|
6867
|
+
/** Timestamp of when the template was created. Example: "2022-06-14 15:10:42.842Z" */
|
|
6868
|
+
'createdAt': string;
|
|
6869
|
+
/** Timestamp of when the template was last updated. Example: "2022-06-14 15:10:42.842Z" */
|
|
6870
|
+
'updatedAt': string;
|
|
6871
|
+
/** Details about the template. */
|
|
6872
|
+
'content': {
|
|
6873
|
+
/** Name of the template. Example: "Example Template" */
|
|
6874
|
+
'name': string;
|
|
6875
|
+
/** Description of the template. Example: "This is a sample template." */
|
|
6876
|
+
'description'?: string;
|
|
6877
|
+
/** The version of the Northflank API to run the template against. Example: "v1" */
|
|
6878
|
+
'apiVersion': 'v1';
|
|
6879
|
+
};
|
|
6880
|
+
}[];
|
|
6881
|
+
};
|
|
6882
|
+
declare type ListTemplatesCall = (opts: ListTemplatesRequest) => Promise<ApiCallResponse<ListTemplatesResult>>;
|
|
6883
|
+
declare type ListTemplatesRequest = {
|
|
6884
|
+
options?: ListTemplatesOptions;
|
|
6885
|
+
};
|
|
6886
|
+
declare type ListTemplatesOptions = {
|
|
6887
|
+
/** The number of results to display per request. Maximum of 100 results per page. */
|
|
6888
|
+
'per_page'?: number;
|
|
6889
|
+
/** The page number to access. */
|
|
6890
|
+
'page'?: number;
|
|
6891
|
+
/** The cursor returned from the previous page of results, used to request the next page. */
|
|
6892
|
+
'cursor'?: string;
|
|
6893
|
+
};
|
|
6894
|
+
/** Get a list of templates */
|
|
6895
|
+
declare class ListTemplatesEndpoint extends GetApiEndpoint<ListTemplatesRequest, ListTemplatesResult> {
|
|
6896
|
+
description: string;
|
|
6897
|
+
withAuth: boolean;
|
|
6898
|
+
requiredPermissions: string;
|
|
6899
|
+
endpointUrl: (opts: ListTemplatesRequest) => string;
|
|
6900
|
+
body: () => undefined;
|
|
6901
|
+
}
|
|
6902
|
+
|
|
6903
|
+
declare type CreateTemplateResult = {
|
|
6904
|
+
/** Details about the newly created template. */
|
|
6905
|
+
'template': {
|
|
6906
|
+
/** ID of the template. Example: "example-template" */
|
|
6907
|
+
'id': string;
|
|
6908
|
+
/** Timestamp of when the template was created. Example: "2022-06-14 15:10:42.842Z" */
|
|
6909
|
+
'createdAt': string;
|
|
6910
|
+
/** Timestamp of when the template was last updated. Example: "2022-06-14 15:10:42.842Z" */
|
|
6911
|
+
'updatedAt': string;
|
|
6912
|
+
'content'?: {
|
|
6913
|
+
/** Name of the template. Example: "Example Template" */
|
|
6914
|
+
'name': string;
|
|
6915
|
+
/** Description of the template. Example: "This is a sample template." */
|
|
6916
|
+
'description'?: string;
|
|
6917
|
+
/** The version of the Northflank API to run the template against. Example: "v1" */
|
|
6918
|
+
'apiVersion': 'v1';
|
|
6919
|
+
/** Details of the project the template will run in. */
|
|
6920
|
+
'project': {
|
|
6921
|
+
/** The ID of the project to use. */
|
|
6922
|
+
'id': string;
|
|
6923
|
+
} | {
|
|
6924
|
+
/** Details about the project to create. */
|
|
6925
|
+
'spec': {
|
|
6926
|
+
/** The name of the project. Example: "New Project" */
|
|
6927
|
+
'name': string;
|
|
6928
|
+
/** The description of the project. Example: "This is a new project." */
|
|
6929
|
+
'description'?: string;
|
|
6930
|
+
/** The region the project will be hosted in. Example: "europe-west" */
|
|
6931
|
+
'region'?: string;
|
|
6932
|
+
/** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
|
|
6933
|
+
'clusterId'?: string;
|
|
6934
|
+
/** The color of the project in the Northflank App. Example: "#EF233C" */
|
|
6935
|
+
'color'?: string;
|
|
6936
|
+
};
|
|
6937
|
+
};
|
|
6938
|
+
'spec': any;
|
|
6939
|
+
};
|
|
6940
|
+
};
|
|
6941
|
+
/** Details about the newly created template run. */
|
|
6942
|
+
'templateRun'?: {
|
|
6943
|
+
/** ID of the template run. Example: "501c1e03-a021-4659-9048-85f8f6ee2bc7" */
|
|
6944
|
+
'id': string;
|
|
6945
|
+
/** Timestamp of when the run was initiated. Example: "2022-06-14 15:10:42.842Z" */
|
|
6946
|
+
'createdAt': string;
|
|
6947
|
+
/** Timestamp of when the run was last updated. Example: "2022-06-14 15:10:42.842Z" */
|
|
6948
|
+
'updatedAt': string;
|
|
6949
|
+
/** Details about the template being run. */
|
|
6950
|
+
'template': {
|
|
6951
|
+
/** ID of the template Example: "example-template" */
|
|
6952
|
+
'id': string;
|
|
6953
|
+
/** The name of the template Example: "Example Template" */
|
|
6954
|
+
'name': string;
|
|
6955
|
+
};
|
|
6956
|
+
/** Status of the template run. Example: "success" */
|
|
6957
|
+
'status': 'waiting' | 'failure' | 'retrying' | 'success' | 'unknown';
|
|
6958
|
+
/** Details about the template run. */
|
|
6959
|
+
'content': {
|
|
6960
|
+
/** Name of the template. Example: "Example Template" */
|
|
6961
|
+
'name': string;
|
|
6962
|
+
/** Description of the template. Example: "This is a sample template." */
|
|
6963
|
+
'description'?: string;
|
|
6964
|
+
/** The version of the Northflank API to run the template against. Example: "v1" */
|
|
6965
|
+
'apiVersion': 'v1';
|
|
6966
|
+
/** Details of the project the template will run in. */
|
|
6967
|
+
'project': {
|
|
6968
|
+
/** The ID of the project to use. */
|
|
6969
|
+
'id': string;
|
|
6970
|
+
} | {
|
|
6971
|
+
/** Details about the project to create. */
|
|
6972
|
+
'spec': {
|
|
6973
|
+
/** The name of the project. Example: "New Project" */
|
|
6974
|
+
'name': string;
|
|
6975
|
+
/** The description of the project. Example: "This is a new project." */
|
|
6976
|
+
'description'?: string;
|
|
6977
|
+
/** The region the project will be hosted in. Example: "europe-west" */
|
|
6978
|
+
'region'?: string;
|
|
6979
|
+
/** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
|
|
6980
|
+
'clusterId'?: string;
|
|
6981
|
+
/** The color of the project in the Northflank App. Example: "#EF233C" */
|
|
6982
|
+
'color'?: string;
|
|
6983
|
+
};
|
|
6984
|
+
};
|
|
6985
|
+
'spec': any;
|
|
6986
|
+
};
|
|
6987
|
+
};
|
|
6988
|
+
};
|
|
6989
|
+
declare type CreateTemplateCall = (opts: CreateTemplateRequest) => Promise<ApiCallResponse<CreateTemplateResult>>;
|
|
6990
|
+
declare type CreateTemplateRequest = {
|
|
6991
|
+
data: CreateTemplateData;
|
|
6992
|
+
};
|
|
6993
|
+
declare type CreateTemplateData = {
|
|
6994
|
+
/** Name of the template. Example: "Example Template" */
|
|
6995
|
+
'name': string;
|
|
6996
|
+
/** Description of the template. Example: "This is a sample template." */
|
|
6997
|
+
'description'?: string;
|
|
6998
|
+
/** The version of the Northflank API to run the template against. Example: "v1" */
|
|
6999
|
+
'apiVersion': 'v1';
|
|
7000
|
+
/** Details of the project the template will run in. */
|
|
7001
|
+
'project': {
|
|
7002
|
+
/** The ID of the project to use. */
|
|
7003
|
+
'id': string;
|
|
7004
|
+
} | {
|
|
7005
|
+
/** Details about the project to create. */
|
|
7006
|
+
'spec': {
|
|
7007
|
+
/** The name of the project. Example: "New Project" */
|
|
7008
|
+
'name': string;
|
|
7009
|
+
/** The description of the project. Example: "This is a new project." */
|
|
7010
|
+
'description'?: string;
|
|
7011
|
+
/** The region the project will be hosted in. Example: "europe-west" */
|
|
7012
|
+
'region'?: string;
|
|
7013
|
+
/** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
|
|
7014
|
+
'clusterId'?: string;
|
|
7015
|
+
/** The color of the project in the Northflank App. Example: "#EF233C" */
|
|
7016
|
+
'color'?: string;
|
|
7017
|
+
};
|
|
7018
|
+
};
|
|
7019
|
+
'spec': any;
|
|
7020
|
+
/** Additional options for the template creation. */
|
|
7021
|
+
'options'?: {
|
|
7022
|
+
/** If true, the template will be ran immediately after creation. Example: true */
|
|
7023
|
+
'runOnCreation'?: boolean;
|
|
7024
|
+
};
|
|
7025
|
+
};
|
|
7026
|
+
/** Create a template */
|
|
7027
|
+
declare class CreateTemplateEndpoint extends PostApiEndpoint<CreateTemplateRequest, CreateTemplateResult> {
|
|
7028
|
+
description: string;
|
|
7029
|
+
withAuth: boolean;
|
|
7030
|
+
requiredPermissions: string;
|
|
7031
|
+
endpointUrl: (opts: CreateTemplateRequest) => string;
|
|
7032
|
+
body: (payload: CreateTemplateRequest) => string;
|
|
7033
|
+
}
|
|
7034
|
+
|
|
7035
|
+
declare type GetTemplateResult = {
|
|
7036
|
+
/** ID of the template. Example: "example-template" */
|
|
7037
|
+
'id': string;
|
|
7038
|
+
/** Timestamp of when the template was created. Example: "2022-06-14 15:10:42.842Z" */
|
|
7039
|
+
'createdAt': string;
|
|
7040
|
+
/** Timestamp of when the template was last updated. Example: "2022-06-14 15:10:42.842Z" */
|
|
7041
|
+
'updatedAt': string;
|
|
7042
|
+
'content'?: {
|
|
7043
|
+
/** Name of the template. Example: "Example Template" */
|
|
7044
|
+
'name': string;
|
|
7045
|
+
/** Description of the template. Example: "This is a sample template." */
|
|
7046
|
+
'description'?: string;
|
|
7047
|
+
/** The version of the Northflank API to run the template against. Example: "v1" */
|
|
7048
|
+
'apiVersion': 'v1';
|
|
7049
|
+
/** Details of the project the template will run in. */
|
|
7050
|
+
'project': {
|
|
7051
|
+
/** The ID of the project to use. */
|
|
7052
|
+
'id': string;
|
|
7053
|
+
} | {
|
|
7054
|
+
/** Details about the project to create. */
|
|
7055
|
+
'spec': {
|
|
7056
|
+
/** The name of the project. Example: "New Project" */
|
|
7057
|
+
'name': string;
|
|
7058
|
+
/** The description of the project. Example: "This is a new project." */
|
|
7059
|
+
'description'?: string;
|
|
7060
|
+
/** The region the project will be hosted in. Example: "europe-west" */
|
|
7061
|
+
'region'?: string;
|
|
7062
|
+
/** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
|
|
7063
|
+
'clusterId'?: string;
|
|
7064
|
+
/** The color of the project in the Northflank App. Example: "#EF233C" */
|
|
7065
|
+
'color'?: string;
|
|
7066
|
+
};
|
|
7067
|
+
};
|
|
7068
|
+
'spec': any;
|
|
7069
|
+
};
|
|
7070
|
+
};
|
|
7071
|
+
declare type GetTemplateCall = (opts: GetTemplateRequest) => Promise<ApiCallResponse<GetTemplateResult>>;
|
|
7072
|
+
declare type GetTemplateRequest = {
|
|
7073
|
+
parameters: GetTemplateParameters;
|
|
7074
|
+
options?: GetTemplateOptions;
|
|
7075
|
+
};
|
|
7076
|
+
declare type GetTemplateParameters = {
|
|
7077
|
+
/** ID of the template */ 'templateId': string;
|
|
7078
|
+
};
|
|
7079
|
+
declare type GetTemplateOptions = {
|
|
7080
|
+
/** The number of results to display per request. Maximum of 100 results per page. */
|
|
7081
|
+
'per_page'?: number;
|
|
7082
|
+
/** The page number to access. */
|
|
7083
|
+
'page'?: number;
|
|
7084
|
+
/** The cursor returned from the previous page of results, used to request the next page. */
|
|
7085
|
+
'cursor'?: string;
|
|
7086
|
+
};
|
|
7087
|
+
/** Get information about the given template. */
|
|
7088
|
+
declare class GetTemplateEndpoint extends GetApiEndpoint<GetTemplateRequest, GetTemplateResult> {
|
|
7089
|
+
description: string;
|
|
7090
|
+
withAuth: boolean;
|
|
7091
|
+
requiredPermissions: string;
|
|
7092
|
+
endpointUrl: (opts: GetTemplateRequest) => string;
|
|
7093
|
+
body: () => undefined;
|
|
7094
|
+
}
|
|
7095
|
+
|
|
7096
|
+
declare type UpdateTemplateResult = {
|
|
7097
|
+
/** ID of the template. Example: "example-template" */
|
|
7098
|
+
'id': string;
|
|
7099
|
+
/** Timestamp of when the template was created. Example: "2022-06-14 15:10:42.842Z" */
|
|
7100
|
+
'createdAt': string;
|
|
7101
|
+
/** Timestamp of when the template was last updated. Example: "2022-06-14 15:10:42.842Z" */
|
|
7102
|
+
'updatedAt': string;
|
|
7103
|
+
'content'?: {
|
|
7104
|
+
/** Name of the template. Example: "Example Template" */
|
|
7105
|
+
'name': string;
|
|
7106
|
+
/** Description of the template. Example: "This is a sample template." */
|
|
7107
|
+
'description'?: string;
|
|
7108
|
+
/** The version of the Northflank API to run the template against. Example: "v1" */
|
|
7109
|
+
'apiVersion': 'v1';
|
|
7110
|
+
/** Details of the project the template will run in. */
|
|
7111
|
+
'project': {
|
|
7112
|
+
/** The ID of the project to use. */
|
|
7113
|
+
'id': string;
|
|
7114
|
+
} | {
|
|
7115
|
+
/** Details about the project to create. */
|
|
7116
|
+
'spec': {
|
|
7117
|
+
/** The name of the project. Example: "New Project" */
|
|
7118
|
+
'name': string;
|
|
7119
|
+
/** The description of the project. Example: "This is a new project." */
|
|
7120
|
+
'description'?: string;
|
|
7121
|
+
/** The region the project will be hosted in. Example: "europe-west" */
|
|
7122
|
+
'region'?: string;
|
|
7123
|
+
/** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
|
|
7124
|
+
'clusterId'?: string;
|
|
7125
|
+
/** The color of the project in the Northflank App. Example: "#EF233C" */
|
|
7126
|
+
'color'?: string;
|
|
7127
|
+
};
|
|
7128
|
+
};
|
|
7129
|
+
'spec': any;
|
|
7130
|
+
};
|
|
7131
|
+
};
|
|
7132
|
+
declare type UpdateTemplateCall = (opts: UpdateTemplateRequest) => Promise<ApiCallResponse<UpdateTemplateResult>>;
|
|
7133
|
+
declare type UpdateTemplateRequest = {
|
|
7134
|
+
parameters: UpdateTemplateParameters;
|
|
7135
|
+
data: UpdateTemplateData;
|
|
7136
|
+
};
|
|
7137
|
+
declare type UpdateTemplateParameters = {
|
|
7138
|
+
/** ID of the template */ 'templateId': string;
|
|
7139
|
+
};
|
|
7140
|
+
declare type UpdateTemplateData = {
|
|
7141
|
+
/** Name of the template. Example: "Example Template" */
|
|
7142
|
+
'name': string;
|
|
7143
|
+
/** Description of the template. Example: "This is a sample template." */
|
|
7144
|
+
'description'?: string;
|
|
7145
|
+
/** The version of the Northflank API to run the template against. Example: "v1" */
|
|
7146
|
+
'apiVersion': 'v1';
|
|
7147
|
+
/** Details of the project the template will run in. */
|
|
7148
|
+
'project': {
|
|
7149
|
+
/** The ID of the project to use. */
|
|
7150
|
+
'id': string;
|
|
7151
|
+
} | {
|
|
7152
|
+
/** Details about the project to create. */
|
|
7153
|
+
'spec': {
|
|
7154
|
+
/** The name of the project. Example: "New Project" */
|
|
7155
|
+
'name': string;
|
|
7156
|
+
/** The description of the project. Example: "This is a new project." */
|
|
7157
|
+
'description'?: string;
|
|
7158
|
+
/** The region the project will be hosted in. Example: "europe-west" */
|
|
7159
|
+
'region'?: string;
|
|
7160
|
+
/** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
|
|
7161
|
+
'clusterId'?: string;
|
|
7162
|
+
/** The color of the project in the Northflank App. Example: "#EF233C" */
|
|
7163
|
+
'color'?: string;
|
|
7164
|
+
};
|
|
7165
|
+
};
|
|
7166
|
+
'spec': any;
|
|
7167
|
+
};
|
|
7168
|
+
/** Update a template */
|
|
7169
|
+
declare class UpdateTemplateEndpoint extends PostApiEndpoint<UpdateTemplateRequest, UpdateTemplateResult> {
|
|
7170
|
+
description: string;
|
|
7171
|
+
withAuth: boolean;
|
|
7172
|
+
requiredPermissions: string;
|
|
7173
|
+
endpointUrl: (opts: UpdateTemplateRequest) => string;
|
|
7174
|
+
body: (payload: UpdateTemplateRequest) => string;
|
|
7175
|
+
}
|
|
7176
|
+
|
|
7177
|
+
declare type DeleteTemplateResult = any;
|
|
7178
|
+
declare type DeleteTemplateCall = (opts: DeleteTemplateRequest) => Promise<ApiCallResponse<DeleteTemplateResult>>;
|
|
7179
|
+
declare type DeleteTemplateRequest = {
|
|
7180
|
+
parameters: DeleteTemplateParameters;
|
|
7181
|
+
};
|
|
7182
|
+
declare type DeleteTemplateParameters = {
|
|
7183
|
+
/** ID of the template */ 'templateId': string;
|
|
7184
|
+
};
|
|
7185
|
+
/** Delete a template */
|
|
7186
|
+
declare class DeleteTemplateEndpoint extends DeleteApiEndpoint<DeleteTemplateRequest, DeleteTemplateResult> {
|
|
7187
|
+
description: string;
|
|
7188
|
+
withAuth: boolean;
|
|
7189
|
+
requiredPermissions: string;
|
|
7190
|
+
endpointUrl: (opts: DeleteTemplateRequest) => string;
|
|
7191
|
+
body: () => undefined;
|
|
7192
|
+
}
|
|
7193
|
+
|
|
7194
|
+
declare type RunTemplateResult = {
|
|
7195
|
+
/** ID of the template run. Example: "501c1e03-a021-4659-9048-85f8f6ee2bc7" */
|
|
7196
|
+
'id': string;
|
|
7197
|
+
/** Timestamp of when the run was initiated. Example: "2022-06-14 15:10:42.842Z" */
|
|
7198
|
+
'createdAt': string;
|
|
7199
|
+
/** Timestamp of when the run was last updated. Example: "2022-06-14 15:10:42.842Z" */
|
|
7200
|
+
'updatedAt': string;
|
|
7201
|
+
/** Details about the template being run. */
|
|
7202
|
+
'template': {
|
|
7203
|
+
/** ID of the template Example: "example-template" */
|
|
7204
|
+
'id': string;
|
|
7205
|
+
/** The name of the template Example: "Example Template" */
|
|
7206
|
+
'name': string;
|
|
7207
|
+
};
|
|
7208
|
+
/** Status of the template run. Example: "success" */
|
|
7209
|
+
'status': 'waiting' | 'failure' | 'retrying' | 'success' | 'unknown';
|
|
7210
|
+
/** Details about the template run. */
|
|
7211
|
+
'content': {
|
|
7212
|
+
/** Name of the template. Example: "Example Template" */
|
|
7213
|
+
'name': string;
|
|
7214
|
+
/** Description of the template. Example: "This is a sample template." */
|
|
7215
|
+
'description'?: string;
|
|
7216
|
+
/** The version of the Northflank API to run the template against. Example: "v1" */
|
|
7217
|
+
'apiVersion': 'v1';
|
|
7218
|
+
/** Details of the project the template will run in. */
|
|
7219
|
+
'project': {
|
|
7220
|
+
/** The ID of the project to use. */
|
|
7221
|
+
'id': string;
|
|
7222
|
+
} | {
|
|
7223
|
+
/** Details about the project to create. */
|
|
7224
|
+
'spec': {
|
|
7225
|
+
/** The name of the project. Example: "New Project" */
|
|
7226
|
+
'name': string;
|
|
7227
|
+
/** The description of the project. Example: "This is a new project." */
|
|
7228
|
+
'description'?: string;
|
|
7229
|
+
/** The region the project will be hosted in. Example: "europe-west" */
|
|
7230
|
+
'region'?: string;
|
|
7231
|
+
/** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
|
|
7232
|
+
'clusterId'?: string;
|
|
7233
|
+
/** The color of the project in the Northflank App. Example: "#EF233C" */
|
|
7234
|
+
'color'?: string;
|
|
7235
|
+
};
|
|
7236
|
+
};
|
|
7237
|
+
'spec': any;
|
|
7238
|
+
};
|
|
7239
|
+
};
|
|
7240
|
+
declare type RunTemplateCall = (opts: RunTemplateRequest) => Promise<ApiCallResponse<RunTemplateResult>>;
|
|
7241
|
+
declare type RunTemplateRequest = {
|
|
7242
|
+
parameters: RunTemplateParameters;
|
|
7243
|
+
};
|
|
7244
|
+
declare type RunTemplateParameters = {
|
|
7245
|
+
/** ID of the template */ 'templateId': string;
|
|
7246
|
+
};
|
|
7247
|
+
/** Run a template */
|
|
7248
|
+
declare class RunTemplateEndpoint extends PostApiEndpoint<RunTemplateRequest, RunTemplateResult> {
|
|
7249
|
+
description: string;
|
|
7250
|
+
withAuth: boolean;
|
|
7251
|
+
requiredPermissions: string;
|
|
7252
|
+
endpointUrl: (opts: RunTemplateRequest) => string;
|
|
7253
|
+
body: () => undefined;
|
|
7254
|
+
}
|
|
7255
|
+
|
|
7256
|
+
declare type ListTemplaterunsResult = {
|
|
7257
|
+
/** An array of template run objects. */
|
|
7258
|
+
'templateRuns': {
|
|
7259
|
+
/** ID of the template run. Example: "501c1e03-a021-4659-9048-85f8f6ee2bc7" */
|
|
7260
|
+
'id': string;
|
|
7261
|
+
/** Timestamp of when the run was initiated. Example: "2022-06-14 15:10:42.842Z" */
|
|
7262
|
+
'createdAt': string;
|
|
7263
|
+
/** Timestamp of when the run was last updated. Example: "2022-06-14 15:10:42.842Z" */
|
|
7264
|
+
'updatedAt': string;
|
|
7265
|
+
/** Details about the template being run. */
|
|
7266
|
+
'template': {
|
|
7267
|
+
/** ID of the template Example: "example-template" */
|
|
7268
|
+
'id': string;
|
|
7269
|
+
/** The name of the template Example: "Example Template" */
|
|
7270
|
+
'name': string;
|
|
7271
|
+
};
|
|
7272
|
+
/** Details about the template run. */
|
|
7273
|
+
'content': {
|
|
7274
|
+
/** Name of the template. Example: "Example Template" */
|
|
7275
|
+
'name': string;
|
|
7276
|
+
/** Description of the template. Example: "This is a sample template." */
|
|
7277
|
+
'description'?: string;
|
|
7278
|
+
/** The version of the Northflank API to run the template against. Example: "v1" */
|
|
7279
|
+
'apiVersion': 'v1';
|
|
7280
|
+
};
|
|
7281
|
+
/** Status of the template run. Example: "success" */
|
|
7282
|
+
'status': 'waiting' | 'failure' | 'retrying' | 'success' | 'unknown';
|
|
7283
|
+
}[];
|
|
7284
|
+
};
|
|
7285
|
+
declare type ListTemplaterunsCall = (opts: ListTemplaterunsRequest) => Promise<ApiCallResponse<ListTemplaterunsResult>>;
|
|
7286
|
+
declare type ListTemplaterunsRequest = {
|
|
7287
|
+
parameters: ListTemplaterunsParameters;
|
|
7288
|
+
options?: ListTemplaterunsOptions;
|
|
7289
|
+
};
|
|
7290
|
+
declare type ListTemplaterunsParameters = {
|
|
7291
|
+
/** ID of the template */ 'templateId': string;
|
|
7292
|
+
};
|
|
7293
|
+
declare type ListTemplaterunsOptions = {
|
|
7294
|
+
/** The number of results to display per request. Maximum of 100 results per page. */
|
|
7295
|
+
'per_page'?: number;
|
|
7296
|
+
/** The page number to access. */
|
|
7297
|
+
'page'?: number;
|
|
7298
|
+
/** The cursor returned from the previous page of results, used to request the next page. */
|
|
7299
|
+
'cursor'?: string;
|
|
7300
|
+
};
|
|
7301
|
+
/** Get a list of template runs */
|
|
7302
|
+
declare class ListTemplaterunsEndpoint extends GetApiEndpoint<ListTemplaterunsRequest, ListTemplaterunsResult> {
|
|
7303
|
+
description: string;
|
|
7304
|
+
withAuth: boolean;
|
|
7305
|
+
requiredPermissions: string;
|
|
7306
|
+
endpointUrl: (opts: ListTemplaterunsRequest) => string;
|
|
7307
|
+
body: () => undefined;
|
|
7308
|
+
}
|
|
7309
|
+
|
|
7310
|
+
declare type GetTemplaterunResult = {
|
|
7311
|
+
/** ID of the template run. Example: "501c1e03-a021-4659-9048-85f8f6ee2bc7" */
|
|
7312
|
+
'id': string;
|
|
7313
|
+
/** Timestamp of when the run was initiated. Example: "2022-06-14 15:10:42.842Z" */
|
|
7314
|
+
'createdAt': string;
|
|
7315
|
+
/** Timestamp of when the run was last updated. Example: "2022-06-14 15:10:42.842Z" */
|
|
7316
|
+
'updatedAt': string;
|
|
7317
|
+
/** Details about the template being run. */
|
|
7318
|
+
'template': {
|
|
7319
|
+
/** ID of the template Example: "example-template" */
|
|
7320
|
+
'id': string;
|
|
7321
|
+
/** The name of the template Example: "Example Template" */
|
|
7322
|
+
'name': string;
|
|
7323
|
+
};
|
|
7324
|
+
/** Status of the template run. Example: "success" */
|
|
7325
|
+
'status': 'waiting' | 'failure' | 'retrying' | 'success' | 'unknown';
|
|
7326
|
+
/** Details about the template run. */
|
|
7327
|
+
'content': {
|
|
7328
|
+
/** Name of the template. Example: "Example Template" */
|
|
7329
|
+
'name': string;
|
|
7330
|
+
/** Description of the template. Example: "This is a sample template." */
|
|
7331
|
+
'description'?: string;
|
|
7332
|
+
/** The version of the Northflank API to run the template against. Example: "v1" */
|
|
7333
|
+
'apiVersion': 'v1';
|
|
7334
|
+
/** Details of the project the template will run in. */
|
|
7335
|
+
'project': {
|
|
7336
|
+
/** The ID of the project to use. */
|
|
7337
|
+
'id': string;
|
|
7338
|
+
} | {
|
|
7339
|
+
/** Details about the project to create. */
|
|
7340
|
+
'spec': {
|
|
7341
|
+
/** The name of the project. Example: "New Project" */
|
|
7342
|
+
'name': string;
|
|
7343
|
+
/** The description of the project. Example: "This is a new project." */
|
|
7344
|
+
'description'?: string;
|
|
7345
|
+
/** The region the project will be hosted in. Example: "europe-west" */
|
|
7346
|
+
'region'?: string;
|
|
7347
|
+
/** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
|
|
7348
|
+
'clusterId'?: string;
|
|
7349
|
+
/** The color of the project in the Northflank App. Example: "#EF233C" */
|
|
7350
|
+
'color'?: string;
|
|
7351
|
+
};
|
|
7352
|
+
};
|
|
7353
|
+
'spec': any;
|
|
7354
|
+
};
|
|
7355
|
+
};
|
|
7356
|
+
declare type GetTemplaterunCall = (opts: GetTemplaterunRequest) => Promise<ApiCallResponse<GetTemplaterunResult>>;
|
|
7357
|
+
declare type GetTemplaterunRequest = {
|
|
7358
|
+
parameters: GetTemplaterunParameters;
|
|
7359
|
+
options?: GetTemplaterunOptions;
|
|
7360
|
+
};
|
|
7361
|
+
declare type GetTemplaterunParameters = {
|
|
7362
|
+
/** ID of the template */ 'templateId': string;
|
|
7363
|
+
/** ID of the template run */
|
|
7364
|
+
'templateRunId': string;
|
|
7365
|
+
};
|
|
7366
|
+
declare type GetTemplaterunOptions = {
|
|
7367
|
+
/** The number of results to display per request. Maximum of 100 results per page. */
|
|
7368
|
+
'per_page'?: number;
|
|
7369
|
+
/** The page number to access. */
|
|
7370
|
+
'page'?: number;
|
|
7371
|
+
/** The cursor returned from the previous page of results, used to request the next page. */
|
|
7372
|
+
'cursor'?: string;
|
|
7373
|
+
};
|
|
7374
|
+
/** Get information about the given template run. */
|
|
7375
|
+
declare class GetTemplaterunEndpoint extends GetApiEndpoint<GetTemplaterunRequest, GetTemplaterunResult> {
|
|
7376
|
+
description: string;
|
|
7377
|
+
withAuth: boolean;
|
|
7378
|
+
requiredPermissions: string;
|
|
7379
|
+
endpointUrl: (opts: GetTemplaterunRequest) => string;
|
|
7380
|
+
body: () => undefined;
|
|
7381
|
+
}
|
|
7382
|
+
|
|
5508
7383
|
declare type ListReposResult = {
|
|
5509
7384
|
/** A list of accessible repositories. */
|
|
5510
7385
|
'repos'?: {
|
|
@@ -5551,6 +7426,7 @@ declare type ListReposOptions = {
|
|
|
5551
7426
|
declare class ListReposEndpoint extends GetApiEndpoint<ListReposRequest, ListReposResult> {
|
|
5552
7427
|
description: string;
|
|
5553
7428
|
withAuth: boolean;
|
|
7429
|
+
requiredPermissions: string;
|
|
5554
7430
|
endpointUrl: (opts: ListReposRequest) => string;
|
|
5555
7431
|
body: () => undefined;
|
|
5556
7432
|
}
|
|
@@ -5601,6 +7477,7 @@ declare type ListBranchesOptions = {
|
|
|
5601
7477
|
declare class ListBranchesEndpoint extends GetApiEndpoint<ListBranchesRequest, ListBranchesResult> {
|
|
5602
7478
|
description: string;
|
|
5603
7479
|
withAuth: boolean;
|
|
7480
|
+
requiredPermissions: string;
|
|
5604
7481
|
endpointUrl: (opts: ListBranchesRequest) => string;
|
|
5605
7482
|
body: () => undefined;
|
|
5606
7483
|
}
|
|
@@ -5610,9 +7487,16 @@ declare type ListVolumesResult = {
|
|
|
5610
7487
|
'id': string;
|
|
5611
7488
|
/** Volume name Example: "Example Volume" */
|
|
5612
7489
|
'name': string;
|
|
5613
|
-
/** Information about the desired size and type of the volume. Storage class is only configurable with the relevant feature flag enabled for your account
|
|
7490
|
+
/** Information about the desired size and type of the volume. Storage class is only configurable with the relevant feature flag enabled for your account. */
|
|
5614
7491
|
'spec': {
|
|
5615
|
-
|
|
7492
|
+
/** The type of the storage. Example: "ssd" */
|
|
7493
|
+
'storageClassName'?: 'ssd';
|
|
7494
|
+
/** Storage size of the SSD. Example: 4096 */
|
|
7495
|
+
'storageSize': number;
|
|
7496
|
+
} | {
|
|
7497
|
+
/** The type of the storage. Example: "hdd" */
|
|
7498
|
+
'storageClassName': 'hdd';
|
|
7499
|
+
/** Storage size of the HDD. Example: 40960 */
|
|
5616
7500
|
'storageSize': number;
|
|
5617
7501
|
};
|
|
5618
7502
|
/** The object to attach this volume to. */
|
|
@@ -5640,6 +7524,7 @@ declare type ListVolumesParameters = {
|
|
|
5640
7524
|
declare class ListVolumesEndpoint extends GetApiEndpoint<ListVolumesRequest, ListVolumesResult> {
|
|
5641
7525
|
description: string;
|
|
5642
7526
|
withAuth: boolean;
|
|
7527
|
+
requiredPermissions: string;
|
|
5643
7528
|
endpointUrl: (opts: ListVolumesRequest) => string;
|
|
5644
7529
|
body: () => undefined;
|
|
5645
7530
|
}
|
|
@@ -5649,9 +7534,16 @@ declare type CreateVolumeResult = {
|
|
|
5649
7534
|
'id': string;
|
|
5650
7535
|
/** Volume name Example: "Example Volume" */
|
|
5651
7536
|
'name': string;
|
|
5652
|
-
/** Information about the desired size and type of the volume. Storage class is only configurable with the relevant feature flag enabled for your account
|
|
7537
|
+
/** Information about the desired size and type of the volume. Storage class is only configurable with the relevant feature flag enabled for your account. */
|
|
5653
7538
|
'spec': {
|
|
5654
|
-
|
|
7539
|
+
/** The type of the storage. Example: "ssd" */
|
|
7540
|
+
'storageClassName'?: 'ssd';
|
|
7541
|
+
/** Storage size of the SSD. Example: 4096 */
|
|
7542
|
+
'storageSize': number;
|
|
7543
|
+
} | {
|
|
7544
|
+
/** The type of the storage. Example: "hdd" */
|
|
7545
|
+
'storageClassName': 'hdd';
|
|
7546
|
+
/** Storage size of the HDD. Example: 40960 */
|
|
5655
7547
|
'storageSize': number;
|
|
5656
7548
|
};
|
|
5657
7549
|
/** The object to attach this volume to. */
|
|
@@ -5686,9 +7578,16 @@ declare type CreateVolumeData = {
|
|
|
5686
7578
|
/** Specify the path into which the volume should be mounted Example: "/container" */
|
|
5687
7579
|
'containerMountPath': string;
|
|
5688
7580
|
}[];
|
|
5689
|
-
/** Information about the desired size and type of the volume. Storage class is only configurable with the relevant feature flag enabled for your account
|
|
7581
|
+
/** Information about the desired size and type of the volume. Storage class is only configurable with the relevant feature flag enabled for your account. */
|
|
5690
7582
|
'spec': {
|
|
5691
|
-
|
|
7583
|
+
/** The type of the storage. Example: "ssd" */
|
|
7584
|
+
'storageClassName'?: 'ssd';
|
|
7585
|
+
/** Storage size of the SSD. Example: 4096 */
|
|
7586
|
+
'storageSize': number;
|
|
7587
|
+
} | {
|
|
7588
|
+
/** The type of the storage. Example: "hdd" */
|
|
7589
|
+
'storageClassName': 'hdd';
|
|
7590
|
+
/** Storage size of the HDD. Example: 40960 */
|
|
5692
7591
|
'storageSize': number;
|
|
5693
7592
|
};
|
|
5694
7593
|
/** The object to attach this volume to. */
|
|
@@ -5703,6 +7602,7 @@ declare type CreateVolumeData = {
|
|
|
5703
7602
|
declare class CreateVolumeEndpoint extends PostApiEndpoint<CreateVolumeRequest, CreateVolumeResult> {
|
|
5704
7603
|
description: string;
|
|
5705
7604
|
withAuth: boolean;
|
|
7605
|
+
requiredPermissions: string;
|
|
5706
7606
|
endpointUrl: (opts: CreateVolumeRequest) => string;
|
|
5707
7607
|
body: (payload: CreateVolumeRequest) => string;
|
|
5708
7608
|
}
|
|
@@ -5712,9 +7612,16 @@ declare type GetVolumeResult = {
|
|
|
5712
7612
|
'id': string;
|
|
5713
7613
|
/** Volume name Example: "Example Volume" */
|
|
5714
7614
|
'name': string;
|
|
5715
|
-
/** Information about the desired size and type of the volume. Storage class is only configurable with the relevant feature flag enabled for your account
|
|
7615
|
+
/** Information about the desired size and type of the volume. Storage class is only configurable with the relevant feature flag enabled for your account. */
|
|
5716
7616
|
'spec': {
|
|
5717
|
-
|
|
7617
|
+
/** The type of the storage. Example: "ssd" */
|
|
7618
|
+
'storageClassName'?: 'ssd';
|
|
7619
|
+
/** Storage size of the SSD. Example: 4096 */
|
|
7620
|
+
'storageSize': number;
|
|
7621
|
+
} | {
|
|
7622
|
+
/** The type of the storage. Example: "hdd" */
|
|
7623
|
+
'storageClassName': 'hdd';
|
|
7624
|
+
/** Storage size of the HDD. Example: 40960 */
|
|
5718
7625
|
'storageSize': number;
|
|
5719
7626
|
};
|
|
5720
7627
|
/** The object to attach this volume to. */
|
|
@@ -5744,6 +7651,7 @@ declare type GetVolumeParameters = {
|
|
|
5744
7651
|
declare class GetVolumeEndpoint extends GetApiEndpoint<GetVolumeRequest, GetVolumeResult> {
|
|
5745
7652
|
description: string;
|
|
5746
7653
|
withAuth: boolean;
|
|
7654
|
+
requiredPermissions: string;
|
|
5747
7655
|
endpointUrl: (opts: GetVolumeRequest) => string;
|
|
5748
7656
|
body: () => undefined;
|
|
5749
7657
|
}
|
|
@@ -5776,6 +7684,7 @@ declare type UpdateVolumeData = {
|
|
|
5776
7684
|
declare class UpdateVolumeEndpoint extends PostApiEndpoint<UpdateVolumeRequest, UpdateVolumeResult> {
|
|
5777
7685
|
description: string;
|
|
5778
7686
|
withAuth: boolean;
|
|
7687
|
+
requiredPermissions: string;
|
|
5779
7688
|
endpointUrl: (opts: UpdateVolumeRequest) => string;
|
|
5780
7689
|
body: (payload: UpdateVolumeRequest) => string;
|
|
5781
7690
|
}
|
|
@@ -5794,6 +7703,7 @@ declare type DeleteVolumeParameters = {
|
|
|
5794
7703
|
declare class DeleteVolumeEndpoint extends DeleteApiEndpoint<DeleteVolumeRequest, DeleteVolumeResult> {
|
|
5795
7704
|
description: string;
|
|
5796
7705
|
withAuth: boolean;
|
|
7706
|
+
requiredPermissions: string;
|
|
5797
7707
|
endpointUrl: (opts: DeleteVolumeRequest) => string;
|
|
5798
7708
|
body: () => undefined;
|
|
5799
7709
|
}
|
|
@@ -5822,6 +7732,7 @@ declare type AttachVolumeData = {
|
|
|
5822
7732
|
declare class AttachVolumeEndpoint extends PostApiEndpoint<AttachVolumeRequest, AttachVolumeResult> {
|
|
5823
7733
|
description: string;
|
|
5824
7734
|
withAuth: boolean;
|
|
7735
|
+
requiredPermissions: string;
|
|
5825
7736
|
endpointUrl: (opts: AttachVolumeRequest) => string;
|
|
5826
7737
|
body: (payload: AttachVolumeRequest) => string;
|
|
5827
7738
|
}
|
|
@@ -5842,6 +7753,7 @@ declare type DetachVolumeData = any;
|
|
|
5842
7753
|
declare class DetachVolumeEndpoint extends PostApiEndpoint<DetachVolumeRequest, DetachVolumeResult> {
|
|
5843
7754
|
description: string;
|
|
5844
7755
|
withAuth: boolean;
|
|
7756
|
+
requiredPermissions: string;
|
|
5845
7757
|
endpointUrl: (opts: DetachVolumeRequest) => string;
|
|
5846
7758
|
body: (payload: DetachVolumeRequest) => string;
|
|
5847
7759
|
}
|
|
@@ -5870,6 +7782,7 @@ declare type GetServiceBuildargumentsOptions = {
|
|
|
5870
7782
|
declare class GetServiceBuildargumentsEndpoint extends GetApiEndpoint<GetServiceBuildargumentsRequest, GetServiceBuildargumentsResult> {
|
|
5871
7783
|
description: string;
|
|
5872
7784
|
withAuth: boolean;
|
|
7785
|
+
requiredPermissions: string;
|
|
5873
7786
|
endpointUrl: (opts: GetServiceBuildargumentsRequest) => string;
|
|
5874
7787
|
body: () => undefined;
|
|
5875
7788
|
}
|
|
@@ -5898,6 +7811,7 @@ declare type UpdateServiceBuildargumentsData = {
|
|
|
5898
7811
|
declare class UpdateServiceBuildargumentsEndpoint extends PostApiEndpoint<UpdateServiceBuildargumentsRequest, UpdateServiceBuildargumentsResult> {
|
|
5899
7812
|
description: string;
|
|
5900
7813
|
withAuth: boolean;
|
|
7814
|
+
requiredPermissions: string;
|
|
5901
7815
|
endpointUrl: (opts: UpdateServiceBuildargumentsRequest) => string;
|
|
5902
7816
|
body: (payload: UpdateServiceBuildargumentsRequest) => string;
|
|
5903
7817
|
}
|
|
@@ -5968,6 +7882,7 @@ declare type GetServiceBuildargumentdetailsParameters = {
|
|
|
5968
7882
|
declare class GetServiceBuildargumentdetailsEndpoint extends GetApiEndpoint<GetServiceBuildargumentdetailsRequest, GetServiceBuildargumentdetailsResult> {
|
|
5969
7883
|
description: string;
|
|
5970
7884
|
withAuth: boolean;
|
|
7885
|
+
requiredPermissions: string;
|
|
5971
7886
|
endpointUrl: (opts: GetServiceBuildargumentdetailsRequest) => string;
|
|
5972
7887
|
body: () => undefined;
|
|
5973
7888
|
}
|
|
@@ -5996,6 +7911,7 @@ declare type GetServiceRuntimeenvironmentOptions = {
|
|
|
5996
7911
|
declare class GetServiceRuntimeenvironmentEndpoint extends GetApiEndpoint<GetServiceRuntimeenvironmentRequest, GetServiceRuntimeenvironmentResult> {
|
|
5997
7912
|
description: string;
|
|
5998
7913
|
withAuth: boolean;
|
|
7914
|
+
requiredPermissions: string;
|
|
5999
7915
|
endpointUrl: (opts: GetServiceRuntimeenvironmentRequest) => string;
|
|
6000
7916
|
body: () => undefined;
|
|
6001
7917
|
}
|
|
@@ -6029,6 +7945,7 @@ declare type UpdateServiceRuntimeenvironmentData = {
|
|
|
6029
7945
|
declare class UpdateServiceRuntimeenvironmentEndpoint extends PostApiEndpoint<UpdateServiceRuntimeenvironmentRequest, UpdateServiceRuntimeenvironmentResult> {
|
|
6030
7946
|
description: string;
|
|
6031
7947
|
withAuth: boolean;
|
|
7948
|
+
requiredPermissions: string;
|
|
6032
7949
|
endpointUrl: (opts: UpdateServiceRuntimeenvironmentRequest) => string;
|
|
6033
7950
|
body: (payload: UpdateServiceRuntimeenvironmentRequest) => string;
|
|
6034
7951
|
}
|
|
@@ -6099,6 +8016,7 @@ declare type GetServiceRuntimeenvironmentdetailsParameters = {
|
|
|
6099
8016
|
declare class GetServiceRuntimeenvironmentdetailsEndpoint extends GetApiEndpoint<GetServiceRuntimeenvironmentdetailsRequest, GetServiceRuntimeenvironmentdetailsResult> {
|
|
6100
8017
|
description: string;
|
|
6101
8018
|
withAuth: boolean;
|
|
8019
|
+
requiredPermissions: string;
|
|
6102
8020
|
endpointUrl: (opts: GetServiceRuntimeenvironmentdetailsRequest) => string;
|
|
6103
8021
|
body: () => undefined;
|
|
6104
8022
|
}
|
|
@@ -6112,21 +8030,31 @@ declare class ApiClient {
|
|
|
6112
8030
|
list: {
|
|
6113
8031
|
projects: ListProjectsCall;
|
|
6114
8032
|
addons: ListAddonsCall;
|
|
8033
|
+
invoices: ListInvoicesCall;
|
|
8034
|
+
providers: ListProvidersCall;
|
|
8035
|
+
integrations: ListIntegrationsCall;
|
|
8036
|
+
clusters: ListClustersCall;
|
|
6115
8037
|
jobs: ListJobsCall;
|
|
6116
|
-
|
|
8038
|
+
registries: ListRegistriesCall;
|
|
6117
8039
|
domains: ListDomainsCall;
|
|
6118
8040
|
plans: ListPlansCall;
|
|
6119
8041
|
regions: ListRegionsCall;
|
|
6120
8042
|
vcs: ListVcsCall;
|
|
6121
8043
|
secrets: ListSecretsCall;
|
|
6122
8044
|
services: ListServicesCall;
|
|
8045
|
+
templates: ListTemplatesCall;
|
|
8046
|
+
templateRuns: ListTemplaterunsCall;
|
|
6123
8047
|
repos: ListReposCall;
|
|
6124
8048
|
branches: ListBranchesCall;
|
|
6125
8049
|
volumes: ListVolumesCall;
|
|
6126
8050
|
};
|
|
6127
8051
|
create: {
|
|
6128
8052
|
project: CreateProjectCall;
|
|
6129
|
-
addon: CreateAddonCall
|
|
8053
|
+
addon: CreateAddonCall & {
|
|
8054
|
+
backupSchedule: CreateAddonBackupscheduleCall;
|
|
8055
|
+
};
|
|
8056
|
+
integration: CreateIntegrationCall;
|
|
8057
|
+
cluster: CreateClusterCall;
|
|
6130
8058
|
job: {
|
|
6131
8059
|
manual: CreateJobManualCall;
|
|
6132
8060
|
cron: CreateJobCronCall;
|
|
@@ -6138,6 +8066,7 @@ declare class ApiClient {
|
|
|
6138
8066
|
deployment: CreateServiceDeploymentCall;
|
|
6139
8067
|
build: CreateServiceBuildCall;
|
|
6140
8068
|
};
|
|
8069
|
+
template: CreateTemplateCall;
|
|
6141
8070
|
volume: CreateVolumeCall;
|
|
6142
8071
|
};
|
|
6143
8072
|
get: {
|
|
@@ -6151,7 +8080,13 @@ declare class ApiClient {
|
|
|
6151
8080
|
download: GetAddonBackupDownloadCall;
|
|
6152
8081
|
};
|
|
6153
8082
|
containers: GetAddonContainersCall;
|
|
8083
|
+
backupSchedules: GetAddonBackupschedulesCall;
|
|
8084
|
+
};
|
|
8085
|
+
invoice: {
|
|
8086
|
+
details: GetInvoiceDetailsCall;
|
|
6154
8087
|
};
|
|
8088
|
+
integration: GetIntegrationCall;
|
|
8089
|
+
cluster: GetClusterCall;
|
|
6155
8090
|
job: GetJobCall & {
|
|
6156
8091
|
runs: GetJobRunsCall;
|
|
6157
8092
|
run: GetJobRunCall;
|
|
@@ -6167,7 +8102,7 @@ declare class ApiClient {
|
|
|
6167
8102
|
branches: GetJobBranchesCall;
|
|
6168
8103
|
pullRequests: GetJobPullrequestsCall;
|
|
6169
8104
|
};
|
|
6170
|
-
|
|
8105
|
+
registry: GetRegistryCall;
|
|
6171
8106
|
domain: GetDomainCall;
|
|
6172
8107
|
subdomain: GetSubdomainCall;
|
|
6173
8108
|
dnsId: GetDnsidCall;
|
|
@@ -6188,19 +8123,26 @@ declare class ApiClient {
|
|
|
6188
8123
|
runtimeEnvironment: GetServiceRuntimeenvironmentCall;
|
|
6189
8124
|
runtimeEnvironmentDetails: GetServiceRuntimeenvironmentdetailsCall;
|
|
6190
8125
|
};
|
|
8126
|
+
template: GetTemplateCall;
|
|
8127
|
+
templateRun: GetTemplaterunCall;
|
|
6191
8128
|
volume: GetVolumeCall;
|
|
6192
8129
|
};
|
|
6193
8130
|
delete: {
|
|
6194
8131
|
project: DeleteProjectCall;
|
|
6195
|
-
addon: DeleteAddonCall
|
|
8132
|
+
addon: DeleteAddonCall & {
|
|
8133
|
+
backupSchedule: DeleteAddonBackupscheduleCall;
|
|
8134
|
+
};
|
|
6196
8135
|
backup: DeleteBackupCall;
|
|
8136
|
+
integration: DeleteIntegrationCall;
|
|
8137
|
+
cluster: DeleteClusterCall;
|
|
6197
8138
|
job: DeleteJobCall;
|
|
6198
|
-
|
|
8139
|
+
registry: DeleteRegistryCall;
|
|
6199
8140
|
domain: DeleteDomainCall;
|
|
6200
8141
|
subdomain: DeleteSubdomainCall;
|
|
6201
8142
|
secret: DeleteSecretCall;
|
|
6202
8143
|
secretLink: DeleteSecretlinkCall;
|
|
6203
8144
|
service: DeleteServiceCall;
|
|
8145
|
+
template: DeleteTemplateCall;
|
|
6204
8146
|
volume: DeleteVolumeCall;
|
|
6205
8147
|
};
|
|
6206
8148
|
scale: {
|
|
@@ -6214,17 +8156,20 @@ declare class ApiClient {
|
|
|
6214
8156
|
networkSettings: UpdateAddonNetworksettingsCall;
|
|
6215
8157
|
security: UpdateAddonSecurityCall;
|
|
6216
8158
|
};
|
|
8159
|
+
integration: UpdateIntegrationCall;
|
|
8160
|
+
cluster: UpdateClusterCall;
|
|
6217
8161
|
job: {
|
|
6218
8162
|
settings: UpdateJobSettingsCall;
|
|
6219
8163
|
healthChecks: UpdateJobHealthchecksCall;
|
|
6220
8164
|
buildOptions: UpdateJobBuildoptionsCall;
|
|
6221
8165
|
buildSource: UpdateJobBuildsourceCall;
|
|
6222
8166
|
cmdOverride: UpdateJobCmdoverrideCall;
|
|
8167
|
+
entrypointOverride: UpdateJobEntrypointoverrideCall;
|
|
6223
8168
|
buildArguments: UpdateJobBuildargumentsCall;
|
|
6224
8169
|
runtimeEnvironment: UpdateJobRuntimeenvironmentCall;
|
|
6225
8170
|
deployment: UpdateJobDeploymentCall;
|
|
6226
8171
|
};
|
|
6227
|
-
|
|
8172
|
+
registry: UpdateRegistryCall;
|
|
6228
8173
|
secret: UpdateSecretCall;
|
|
6229
8174
|
secretLink: UpdateSecretlinkCall;
|
|
6230
8175
|
service: {
|
|
@@ -6233,10 +8178,12 @@ declare class ApiClient {
|
|
|
6233
8178
|
buildOptions: UpdateServiceBuildoptionsCall;
|
|
6234
8179
|
buildSource: UpdateServiceBuildsourceCall;
|
|
6235
8180
|
cmdOverride: UpdateServiceCmdoverrideCall;
|
|
8181
|
+
entrypointOverride: UpdateServiceEntrypointoverrideCall;
|
|
6236
8182
|
healthChecks: UpdateServiceHealthchecksCall;
|
|
6237
8183
|
buildArguments: UpdateServiceBuildargumentsCall;
|
|
6238
8184
|
runtimeEnvironment: UpdateServiceRuntimeenvironmentCall;
|
|
6239
8185
|
};
|
|
8186
|
+
template: UpdateTemplateCall;
|
|
6240
8187
|
volume: UpdateVolumeCall;
|
|
6241
8188
|
};
|
|
6242
8189
|
backup: {
|
|
@@ -6254,10 +8201,12 @@ declare class ApiClient {
|
|
|
6254
8201
|
};
|
|
6255
8202
|
pause: {
|
|
6256
8203
|
addon: PauseAddonCall;
|
|
8204
|
+
job: PauseJobCall;
|
|
6257
8205
|
service: PauseServiceCall;
|
|
6258
8206
|
};
|
|
6259
8207
|
resume: {
|
|
6260
8208
|
addon: ResumeAddonCall;
|
|
8209
|
+
job: ResumeJobCall;
|
|
6261
8210
|
service: ResumeServiceCall;
|
|
6262
8211
|
};
|
|
6263
8212
|
restart: {
|
|
@@ -6277,6 +8226,14 @@ declare class ApiClient {
|
|
|
6277
8226
|
build: AbortServiceBuildCall;
|
|
6278
8227
|
};
|
|
6279
8228
|
};
|
|
8229
|
+
retain: {
|
|
8230
|
+
addon: {
|
|
8231
|
+
backup: RetainAddonBackupCall;
|
|
8232
|
+
};
|
|
8233
|
+
};
|
|
8234
|
+
suspend: {
|
|
8235
|
+
job: SuspendJobCall;
|
|
8236
|
+
};
|
|
6280
8237
|
start: {
|
|
6281
8238
|
job: {
|
|
6282
8239
|
run: StartJobRunCall;
|
|
@@ -6287,7 +8244,7 @@ declare class ApiClient {
|
|
|
6287
8244
|
};
|
|
6288
8245
|
};
|
|
6289
8246
|
add: {
|
|
6290
|
-
|
|
8247
|
+
registry: AddRegistryCall;
|
|
6291
8248
|
domain: {
|
|
6292
8249
|
subdomain: AddDomainSubdomainCall;
|
|
6293
8250
|
};
|
|
@@ -6304,6 +8261,9 @@ declare class ApiClient {
|
|
|
6304
8261
|
unassign: {
|
|
6305
8262
|
subdomain: UnassignSubdomainCall;
|
|
6306
8263
|
};
|
|
8264
|
+
run: {
|
|
8265
|
+
template: RunTemplateCall;
|
|
8266
|
+
};
|
|
6307
8267
|
attach: {
|
|
6308
8268
|
volume: AttachVolumeCall;
|
|
6309
8269
|
};
|
|
@@ -6314,21 +8274,31 @@ declare class ApiClient {
|
|
|
6314
8274
|
list: {
|
|
6315
8275
|
projects: ListProjectsEndpoint;
|
|
6316
8276
|
addons: ListAddonsEndpoint;
|
|
8277
|
+
invoices: ListInvoicesEndpoint;
|
|
8278
|
+
providers: ListProvidersEndpoint;
|
|
8279
|
+
integrations: ListIntegrationsEndpoint;
|
|
8280
|
+
clusters: ListClustersEndpoint;
|
|
6317
8281
|
jobs: ListJobsEndpoint;
|
|
6318
|
-
|
|
8282
|
+
registries: ListRegistriesEndpoint;
|
|
6319
8283
|
domains: ListDomainsEndpoint;
|
|
6320
8284
|
plans: ListPlansEndpoint;
|
|
6321
8285
|
regions: ListRegionsEndpoint;
|
|
6322
8286
|
vcs: ListVcsEndpoint;
|
|
6323
8287
|
secrets: ListSecretsEndpoint;
|
|
6324
8288
|
services: ListServicesEndpoint;
|
|
8289
|
+
templates: ListTemplatesEndpoint;
|
|
8290
|
+
templateRuns: ListTemplaterunsEndpoint;
|
|
6325
8291
|
repos: ListReposEndpoint;
|
|
6326
8292
|
branches: ListBranchesEndpoint;
|
|
6327
8293
|
volumes: ListVolumesEndpoint;
|
|
6328
8294
|
};
|
|
6329
8295
|
create: {
|
|
6330
8296
|
project: CreateProjectEndpoint;
|
|
6331
|
-
addon: CreateAddonEndpoint
|
|
8297
|
+
addon: CreateAddonEndpoint & {
|
|
8298
|
+
backupSchedule: CreateAddonBackupscheduleEndpoint;
|
|
8299
|
+
};
|
|
8300
|
+
integration: CreateIntegrationEndpoint;
|
|
8301
|
+
cluster: CreateClusterEndpoint;
|
|
6332
8302
|
job: {
|
|
6333
8303
|
manual: CreateJobManualEndpoint;
|
|
6334
8304
|
cron: CreateJobCronEndpoint;
|
|
@@ -6340,6 +8310,7 @@ declare class ApiClient {
|
|
|
6340
8310
|
deployment: CreateServiceDeploymentEndpoint;
|
|
6341
8311
|
build: CreateServiceBuildEndpoint;
|
|
6342
8312
|
};
|
|
8313
|
+
template: CreateTemplateEndpoint;
|
|
6343
8314
|
volume: CreateVolumeEndpoint;
|
|
6344
8315
|
};
|
|
6345
8316
|
get: {
|
|
@@ -6353,7 +8324,13 @@ declare class ApiClient {
|
|
|
6353
8324
|
download: GetAddonBackupDownloadEndpoint;
|
|
6354
8325
|
};
|
|
6355
8326
|
containers: GetAddonContainersEndpoint;
|
|
8327
|
+
backupSchedules: GetAddonBackupschedulesEndpoint;
|
|
8328
|
+
};
|
|
8329
|
+
invoice: {
|
|
8330
|
+
details: GetInvoiceDetailsEndpoint;
|
|
6356
8331
|
};
|
|
8332
|
+
integration: GetIntegrationEndpoint;
|
|
8333
|
+
cluster: GetClusterEndpoint;
|
|
6357
8334
|
job: GetJobEndpoint & {
|
|
6358
8335
|
runs: GetJobRunsEndpoint;
|
|
6359
8336
|
run: GetJobRunEndpoint;
|
|
@@ -6369,7 +8346,7 @@ declare class ApiClient {
|
|
|
6369
8346
|
branches: GetJobBranchesEndpoint;
|
|
6370
8347
|
pullRequests: GetJobPullrequestsEndpoint;
|
|
6371
8348
|
};
|
|
6372
|
-
|
|
8349
|
+
registry: GetRegistryEndpoint;
|
|
6373
8350
|
domain: GetDomainEndpoint;
|
|
6374
8351
|
subdomain: GetSubdomainEndpoint;
|
|
6375
8352
|
dnsId: GetDnsidEndpoint;
|
|
@@ -6390,19 +8367,26 @@ declare class ApiClient {
|
|
|
6390
8367
|
runtimeEnvironment: GetServiceRuntimeenvironmentEndpoint;
|
|
6391
8368
|
runtimeEnvironmentDetails: GetServiceRuntimeenvironmentdetailsEndpoint;
|
|
6392
8369
|
};
|
|
8370
|
+
template: GetTemplateEndpoint;
|
|
8371
|
+
templateRun: GetTemplaterunEndpoint;
|
|
6393
8372
|
volume: GetVolumeEndpoint;
|
|
6394
8373
|
};
|
|
6395
8374
|
delete: {
|
|
6396
8375
|
project: DeleteProjectEndpoint;
|
|
6397
|
-
addon: DeleteAddonEndpoint
|
|
8376
|
+
addon: DeleteAddonEndpoint & {
|
|
8377
|
+
backupSchedule: DeleteAddonBackupscheduleEndpoint;
|
|
8378
|
+
};
|
|
6398
8379
|
backup: DeleteBackupEndpoint;
|
|
8380
|
+
integration: DeleteIntegrationEndpoint;
|
|
8381
|
+
cluster: DeleteClusterEndpoint;
|
|
6399
8382
|
job: DeleteJobEndpoint;
|
|
6400
|
-
|
|
8383
|
+
registry: DeleteRegistryEndpoint;
|
|
6401
8384
|
domain: DeleteDomainEndpoint;
|
|
6402
8385
|
subdomain: DeleteSubdomainEndpoint;
|
|
6403
8386
|
secret: DeleteSecretEndpoint;
|
|
6404
8387
|
secretLink: DeleteSecretlinkEndpoint;
|
|
6405
8388
|
service: DeleteServiceEndpoint;
|
|
8389
|
+
template: DeleteTemplateEndpoint;
|
|
6406
8390
|
volume: DeleteVolumeEndpoint;
|
|
6407
8391
|
};
|
|
6408
8392
|
scale: {
|
|
@@ -6416,17 +8400,20 @@ declare class ApiClient {
|
|
|
6416
8400
|
networkSettings: UpdateAddonNetworksettingsEndpoint;
|
|
6417
8401
|
security: UpdateAddonSecurityEndpoint;
|
|
6418
8402
|
};
|
|
8403
|
+
integration: UpdateIntegrationEndpoint;
|
|
8404
|
+
cluster: UpdateClusterEndpoint;
|
|
6419
8405
|
job: {
|
|
6420
8406
|
settings: UpdateJobSettingsEndpoint;
|
|
6421
8407
|
healthChecks: UpdateJobHealthchecksEndpoint;
|
|
6422
8408
|
buildOptions: UpdateJobBuildoptionsEndpoint;
|
|
6423
8409
|
buildSource: UpdateJobBuildsourceEndpoint;
|
|
6424
8410
|
cmdOverride: UpdateJobCmdoverrideEndpoint;
|
|
8411
|
+
entrypointOverride: UpdateJobEntrypointoverrideEndpoint;
|
|
6425
8412
|
buildArguments: UpdateJobBuildargumentsEndpoint;
|
|
6426
8413
|
runtimeEnvironment: UpdateJobRuntimeenvironmentEndpoint;
|
|
6427
8414
|
deployment: UpdateJobDeploymentEndpoint;
|
|
6428
8415
|
};
|
|
6429
|
-
|
|
8416
|
+
registry: UpdateRegistryEndpoint;
|
|
6430
8417
|
secret: UpdateSecretEndpoint;
|
|
6431
8418
|
secretLink: UpdateSecretlinkEndpoint;
|
|
6432
8419
|
service: {
|
|
@@ -6435,10 +8422,12 @@ declare class ApiClient {
|
|
|
6435
8422
|
buildOptions: UpdateServiceBuildoptionsEndpoint;
|
|
6436
8423
|
buildSource: UpdateServiceBuildsourceEndpoint;
|
|
6437
8424
|
cmdOverride: UpdateServiceCmdoverrideEndpoint;
|
|
8425
|
+
entrypointOverride: UpdateServiceEntrypointoverrideEndpoint;
|
|
6438
8426
|
healthChecks: UpdateServiceHealthchecksEndpoint;
|
|
6439
8427
|
buildArguments: UpdateServiceBuildargumentsEndpoint;
|
|
6440
8428
|
runtimeEnvironment: UpdateServiceRuntimeenvironmentEndpoint;
|
|
6441
8429
|
};
|
|
8430
|
+
template: UpdateTemplateEndpoint;
|
|
6442
8431
|
volume: UpdateVolumeEndpoint;
|
|
6443
8432
|
};
|
|
6444
8433
|
backup: {
|
|
@@ -6456,10 +8445,12 @@ declare class ApiClient {
|
|
|
6456
8445
|
};
|
|
6457
8446
|
pause: {
|
|
6458
8447
|
addon: PauseAddonEndpoint;
|
|
8448
|
+
job: PauseJobEndpoint;
|
|
6459
8449
|
service: PauseServiceEndpoint;
|
|
6460
8450
|
};
|
|
6461
8451
|
resume: {
|
|
6462
8452
|
addon: ResumeAddonEndpoint;
|
|
8453
|
+
job: ResumeJobEndpoint;
|
|
6463
8454
|
service: ResumeServiceEndpoint;
|
|
6464
8455
|
};
|
|
6465
8456
|
restart: {
|
|
@@ -6479,6 +8470,14 @@ declare class ApiClient {
|
|
|
6479
8470
|
build: AbortServiceBuildEndpoint;
|
|
6480
8471
|
};
|
|
6481
8472
|
};
|
|
8473
|
+
retain: {
|
|
8474
|
+
addon: {
|
|
8475
|
+
backup: RetainAddonBackupEndpoint;
|
|
8476
|
+
};
|
|
8477
|
+
};
|
|
8478
|
+
suspend: {
|
|
8479
|
+
job: SuspendJobEndpoint;
|
|
8480
|
+
};
|
|
6482
8481
|
start: {
|
|
6483
8482
|
job: {
|
|
6484
8483
|
run: StartJobRunEndpoint;
|
|
@@ -6489,7 +8488,7 @@ declare class ApiClient {
|
|
|
6489
8488
|
};
|
|
6490
8489
|
};
|
|
6491
8490
|
add: {
|
|
6492
|
-
|
|
8491
|
+
registry: AddRegistryEndpoint;
|
|
6493
8492
|
domain: {
|
|
6494
8493
|
subdomain: AddDomainSubdomainEndpoint;
|
|
6495
8494
|
};
|
|
@@ -6506,6 +8505,9 @@ declare class ApiClient {
|
|
|
6506
8505
|
unassign: {
|
|
6507
8506
|
subdomain: UnassignSubdomainEndpoint;
|
|
6508
8507
|
};
|
|
8508
|
+
run: {
|
|
8509
|
+
template: RunTemplateEndpoint;
|
|
8510
|
+
};
|
|
6509
8511
|
attach: {
|
|
6510
8512
|
volume: AttachVolumeEndpoint;
|
|
6511
8513
|
};
|
|
@@ -6521,4 +8523,4 @@ declare type ApiClientOpts = {
|
|
|
6521
8523
|
customUserAgent?: string;
|
|
6522
8524
|
};
|
|
6523
8525
|
|
|
6524
|
-
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 };
|
|
8526
|
+
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 };
|