@northflank/js-client 0.5.3 → 0.5.4

package/dist/cjs/api-client.d.ts

@@ -1534,6 +1534,8 @@ declare type CreateJobManualData = {
     'activeDeadlineSeconds'?: number;
     /** Where to deploy the job from. */
     'deployment'?: {
+        /** If set, the service runs a custom command rather than one defined in the Dockerfile. Example: "nginx -g" */
+        'cmdOverride'?: string;
         'vcs': {
             /** URL of the Git repo to build. Example: "https://github.com/northflank/gatsby-with-northflank" */
             'projectUrl': string;
@@ -1547,6 +1549,8 @@ declare type CreateJobManualData = {
             'projectBranch': string;
         };
     } | {
+        /** If set, the service runs a custom command rather than one defined in the Dockerfile. Example: "nginx -g" */
+        'cmdOverride'?: string;
         'external': {
             /** Image to be deployed. When not deploying from Dockerhub the URL must be specified. Example: "nginx:latest" */
             'imagePath': string;
@@ -1554,6 +1558,8 @@ declare type CreateJobManualData = {
             'credentials'?: string;
         };
     } | {
+        /** If set, the service runs a custom command rather than one defined in the Dockerfile. Example: "nginx -g" */
+        'cmdOverride'?: string;
         'internal': {
             /** ID of the build service to deploy Example: "example-build-service" */
             'id'?: string;
@@ -1562,7 +1568,7 @@ declare type CreateJobManualData = {
             /** Commit SHA to deploy, or 'latest' to deploy the most recent commit Example: "latest" */
             'buildSHA'?: any;
         };
-    };
+    } | any;
     'buildConfiguration'?: {
         /** 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. */
         'pathIgnoreRules'?: string[];
@@ -1571,6 +1577,8 @@ declare type CreateJobManualData = {
         'dockerfile': {
             /** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
             'buildEngine'?: 'kaniko' | 'buildkit';
+            /** Should intermediate image layers be cached? Only supported by Kaniko. */
+            'useCache'?: boolean;
             /** The file path of the Dockerfile. Example: "/Dockerfile" */
             'dockerFilePath': string;
             /** The working directory of the Dockerfile. Example: "/" */
@@ -1704,6 +1712,8 @@ declare type CreateJobCronData = {
     'activeDeadlineSeconds'?: number;
     /** Where to deploy the job from. */
     'deployment'?: {
+        /** If set, the service runs a custom command rather than one defined in the Dockerfile. Example: "nginx -g" */
+        'cmdOverride'?: string;
         'vcs': {
             /** URL of the Git repo to build. Example: "https://github.com/northflank/gatsby-with-northflank" */
             'projectUrl': string;
@@ -1717,6 +1727,8 @@ declare type CreateJobCronData = {
             'projectBranch': string;
         };
     } | {
+        /** If set, the service runs a custom command rather than one defined in the Dockerfile. Example: "nginx -g" */
+        'cmdOverride'?: string;
         'external': {
             /** Image to be deployed. When not deploying from Dockerhub the URL must be specified. Example: "nginx:latest" */
             'imagePath': string;
@@ -1724,6 +1736,8 @@ declare type CreateJobCronData = {
             'credentials'?: string;
         };
     } | {
+        /** If set, the service runs a custom command rather than one defined in the Dockerfile. Example: "nginx -g" */
+        'cmdOverride'?: string;
         'internal': {
             /** ID of the build service to deploy Example: "example-build-service" */
             'id'?: string;
@@ -1732,7 +1746,7 @@ declare type CreateJobCronData = {
             /** Commit SHA to deploy, or 'latest' to deploy the most recent commit Example: "latest" */
             'buildSHA'?: any;
         };
-    };
+    } | any;
     'buildConfiguration'?: {
         /** 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. */
         'pathIgnoreRules'?: string[];
@@ -1741,6 +1755,8 @@ declare type CreateJobCronData = {
         'dockerfile': {
             /** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
             'buildEngine'?: 'kaniko' | 'buildkit';
+            /** Should intermediate image layers be cached? Only supported by Kaniko. */
+            'useCache'?: boolean;
             /** The file path of the Dockerfile. Example: "/Dockerfile" */
             'dockerFilePath': string;
             /** The working directory of the Dockerfile. Example: "/" */
@@ -1843,13 +1859,34 @@ declare type StartJobRunParameters = {
 declare type StartJobRunData = {
     /** 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"} */
     'runtimeEnvironment'?: any;
-    /** Details about the addon's deployment. */
     'deployment'?: {
-        /** Details about the addon's Docker deployment. */
+        /** Optional: Specify the job run docker configuration. */
+        'docker'?: {
+            /** The CMD override to use when running the job. Example: "nginx -g" */
+            'cmd'?: string;
+        };
+        /** Optional: Specify the commit to run */
+        'internal'?: {
+            /** ID of the build service to deploy Example: "example-build-service" */
+            'id'?: string;
+            /** Branch to deploy Example: "master" */
+            'branch'?: string;
+            /** Commit SHA to deploy, or 'latest' to deploy the most recent commit Example: "latest" */
+            'buildSHA'?: any;
+        };
+    } | {
+        /** Optional: Specify the job run docker configuration. */
         'docker'?: {
             /** The CMD override to use when running the job. Example: "nginx -g" */
             'cmd'?: string;
         };
+        /** Optional: Specify the external image to run */
+        'external'?: {
+            /** Image to be deployed. When not deploying from Dockerhub the URL must be specified. Example: "nginx:latest" */
+            'imagePath': string;
+            /** ID of the saved credentials to use to access this external image. Example: "example-credentials" */
+            'credentials'?: string;
+        };
     };
 };
 /** Starts a new job run for the given job */
@@ -2119,6 +2156,9 @@ declare type StartJobBuildParameters = {
 declare type StartJobBuildData = {
     /** Commit sha to build. If not provided, will build the most recent commit of the job's branch. Example: "262ed9817b3cad5142fbceabe0c9e371e390d616" */
     'sha'?: string;
+    'overrides'?: {
+        'buildArguments'?: any;
+    };
 };
 /** Start a new build for the given job. Given a commit sha, it will build that commit. */
 declare class StartJobBuildEndpoint extends PostApiEndpoint<StartJobBuildRequest, StartJobBuildResult> {
@@ -2204,6 +2244,8 @@ declare type UpdateJobBuildoptionsData = {
     'dockerfile': {
         /** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
         'buildEngine'?: 'kaniko' | 'buildkit';
+        /** Should intermediate image layers be cached? Only supported by Kaniko. */
+        'useCache'?: boolean;
         /** The file path of the Dockerfile. Example: "/Dockerfile" */
         'dockerFilePath'?: string;
         /** The working directory of the Dockerfile. Example: "/" */
@@ -2278,7 +2320,7 @@ declare type UpdateJobCmdoverrideParameters = {
 };
 declare type UpdateJobCmdoverrideData = {
     /** The CMD to run, or null to disable the override. Example: "nginx -g" */
-    'cmd': string;
+    'cmdOverride': string;
 };
 /** Sets the Docker CMD override for the given job. */
 declare class UpdateJobCmdoverrideEndpoint extends PostApiEndpoint<UpdateJobCmdoverrideRequest, UpdateJobCmdoverrideResult> {
@@ -3297,7 +3339,7 @@ declare type CreateSecretData = {
     /** A description of the secret. Example: "A description" */
     'description'?: string;
     /** The type of the created secret Example: "environment" */
-    'secretType': 'environment' | 'arguments';
+    'secretType': 'environment-arguments' | 'environment' | 'arguments';
     /** The priority with which different secrets will be merged. Example: 10 */
     'priority': number;
     /** Restriction settings of the secret */
@@ -3448,7 +3490,7 @@ declare type UpdateSecretData = {
         }[];
     }[];
     /** The type of the created secret Example: "environment" */
-    'secretType'?: 'environment' | 'arguments';
+    'secretType'?: 'environment-arguments' | 'environment' | 'arguments';
     /** Secret contents as JSON object, encrypted at rest. Keys must only contain letters and numbers separated with underscores, may not start with a number Example: {"NODE_ENV":"production","MONGO_DB":"some_connection_string"} */
     'data'?: any;
 };
@@ -3798,6 +3840,8 @@ declare type CreateServiceCombinedData = {
         'dockerfile': {
             /** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
             'buildEngine'?: 'kaniko' | 'buildkit';
+            /** Should intermediate image layers be cached? Only supported by Kaniko. */
+            'useCache'?: boolean;
             /** The file path of the Dockerfile. Example: "/Dockerfile" */
             'dockerFilePath': string;
             /** The working directory of the Dockerfile. Example: "/" */
@@ -4106,6 +4150,8 @@ declare type CreateServiceBuildData = {
         'dockerfile': {
             /** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
             'buildEngine'?: 'kaniko' | 'buildkit';
+            /** Should intermediate image layers be cached? Only supported by Kaniko. */
+            'useCache'?: boolean;
             /** The file path of the Dockerfile. Example: "/Dockerfile" */
             'dockerFilePath': string;
             /** The working directory of the Dockerfile. Example: "/" */
@@ -4640,6 +4686,8 @@ declare type UpdateServiceBuildoptionsData = {
     'dockerfile': {
         /** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
         'buildEngine'?: 'kaniko' | 'buildkit';
+        /** Should intermediate image layers be cached? Only supported by Kaniko. */
+        'useCache'?: boolean;
         /** The file path of the Dockerfile. Example: "/Dockerfile" */
         'dockerFilePath'?: string;
         /** The working directory of the Dockerfile. Example: "/" */
@@ -4726,7 +4774,7 @@ declare type UpdateServiceCmdoverrideParameters = {
 };
 declare type UpdateServiceCmdoverrideData = {
     /** The CMD to run, or null to disable the override. Example: "nginx -g" */
-    'cmd': string;
+    'cmdOverride': string;
 };
 /** Sets the Docker CMD override for the given service. */
 declare class UpdateServiceCmdoverrideEndpoint extends PostApiEndpoint<UpdateServiceCmdoverrideRequest, UpdateServiceCmdoverrideResult> {
@@ -4907,6 +4955,9 @@ declare type StartServiceBuildData = {
     'branch'?: string;
     /** ID of a pull request to build from. If `sha` is not provided, the latest commit of this pull request will be built. Only supported by build services. Build services require either `branch` or `pullRequestId` field, but cannot be provided with both. */
     'pullRequestId'?: number;
+    'overrides'?: {
+        'buildArguments'?: any;
+    };
 };
 /** Start a new build for the given combined or build service. If given a commit sha, it will build that commit. Otherwise, the most recent relevant commit will be built. If the service provided is a build service, a branch name or pull request to build from is required. */
 declare class StartServiceBuildEndpoint extends PostApiEndpoint<StartServiceBuildRequest, StartServiceBuildResult> {