@northflank/js-client 0.4.1 → 0.5.0-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 +6013 -0
- package/dist/cjs/api-client.js +1 -0
- package/dist/cjs/package.json +3 -0
- package/dist/esm/api-client.d.ts +6013 -0
- package/dist/esm/api-client.js +15 -0
- package/dist/esm/package.json +3 -0
- package/package.json +12 -19
- package/dist/api-client.d.ts +0 -481
- package/dist/api-client.js +0 -748
- package/dist/api-endpoint.d.ts +0 -63
- package/dist/api-endpoint.js +0 -216
- package/dist/context/api-client-context-provider.d.ts +0 -47
- package/dist/context/api-client-context-provider.js +0 -332
- package/dist/context/api-client-file-context-provider.d.ts +0 -11
- package/dist/context/api-client-file-context-provider.js +0 -138
- package/dist/context/api-client-in-memory-context-provider.d.ts +0 -6
- package/dist/context/api-client-in-memory-context-provider.js +0 -82
- package/dist/context/index.d.ts +0 -3
- package/dist/context/index.js +0 -15
- package/dist/endpoints/abort/addon/backup.d.ts +0 -21
- package/dist/endpoints/abort/addon/backup.js +0 -36
- package/dist/endpoints/abort/addon/restore.d.ts +0 -26
- package/dist/endpoints/abort/addon/restore.js +0 -36
- package/dist/endpoints/abort/job/build.d.ts +0 -21
- package/dist/endpoints/abort/job/build.js +0 -36
- package/dist/endpoints/abort/job/run.d.ts +0 -21
- package/dist/endpoints/abort/job/run.js +0 -36
- package/dist/endpoints/abort/service/build.d.ts +0 -21
- package/dist/endpoints/abort/service/build.js +0 -36
- package/dist/endpoints/add/domain/subdomain.d.ts +0 -33
- package/dist/endpoints/add/domain/subdomain.js +0 -36
- package/dist/endpoints/add/registryCredentials.d.ts +0 -47
- package/dist/endpoints/add/registryCredentials.js +0 -36
- package/dist/endpoints/assign/subdomain/service.d.ts +0 -28
- package/dist/endpoints/assign/subdomain/service.js +0 -36
- package/dist/endpoints/backup/addon.d.ts +0 -51
- package/dist/endpoints/backup/addon.js +0 -36
- package/dist/endpoints/create/addon.d.ts +0 -90
- package/dist/endpoints/create/addon.js +0 -36
- package/dist/endpoints/create/domain.d.ts +0 -27
- package/dist/endpoints/create/domain.js +0 -36
- package/dist/endpoints/create/job/cron.d.ts +0 -157
- package/dist/endpoints/create/job/cron.js +0 -36
- package/dist/endpoints/create/job/manual.d.ts +0 -147
- package/dist/endpoints/create/job/manual.js +0 -36
- package/dist/endpoints/create/project.d.ts +0 -29
- package/dist/endpoints/create/project.js +0 -36
- package/dist/endpoints/create/secret.d.ts +0 -79
- package/dist/endpoints/create/secret.js +0 -36
- package/dist/endpoints/create/service/build.d.ts +0 -116
- package/dist/endpoints/create/service/build.js +0 -36
- package/dist/endpoints/create/service/combined.d.ts +0 -166
- package/dist/endpoints/create/service/combined.js +0 -36
- package/dist/endpoints/create/service/deployment.d.ts +0 -137
- package/dist/endpoints/create/service/deployment.js +0 -36
- package/dist/endpoints/delete/addon.d.ts +0 -19
- package/dist/endpoints/delete/addon.js +0 -36
- package/dist/endpoints/delete/backup.d.ts +0 -21
- package/dist/endpoints/delete/backup.js +0 -36
- package/dist/endpoints/delete/domain.d.ts +0 -17
- package/dist/endpoints/delete/domain.js +0 -36
- package/dist/endpoints/delete/job.d.ts +0 -19
- package/dist/endpoints/delete/job.js +0 -36
- package/dist/endpoints/delete/project.d.ts +0 -17
- package/dist/endpoints/delete/project.js +0 -36
- package/dist/endpoints/delete/registryCredentials.d.ts +0 -17
- package/dist/endpoints/delete/registryCredentials.js +0 -36
- package/dist/endpoints/delete/secret.d.ts +0 -19
- package/dist/endpoints/delete/secret.js +0 -36
- package/dist/endpoints/delete/secretLink.d.ts +0 -21
- package/dist/endpoints/delete/secretLink.js +0 -36
- package/dist/endpoints/delete/service.d.ts +0 -19
- package/dist/endpoints/delete/service.js +0 -36
- package/dist/endpoints/delete/subdomain.d.ts +0 -19
- package/dist/endpoints/delete/subdomain.js +0 -36
- package/dist/endpoints/get/addon/backup/download.d.ts +0 -24
- package/dist/endpoints/get/addon/backup/download.js +0 -36
- package/dist/endpoints/get/addon/backup.d.ts +0 -46
- package/dist/endpoints/get/addon/backup.js +0 -36
- package/dist/endpoints/get/addon/backups.d.ts +0 -54
- package/dist/endpoints/get/addon/backups.js +0 -40
- package/dist/endpoints/get/addon/containers.d.ts +0 -40
- package/dist/endpoints/get/addon/containers.js +0 -40
- package/dist/endpoints/get/addon/credentials.d.ts +0 -24
- package/dist/endpoints/get/addon/credentials.js +0 -36
- package/dist/endpoints/get/addon/types.d.ts +0 -48
- package/dist/endpoints/get/addon/types.js +0 -36
- package/dist/endpoints/get/addon/version.d.ts +0 -53
- package/dist/endpoints/get/addon/version.js +0 -36
- package/dist/endpoints/get/addon.d.ts +0 -69
- package/dist/endpoints/get/addon.js +0 -36
- package/dist/endpoints/get/dnsId.d.ts +0 -15
- package/dist/endpoints/get/dnsId.js +0 -36
- package/dist/endpoints/get/domain.d.ts +0 -33
- package/dist/endpoints/get/domain.js +0 -36
- package/dist/endpoints/get/job/buildArguments.d.ts +0 -19
- package/dist/endpoints/get/job/buildArguments.js +0 -36
- package/dist/endpoints/get/job/builds.d.ts +0 -50
- package/dist/endpoints/get/job/builds.js +0 -39
- package/dist/endpoints/get/job/containers.d.ts +0 -40
- package/dist/endpoints/get/job/containers.js +0 -40
- package/dist/endpoints/get/job/deployment.d.ts +0 -51
- package/dist/endpoints/get/job/deployment.js +0 -36
- package/dist/endpoints/get/job/environment.d.ts +0 -24
- package/dist/endpoints/get/job/environment.js +0 -40
- package/dist/endpoints/get/job/environmentDetails.d.ts +0 -42
- package/dist/endpoints/get/job/environmentDetails.js +0 -36
- package/dist/endpoints/get/job/healthChecks.d.ts +0 -44
- package/dist/endpoints/get/job/healthChecks.js +0 -36
- package/dist/endpoints/get/job/run.d.ts +0 -42
- package/dist/endpoints/get/job/run.js +0 -36
- package/dist/endpoints/get/job/runs.d.ts +0 -52
- package/dist/endpoints/get/job/runs.js +0 -39
- package/dist/endpoints/get/job.d.ts +0 -86
- package/dist/endpoints/get/job.js +0 -36
- package/dist/endpoints/get/project.d.ts +0 -72
- package/dist/endpoints/get/project.js +0 -36
- package/dist/endpoints/get/registryCredentials.d.ts +0 -34
- package/dist/endpoints/get/registryCredentials.js +0 -36
- package/dist/endpoints/get/secret.d.ts +0 -55
- package/dist/endpoints/get/secret.js +0 -39
- package/dist/endpoints/get/secretDetails.d.ts +0 -63
- package/dist/endpoints/get/secretDetails.js +0 -36
- package/dist/endpoints/get/secretLink.d.ts +0 -44
- package/dist/endpoints/get/secretLink.js +0 -36
- package/dist/endpoints/get/service/buildArguments.d.ts +0 -19
- package/dist/endpoints/get/service/buildArguments.js +0 -36
- package/dist/endpoints/get/service/builds.d.ts +0 -50
- package/dist/endpoints/get/service/builds.js +0 -40
- package/dist/endpoints/get/service/containers.d.ts +0 -40
- package/dist/endpoints/get/service/containers.js +0 -40
- package/dist/endpoints/get/service/deployment.d.ts +0 -51
- package/dist/endpoints/get/service/deployment.js +0 -36
- package/dist/endpoints/get/service/environmentVariableDetails.d.ts +0 -42
- package/dist/endpoints/get/service/environmentVariableDetails.js +0 -36
- package/dist/endpoints/get/service/environmentVariables.d.ts +0 -24
- package/dist/endpoints/get/service/environmentVariables.js +0 -40
- package/dist/endpoints/get/service/healthChecks.d.ts +0 -44
- package/dist/endpoints/get/service/healthChecks.js +0 -36
- package/dist/endpoints/get/service/ports.d.ts +0 -35
- package/dist/endpoints/get/service/ports.js +0 -36
- package/dist/endpoints/get/service.d.ts +0 -103
- package/dist/endpoints/get/service.js +0 -36
- package/dist/endpoints/get/subdomain.d.ts +0 -30
- package/dist/endpoints/get/subdomain.js +0 -36
- package/dist/endpoints/import/addon/backup.d.ts +0 -31
- package/dist/endpoints/import/addon/backup.js +0 -36
- package/dist/endpoints/list/addons.d.ts +0 -45
- package/dist/endpoints/list/addons.js +0 -39
- package/dist/endpoints/list/domains.d.ts +0 -34
- package/dist/endpoints/list/domains.js +0 -39
- package/dist/endpoints/list/jobs.d.ts +0 -44
- package/dist/endpoints/list/jobs.js +0 -39
- package/dist/endpoints/list/plans.d.ts +0 -30
- package/dist/endpoints/list/plans.js +0 -36
- package/dist/endpoints/list/projects.d.ts +0 -32
- package/dist/endpoints/list/projects.js +0 -39
- package/dist/endpoints/list/regions.d.ts +0 -18
- package/dist/endpoints/list/regions.js +0 -36
- package/dist/endpoints/list/registryCredentials.d.ts +0 -41
- package/dist/endpoints/list/registryCredentials.js +0 -39
- package/dist/endpoints/list/secrets.d.ts +0 -52
- package/dist/endpoints/list/secrets.js +0 -39
- package/dist/endpoints/list/services.d.ts +0 -44
- package/dist/endpoints/list/services.js +0 -39
- package/dist/endpoints/list/vcs.d.ts +0 -51
- package/dist/endpoints/list/vcs.js +0 -36
- package/dist/endpoints/pause/addon.d.ts +0 -19
- package/dist/endpoints/pause/addon.js +0 -36
- package/dist/endpoints/pause/service.d.ts +0 -19
- package/dist/endpoints/pause/service.js +0 -36
- package/dist/endpoints/restart/addon.d.ts +0 -19
- package/dist/endpoints/restart/addon.js +0 -36
- package/dist/endpoints/restart/service.d.ts +0 -19
- package/dist/endpoints/restart/service.js +0 -36
- package/dist/endpoints/restore/addon/backup.d.ts +0 -21
- package/dist/endpoints/restore/addon/backup.js +0 -36
- package/dist/endpoints/resume/addon.d.ts +0 -19
- package/dist/endpoints/resume/addon.js +0 -36
- package/dist/endpoints/resume/service.d.ts +0 -24
- package/dist/endpoints/resume/service.js +0 -36
- package/dist/endpoints/scale/addon.d.ts +0 -28
- package/dist/endpoints/scale/addon.js +0 -36
- package/dist/endpoints/scale/service.d.ts +0 -26
- package/dist/endpoints/scale/service.js +0 -36
- package/dist/endpoints/start/job/build.d.ts +0 -37
- package/dist/endpoints/start/job/build.js +0 -36
- package/dist/endpoints/start/job/run.d.ts +0 -37
- package/dist/endpoints/start/job/run.js +0 -36
- package/dist/endpoints/start/service/build.d.ts +0 -41
- package/dist/endpoints/start/service/build.js +0 -36
- package/dist/endpoints/unassign/subdomain.d.ts +0 -19
- package/dist/endpoints/unassign/subdomain.js +0 -36
- package/dist/endpoints/update/addon/networkSettings.d.ts +0 -26
- package/dist/endpoints/update/addon/networkSettings.js +0 -36
- package/dist/endpoints/update/addon/security.d.ts +0 -29
- package/dist/endpoints/update/addon/security.js +0 -36
- package/dist/endpoints/update/addon/version.d.ts +0 -24
- package/dist/endpoints/update/addon/version.js +0 -36
- package/dist/endpoints/update/job/buildArguments.d.ts +0 -24
- package/dist/endpoints/update/job/buildArguments.js +0 -36
- package/dist/endpoints/update/job/cmdOverride.d.ts +0 -24
- package/dist/endpoints/update/job/cmdOverride.js +0 -36
- package/dist/endpoints/update/job/deployment.d.ts +0 -37
- package/dist/endpoints/update/job/deployment.js +0 -36
- package/dist/endpoints/update/job/environment.d.ts +0 -24
- package/dist/endpoints/update/job/environment.js +0 -36
- package/dist/endpoints/update/job/healthChecks.d.ts +0 -45
- package/dist/endpoints/update/job/healthChecks.js +0 -36
- package/dist/endpoints/update/job/settings.d.ts +0 -30
- package/dist/endpoints/update/job/settings.js +0 -36
- package/dist/endpoints/update/registryCredentials.d.ts +0 -31
- package/dist/endpoints/update/registryCredentials.js +0 -36
- package/dist/endpoints/update/secret.d.ts +0 -54
- package/dist/endpoints/update/secret.js +0 -36
- package/dist/endpoints/update/secretLink.d.ts +0 -40
- package/dist/endpoints/update/secretLink.js +0 -36
- package/dist/endpoints/update/service/buildArguments.d.ts +0 -24
- package/dist/endpoints/update/service/buildArguments.js +0 -36
- package/dist/endpoints/update/service/buildOptions.d.ts +0 -52
- package/dist/endpoints/update/service/buildOptions.js +0 -36
- package/dist/endpoints/update/service/cmdOverride.d.ts +0 -24
- package/dist/endpoints/update/service/cmdOverride.js +0 -36
- package/dist/endpoints/update/service/deployment.d.ts +0 -37
- package/dist/endpoints/update/service/deployment.js +0 -36
- package/dist/endpoints/update/service/environmentVariables.d.ts +0 -29
- package/dist/endpoints/update/service/environmentVariables.js +0 -36
- package/dist/endpoints/update/service/healthChecks.d.ts +0 -45
- package/dist/endpoints/update/service/healthChecks.js +0 -36
- package/dist/endpoints/update/service/ports.d.ts +0 -55
- package/dist/endpoints/update/service/ports.js +0 -36
- package/dist/endpoints/verify/domain.d.ts +0 -17
- package/dist/endpoints/verify/domain.js +0 -36
- package/dist/endpoints/verify/subdomain.d.ts +0 -19
- package/dist/endpoints/verify/subdomain.js +0 -36
- package/dist/port-forward/client/api-helper.d.ts +0 -30
- package/dist/port-forward/client/api-helper.js +0 -102
- package/dist/port-forward/client/atomic-write.d.ts +0 -3
- package/dist/port-forward/client/atomic-write.js +0 -95
- package/dist/port-forward/client/host-file-ast.d.ts +0 -52
- package/dist/port-forward/client/host-file-ast.js +0 -279
- package/dist/port-forward/client/host-file.d.ts +0 -26
- package/dist/port-forward/client/host-file.js +0 -226
- package/dist/port-forward/client/loopback.d.ts +0 -4
- package/dist/port-forward/client/loopback.js +0 -219
- package/dist/port-forward/client/port-forwarder.d.ts +0 -86
- package/dist/port-forward/client/port-forwarder.js +0 -593
- package/dist/port-forward/client/port-tunnel-tcp.d.ts +0 -34
- package/dist/port-forward/client/port-tunnel-tcp.js +0 -209
- package/dist/port-forward/client/port-tunnel-udp.d.ts +0 -25
- package/dist/port-forward/client/port-tunnel-udp.js +0 -147
- package/dist/port-forward/client/port-tunnel.d.ts +0 -32
- package/dist/port-forward/client/port-tunnel.js +0 -2
- package/dist/port-forward/client/promise-mutex.d.ts +0 -4
- package/dist/port-forward/client/promise-mutex.js +0 -62
- package/dist/utils.d.ts +0 -8
- package/dist/utils.js +0 -97
|
@@ -1,47 +0,0 @@
|
|
|
1
|
-
/** WARNING: Autogenerated Code - do not modify! */
|
|
2
|
-
import { ApiCallResponse, PostApiEndpoint } from '../../api-endpoint';
|
|
3
|
-
export declare type AddRegistrycredentialsResult = {
|
|
4
|
-
/** Identifier for the credentials. Example: "example-credentials" */
|
|
5
|
-
'id': string;
|
|
6
|
-
/** Name of the saved credentials. Example: "Example Credentials" */
|
|
7
|
-
'name': string;
|
|
8
|
-
/** Description of the saved credentials. Example: "This is a set of saved credentials." */
|
|
9
|
-
'description': string;
|
|
10
|
-
/** Data about whether the credentials are restricted to certain projects. */
|
|
11
|
-
'restrictions': {
|
|
12
|
-
/** Whether the credentials are restricted to specific projects. Example: true */
|
|
13
|
-
'restricted': boolean;
|
|
14
|
-
/** An array of projects the credentials are restricted to, if applicable. */
|
|
15
|
-
'projects': string[];
|
|
16
|
-
};
|
|
17
|
-
/** The registry provider associated with this set of credentials. Example: "dockerhub" */
|
|
18
|
-
'provider': 'dockerhub' | 'gcr-eu' | 'gcr-us' | 'gitlab' | 'github' | 'custom';
|
|
19
|
-
};
|
|
20
|
-
export declare type AddRegistrycredentialsCall = (opts: AddRegistrycredentialsRequest) => Promise<ApiCallResponse<AddRegistrycredentialsResult>>;
|
|
21
|
-
export declare type AddRegistrycredentialsRequest = {
|
|
22
|
-
data: AddRegistrycredentialsData;
|
|
23
|
-
};
|
|
24
|
-
export declare type AddRegistrycredentialsData = {
|
|
25
|
-
/** Name of the credentials. Example: "Example Credentials" */
|
|
26
|
-
'name': string;
|
|
27
|
-
/** Description of the credentials. Example: "This is a set of saved credentials." */
|
|
28
|
-
'description': string;
|
|
29
|
-
/** The registry provider associated with this set of credentials. Example: "dockerhub" */
|
|
30
|
-
'provider': 'dockerhub' | 'gcr-eu' | 'gcr-us' | 'gitlab' | 'github' | 'custom';
|
|
31
|
-
/** Data about whether the credentials are restricted to certain projects. */
|
|
32
|
-
'restrictions'?: {
|
|
33
|
-
/** Whether the credentials are restricted to specific projects. Example: true */
|
|
34
|
-
'restricted'?: boolean;
|
|
35
|
-
/** An array of projects the credentials are restricted to, if applicable. */
|
|
36
|
-
'projects'?: string[];
|
|
37
|
-
};
|
|
38
|
-
/** The registry credential data to save. Example: {"auths":{"https://index.docker.io/v1/":{"auth":"[YOUR AUTH KEY]"}}} */
|
|
39
|
-
'data': any;
|
|
40
|
-
};
|
|
41
|
-
/** Adds a new set of container registry credentials to this account. */
|
|
42
|
-
export declare class AddRegistrycredentialsEndpoint extends PostApiEndpoint<AddRegistrycredentialsRequest, AddRegistrycredentialsResult> {
|
|
43
|
-
description: string;
|
|
44
|
-
withAuth: boolean;
|
|
45
|
-
endpointUrl: (opts: AddRegistrycredentialsRequest) => string;
|
|
46
|
-
body: (payload: AddRegistrycredentialsRequest) => string;
|
|
47
|
-
}
|
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/** WARNING: Autogenerated Code - do not modify! */
|
|
3
|
-
var __extends = (this && this.__extends) || (function () {
|
|
4
|
-
var extendStatics = function (d, b) {
|
|
5
|
-
extendStatics = Object.setPrototypeOf ||
|
|
6
|
-
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
|
|
7
|
-
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
|
|
8
|
-
return extendStatics(d, b);
|
|
9
|
-
};
|
|
10
|
-
return function (d, b) {
|
|
11
|
-
if (typeof b !== "function" && b !== null)
|
|
12
|
-
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
|
|
13
|
-
extendStatics(d, b);
|
|
14
|
-
function __() { this.constructor = d; }
|
|
15
|
-
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
|
|
16
|
-
};
|
|
17
|
-
})();
|
|
18
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
19
|
-
exports.AddRegistrycredentialsEndpoint = void 0;
|
|
20
|
-
var api_endpoint_1 = require("../../api-endpoint");
|
|
21
|
-
/** Adds a new set of container registry credentials to this account. */
|
|
22
|
-
var AddRegistrycredentialsEndpoint = /** @class */ (function (_super) {
|
|
23
|
-
__extends(AddRegistrycredentialsEndpoint, _super);
|
|
24
|
-
function AddRegistrycredentialsEndpoint() {
|
|
25
|
-
var _this = _super !== null && _super.apply(this, arguments) || this;
|
|
26
|
-
_this.description = 'Adds a new set of container registry credentials to this account.';
|
|
27
|
-
_this.withAuth = true;
|
|
28
|
-
_this.endpointUrl = function (opts) {
|
|
29
|
-
return "/v1/registry-credentials";
|
|
30
|
-
};
|
|
31
|
-
_this.body = function (payload) { return JSON.stringify(payload.data); };
|
|
32
|
-
return _this;
|
|
33
|
-
}
|
|
34
|
-
return AddRegistrycredentialsEndpoint;
|
|
35
|
-
}(api_endpoint_1.PostApiEndpoint));
|
|
36
|
-
exports.AddRegistrycredentialsEndpoint = AddRegistrycredentialsEndpoint;
|
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
/** WARNING: Autogenerated Code - do not modify! */
|
|
2
|
-
import { ApiCallResponse, PostApiEndpoint } from '../../../api-endpoint';
|
|
3
|
-
export declare type AssignSubdomainServiceResult = any;
|
|
4
|
-
export declare type AssignSubdomainServiceCall = (opts: AssignSubdomainServiceRequest) => Promise<ApiCallResponse<AssignSubdomainServiceResult>>;
|
|
5
|
-
export declare type AssignSubdomainServiceRequest = {
|
|
6
|
-
parameters: AssignSubdomainServiceParameters;
|
|
7
|
-
data: AssignSubdomainServiceData;
|
|
8
|
-
};
|
|
9
|
-
export declare type AssignSubdomainServiceParameters = {
|
|
10
|
-
/** Name of the domain */ 'domain': string;
|
|
11
|
-
/** Name of the subdomain */
|
|
12
|
-
'subdomain': string;
|
|
13
|
-
};
|
|
14
|
-
export declare type AssignSubdomainServiceData = {
|
|
15
|
-
/** The ID of the service to assign the subdomain to. Example: "example-service" */
|
|
16
|
-
'serviceId': string;
|
|
17
|
-
/** The ID of the project the service belongs to. Example: "default-project" */
|
|
18
|
-
'projectId': string;
|
|
19
|
-
/** The name of the port that will be assigned to the subdomain. Example: "port-1" */
|
|
20
|
-
'portName': string;
|
|
21
|
-
};
|
|
22
|
-
/** Assigns a service port to the given subdomain */
|
|
23
|
-
export declare class AssignSubdomainServiceEndpoint extends PostApiEndpoint<AssignSubdomainServiceRequest, AssignSubdomainServiceResult> {
|
|
24
|
-
description: string;
|
|
25
|
-
withAuth: boolean;
|
|
26
|
-
endpointUrl: (opts: AssignSubdomainServiceRequest) => string;
|
|
27
|
-
body: (payload: AssignSubdomainServiceRequest) => string;
|
|
28
|
-
}
|
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/** WARNING: Autogenerated Code - do not modify! */
|
|
3
|
-
var __extends = (this && this.__extends) || (function () {
|
|
4
|
-
var extendStatics = function (d, b) {
|
|
5
|
-
extendStatics = Object.setPrototypeOf ||
|
|
6
|
-
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
|
|
7
|
-
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
|
|
8
|
-
return extendStatics(d, b);
|
|
9
|
-
};
|
|
10
|
-
return function (d, b) {
|
|
11
|
-
if (typeof b !== "function" && b !== null)
|
|
12
|
-
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
|
|
13
|
-
extendStatics(d, b);
|
|
14
|
-
function __() { this.constructor = d; }
|
|
15
|
-
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
|
|
16
|
-
};
|
|
17
|
-
})();
|
|
18
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
19
|
-
exports.AssignSubdomainServiceEndpoint = void 0;
|
|
20
|
-
var api_endpoint_1 = require("../../../api-endpoint");
|
|
21
|
-
/** Assigns a service port to the given subdomain */
|
|
22
|
-
var AssignSubdomainServiceEndpoint = /** @class */ (function (_super) {
|
|
23
|
-
__extends(AssignSubdomainServiceEndpoint, _super);
|
|
24
|
-
function AssignSubdomainServiceEndpoint() {
|
|
25
|
-
var _this = _super !== null && _super.apply(this, arguments) || this;
|
|
26
|
-
_this.description = 'Assigns a service port to the given subdomain';
|
|
27
|
-
_this.withAuth = true;
|
|
28
|
-
_this.endpointUrl = function (opts) {
|
|
29
|
-
return "/v1/domains/" + opts.parameters.domain + "/subdomains/" + opts.parameters.subdomain + "/assign";
|
|
30
|
-
};
|
|
31
|
-
_this.body = function (payload) { return JSON.stringify(payload.data); };
|
|
32
|
-
return _this;
|
|
33
|
-
}
|
|
34
|
-
return AssignSubdomainServiceEndpoint;
|
|
35
|
-
}(api_endpoint_1.PostApiEndpoint));
|
|
36
|
-
exports.AssignSubdomainServiceEndpoint = AssignSubdomainServiceEndpoint;
|
|
@@ -1,51 +0,0 @@
|
|
|
1
|
-
/** WARNING: Autogenerated Code - do not modify! */
|
|
2
|
-
import { ApiCallResponse, PostApiEndpoint } from '../../api-endpoint';
|
|
3
|
-
export declare type BackupAddonResult = {
|
|
4
|
-
/** The identifier for the backup. Example: "example-backup" */
|
|
5
|
-
'id': string;
|
|
6
|
-
/** The name of the backup. Example: "Example Backup" */
|
|
7
|
-
'name': string;
|
|
8
|
-
/** The current status of the backup. Example: "completed" */
|
|
9
|
-
'status': 'scheduled' | 'in-progress' | 'completed' | 'aborting' | 'aborted' | 'failed' | 'not-supported';
|
|
10
|
-
/** The time the backup was initiated. Example: "2021-01-20T11:19:53.175Z" */
|
|
11
|
-
'createdAt': string;
|
|
12
|
-
/** The time the backup was completed. Example: "2021-01-20T11:19:54.494Z" */
|
|
13
|
-
'completedAt': string;
|
|
14
|
-
/** Data about the backup configuration. */
|
|
15
|
-
'config': {
|
|
16
|
-
/** Data about the source of the backup. */
|
|
17
|
-
'source'?: {
|
|
18
|
-
/** The type of backup. Example: "snapshot" */
|
|
19
|
-
'type'?: 'fileUpload' | 'liveInstance' | 'snapshot' | 'externalDump' | 'sameAddon';
|
|
20
|
-
};
|
|
21
|
-
/** The size of the backup, in bytes Example: "1234" */
|
|
22
|
-
'size': string;
|
|
23
|
-
/** The version of the addon at the time of the backup. If the backup type is `snapshot`, the addon will be restored to this version when the backup is restored. Example: "4.4.8" */
|
|
24
|
-
'addonVersion'?: string;
|
|
25
|
-
};
|
|
26
|
-
/** An object containing the restore history for the given backup. Example: {"1611305397038":{"restoreTimestamp":"2021-01-22T08:49:57.038Z","status":"completed","completedAt":"2021-01-22T08:50:30.749Z"}} */
|
|
27
|
-
'restores': any;
|
|
28
|
-
};
|
|
29
|
-
export declare type BackupAddonCall = (opts: BackupAddonRequest) => Promise<ApiCallResponse<BackupAddonResult>>;
|
|
30
|
-
export declare type BackupAddonRequest = {
|
|
31
|
-
parameters: BackupAddonParameters;
|
|
32
|
-
data: BackupAddonData;
|
|
33
|
-
};
|
|
34
|
-
export declare type BackupAddonParameters = {
|
|
35
|
-
/** ID of the project */ 'projectId': string;
|
|
36
|
-
/** ID of the addon */
|
|
37
|
-
'addonId': string;
|
|
38
|
-
};
|
|
39
|
-
export declare type BackupAddonData = {
|
|
40
|
-
/** The name of the backup. If not provided, a default name will be generated containing the current date. Example: "Example Backup" */
|
|
41
|
-
'name'?: string;
|
|
42
|
-
/** The type of backup to perform. Defaults to `snapshot`. Example: "snapshot" */
|
|
43
|
-
'backupType'?: 'dump' | 'snapshot';
|
|
44
|
-
};
|
|
45
|
-
/** Initiates a backup for the given addon */
|
|
46
|
-
export declare class BackupAddonEndpoint extends PostApiEndpoint<BackupAddonRequest, BackupAddonResult> {
|
|
47
|
-
description: string;
|
|
48
|
-
withAuth: boolean;
|
|
49
|
-
endpointUrl: (opts: BackupAddonRequest) => string;
|
|
50
|
-
body: (payload: BackupAddonRequest) => string;
|
|
51
|
-
}
|
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/** WARNING: Autogenerated Code - do not modify! */
|
|
3
|
-
var __extends = (this && this.__extends) || (function () {
|
|
4
|
-
var extendStatics = function (d, b) {
|
|
5
|
-
extendStatics = Object.setPrototypeOf ||
|
|
6
|
-
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
|
|
7
|
-
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
|
|
8
|
-
return extendStatics(d, b);
|
|
9
|
-
};
|
|
10
|
-
return function (d, b) {
|
|
11
|
-
if (typeof b !== "function" && b !== null)
|
|
12
|
-
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
|
|
13
|
-
extendStatics(d, b);
|
|
14
|
-
function __() { this.constructor = d; }
|
|
15
|
-
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
|
|
16
|
-
};
|
|
17
|
-
})();
|
|
18
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
19
|
-
exports.BackupAddonEndpoint = void 0;
|
|
20
|
-
var api_endpoint_1 = require("../../api-endpoint");
|
|
21
|
-
/** Initiates a backup for the given addon */
|
|
22
|
-
var BackupAddonEndpoint = /** @class */ (function (_super) {
|
|
23
|
-
__extends(BackupAddonEndpoint, _super);
|
|
24
|
-
function BackupAddonEndpoint() {
|
|
25
|
-
var _this = _super !== null && _super.apply(this, arguments) || this;
|
|
26
|
-
_this.description = 'Initiates a backup for the given addon';
|
|
27
|
-
_this.withAuth = true;
|
|
28
|
-
_this.endpointUrl = function (opts) {
|
|
29
|
-
return "/v1/projects/" + opts.parameters.projectId + "/addons/" + opts.parameters.addonId + "/backups";
|
|
30
|
-
};
|
|
31
|
-
_this.body = function (payload) { return JSON.stringify(payload.data); };
|
|
32
|
-
return _this;
|
|
33
|
-
}
|
|
34
|
-
return BackupAddonEndpoint;
|
|
35
|
-
}(api_endpoint_1.PostApiEndpoint));
|
|
36
|
-
exports.BackupAddonEndpoint = BackupAddonEndpoint;
|
|
@@ -1,90 +0,0 @@
|
|
|
1
|
-
/** WARNING: Autogenerated Code - do not modify! */
|
|
2
|
-
import { ApiCallResponse, PostApiEndpoint } from '../../api-endpoint';
|
|
3
|
-
export declare type CreateAddonResult = {
|
|
4
|
-
/** Identifier for the addon. Example: "example-addon" */
|
|
5
|
-
'id': string;
|
|
6
|
-
/** Addon name. Example: "Example Addon" */
|
|
7
|
-
'name': string;
|
|
8
|
-
/** Full identifier for the addon. Example: "/example-user/default-project/example-addon" */
|
|
9
|
-
'appId': string;
|
|
10
|
-
/** A short description of the addon. Example: "This is the addon description" */
|
|
11
|
-
'description'?: string;
|
|
12
|
-
/** The time the addon was created. Example: "2021-01-20T11:19:53.175Z" */
|
|
13
|
-
'createdAt': string;
|
|
14
|
-
/** Details about the addon's specifications. */
|
|
15
|
-
'spec': {
|
|
16
|
-
/** The type of the addon Example: "mongodb" */
|
|
17
|
-
'type': string;
|
|
18
|
-
/** Details about the addon configuration. */
|
|
19
|
-
'config': {
|
|
20
|
-
/** The version of the addon running. Example: "4.2.14" */
|
|
21
|
-
'versionTag': string;
|
|
22
|
-
/** The support status of the current addon version. Example: "active" */
|
|
23
|
-
'lifecycleStatus': 'active' | 'deprecated' | 'discontinued';
|
|
24
|
-
/** Details about the addon deployment. */
|
|
25
|
-
'deployment': {
|
|
26
|
-
/** The number of replicas running for this addon. Example: 1 */
|
|
27
|
-
'replicas': number;
|
|
28
|
-
/** The size of the addon storage, in MB. Example: 1024 */
|
|
29
|
-
'storageSize': number;
|
|
30
|
-
/** The deployment plan used by the addon. Example: "nf-compute-20" */
|
|
31
|
-
'planId': string;
|
|
32
|
-
/** The region where the addon is deployed. Example: "europe-west" */
|
|
33
|
-
'region': string;
|
|
34
|
-
};
|
|
35
|
-
/** Details about the addon networking settings. */
|
|
36
|
-
'networking': {
|
|
37
|
-
/** Whether this addon is provisioned with a TLS certificate. Example: true */
|
|
38
|
-
'tlsEnabled': boolean;
|
|
39
|
-
/** Whether this addon is publicly accessible via the internet. Example: true */
|
|
40
|
-
'externalAccessEnabled': boolean;
|
|
41
|
-
/** An array of IP policy rules. */
|
|
42
|
-
'ipPolicies'?: {
|
|
43
|
-
/** An IP address used by this rule. Example: "127.0.0.1" */
|
|
44
|
-
'address': string;
|
|
45
|
-
/** The action for this rule. Example: "ALLOW" */
|
|
46
|
-
'action': 'DENY' | 'ALLOW';
|
|
47
|
-
}[];
|
|
48
|
-
};
|
|
49
|
-
};
|
|
50
|
-
};
|
|
51
|
-
/** The current state of the addon. Example: "preDeployment" */
|
|
52
|
-
'status': 'preDeployment' | 'triggerAllocation' | 'allocating' | 'postDeployment' | 'running' | 'paused' | 'scaling' | 'upgrading' | 'backup' | 'restore' | 'failed' | 'deleting' | 'deleted';
|
|
53
|
-
};
|
|
54
|
-
export declare type CreateAddonCall = (opts: CreateAddonRequest) => Promise<ApiCallResponse<CreateAddonResult>>;
|
|
55
|
-
export declare type CreateAddonRequest = {
|
|
56
|
-
parameters: CreateAddonParameters;
|
|
57
|
-
data: CreateAddonData;
|
|
58
|
-
};
|
|
59
|
-
export declare type CreateAddonParameters = {
|
|
60
|
-
/** ID of the project */ 'projectId': string;
|
|
61
|
-
};
|
|
62
|
-
export declare type CreateAddonData = {
|
|
63
|
-
/** The name of the addon. Example: "Example Addon" */
|
|
64
|
-
'name': string;
|
|
65
|
-
/** A description of the addon. Example: "An addon description" */
|
|
66
|
-
'description'?: string;
|
|
67
|
-
/** The identifier for the type of addon. Addon types can be found at the Get Addon Types endpoint. Example: "postgres" */
|
|
68
|
-
'type': string;
|
|
69
|
-
/** The version of the addon type to use. Example: "12.4.0" */
|
|
70
|
-
'version': string;
|
|
71
|
-
'billing': {
|
|
72
|
-
/** The ID of the deployment plan to use. Example: "nf-compute-20" */
|
|
73
|
-
'deploymentPlan': string;
|
|
74
|
-
/** The size of the addon storage, in megabytes. Example: 1024 */
|
|
75
|
-
'storage': number;
|
|
76
|
-
/** The number of addon replicas to run. Example: 1 */
|
|
77
|
-
'replicas': number;
|
|
78
|
-
};
|
|
79
|
-
/** Enables access to the addon via TLS (if supported by the addon type). */
|
|
80
|
-
'tlsEnabled'?: boolean;
|
|
81
|
-
/** Enables external access to the addon via TLS (if supported by the addon type). */
|
|
82
|
-
'externalAccessEnabled'?: boolean;
|
|
83
|
-
};
|
|
84
|
-
/** Creates a new addon */
|
|
85
|
-
export declare class CreateAddonEndpoint extends PostApiEndpoint<CreateAddonRequest, CreateAddonResult> {
|
|
86
|
-
description: string;
|
|
87
|
-
withAuth: boolean;
|
|
88
|
-
endpointUrl: (opts: CreateAddonRequest) => string;
|
|
89
|
-
body: (payload: CreateAddonRequest) => string;
|
|
90
|
-
}
|
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/** WARNING: Autogenerated Code - do not modify! */
|
|
3
|
-
var __extends = (this && this.__extends) || (function () {
|
|
4
|
-
var extendStatics = function (d, b) {
|
|
5
|
-
extendStatics = Object.setPrototypeOf ||
|
|
6
|
-
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
|
|
7
|
-
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
|
|
8
|
-
return extendStatics(d, b);
|
|
9
|
-
};
|
|
10
|
-
return function (d, b) {
|
|
11
|
-
if (typeof b !== "function" && b !== null)
|
|
12
|
-
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
|
|
13
|
-
extendStatics(d, b);
|
|
14
|
-
function __() { this.constructor = d; }
|
|
15
|
-
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
|
|
16
|
-
};
|
|
17
|
-
})();
|
|
18
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
19
|
-
exports.CreateAddonEndpoint = void 0;
|
|
20
|
-
var api_endpoint_1 = require("../../api-endpoint");
|
|
21
|
-
/** Creates a new addon */
|
|
22
|
-
var CreateAddonEndpoint = /** @class */ (function (_super) {
|
|
23
|
-
__extends(CreateAddonEndpoint, _super);
|
|
24
|
-
function CreateAddonEndpoint() {
|
|
25
|
-
var _this = _super !== null && _super.apply(this, arguments) || this;
|
|
26
|
-
_this.description = 'Creates a new addon';
|
|
27
|
-
_this.withAuth = true;
|
|
28
|
-
_this.endpointUrl = function (opts) {
|
|
29
|
-
return "/v1/projects/" + opts.parameters.projectId + "/addons";
|
|
30
|
-
};
|
|
31
|
-
_this.body = function (payload) { return JSON.stringify(payload.data); };
|
|
32
|
-
return _this;
|
|
33
|
-
}
|
|
34
|
-
return CreateAddonEndpoint;
|
|
35
|
-
}(api_endpoint_1.PostApiEndpoint));
|
|
36
|
-
exports.CreateAddonEndpoint = CreateAddonEndpoint;
|
|
@@ -1,27 +0,0 @@
|
|
|
1
|
-
/** WARNING: Autogenerated Code - do not modify! */
|
|
2
|
-
import { ApiCallResponse, PostApiEndpoint } from '../../api-endpoint';
|
|
3
|
-
export declare type CreateDomainResult = {
|
|
4
|
-
/** The domain name. Example: "example.com" */
|
|
5
|
-
'name': string;
|
|
6
|
-
/** The status of the domain verification. Example: "pending" */
|
|
7
|
-
'status': 'pending' | 'verified';
|
|
8
|
-
/** The hostname to add to your domain's DNS records as a TXT record to verify the domain. Example: "nfverify1608026055" */
|
|
9
|
-
'hostname': string;
|
|
10
|
-
/** The token to add as the content of the TXT record to verify the domain. Example: "e596987b52855a4a773ef580ce2985d7746b37ce8b2a443d20fa27b913d8f57" */
|
|
11
|
-
'token': string;
|
|
12
|
-
} | any;
|
|
13
|
-
export declare type CreateDomainCall = (opts: CreateDomainRequest) => Promise<ApiCallResponse<CreateDomainResult>>;
|
|
14
|
-
export declare type CreateDomainRequest = {
|
|
15
|
-
data: CreateDomainData;
|
|
16
|
-
};
|
|
17
|
-
export declare type CreateDomainData = {
|
|
18
|
-
/** The domain name to register. Example: "example.com" */
|
|
19
|
-
'domain': string;
|
|
20
|
-
};
|
|
21
|
-
/** Registers a new domain */
|
|
22
|
-
export declare class CreateDomainEndpoint extends PostApiEndpoint<CreateDomainRequest, CreateDomainResult> {
|
|
23
|
-
description: string;
|
|
24
|
-
withAuth: boolean;
|
|
25
|
-
endpointUrl: (opts: CreateDomainRequest) => string;
|
|
26
|
-
body: (payload: CreateDomainRequest) => string;
|
|
27
|
-
}
|
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/** WARNING: Autogenerated Code - do not modify! */
|
|
3
|
-
var __extends = (this && this.__extends) || (function () {
|
|
4
|
-
var extendStatics = function (d, b) {
|
|
5
|
-
extendStatics = Object.setPrototypeOf ||
|
|
6
|
-
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
|
|
7
|
-
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
|
|
8
|
-
return extendStatics(d, b);
|
|
9
|
-
};
|
|
10
|
-
return function (d, b) {
|
|
11
|
-
if (typeof b !== "function" && b !== null)
|
|
12
|
-
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
|
|
13
|
-
extendStatics(d, b);
|
|
14
|
-
function __() { this.constructor = d; }
|
|
15
|
-
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
|
|
16
|
-
};
|
|
17
|
-
})();
|
|
18
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
19
|
-
exports.CreateDomainEndpoint = void 0;
|
|
20
|
-
var api_endpoint_1 = require("../../api-endpoint");
|
|
21
|
-
/** Registers a new domain */
|
|
22
|
-
var CreateDomainEndpoint = /** @class */ (function (_super) {
|
|
23
|
-
__extends(CreateDomainEndpoint, _super);
|
|
24
|
-
function CreateDomainEndpoint() {
|
|
25
|
-
var _this = _super !== null && _super.apply(this, arguments) || this;
|
|
26
|
-
_this.description = 'Registers a new domain';
|
|
27
|
-
_this.withAuth = true;
|
|
28
|
-
_this.endpointUrl = function (opts) {
|
|
29
|
-
return "/v1/domains";
|
|
30
|
-
};
|
|
31
|
-
_this.body = function (payload) { return JSON.stringify(payload.data); };
|
|
32
|
-
return _this;
|
|
33
|
-
}
|
|
34
|
-
return CreateDomainEndpoint;
|
|
35
|
-
}(api_endpoint_1.PostApiEndpoint));
|
|
36
|
-
exports.CreateDomainEndpoint = CreateDomainEndpoint;
|
|
@@ -1,157 +0,0 @@
|
|
|
1
|
-
/** WARNING: Autogenerated Code - do not modify! */
|
|
2
|
-
import { ApiCallResponse, PostApiEndpoint } from '../../../api-endpoint';
|
|
3
|
-
export declare type CreateJobCronResult = {
|
|
4
|
-
/** Identifier for the job Example: "example-job" */
|
|
5
|
-
'id': string;
|
|
6
|
-
/** Full identifier used for job deployment Example: "/example-user/default-project/example-job" */
|
|
7
|
-
'appId': string;
|
|
8
|
-
/** Job name Example: "Example Job" */
|
|
9
|
-
'name': string;
|
|
10
|
-
/** A short description of the job Example: "This is the job description" */
|
|
11
|
-
'description'?: string;
|
|
12
|
-
/** ID of the project that the service belongs to Example: "default-project" */
|
|
13
|
-
'projectId': string;
|
|
14
|
-
/** The time the job was created. Example: "2021-01-20T11:19:53.175Z" */
|
|
15
|
-
'createdAt': string;
|
|
16
|
-
'vcsData'?: {
|
|
17
|
-
/** URL of the repository being built Example: "https://github.com/northflank/gatsby-with-northflank" */
|
|
18
|
-
'projectUrl': string;
|
|
19
|
-
/** VCS provider for the repo being built Example: "github" */
|
|
20
|
-
'projectType': 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
|
|
21
|
-
/** ID of the self-hosted VCS, if applicable. Example: "example-team/self-hosted-vcs" */
|
|
22
|
-
'vcsId'?: string;
|
|
23
|
-
/** Branch of the repo being built Example: "master" */
|
|
24
|
-
'projectBranch'?: string;
|
|
25
|
-
/** Whether the repo is being accessed without authentication. */
|
|
26
|
-
'publicRepo'?: boolean;
|
|
27
|
-
/** Working directory used by the dockerfile Example: "/" */
|
|
28
|
-
'dockerWorkDir': string;
|
|
29
|
-
/** File path of the Dockerfile Example: "/Dockerfile" */
|
|
30
|
-
'dockerFilePath': string;
|
|
31
|
-
};
|
|
32
|
-
'buildEngineConfiguration'?: {
|
|
33
|
-
/** The build engine used. Example: "buildpack" */
|
|
34
|
-
'builder'?: 'buildpack' | 'kaniko' | 'buildkit';
|
|
35
|
-
'buildpack'?: {
|
|
36
|
-
/** The Buildpack stack used. Example: "HEROKU_20" */
|
|
37
|
-
'builder'?: 'HEROKU_20' | 'HEROKU_18' | 'GOOGLE_V1' | 'CNB_ALPINE' | 'CNB_BIONIC' | 'PAKETO_TINY';
|
|
38
|
-
/** Array of custom Buildpacks used. */
|
|
39
|
-
'buildpackLocators'?: string[];
|
|
40
|
-
};
|
|
41
|
-
};
|
|
42
|
-
/** Whether Continuous Integration is disabled */
|
|
43
|
-
'disabledCI': boolean;
|
|
44
|
-
/** Whether Continuous Deployment is disabled */
|
|
45
|
-
'disabledCD': boolean;
|
|
46
|
-
'deployment'?: {
|
|
47
|
-
/** Region where this job is deployed and built Example: "europe-west" */
|
|
48
|
-
'region'?: string;
|
|
49
|
-
};
|
|
50
|
-
'billing': {
|
|
51
|
-
/** ID of the billing plan used by this job Example: "nf-compute-20" */
|
|
52
|
-
'deploymentPlan': string;
|
|
53
|
-
};
|
|
54
|
-
/** Job settings */
|
|
55
|
-
'settings': {
|
|
56
|
-
/** Cron job specific settings */
|
|
57
|
-
'cron'?: {
|
|
58
|
-
/** The cron timer scheduling when to run the job. Example: "30 8 * * *" */
|
|
59
|
-
'schedule'?: string;
|
|
60
|
-
/** Whether this job should run when another instance of the job is already running. Example: "Allow" */
|
|
61
|
-
'concurrencyPolicy'?: 'Allow' | 'Forbid' | 'Replace';
|
|
62
|
-
};
|
|
63
|
-
/** The number of attempts to rerun a job before it is marked as failed. */
|
|
64
|
-
'backoffLimit': number;
|
|
65
|
-
/** The maximum amount of time, in seconds, for a job to run before it is marked as failed. Example: 600 */
|
|
66
|
-
'activeDeadlineSeconds': number;
|
|
67
|
-
};
|
|
68
|
-
/** Type of the job (manual or cron) Example: "cron" */
|
|
69
|
-
'jobType': 'cron' | 'manual';
|
|
70
|
-
/** Whether the job will be built immediately Example: true */
|
|
71
|
-
'buildInitiated': boolean;
|
|
72
|
-
};
|
|
73
|
-
export declare type CreateJobCronCall = (opts: CreateJobCronRequest) => Promise<ApiCallResponse<CreateJobCronResult>>;
|
|
74
|
-
export declare type CreateJobCronRequest = {
|
|
75
|
-
parameters: CreateJobCronParameters;
|
|
76
|
-
data: CreateJobCronData;
|
|
77
|
-
};
|
|
78
|
-
export declare type CreateJobCronParameters = {
|
|
79
|
-
/** ID of the project */ 'projectId': string;
|
|
80
|
-
};
|
|
81
|
-
export declare type CreateJobCronData = {
|
|
82
|
-
/** The name of the job. Example: "Example Job" */
|
|
83
|
-
'name': string;
|
|
84
|
-
/** A description of the job. Example: "A job description" */
|
|
85
|
-
'description'?: string;
|
|
86
|
-
'billing': {
|
|
87
|
-
/** The ID of the deployment plan to use. Example: "nf-compute-20" */
|
|
88
|
-
'deploymentPlan': string;
|
|
89
|
-
};
|
|
90
|
-
/** The number of attempts to rerun a job before it is marked as failed. */
|
|
91
|
-
'backoffLimit': number;
|
|
92
|
-
/** The maximum amount of time, in seconds, for a job to run before it is marked as failed. Example: 600 */
|
|
93
|
-
'activeDeadlineSeconds'?: number;
|
|
94
|
-
/** Where to deploy the job from. */
|
|
95
|
-
'deployment'?: {
|
|
96
|
-
'vcs': {
|
|
97
|
-
/** URL of the Git repo to build. Example: "https://github.com/northflank/gatsby-with-northflank" */
|
|
98
|
-
'projectUrl': string;
|
|
99
|
-
/** The VCS provider to use. Example: "github" */
|
|
100
|
-
'projectType': 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
|
|
101
|
-
/** If projectType is self-hosted, the ID of the self-hosted vcs to use. */
|
|
102
|
-
'vcsId'?: string;
|
|
103
|
-
/** The name of the branch to use. Example: "master" */
|
|
104
|
-
'projectBranch': string;
|
|
105
|
-
};
|
|
106
|
-
} | {
|
|
107
|
-
'external': {
|
|
108
|
-
/** Path of the external image excluding the hostname Example: "nginx:latest" */
|
|
109
|
-
'imagePath': string;
|
|
110
|
-
/** ID of the saved credentials to use to access this external image. Example: "example-credentials" */
|
|
111
|
-
'credentials'?: string;
|
|
112
|
-
};
|
|
113
|
-
} | {
|
|
114
|
-
'internal': {
|
|
115
|
-
/** ID of the build service to deploy Example: "example-build-service" */
|
|
116
|
-
'id'?: string;
|
|
117
|
-
/** Branch to deploy Example: "master" */
|
|
118
|
-
'branch'?: string;
|
|
119
|
-
/** Commit SHA to deploy, or 'latest' to deploy the most recent commit Example: "latest" */
|
|
120
|
-
'buildSHA'?: any;
|
|
121
|
-
};
|
|
122
|
-
};
|
|
123
|
-
'buildSettings'?: {
|
|
124
|
-
'dockerfile': {
|
|
125
|
-
/** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
|
|
126
|
-
'buildEngine'?: 'kaniko' | 'buildkit';
|
|
127
|
-
/** The file path of the Dockerfile. Example: "/Dockerfile" */
|
|
128
|
-
'dockerFilePath': string;
|
|
129
|
-
/** The working directory of the Dockerfile. Example: "/" */
|
|
130
|
-
'dockerWorkDir': string;
|
|
131
|
-
};
|
|
132
|
-
} | {
|
|
133
|
-
'buildpack': {
|
|
134
|
-
/** Buildpack stack to use. Defaults to recommended stack `HEROKU_20`. Example: "HEROKU_20" */
|
|
135
|
-
'builder'?: 'HEROKU_20' | 'HEROKU_18' | 'GOOGLE_V1' | 'CNB_ALPINE' | 'CNB_BIONIC' | 'PAKETO_TINY';
|
|
136
|
-
/** Array of custom Buildpacks to use. */
|
|
137
|
-
'buildpackLocators'?: string[];
|
|
138
|
-
/** The working directory to build in. Example: "/" */
|
|
139
|
-
'buildContext'?: string;
|
|
140
|
-
};
|
|
141
|
-
};
|
|
142
|
-
/** An object containing the environment variables to set for the job. Example: {"variable1":"abcdef","variable2":"12345"} */
|
|
143
|
-
'environment'?: any;
|
|
144
|
-
/** An object containing the build arguments to set for the job. Example: {"variable1":"abcdef","variable2":"12345"} */
|
|
145
|
-
'buildArguments'?: any;
|
|
146
|
-
/** The cron timer scheduling when to run the job. Example: "30 8 * * *" */
|
|
147
|
-
'schedule': string;
|
|
148
|
-
/** Whether this job should run when another instance of the job is already running. `allow` will enable multiple instances of this job to run. `forbid` will keep the current instance of the job running and stop a new instance from being run. `replace` will terminate any currently running instance of the job and start a new one. Example: "forbid" */
|
|
149
|
-
'concurrencyPolicy': 'allow' | 'forbid' | 'replace';
|
|
150
|
-
};
|
|
151
|
-
/** Creates a new cron job */
|
|
152
|
-
export declare class CreateJobCronEndpoint extends PostApiEndpoint<CreateJobCronRequest, CreateJobCronResult> {
|
|
153
|
-
description: string;
|
|
154
|
-
withAuth: boolean;
|
|
155
|
-
endpointUrl: (opts: CreateJobCronRequest) => string;
|
|
156
|
-
body: (payload: CreateJobCronRequest) => string;
|
|
157
|
-
}
|
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/** WARNING: Autogenerated Code - do not modify! */
|
|
3
|
-
var __extends = (this && this.__extends) || (function () {
|
|
4
|
-
var extendStatics = function (d, b) {
|
|
5
|
-
extendStatics = Object.setPrototypeOf ||
|
|
6
|
-
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
|
|
7
|
-
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
|
|
8
|
-
return extendStatics(d, b);
|
|
9
|
-
};
|
|
10
|
-
return function (d, b) {
|
|
11
|
-
if (typeof b !== "function" && b !== null)
|
|
12
|
-
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
|
|
13
|
-
extendStatics(d, b);
|
|
14
|
-
function __() { this.constructor = d; }
|
|
15
|
-
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
|
|
16
|
-
};
|
|
17
|
-
})();
|
|
18
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
19
|
-
exports.CreateJobCronEndpoint = void 0;
|
|
20
|
-
var api_endpoint_1 = require("../../../api-endpoint");
|
|
21
|
-
/** Creates a new cron job */
|
|
22
|
-
var CreateJobCronEndpoint = /** @class */ (function (_super) {
|
|
23
|
-
__extends(CreateJobCronEndpoint, _super);
|
|
24
|
-
function CreateJobCronEndpoint() {
|
|
25
|
-
var _this = _super !== null && _super.apply(this, arguments) || this;
|
|
26
|
-
_this.description = 'Creates a new cron job';
|
|
27
|
-
_this.withAuth = true;
|
|
28
|
-
_this.endpointUrl = function (opts) {
|
|
29
|
-
return "/v1/projects/" + opts.parameters.projectId + "/jobs/cron";
|
|
30
|
-
};
|
|
31
|
-
_this.body = function (payload) { return JSON.stringify(payload.data); };
|
|
32
|
-
return _this;
|
|
33
|
-
}
|
|
34
|
-
return CreateJobCronEndpoint;
|
|
35
|
-
}(api_endpoint_1.PostApiEndpoint));
|
|
36
|
-
exports.CreateJobCronEndpoint = CreateJobCronEndpoint;
|