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

package/dist/cjs/endpoints/create/cluster.d.ts

@@ -1,97 +0,0 @@
-import { ApiCallResponse, PostApiEndpoint } from '../../api-endpoint';
-export declare type CreateClusterResult = {
-    /** Identifier for the cluster. Example: "gcp-cluster-1" */
-    'id': string;
-    /** The name of the cluster. Example: "GCP Cluster 1" */
-    'name': string;
-    /** A short description of the cluster. Example: "The cluster description" */
-    'description'?: string;
-    /** The cloud provider to which this cluster belongs to. Example: "gcp" */
-    'provider'?: string;
-    /** ID of the provider integration used by this cluster. Example: "gcp-integration" */
-    'integrationId': string;
-    'nodePools': {
-        'availabilityZones'?: string[];
-        'nodeTypes': string[];
-        'nodeCount': number;
-        'autoscaling'?: {
-            'enabled'?: boolean;
-            'min'?: number;
-            'max'?: number;
-        };
-        /** Configures node pool with preemptible / spot instances if enabled. */
-        'preemptible'?: boolean;
-        'diskType'?: string;
-        'diskSize': number;
-        /** ID of existing node pool. Must be passed when modifying existing node pools. Not relevant for new node pools Example: "6aa96121-0345-43ad-bade-af36d540c222" */
-        'id'?: string;
-    };
-    'status'?: {
-        'state'?: {
-            'state'?: string;
-            'transitionTime'?: string;
-        };
-        'nextUpdateAfter'?: string;
-    };
-    /** The time the cluster was created. Example: "2021-01-20T11:19:53.175Z" */
-    'createdAt': string;
-    /** Indicates if provider resource deletion has been requested by the user. */
-    'deletionRequested': boolean;
-};
-export declare type CreateClusterCall = (opts: CreateClusterRequest) => Promise<ApiCallResponse<CreateClusterResult>>;
-export declare type CreateClusterRequest = {
-    data: CreateClusterData;
-};
-export declare type CreateClusterData = {
-    /** The name of the cluster. Example: "GCP Cluster 1" */
-    'name': string;
-    /** The description of the cluster. Example: "This is a new cluster." */
-    'description'?: string;
-    /** Cloud provider to be used for the selected resource Example: "gcp" */
-    'provider': 'gcp' | 'aws' | 'azure' | 'do';
-    /** Region of the cluster. */
-    'region': string;
-    /** Kubernetes version of the cluster. */
-    'kubernetesVersion': string;
-    /** Existing integration to use for this cluster. Example: "gcp-integration" */
-    'integrationId'?: string;
-    /** Cloud provider credential input, required fields dependent on which provider is chosen. */
-    'integration'?: {
-        /** Contents of a GCP key file. */
-        'keyfileJson'?: string;
-        /** AWS access key. */
-        'accessKey'?: string;
-        /** AWS secret key. */
-        'secretKey'?: string;
-        /** DO API key. */
-        'apiKey'?: string;
-    };
-    /** An array of node pools. */
-    'nodePools': {
-        'availabilityZones'?: string[];
-        'nodeTypes': string[];
-        'nodeCount': number;
-        'autoscaling'?: {
-            'enabled'?: boolean;
-            'min'?: number;
-            'max'?: number;
-        };
-        /** Configures node pool with preemptible / spot instances if enabled. */
-        'preemptible'?: boolean;
-        'diskType'?: string;
-        'diskSize': number;
-    }[];
-    /** GCP specific data. Required when `provider` is `gcp`. */
-    'gcp'?: {
-        /** Project ID */
-        'projectId': string;
-    };
-};
-/** Creates a new cluster. */
-export declare class CreateClusterEndpoint extends PostApiEndpoint<CreateClusterRequest, CreateClusterResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: CreateClusterRequest) => string;
-    body: (payload: CreateClusterRequest) => string;
-}

package/dist/cjs/endpoints/create/domain.d.ts

@@ -1,27 +0,0 @@
-import { ApiCallResponse, PostApiEndpoint } from '../../api-endpoint';
-export declare type CreateDomainResult = {
-    /** The domain name. Example: "example.com" */
-    'name': string;
-    /** The status of the domain verification. Example: "pending" */
-    'status': 'pending' | 'verified';
-    /** The hostname to add to your domain's DNS records as a TXT record to verify the domain. Example: "nfverify1608026055" */
-    'hostname': string;
-    /** The token to add as the content of the TXT record to verify the domain. Example: "e596987b52855a4a773ef580ce2985d7746b37ce8b2a443d20fa27b913d8f57" */
-    'token': string;
-} | any;
-export declare type CreateDomainCall = (opts: CreateDomainRequest) => Promise<ApiCallResponse<CreateDomainResult>>;
-export declare type CreateDomainRequest = {
-    data: CreateDomainData;
-};
-export declare type CreateDomainData = {
-    /** The domain name to register. Example: "example.com" */
-    'domain': string;
-};
-/** Registers a new domain */
-export declare class CreateDomainEndpoint extends PostApiEndpoint<CreateDomainRequest, CreateDomainResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: CreateDomainRequest) => string;
-    body: (payload: CreateDomainRequest) => string;
-}

package/dist/cjs/endpoints/create/integration.d.ts

@@ -1,58 +0,0 @@
-import { ApiCallResponse, PostApiEndpoint } from '../../api-endpoint';
-export declare type CreateIntegrationResult = {
-    /** Identifier for the integration. Example: "gcp-integration" */
-    'id': string;
-    /** The name of the integration. Example: "GCP integration" */
-    'name': string;
-    /** A short description of the integration. Example: "The integration description" */
-    'description'?: string;
-    /** Cloud provider credential input, required fields dependent on which provider is chosen. */
-    'credentials': {
-        /** Contents of a GCP key file. */
-        'keyfileJson'?: string;
-        /** AWS access key. */
-        'accessKey'?: string;
-        /** AWS secret key. */
-        'secretKey'?: string;
-        /** DO API key. */
-        'apiKey'?: string;
-    };
-    /** The time the integration was created. Example: "2021-01-20T11:19:53.175Z" */
-    'createdAt': string;
-};
-export declare type CreateIntegrationCall = (opts: CreateIntegrationRequest) => Promise<ApiCallResponse<CreateIntegrationResult>>;
-export declare type CreateIntegrationRequest = {
-    data: CreateIntegrationData;
-};
-export declare type CreateIntegrationData = {
-    /** The name of the cloud provider integration. Example: "New Integration" */
-    'name': string;
-    /** The description of the integration. Example: "This is a new cloud provider integration." */
-    'description'?: string;
-    /** Cloud provider to be used for the selected resource Example: "gcp" */
-    'provider': 'gcp' | 'aws' | 'azure' | 'do';
-    /** Cloud provider credential input, required fields dependent on which provider is chosen. */
-    'credentials': {
-        /** Contents of a GCP key file. */
-        'keyfileJson'?: string;
-        /** AWS access key. */
-        'accessKey'?: string;
-        /** AWS secret key. */
-        'secretKey'?: string;
-        /** DO API key. */
-        'apiKey'?: string;
-    };
-    /** GCP specific data. Required when `provider` is `gcp`. */
-    'gcp'?: {
-        /** Project ID */
-        'projectId': string;
-    };
-};
-/** Creates a new integration. */
-export declare class CreateIntegrationEndpoint extends PostApiEndpoint<CreateIntegrationRequest, CreateIntegrationResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: CreateIntegrationRequest) => string;
-    body: (payload: CreateIntegrationRequest) => string;
-}

package/dist/cjs/endpoints/create/job/cron.d.ts

@@ -1,247 +0,0 @@
-import { ApiCallResponse, PostApiEndpoint } from '../../../api-endpoint';
-export declare type CreateJobCronResult = {
-    /** Identifier for the job Example: "example-job" */
-    'id': string;
-    /** Full identifier used for job deployment Example: "/example-user/default-project/example-job" */
-    'appId': string;
-    /** Job name Example: "Example Job" */
-    'name': string;
-    /** A short description of the job Example: "This is the job description" */
-    'description'?: string;
-    /** ID of the project that the job belongs to Example: "default-project" */
-    'projectId': string;
-    /** The time the job was created. Example: "2021-01-20T11:19:53.175Z" */
-    'createdAt': string;
-    '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'?: {
-        /** 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 Continuous Integration is disabled */
-    'disabledCI': boolean;
-    /** Whether Continuous Deployment is disabled */
-    'disabledCD': boolean;
-    'deployment'?: {
-        /** Region where this job is deployed and built Example: "europe-west" */
-        'region'?: 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;
-            };
-        };
-    };
-    'billing': {
-        /** ID of the billing plan used by this job Example: "nf-compute-20" */
-        'deploymentPlan': string;
-    };
-    /** Job settings */
-    'settings': {
-        /** Cron job specific settings */
-        'cron'?: {
-            /** The cron timer scheduling when to run the job. Example: "30 8 * * *" */
-            'schedule'?: string;
-            /** Whether this job should run when another instance of the job is already running. Example: "Allow" */
-            'concurrencyPolicy'?: 'Allow' | 'Forbid' | 'Replace';
-        };
-        /** The number of attempts to rerun a job before it is marked as failed. */
-        'backoffLimit': number;
-        /** The maximum amount of time, in seconds, for a job to run before it is marked as failed. Example: 600 */
-        'activeDeadlineSeconds': number;
-    };
-    /** Type of the job (manual or cron) Example: "cron" */
-    'jobType': 'manual' | 'cron';
-    /** Whether the job will be built immediately Example: true */
-    'buildInitiated': boolean;
-};
-export declare type CreateJobCronCall = (opts: CreateJobCronRequest) => Promise<ApiCallResponse<CreateJobCronResult>>;
-export declare type CreateJobCronRequest = {
-    parameters: CreateJobCronParameters;
-    data: CreateJobCronData;
-};
-export declare type CreateJobCronParameters = {
-    /** ID of the project */ 'projectId': string;
-};
-export declare type CreateJobCronData = {
-    /** The name of the job. Example: "Example Job" */
-    'name': string;
-    /** A description of the job. Example: "A job description" */
-    'description'?: string;
-    'billing': {
-        /** The ID of the deployment plan to use. Example: "nf-compute-20" */
-        'deploymentPlan': string;
-    };
-    /** The number of attempts to rerun a job before it is marked as failed. */
-    'backoffLimit': number;
-    /** Configure when the job should be run if the source image changes. Example: "never" */
-    'runOnSourceChange'?: 'never' | 'cd-promote' | 'always';
-    /** The maximum amount of time, in seconds, for a job to run before it is marked as failed. Example: 600 */
-    'activeDeadlineSeconds'?: number;
-    /** Where to deploy the job from. */
-    'deployment'?: {
-        /** If set, the job runs a custom command rather than one defined in the Dockerfile. Example: "nginx -g" */
-        'cmdOverride'?: string;
-        /** If set, the job 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;
-            };
-        };
-        'vcs': {
-            /** 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;
-        };
-    } | {
-        /** If set, the job runs a custom command rather than one defined in the Dockerfile. Example: "nginx -g" */
-        'cmdOverride'?: string;
-        /** If set, the job 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;
-        };
-    } | {
-        /** If set, the job runs a custom command rather than one defined in the Dockerfile. Example: "nginx -g" */
-        'cmdOverride'?: string;
-        /** If set, the job 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;
-        };
-    } | 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[];
-    };
-    '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;
-        };
-    };
-    /** An object containing the runtime environment to set for the job. Keys must only contain letters and numbers separated with underscores, may not start with a number Example: {"variable1":"abcdef","variable2":"12345"} */
-    '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 job. Keys must only contain letters and numbers separated with underscores, may not start with a number Example: {"variable1":"abcdef","variable2":"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;
-    /** The cron timer scheduling when to run the job. Example: "30 8 * * *" */
-    'schedule': string;
-    /** 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" */
-    'concurrencyPolicy': 'allow' | 'forbid' | 'replace';
-};
-/** Creates a new cron job */
-export declare class CreateJobCronEndpoint extends PostApiEndpoint<CreateJobCronRequest, CreateJobCronResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: CreateJobCronRequest) => string;
-    body: (payload: CreateJobCronRequest) => string;
-}