@northflank/js-client 0.7.0 → 0.7.1-beta.0

package/dist/esm/endpoints/create/service/build.d.ts

@@ -1,161 +0,0 @@
-import { ApiCallResponse, PostApiEndpoint } from '../../../api-endpoint';
-export declare type CreateServiceBuildResult = {
-    /** Identifier for the service Example: "example-service" */
-    'id': string;
-    /** Full identifier used for service deployment Example: "/example-user/default-project/example-service" */
-    'appId': string;
-    /** Service name Example: "Example Service" */
-    'name': string;
-    /** A short description of the service Example: "This is the service description" */
-    'description'?: string;
-    /** ID of the project that the service belongs to Example: "default-project" */
-    'projectId': string;
-    /** The time the service was created. Example: "2021-01-20T11:19:53.175Z" */
-    'createdAt': string;
-    /** Whether Continuous Integration is disabled */
-    'disabledCI': boolean;
-    /** Whether Continuous Deployment is disabled */
-    'disabledCD': boolean;
-    'billing': {
-        /** ID of the billing plan used by this service Example: "nf-compute-20" */
-        'deploymentPlan': string;
-    };
-    /** Details about the current service status. */
-    'status': {
-        /** Details about the status of the most recent build. */
-        'build'?: {
-            /** The current status of the build. Example: "SUCCESS" */
-            'status': 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUCCESS' | 'CRASHED';
-            /** The timestamp of when the build reached this status. Example: "2021-11-29T11:47:16.624Z" */
-            'lastTransitionTime'?: string;
-        };
-        /** Details about the current deployment status. */
-        'deployment'?: {
-            /** The current status of the deployment. Example: "COMPLETED" */
-            'status': 'IN_PROGRESS' | 'COMPLETED';
-            /** The reason the current deployment was started. Example: "DEPLOYING" */
-            'reason': 'SCALING' | 'DEPLOYING';
-            /** The timestamp of when the deployment reached this status. Example: "2021-11-29T11:47:16.624Z" */
-            'lastTransitionTime'?: string;
-        };
-    };
-    /** Is the service paused? */
-    'servicePaused': boolean;
-    /** Type of the service (combined, build or deployment) Example: "build" */
-    'serviceType': 'combined' | 'build' | 'deployment';
-    'vcsData'?: {
-        /** URL of the repository being built Example: "https://github.com/northflank/gatsby-with-northflank" */
-        'projectUrl': string;
-        /** VCS provider for the repo being built Example: "github" */
-        'projectType': 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
-        /** ID of the self-hosted VCS, if applicable. Example: "example-team/self-hosted-vcs" */
-        'selfHostedVcsId'?: string;
-        /** Branch of the repo being built Example: "master" */
-        'projectBranch'?: string;
-        /** Whether the repo is being accessed without authentication. */
-        'publicRepo'?: boolean;
-        /** Working directory used by the dockerfile Example: "/" */
-        'dockerWorkDir': string;
-        /** File path of the Dockerfile Example: "/Dockerfile" */
-        'dockerFilePath': string;
-    };
-    'buildConfiguration'?: {
-        'branchRestrictions'?: string[];
-        'prRestrictions'?: string[];
-        'pathIgnoreRules': string[];
-    };
-    'buildEngineConfiguration': {
-        /** The build engine used. Example: "buildpack" */
-        'buildEngine'?: 'buildpack' | 'kaniko' | 'buildkit';
-        /** Details about Buildpack settings. */
-        'buildpack'?: {
-            /** The Buildpack stack used. Example: "HEROKU_20" */
-            'builder'?: 'HEROKU_20' | 'HEROKU_18' | 'GOOGLE_V1' | 'CNB_ALPINE' | 'CNB_BIONIC' | 'PAKETO_TINY' | 'PAKETO_BASE' | 'PAKETO_FULL';
-            /** Array of custom Buildpacks used. */
-            'buildpackLocators'?: string[];
-            /** Should build dependencies be cached? */
-            'useCache'?: boolean;
-        };
-        /** Details about Buildkit settings. */
-        'buildkit'?: {
-            /** Should intermediate image layers be cached? */
-            'useCache'?: boolean;
-        };
-        /** Details about Kaniko settings. */
-        'kaniko'?: {
-            /** Should intermediate image layers be cached? */
-            'useCache'?: boolean;
-        };
-    };
-} | any;
-export declare type CreateServiceBuildCall = (opts: CreateServiceBuildRequest) => Promise<ApiCallResponse<CreateServiceBuildResult>>;
-export declare type CreateServiceBuildRequest = {
-    parameters: CreateServiceBuildParameters;
-    data: CreateServiceBuildData;
-};
-export declare type CreateServiceBuildParameters = {
-    /** ID of the project */ 'projectId': string;
-};
-export declare type CreateServiceBuildData = {
-    /** The name of the service. Example: "Example Service" */
-    'name': string;
-    /** A description of the service. Example: "A service description" */
-    'description'?: string;
-    'billing': {
-        /** The ID of the deployment plan to use. Example: "nf-compute-20" */
-        'deploymentPlan': string;
-    };
-    'vcsData': {
-        /** URL of the Git repo to build. Example: "https://github.com/northflank/gatsby-with-northflank" */
-        'projectUrl': string;
-        /** The VCS provider to use. Example: "github" */
-        'projectType': 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
-        /** If projectType is self-hosted, the ID of the self-hosted vcs to use. */
-        'selfHostedVcsId'?: string;
-        /** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
-        'accountLogin'?: string;
-    };
-    'buildSettings': {
-        'dockerfile': {
-            /** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
-            'buildEngine'?: 'kaniko' | 'buildkit';
-            /** Should intermediate image layers be cached? */
-            'useCache'?: boolean;
-            /** The file path of the Dockerfile. Example: "/Dockerfile" */
-            'dockerFilePath': string;
-            /** The working directory of the Dockerfile. Example: "/" */
-            'dockerWorkDir': string;
-        };
-    } | {
-        'buildpack': {
-            /** Buildpack stack to use. Defaults to recommended stack `HEROKU_20`. Example: "HEROKU_20" */
-            'builder'?: 'HEROKU_20' | 'HEROKU_18' | 'GOOGLE_V1' | 'CNB_ALPINE' | 'CNB_BIONIC' | 'PAKETO_TINY' | 'PAKETO_BASE' | 'PAKETO_FULL';
-            /** Array of custom Buildpacks to use. */
-            'buildpackLocators'?: string[];
-            /** The working directory to build in. Example: "/" */
-            'buildContext'?: string;
-            /** Should build dependencies be cached? */
-            'useCache'?: boolean;
-        };
-    };
-    'buildConfiguration'?: {
-        /** 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. */
-        'prRestrictions'?: string[];
-        /** An array of branch build rules. Only supported for build services. Each commit belonging to a branch that matches one of the provided build rules will be built automatically. */
-        'branchRestrictions'?: string[];
-        /** 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[];
-    };
-    /** An object containing the build arguments to set for the service Example: {"ARGUMENT_1":"abcdef","ARGUMENT_2":"12345"} */
-    'buildArguments'?: any;
-    /** Secret files as JSON object, encrypted at rest. File path must be absolute Example: {"/dir/fileName":{"data":"VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=","encoding":"utf-8"}} */
-    'buildFiles'?: any;
-};
-/** Creates a new build service. */
-export declare class CreateServiceBuildEndpoint extends PostApiEndpoint<CreateServiceBuildRequest, CreateServiceBuildResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: CreateServiceBuildRequest) => string;
-    body: (payload: CreateServiceBuildRequest) => string;
-}

package/dist/esm/endpoints/create/service/combined.d.ts

@@ -1,255 +0,0 @@
-import { ApiCallResponse, PostApiEndpoint } from '../../../api-endpoint';
-export declare type CreateServiceCombinedResult = {
-    /** Identifier for the service Example: "example-service" */
-    'id': string;
-    /** Full identifier used for service deployment Example: "/example-user/default-project/example-service" */
-    'appId': string;
-    /** Service name Example: "Example Service" */
-    'name': string;
-    /** A short description of the service Example: "This is the service description" */
-    'description'?: string;
-    /** ID of the project that the service belongs to Example: "default-project" */
-    'projectId': string;
-    /** The time the service was created. Example: "2021-01-20T11:19:53.175Z" */
-    'createdAt': string;
-    /** Whether Continuous Integration is disabled */
-    'disabledCI': boolean;
-    /** Whether Continuous Deployment is disabled */
-    'disabledCD': boolean;
-    'billing': {
-        /** ID of the billing plan used by this service Example: "nf-compute-20" */
-        'deploymentPlan': string;
-    };
-    /** Details about the current service status. */
-    'status': {
-        /** Details about the status of the most recent build. */
-        'build'?: {
-            /** The current status of the build. Example: "SUCCESS" */
-            'status': 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUCCESS' | 'CRASHED';
-            /** The timestamp of when the build reached this status. Example: "2021-11-29T11:47:16.624Z" */
-            'lastTransitionTime'?: string;
-        };
-        /** Details about the current deployment status. */
-        'deployment'?: {
-            /** The current status of the deployment. Example: "COMPLETED" */
-            'status': 'IN_PROGRESS' | 'COMPLETED';
-            /** The reason the current deployment was started. Example: "DEPLOYING" */
-            'reason': 'SCALING' | 'DEPLOYING';
-            /** The timestamp of when the deployment reached this status. Example: "2021-11-29T11:47:16.624Z" */
-            'lastTransitionTime'?: string;
-        };
-    };
-    /** Is the service paused? */
-    'servicePaused': boolean;
-    /** Type of the service (combined, build or deployment) Example: "combined" */
-    'serviceType': 'combined' | 'build' | 'deployment';
-    'vcsData'?: {
-        /** URL of the repository being built Example: "https://github.com/northflank/gatsby-with-northflank" */
-        'projectUrl': string;
-        /** VCS provider for the repo being built Example: "github" */
-        'projectType': 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
-        /** ID of the self-hosted VCS, if applicable. Example: "example-team/self-hosted-vcs" */
-        'selfHostedVcsId'?: string;
-        /** Branch of the repo being built Example: "master" */
-        'projectBranch'?: string;
-        /** Whether the repo is being accessed without authentication. */
-        'publicRepo'?: boolean;
-        /** Working directory used by the dockerfile Example: "/" */
-        'dockerWorkDir': string;
-        /** File path of the Dockerfile Example: "/Dockerfile" */
-        'dockerFilePath': string;
-    };
-    'deployment'?: {
-        /** Region where this service is deployed and/or built Example: "europe-west" */
-        'region'?: string;
-        /** Number of instances/replicas running Example: 1 */
-        'instances'?: number;
-        'internal'?: {
-            /** Database ID of deployed entity Example: "example-service" */
-            'nfObjectId': string;
-            /** Type of deployed entity Example: "service" */
-            'nfObjectType': 'service';
-            /** URL of the repository being deployed Example: "https://github.com/northflank/gatsby-with-northflank" */
-            'repository': string;
-            /** Branch of the repo being deployed Example: "master" */
-            'branch': string;
-            /** Commit SHA to be deployed. `latest` means the latest commit is automatically being deployed. Example: "latest" */
-            'buildSHA': string;
-            /** Currently deployed commit SHA. If buildSHA is set to `latest`, this will show the SHA of the latest commit. Example: "262ed9817b3cad5142fbceabe0c9e371e390d616" */
-            'deployedSHA'?: string;
-        };
-    };
-    '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[];
-    };
-    'buildEngineConfiguration': {
-        /** The build engine used. Example: "buildpack" */
-        'buildEngine'?: 'buildpack' | 'kaniko' | 'buildkit';
-        /** Details about Buildpack settings. */
-        'buildpack'?: {
-            /** The Buildpack stack used. Example: "HEROKU_20" */
-            'builder'?: 'HEROKU_20' | 'HEROKU_18' | 'GOOGLE_V1' | 'CNB_ALPINE' | 'CNB_BIONIC' | 'PAKETO_TINY' | 'PAKETO_BASE' | 'PAKETO_FULL';
-            /** Array of custom Buildpacks used. */
-            'buildpackLocators'?: string[];
-            /** Should build dependencies be cached? */
-            'useCache'?: boolean;
-        };
-        /** Details about Buildkit settings. */
-        'buildkit'?: {
-            /** Should intermediate image layers be cached? */
-            'useCache'?: boolean;
-        };
-        /** Details about Kaniko settings. */
-        'kaniko'?: {
-            /** Should intermediate image layers be cached? */
-            'useCache'?: boolean;
-        };
-    };
-    /** Whether the service will be built immediately Example: true */
-    'buildInitiated': boolean;
-    /** The ID of the initial build of the service. Example: "joyous-view-6290" */
-    'buildId'?: string;
-} | any;
-export declare type CreateServiceCombinedCall = (opts: CreateServiceCombinedRequest) => Promise<ApiCallResponse<CreateServiceCombinedResult>>;
-export declare type CreateServiceCombinedRequest = {
-    parameters: CreateServiceCombinedParameters;
-    data: CreateServiceCombinedData;
-};
-export declare type CreateServiceCombinedParameters = {
-    /** ID of the project */ 'projectId': string;
-};
-export declare type CreateServiceCombinedData = {
-    /** The name of the service. Example: "Example Service" */
-    'name': string;
-    /** A description of the service. Example: "A service description" */
-    'description'?: string;
-    'billing': {
-        /** The ID of the deployment plan to use. Example: "nf-compute-20" */
-        'deploymentPlan': string;
-    };
-    'deployment': {
-        /** The number of instances to run the service on. Example: 1 */
-        'instances': number;
-        /** If set, the service runs a custom command rather than one defined in the Dockerfile. Example: "nginx -g" */
-        'cmdOverride'?: string;
-        /** If set, the service runs a custom entrypoint rather than one defined in the Dockerfile. Example: "/custom-entrypoint.sh" */
-        'entrypointOverride'?: string;
-        'storage'?: {
-            'ephemeralStorage'?: {
-                /** Ephemeral storage per container in MB Example: 1024 */
-                'storageSize'?: number;
-            };
-        };
-    };
-    'ports'?: {
-        /** The name used to identify the port. Example: "port-1" */
-        'name': string;
-        /** The port number. Example: 8080 */
-        'internalPort': number;
-        /** If true, the port will be exposed publicly. Example: true */
-        'public'?: boolean;
-        'security'?: {
-            /** An array of credentials to access the service. */
-            'credentials'?: {
-                /** The username to access the service Example: "admin" */
-                'username': string;
-                /** The password to access the service with this username. Example: "password123" */
-                'password': string;
-                /** The type of authentication used Example: "basic-auth" */
-                'type': 'basic-auth';
-            }[];
-            /** An array of IP address policies. */
-            'policies'?: {
-                /** An array of IP addresses used for this rule */
-                'addresses': string[];
-                /** The action for this rule. Example: "DENY" */
-                'action': 'ALLOW' | 'DENY';
-            }[];
-        };
-        /** An array of domains to redirect to this port. Each domain must first be verified and registered to your account. */
-        'domains'?: string[];
-        /** Disable routing on the default code.run domain for public HTTP ports with custom domains. */
-        'disableNfDomain'?: boolean;
-        /** The protocol to use for the port. Example: "HTTP" */
-        'protocol': 'HTTP' | 'HTTP/2' | 'TCP' | 'UDP';
-    }[];
-    'vcsData': {
-        /** URL of the Git repo to build. Example: "https://github.com/northflank/gatsby-with-northflank" */
-        'projectUrl': string;
-        /** The VCS provider to use. Example: "github" */
-        'projectType': 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
-        /** If projectType is self-hosted, the ID of the self-hosted vcs to use. */
-        'selfHostedVcsId'?: string;
-        /** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
-        'accountLogin'?: string;
-        /** The name of the branch to use. Example: "master" */
-        'projectBranch': string;
-    };
-    'buildSettings': {
-        'dockerfile': {
-            /** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
-            'buildEngine'?: 'kaniko' | 'buildkit';
-            /** Should intermediate image layers be cached? */
-            'useCache'?: boolean;
-            /** The file path of the Dockerfile. Example: "/Dockerfile" */
-            'dockerFilePath': string;
-            /** The working directory of the Dockerfile. Example: "/" */
-            'dockerWorkDir': string;
-        };
-    } | {
-        'buildpack': {
-            /** Buildpack stack to use. Defaults to recommended stack `HEROKU_20`. Example: "HEROKU_20" */
-            'builder'?: 'HEROKU_20' | 'HEROKU_18' | 'GOOGLE_V1' | 'CNB_ALPINE' | 'CNB_BIONIC' | 'PAKETO_TINY' | 'PAKETO_BASE' | 'PAKETO_FULL';
-            /** Array of custom Buildpacks to use. */
-            'buildpackLocators'?: string[];
-            /** The working directory to build in. Example: "/" */
-            'buildContext'?: string;
-            /** Should build dependencies be cached? */
-            'useCache'?: boolean;
-        };
-    };
-    '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[];
-    };
-    /** An object containing the runtime environment to set for the service. 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;
-    /** Secret files as JSON object, encrypted at rest. File path must be absolute Example: {"/dir/fileName":{"data":"VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=","encoding":"utf-8"}} */
-    'runtimeFiles'?: any;
-    /** An object containing the build arguments to set for the service. Keys must only contain letters and numbers separated with underscores, may not start with a number Example: {"ARGUMENT_1":"abcdef","ARGUMENT_2":"12345"} */
-    'buildArguments'?: any;
-    /** Secret files as JSON object, encrypted at rest. File path must be absolute Example: {"/dir/fileName":{"data":"VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=","encoding":"utf-8"}} */
-    'buildFiles'?: any;
-    /** An array of health checks. */
-    'healthChecks'?: {
-        /** The protocol to access the health check with. Example: "HTTP" */
-        'protocol': 'HTTP' | 'CMD' | 'TCP';
-        /** The type of health check. Example: "readinessProbe" */
-        'type': 'livenessProbe' | 'readinessProbe' | 'startupProbe';
-        /** The path of the health check endpoint. Required when protocol is HTTP. Example: "/health-check" */
-        'path'?: string;
-        /** The command to run for the health check. Required when protocol is CMD */
-        'cmd'?: string;
-        /** Port number for the health check endpoint. Required when protocol is HTTP. Example: 8080 */
-        'port'?: number;
-        /** Initial delay, in seconds, before the health check is first run. Example: 10 */
-        'initialDelaySeconds': number;
-        /** The time between each check, in seconds. Example: 60 */
-        'periodSeconds': number;
-        /** The time to wait for a response before marking the health check as a failure. Example: 1 */
-        'timeoutSeconds': number;
-        /** The maximum number of allowed failures. Example: 3 */
-        'failureThreshold': number;
-        /** The number of successes required to mark the health check as a success. Example: 1 */
-        'successThreshold'?: number;
-    }[];
-};
-/** Creates a new combined service. */
-export declare class CreateServiceCombinedEndpoint extends PostApiEndpoint<CreateServiceCombinedRequest, CreateServiceCombinedResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: CreateServiceCombinedRequest) => string;
-    body: (payload: CreateServiceCombinedRequest) => string;
-}

package/dist/esm/endpoints/create/service/deployment.d.ts

@@ -1,242 +0,0 @@
-import { ApiCallResponse, PostApiEndpoint } from '../../../api-endpoint';
-export declare type CreateServiceDeploymentResult = {
-    /** Identifier for the service Example: "example-service" */
-    'id': string;
-    /** Full identifier used for service deployment Example: "/example-user/default-project/example-service" */
-    'appId': string;
-    /** Service name Example: "Example Service" */
-    'name': string;
-    /** A short description of the service Example: "This is the service description" */
-    'description'?: string;
-    /** ID of the project that the service belongs to Example: "default-project" */
-    'projectId': string;
-    /** The time the service was created. Example: "2021-01-20T11:19:53.175Z" */
-    'createdAt': string;
-    /** Whether Continuous Integration is disabled */
-    'disabledCI': boolean;
-    /** Whether Continuous Deployment is disabled */
-    'disabledCD': boolean;
-    'billing': {
-        /** ID of the billing plan used by this service Example: "nf-compute-20" */
-        'deploymentPlan': string;
-    };
-    /** Details about the current service status. */
-    'status': {
-        /** Details about the status of the most recent build. */
-        'build'?: {
-            /** The current status of the build. Example: "SUCCESS" */
-            'status': 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUCCESS' | 'CRASHED';
-            /** The timestamp of when the build reached this status. Example: "2021-11-29T11:47:16.624Z" */
-            'lastTransitionTime'?: string;
-        };
-        /** Details about the current deployment status. */
-        'deployment'?: {
-            /** The current status of the deployment. Example: "COMPLETED" */
-            'status': 'IN_PROGRESS' | 'COMPLETED';
-            /** The reason the current deployment was started. Example: "DEPLOYING" */
-            'reason': 'SCALING' | 'DEPLOYING';
-            /** The timestamp of when the deployment reached this status. Example: "2021-11-29T11:47:16.624Z" */
-            'lastTransitionTime'?: string;
-        };
-    };
-    /** Is the service paused? */
-    'servicePaused': boolean;
-    /** Type of the service (combined, build or deployment) Example: "deployment" */
-    'serviceType': 'combined' | 'build' | 'deployment';
-    'deployment'?: {
-        /** Region where this service is deployed and/or built Example: "europe-west" */
-        'region'?: string;
-        /** Number of instances/replicas running Example: 1 */
-        'instances'?: number;
-        /** Data about a deployment from an external registry. */
-        'external'?: {
-            /** Path of the external image excluding the hostname */
-            'imagePath': string;
-            /** Registry provider hosting the external image */
-            'registryProvider': 'dockerhub' | 'gcr' | 'gcr-eu' | 'gcr-us' | 'gitlab' | 'github' | 'custom';
-            /** Does the image require authentication */
-            'privateImage': boolean;
-        };
-        'internal'?: {
-            /** Database ID of deployed entity Example: "example-service" */
-            'nfObjectId': string;
-            /** Type of deployed entity Example: "service" */
-            'nfObjectType': 'service';
-            /** URL of the repository being deployed Example: "https://github.com/northflank/gatsby-with-northflank" */
-            'repository': string;
-            /** Branch of the repo being deployed Example: "master" */
-            'branch': string;
-            /** Commit SHA to be deployed. `latest` means the latest commit is automatically being deployed. Example: "latest" */
-            'buildSHA': string;
-            /** Currently deployed commit SHA. If buildSHA is set to `latest`, this will show the SHA of the latest commit. Example: "262ed9817b3cad5142fbceabe0c9e371e390d616" */
-            'deployedSHA'?: string;
-        };
-        /** Details about the Docker overrides for this deployment. */
-        'docker'?: {
-            /** Details about the CMD override for this deployment. */
-            'cmd': {
-                /** Whether the CMD override is enabled. Example: true */
-                'enabled': boolean;
-                /** The CMD to run instead of the default if CMD override is enabled. Example: "nginx -g" */
-                'value': string;
-            };
-            /** Details about the entrypoint override for this deployment. */
-            'entrypoint': {
-                /** Whether the entrypoint override is enabled. Example: true */
-                'enabled': boolean;
-                /** The CMD to run instead of the default if entrypoint override is enabled. Example: "/docker-entrypoint.sh" */
-                'value': string;
-            };
-        };
-        /** Details about storage settings for this deployment. */
-        'storage'?: {
-            /** Details about ephemeral storage settings for this deployment. */
-            'ephemeralStorage'?: {
-                /** Ephemeral storage per container in MB Example: 1024 */
-                'storageSize': number;
-            };
-        };
-    };
-} | any;
-export declare type CreateServiceDeploymentCall = (opts: CreateServiceDeploymentRequest) => Promise<ApiCallResponse<CreateServiceDeploymentResult>>;
-export declare type CreateServiceDeploymentRequest = {
-    parameters: CreateServiceDeploymentParameters;
-    data: CreateServiceDeploymentData;
-};
-export declare type CreateServiceDeploymentParameters = {
-    /** ID of the project */ 'projectId': string;
-};
-export declare type CreateServiceDeploymentData = {
-    /** The name of the service. Example: "Example Service" */
-    'name': string;
-    /** A description of the service. Example: "A service description" */
-    'description'?: string;
-    'billing': {
-        /** The ID of the deployment plan to use. Example: "nf-compute-20" */
-        'deploymentPlan': string;
-    };
-    /** Deployment type */
-    'deployment': {
-        /** The number of instances to run the service on. Example: 1 */
-        'instances': number;
-        /** If set, the service runs a custom command rather than one defined in the Dockerfile. Example: "nginx -g" */
-        'cmdOverride'?: string;
-        /** If set, the service runs a custom entrypoint rather than one defined in the Dockerfile. Example: "/custom-entrypoint.sh" */
-        'entrypointOverride'?: string;
-        'storage'?: {
-            'ephemeralStorage'?: {
-                /** Ephemeral storage per container in MB Example: 1024 */
-                'storageSize'?: number;
-            };
-        };
-        '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'?: string | 'latest';
-            /** ID of the build that should be deployed Example: "premium-guide-6393" */
-            'buildId'?: string;
-        };
-    } | {
-        /** The number of instances to run the service on. Example: 1 */
-        'instances': number;
-        /** If set, the service runs a custom command rather than one defined in the Dockerfile. Example: "nginx -g" */
-        'cmdOverride'?: string;
-        /** If set, the service runs a custom entrypoint rather than one defined in the Dockerfile. Example: "/custom-entrypoint.sh" */
-        'entrypointOverride'?: string;
-        'storage'?: {
-            'ephemeralStorage'?: {
-                /** Ephemeral storage per container in MB Example: 1024 */
-                'storageSize'?: number;
-            };
-        };
-        '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;
-        };
-    } | {
-        /** The number of instances to run the service on. Example: 1 */
-        'instances': number;
-        /** If set, the service runs a custom command rather than one defined in the Dockerfile. Example: "nginx -g" */
-        'cmdOverride'?: string;
-        /** If set, the service runs a custom entrypoint rather than one defined in the Dockerfile. Example: "/custom-entrypoint.sh" */
-        'entrypointOverride'?: string;
-        'storage'?: {
-            'ephemeralStorage'?: {
-                /** Ephemeral storage per container in MB Example: 1024 */
-                'storageSize'?: number;
-            };
-        };
-    };
-    'ports'?: {
-        /** The name used to identify the port. Example: "port-1" */
-        'name': string;
-        /** The port number. Example: 8080 */
-        'internalPort': number;
-        /** If true, the port will be exposed publicly. Example: true */
-        'public'?: boolean;
-        'security'?: {
-            /** An array of credentials to access the service. */
-            'credentials'?: {
-                /** The username to access the service Example: "admin" */
-                'username': string;
-                /** The password to access the service with this username. Example: "password123" */
-                'password': string;
-                /** The type of authentication used Example: "basic-auth" */
-                'type': 'basic-auth';
-            }[];
-            /** An array of IP address policies. */
-            'policies'?: {
-                /** An array of IP addresses used for this rule */
-                'addresses': string[];
-                /** The action for this rule. Example: "DENY" */
-                'action': 'ALLOW' | 'DENY';
-            }[];
-        };
-        /** An array of domains to redirect to this port. Each domain must first be verified and registered to your account. */
-        'domains'?: string[];
-        /** Disable routing on the default code.run domain for public HTTP ports with custom domains. */
-        'disableNfDomain'?: boolean;
-        /** The protocol to use for the port. Example: "HTTP" */
-        'protocol': 'HTTP' | 'HTTP/2' | 'TCP' | 'UDP';
-    }[];
-    /** An object containing the runtime environment to set for the service Example: {"VARIABLE_1":"abcdef","VARIABLE_2":"12345"} */
-    'runtimeEnvironment'?: any;
-    /** Secret files as JSON object, encrypted at rest. File path must be absolute Example: {"/dir/fileName":{"data":"VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=","encoding":"utf-8"}} */
-    'runtimeFiles'?: any;
-    /** An array of health checks. */
-    'healthChecks'?: {
-        /** The protocol to access the health check with. Example: "HTTP" */
-        'protocol': 'HTTP' | 'CMD' | 'TCP';
-        /** The type of health check. Example: "readinessProbe" */
-        'type': 'livenessProbe' | 'readinessProbe' | 'startupProbe';
-        /** The path of the health check endpoint. Required when protocol is HTTP. Example: "/health-check" */
-        'path'?: string;
-        /** The command to run for the health check. Required when protocol is CMD */
-        'cmd'?: string;
-        /** Port number for the health check endpoint. Required when protocol is HTTP. Example: 8080 */
-        'port'?: number;
-        /** Initial delay, in seconds, before the health check is first run. Example: 10 */
-        'initialDelaySeconds': number;
-        /** The time between each check, in seconds. Example: 60 */
-        'periodSeconds': number;
-        /** The time to wait for a response before marking the health check as a failure. Example: 1 */
-        'timeoutSeconds': number;
-        /** The maximum number of allowed failures. Example: 3 */
-        'failureThreshold': number;
-        /** The number of successes required to mark the health check as a success. Example: 1 */
-        'successThreshold'?: number;
-    }[];
-};
-/** Creates a new deployment service. */
-export declare class CreateServiceDeploymentEndpoint extends PostApiEndpoint<CreateServiceDeploymentRequest, CreateServiceDeploymentResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: CreateServiceDeploymentRequest) => string;
-    body: (payload: CreateServiceDeploymentRequest) => string;
-}