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

package/dist/cjs/endpoints/get/job/builds.d.ts

@@ -1,52 +0,0 @@
-import { ApiCallResponse, GetApiEndpoint } from '../../../api-endpoint';
-export declare type GetJobBuildsResult = {
-    /** An array of builds. */
-    'builds': {
-        /** ID of the build. Example: "joyous-view-6290" */
-        'id': string;
-        /** Name of the branch the built commit belongs to. Example: "main" */
-        'branch'?: string;
-        /** ID of the pull request the commit belongs to. */
-        'pullRequestId'?: number;
-        /** The status of the build. Example: "SUCCESS" */
-        'status'?: 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUCCESS' | 'CRASHED';
-        /** The sha of the built commit. Example: "12c15e7ee25fd78f567ebf87f9178b8ad70025b3" */
-        'sha'?: string;
-        /** Whether the build has finished. Example: true */
-        'concluded'?: boolean;
-        /** Timestamp of the build initiation. Example: "2021-07-28T15:55:38.296Z" */
-        'createdAt'?: string;
-        /** Whether the build was successful. Example: true */
-        'success'?: boolean;
-        /** Description of the build status. Example: "Image successfully built" */
-        'message'?: string;
-        /** Timestamp of the build concluding. Example: 1606237973 */
-        'buildConcludedAt'?: number;
-    }[];
-};
-export declare type GetJobBuildsCall = (opts: GetJobBuildsRequest) => Promise<ApiCallResponse<GetJobBuildsResult>>;
-export declare type GetJobBuildsRequest = {
-    parameters: GetJobBuildsParameters;
-    options?: GetJobBuildsOptions;
-};
-export declare type GetJobBuildsParameters = {
-    /** ID of the project */ 'projectId': string;
-    /** ID of the job */
-    'jobId': string;
-};
-export declare type GetJobBuildsOptions = {
-    /** The number of results to display per request. Maximum of 100 results per page. */
-    'per_page'?: number;
-    /** The page number to access. */
-    'page'?: number;
-    /** The cursor returned from the previous page of results, used to request the next page. */
-    'cursor'?: string;
-};
-/** Lists builds for the given job. */
-export declare class GetJobBuildsEndpoint extends GetApiEndpoint<GetJobBuildsRequest, GetJobBuildsResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: GetJobBuildsRequest) => string;
-    body: () => undefined;
-}

package/dist/cjs/endpoints/get/job/containers.d.ts

@@ -1,40 +0,0 @@
-import { ApiCallResponse, GetApiEndpoint } from '../../../api-endpoint';
-export declare type GetJobContainersResult = {
-    /** An array of containers. */
-    'containers': {
-        /** The name of the container. Example: "example-service-78b4d4459d-sbtn8" */
-        'name': string;
-        /** The timestamp the container was created. Example: 1611241087 */
-        'createdAt': number;
-        /** The current status of the container. Example: "TASK_RUNNING" */
-        'status': 'TASK_RUNNING' | 'TASK_STARTING' | 'TASK_STAGING' | 'TASK_KILLING' | 'TASK_KILLED' | 'TASK_FAILED' | 'TASK_FINISHED';
-        /** The timestamp the container was last updated. Example: 1611241087 */
-        'updatedAt': number;
-    }[];
-};
-export declare type GetJobContainersCall = (opts: GetJobContainersRequest) => Promise<ApiCallResponse<GetJobContainersResult>>;
-export declare type GetJobContainersRequest = {
-    parameters: GetJobContainersParameters;
-    options?: GetJobContainersOptions;
-};
-export declare type GetJobContainersParameters = {
-    /** ID of the project */ 'projectId': string;
-    /** ID of the job */
-    'jobId': string;
-};
-export declare type GetJobContainersOptions = {
-    /** The number of results to display per request. Maximum of 100 results per page. */
-    'per_page'?: number;
-    /** The page number to access. */
-    'page'?: number;
-    /** The cursor returned from the previous page of results, used to request the next page. */
-    'cursor'?: string;
-};
-/** Gets a list of containers for the given job. */
-export declare class GetJobContainersEndpoint extends GetApiEndpoint<GetJobContainersRequest, GetJobContainersResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: GetJobContainersRequest) => string;
-    body: () => undefined;
-}

package/dist/cjs/endpoints/get/job/deployment.d.ts

@@ -1,55 +0,0 @@
-import { ApiCallResponse, GetApiEndpoint } from '../../../api-endpoint';
-export declare type GetJobDeploymentResult = {
-    /** Region where this service is deployed and/or built Example: "europe-west" */
-    'region'?: string;
-    /** Number of instances/replicas running Example: 1 */
-    'instances'?: number;
-    'internal': {
-        /** Full identifier of deployed entity Example: "/example-user/default-project/example-service" */
-        'appId': string;
-        /** ID of deployed entity Example: "example-service" */
-        'nfObjectId': string;
-        /** 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;
-        /** ID of the build currently deployed. Example: "incredible-land-3266" */
-        'buildId': string;
-        /** Commit SHA being 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;
-        /** Type of deployed entity Example: "service" */
-        'nfObjectType': 'service' | 'job';
-    };
-} | {
-    /** Region where this service is deployed and/or built Example: "europe-west" */
-    'region'?: string;
-    /** Number of instances/replicas running Example: 1 */
-    'instances'?: number;
-    'external': {
-        /** Path of the external image excluding the hostname Example: "nginx:latest" */
-        'imagePath': string;
-        /** Registry provider hosting the external image Example: "dockerhub" */
-        'registryProvider': 'dockerhub' | 'gcr' | 'gcr-eu' | 'gcr-us' | 'gitlab' | 'github' | 'custom';
-        /** Does the image require authentication */
-        'privateImage': boolean;
-    };
-};
-export declare type GetJobDeploymentCall = (opts: GetJobDeploymentRequest) => Promise<ApiCallResponse<GetJobDeploymentResult>>;
-export declare type GetJobDeploymentRequest = {
-    parameters: GetJobDeploymentParameters;
-};
-export declare type GetJobDeploymentParameters = {
-    /** ID of the project */ 'projectId': string;
-    /** ID of the job */
-    'jobId': string;
-};
-/** Gets information about the deployment of the given job. */
-export declare class GetJobDeploymentEndpoint extends GetApiEndpoint<GetJobDeploymentRequest, GetJobDeploymentResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: GetJobDeploymentRequest) => string;
-    body: () => undefined;
-}

package/dist/cjs/endpoints/get/job/healthChecks.d.ts

@@ -1,45 +0,0 @@
-import { ApiCallResponse, GetApiEndpoint } from '../../../api-endpoint';
-export declare type GetJobHealthchecksResult = {
-    /** 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';
-        /** The path of the health check endpoint. Example: "/health-check" */
-        'path'?: string;
-        /** The command to run for the health check. */
-        'cmd'?: any;
-        /** HTTP port number for the health check endpoint. Example: 3000 */
-        'httpPort'?: any;
-        /** TCP port number for the health check endpoint. */
-        'tcpSocketPort'?: any;
-        /** 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'?: any;
-    }[];
-};
-export declare type GetJobHealthchecksCall = (opts: GetJobHealthchecksRequest) => Promise<ApiCallResponse<GetJobHealthchecksResult>>;
-export declare type GetJobHealthchecksRequest = {
-    parameters: GetJobHealthchecksParameters;
-};
-export declare type GetJobHealthchecksParameters = {
-    /** ID of the project */ 'projectId': string;
-    /** ID of the job */
-    'jobId': string;
-};
-/** Lists the health checks for the given job. */
-export declare class GetJobHealthchecksEndpoint extends GetApiEndpoint<GetJobHealthchecksRequest, GetJobHealthchecksResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: GetJobHealthchecksRequest) => string;
-    body: () => undefined;
-}

package/dist/cjs/endpoints/get/job/pullRequests.d.ts

@@ -1,49 +0,0 @@
-import { ApiCallResponse, GetApiEndpoint } from '../../../api-endpoint';
-export declare type GetJobPullrequestsResult = {
-    /** A list of pull requests for this repository. */
-    'pullRequests'?: {
-        /** ID number of the pull request. Example: 1 */
-        'id': number;
-        /** Status of the pull request. Example: "OPEN" */
-        'state': string;
-        /** Title of the pull request. Example: "Add new feature handling" */
-        'title': string;
-        /** Name of the branch the pull request is merging from. Example: "feature/new-feature" */
-        'source': string;
-        /** Name of the branch the pull request is being merged into. Example: "main" */
-        'destination': string;
-        /** SHA of the most recent commit of the pull request. Example: "4f101d8821aeb3e4f81f95f3e886a2759ba7b9db" */
-        'sha': string;
-        /** The timestamp the pull request was opened. Example: "2021-03-22T11:05:52.000Z" */
-        'created_at': string;
-        /** The timestamp the pull request was last updated at. Example: "2021-05-11T16:05:43.000Z" */
-        'updated_at': string;
-        'html_url': string;
-    }[];
-};
-export declare type GetJobPullrequestsCall = (opts: GetJobPullrequestsRequest) => Promise<ApiCallResponse<GetJobPullrequestsResult>>;
-export declare type GetJobPullrequestsRequest = {
-    parameters: GetJobPullrequestsParameters;
-    options?: GetJobPullrequestsOptions;
-};
-export declare type GetJobPullrequestsParameters = {
-    /** ID of the project */ 'projectId': string;
-    /** ID of the job */
-    'jobId': string;
-};
-export declare type GetJobPullrequestsOptions = {
-    /** The number of results to display per request. Maximum of 100 results per page. */
-    'per_page'?: number;
-    /** The page number to access. */
-    'page'?: number;
-    /** The cursor returned from the previous page of results, used to request the next page. */
-    'cursor'?: string;
-};
-/** Gets information about the pull-requests of the given job. */
-export declare class GetJobPullrequestsEndpoint extends GetApiEndpoint<GetJobPullrequestsRequest, GetJobPullrequestsResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: GetJobPullrequestsRequest) => string;
-    body: () => undefined;
-}

package/dist/cjs/endpoints/get/job/run.d.ts

@@ -1,44 +0,0 @@
-import { ApiCallResponse, GetApiEndpoint } from '../../../api-endpoint';
-export declare type GetJobRunResult = {
-    /** The ID of the job run Example: "d34582a4-35bd-4c71-8e7c-e36999b88723" */
-    'id': string;
-    /** Whether the run is currently in progress */
-    'active': number;
-    /** The number of attempts to retry this job run before it is marked as failed. */
-    'backoffLimit': number;
-    /** The number of times this job run has concluded successfully or with an error. Example: 1 */
-    'completions': number;
-    /** Has the job run finished? Example: true */
-    'concluded': boolean;
-    /** Whether this job run failed to complete successfully */
-    'failed': number;
-    /** The name of the job run Example: "example-job-5fcf67bc56e1913e21d49504" */
-    'runName': string;
-    /** A string representing the status of the job. Either SUCCESS, RUNNING or FAILED Example: "SUCCESS" */
-    'status': 'SUCCESS' | 'RUNNING' | 'FAILED';
-    /** Whether this job run completed successfully */
-    'succeeded': number;
-    /** The timestamp when the job run started. Example: "2020-12-08T11:47:08Z" */
-    'startedAt': string;
-    /** The timestamp when the job run concluded. Example: "2020-12-08T11:52:08Z" */
-    'concludedAt': string;
-};
-export declare type GetJobRunCall = (opts: GetJobRunRequest) => Promise<ApiCallResponse<GetJobRunResult>>;
-export declare type GetJobRunRequest = {
-    parameters: GetJobRunParameters;
-};
-export declare type GetJobRunParameters = {
-    /** ID of the project */ 'projectId': string;
-    /** ID of the job */
-    'jobId': string;
-    /** ID of the job run */
-    'runId': string;
-};
-/** Returns data about the given job run */
-export declare class GetJobRunEndpoint extends GetApiEndpoint<GetJobRunRequest, GetJobRunResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: GetJobRunRequest) => string;
-    body: () => undefined;
-}

package/dist/cjs/endpoints/get/job/runs.d.ts

@@ -1,54 +0,0 @@
-import { ApiCallResponse, GetApiEndpoint } from '../../../api-endpoint';
-export declare type GetJobRunsResult = {
-    /** An array of job run objects. */
-    'runs': {
-        /** The ID of the job run Example: "d34582a4-35bd-4c71-8e7c-e36999b88723" */
-        'id': string;
-        /** Whether the run is currently in progress */
-        'active': number;
-        /** The number of attempts to retry this job run before it is marked as failed. */
-        'backoffLimit': number;
-        /** The number of times this job run has concluded successfully or with an error. Example: 1 */
-        'completions': number;
-        /** Has the job run finished? Example: true */
-        'concluded': boolean;
-        /** Whether this job run failed to complete successfully */
-        'failed': number;
-        /** The name of the job run Example: "example-job-5fcf67bc56e1913e21d49504" */
-        'runName': string;
-        /** A string representing the status of the job. Either SUCCESS, RUNNING or FAILED Example: "SUCCESS" */
-        'status': 'SUCCESS' | 'RUNNING' | 'FAILED';
-        /** Whether this job run completed successfully */
-        'succeeded': number;
-        /** The timestamp when the job run started. Example: "2020-12-08T11:47:08Z" */
-        'startedAt': string;
-        /** The timestamp when the job run concluded. Example: "2020-12-08T11:52:08Z" */
-        'concludedAt': string;
-    }[];
-};
-export declare type GetJobRunsCall = (opts: GetJobRunsRequest) => Promise<ApiCallResponse<GetJobRunsResult>>;
-export declare type GetJobRunsRequest = {
-    parameters: GetJobRunsParameters;
-    options?: GetJobRunsOptions;
-};
-export declare type GetJobRunsParameters = {
-    /** ID of the project */ 'projectId': string;
-    /** ID of the job */
-    'jobId': string;
-};
-export declare type GetJobRunsOptions = {
-    /** The number of results to display per request. Maximum of 100 results per page. */
-    'per_page'?: number;
-    /** The page number to access. */
-    'page'?: number;
-    /** The cursor returned from the previous page of results, used to request the next page. */
-    'cursor'?: string;
-};
-/** Fetches run history for the given job */
-export declare class GetJobRunsEndpoint extends GetApiEndpoint<GetJobRunsRequest, GetJobRunsResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: GetJobRunsRequest) => string;
-    body: () => undefined;
-}

package/dist/cjs/endpoints/get/job/runtimeEnvironment.d.ts

@@ -1,29 +0,0 @@
-import { ApiCallResponse, GetApiEndpoint } from '../../../api-endpoint';
-export declare type GetJobRuntimeenvironmentResult = {
-    /** The runtime environment variables, formatted as a JSON object. If the `show` parameter is set to `this`, this will only contain secrets saved to this entity. If the `show` parameter is set to `inherited`, this will only contain secrets inherited from linked secret groups. Otherwise, this will contain both. Example: {"VARIABLE_1":"abcdef","VARIABLE_2":"12345"} */
-    'runtimeEnvironment': any;
-    /** The runtime secret files, formatted as a JSON object. If the `show` parameter is set to `this`, this will only contain files saved to this entity. If the `show` parameter is set to `inherited`, this will only contain files inherited from linked secret groups. Otherwise, this will contain both. Example: {"/dir/fileName":{"data":"VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=","encoding":"utf-8"}} */
-    'runtimeFiles': any;
-};
-export declare type GetJobRuntimeenvironmentCall = (opts: GetJobRuntimeenvironmentRequest) => Promise<ApiCallResponse<GetJobRuntimeenvironmentResult>>;
-export declare type GetJobRuntimeenvironmentRequest = {
-    parameters: GetJobRuntimeenvironmentParameters;
-    options?: GetJobRuntimeenvironmentOptions;
-};
-export declare type GetJobRuntimeenvironmentParameters = {
-    /** ID of the project */ 'projectId': string;
-    /** ID of the job */
-    'jobId': string;
-};
-export declare type GetJobRuntimeenvironmentOptions = {
-    /** Which secrets to display - if set to `this` only the group's secrets are displayed, if set to `inherited` only secrets from linked addons are displayed, if set to `all` or not provided, both are displayed. */
-    'show'?: string;
-};
-/** Returns the runtime environment for the given job. If the API key does not have the permission 'Project > Secrets > General > Read', secrets inherited from secret groups will not be displayed. */
-export declare class GetJobRuntimeenvironmentEndpoint extends GetApiEndpoint<GetJobRuntimeenvironmentRequest, GetJobRuntimeenvironmentResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: GetJobRuntimeenvironmentRequest) => string;
-    body: () => undefined;
-}

package/dist/cjs/endpoints/get/job/runtimeEnvironmentDetails.d.ts

@@ -1,71 +0,0 @@
-import { ApiCallResponse, GetApiEndpoint } from '../../../api-endpoint';
-export declare type GetJobRuntimeenvironmentdetailsResult = {
-    /** Details about all the secrets accessible by the service. */
-    'runtimeEnvironment': {
-        /** A stored secret and details about it and its value. This can have the name of any saved secret. */
-        'MY_VARIABLE_NAME'?: {
-            /** The value of the secret. Example: "abcdef123456" */
-            'value': any;
-            /** The ID of the secret group the secret is inherited from, if applicable. Example: "example-secret" */
-            'inheritedFrom'?: string;
-            /** The ID of the addon the secret is inherited from, if applicable. Example: "example-addon" */
-            'addonId'?: string;
-            /** The priority of the secret group the secret is inherited from, if applicable. Example: 10 */
-            'priority'?: number;
-            /** An array containing data about other places the secret has been inherited from, but that are not being used as a secret with the same key exists with a higher priority. */
-            'overriding': {
-                /** The value of the secret. Example: "ffffffffffff" */
-                'value': any;
-                /** The ID of the secret group the secret is inherited from. Example: "secret-2" */
-                'inheritedFrom': string;
-                /** The ID of the addon the secret is inherited from, if applicable. Example: "addon-2" */
-                'addonId'?: string;
-                /** The priority of the secret group the secret is inherited from. */
-                'priority': number;
-            }[];
-        };
-    };
-    /** Details about all the secrets accessible by the service. */
-    'runtimeFiles': {
-        /** A stored secret and details about it and its value. This can have the name of any saved secret. */
-        '/dir/fileName'?: {
-            /** The value of the secret. Example: {"/dir/fileName":{"data":"VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=","encoding":"utf-8"}} */
-            'value': {
-                /** base64 encoded string of the file contents Example: "VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=" */
-                'data'?: string;
-                /** Original encoding of the file Example: "utf-8" */
-                'encoding'?: string;
-            };
-            /** The ID of the secret group the secret is inherited from, if applicable. Example: "example-secret" */
-            'inheritedFrom'?: string;
-            /** The priority of the secret group the secret is inherited from, if applicable. Example: 10 */
-            'priority'?: number;
-            /** An array containing data about other places the file has been inherited from, but that are not being used as a secret with the same file path exists with a higher priority. */
-            'overriding': {
-                /** The value of the secret. Example: "ffffffffffff" */
-                'value': any;
-                /** The ID of the secret group the secret is inherited from. Example: "secret-2" */
-                'inheritedFrom': string;
-                /** The priority of the secret group the secret is inherited from. */
-                'priority': number;
-            }[];
-        };
-    };
-};
-export declare type GetJobRuntimeenvironmentdetailsCall = (opts: GetJobRuntimeenvironmentdetailsRequest) => Promise<ApiCallResponse<GetJobRuntimeenvironmentdetailsResult>>;
-export declare type GetJobRuntimeenvironmentdetailsRequest = {
-    parameters: GetJobRuntimeenvironmentdetailsParameters;
-};
-export declare type GetJobRuntimeenvironmentdetailsParameters = {
-    /** ID of the project */ 'projectId': string;
-    /** ID of the job */
-    'jobId': string;
-};
-/** Get details about the runtime environment accessible by the given job. Also requires the permission 'Project > Secrets > General > Read' */
-export declare class GetJobRuntimeenvironmentdetailsEndpoint extends GetApiEndpoint<GetJobRuntimeenvironmentdetailsRequest, GetJobRuntimeenvironmentdetailsResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: GetJobRuntimeenvironmentdetailsRequest) => string;
-    body: () => undefined;
-}

package/dist/cjs/endpoints/get/job.d.ts

@@ -1,128 +0,0 @@
-import { ApiCallResponse, GetApiEndpoint } from '../../api-endpoint';
-export declare type GetJobResult = {
-    /** 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;
-    /** Type of the job (manual or cron) Example: "cron" */
-    'jobType': 'manual' | 'cron';
-    /** 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;
-    };
-};
-export declare type GetJobCall = (opts: GetJobRequest) => Promise<ApiCallResponse<GetJobResult>>;
-export declare type GetJobRequest = {
-    parameters: GetJobParameters;
-};
-export declare type GetJobParameters = {
-    /** ID of the project */ 'projectId': string;
-    /** ID of the job */
-    'jobId': string;
-};
-/** Gets information about the given job */
-export declare class GetJobEndpoint extends GetApiEndpoint<GetJobRequest, GetJobResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: GetJobRequest) => string;
-    body: () => undefined;
-}

package/dist/cjs/endpoints/get/project.d.ts

@@ -1,72 +0,0 @@
-import { ApiCallResponse, GetApiEndpoint } from '../../api-endpoint';
-export declare type GetProjectResult = {
-    /** Identifier for the project. Example: "default-project" */
-    'id': string;
-    /** The name of the project. Example: "Default Project" */
-    'name': string;
-    /** A short description of the project. Example: "The project description" */
-    'description'?: string;
-    'deployment': {
-        /** The region where the project's services, jobs and addons are deployed in. Example: "europe-west" */
-        'region': string;
-    };
-    /** The time the project was created. Example: "2021-01-20T11:19:53.175Z" */
-    'createdAt': string;
-    /** An array of services belonging to the project. */
-    'services': {
-        /** Identifier for the service. Example: "example-service" */
-        'id': string;
-        /** Full identifier used for service deployment Example: "/example-user/default-project/example-service" */
-        'appId': string;
-        /** The name of the service. Example: "Example Service" */
-        'name': string;
-        /** A short description of the service. Example: "This is the service description" */
-        'description'?: string;
-        /** Type of the service (combined, build or deployment) Example: "combined" */
-        'serviceType': 'combined' | 'build' | 'deployment';
-    }[];
-    /** An array of jobs belonging to the project. */
-    'jobs': {
-        /** Identifier for the job. Example: "example-job" */
-        'id': string;
-        /** Full identifier used for deployment Example: "/example-user/default-project/example-job" */
-        'appId': string;
-        /** The name of the job. Example: "Example Job" */
-        'name': string;
-        /** A short description of the job. Example: "This is the job description" */
-        'description'?: string;
-        /** Type of the service (manual or cron) Example: "cron" */
-        'jobType': 'manual' | 'cron';
-    }[];
-    /** An array of addons belonging to the project. */
-    'addons': {
-        /** Identifier for the addon. Example: "example-addon" */
-        'id': string;
-        /** Full identifier used for deployment Example: "/example-user/default-project/example-addon" */
-        'appId': string;
-        /** The name of the addon. Example: "Example Addon" */
-        'name': string;
-        /** A short description of the addon. Example: "This is the addon description" */
-        'description'?: string;
-        /** Details about the addon's specifications. */
-        'spec': {
-            /** The type of the addon Example: "mongodb" */
-            'type': string;
-        };
-    }[];
-};
-export declare type GetProjectCall = (opts: GetProjectRequest) => Promise<ApiCallResponse<GetProjectResult>>;
-export declare type GetProjectRequest = {
-    parameters: GetProjectParameters;
-};
-export declare type GetProjectParameters = {
-    /** ID of the project */ 'projectId': string;
-};
-/** Get information about the given project */
-export declare class GetProjectEndpoint extends GetApiEndpoint<GetProjectRequest, GetProjectResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: GetProjectRequest) => string;
-    body: () => undefined;
-}