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

package/dist/cjs/endpoints/get/service/ports.d.ts

@@ -1,70 +0,0 @@
-import { ApiCallResponse, GetApiEndpoint } from '../../../api-endpoint';
-export declare type GetServicePortsResult = {
-    /** An array of ports of the service. */
-    'ports': {
-        /** The id used to identify the port across requests. Example: "eonyui" */
-        'id': string;
-        /** The name of the port used in the public url and UI. Example: "port-1" */
-        'name': string;
-        /** The port number. Example: 8080 */
-        'internalPort': number;
-        /** The protocol used by the port. Example: "HTTP" */
-        'protocol': 'HTTP' | 'HTTP/2' | 'TCP' | 'UDP';
-        /** If true, the port is exposed publicly. Example: true */
-        'public': boolean;
-        /** DNS entry for this port. Example: "port-1--example-service--default-service--user-abc1.salvo.code.run" */
-        'dns'?: string;
-        /** An array of domains that redirect to this port. */
-        'domains': {
-            /** The custom domain redirecting to this port. Example: "app.example.com" */
-            'name': string;
-            /** Details about the TLS certificate generation for this domain. */
-            'certificate': {
-                /** Is the certificate in the process of being generated? */
-                'inProgress'?: boolean;
-                /** The timestamp when the TLS certificate will expire. Example: "2022-04-26T09:25:02.000Z" */
-                'expiryDate'?: string;
-                /** The timestamp when a new TLS certificate will be generated. Example: "2022-03-27T09:25:02.000Z" */
-                'refreshDate'?: string;
-            };
-        }[];
-        /** Details about security settings for this port. */
-        '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';
-            }[];
-        };
-        /** Disable routing on the default code.run domain for public HTTP ports with custom domains. */
-        'disableNfDomain'?: boolean;
-    }[];
-};
-export declare type GetServicePortsCall = (opts: GetServicePortsRequest) => Promise<ApiCallResponse<GetServicePortsResult>>;
-export declare type GetServicePortsRequest = {
-    parameters: GetServicePortsParameters;
-};
-export declare type GetServicePortsParameters = {
-    /** ID of the project */ 'projectId': string;
-    /** ID of the service */
-    'serviceId': string;
-};
-/** Lists the ports for the given service. */
-export declare class GetServicePortsEndpoint extends GetApiEndpoint<GetServicePortsRequest, GetServicePortsResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: GetServicePortsRequest) => string;
-    body: () => undefined;
-}

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

@@ -1,49 +0,0 @@
-import { ApiCallResponse, GetApiEndpoint } from '../../../api-endpoint';
-export declare type GetServicePullrequestsResult = {
-    /** 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 GetServicePullrequestsCall = (opts: GetServicePullrequestsRequest) => Promise<ApiCallResponse<GetServicePullrequestsResult>>;
-export declare type GetServicePullrequestsRequest = {
-    parameters: GetServicePullrequestsParameters;
-    options?: GetServicePullrequestsOptions;
-};
-export declare type GetServicePullrequestsParameters = {
-    /** ID of the project */ 'projectId': string;
-    /** ID of the service */
-    'serviceId': string;
-};
-export declare type GetServicePullrequestsOptions = {
-    /** 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 service. */
-export declare class GetServicePullrequestsEndpoint extends GetApiEndpoint<GetServicePullrequestsRequest, GetServicePullrequestsResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: GetServicePullrequestsRequest) => string;
-    body: () => undefined;
-}

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

@@ -1,29 +0,0 @@
-import { ApiCallResponse, GetApiEndpoint } from '../../../api-endpoint';
-export declare type GetServiceRuntimeenvironmentResult = {
-    /** 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 GetServiceRuntimeenvironmentCall = (opts: GetServiceRuntimeenvironmentRequest) => Promise<ApiCallResponse<GetServiceRuntimeenvironmentResult>>;
-export declare type GetServiceRuntimeenvironmentRequest = {
-    parameters: GetServiceRuntimeenvironmentParameters;
-    options?: GetServiceRuntimeenvironmentOptions;
-};
-export declare type GetServiceRuntimeenvironmentParameters = {
-    /** ID of the project */ 'projectId': string;
-    /** ID of the service */
-    'serviceId': string;
-};
-export declare type GetServiceRuntimeenvironmentOptions = {
-    /** 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;
-};
-/** Gets the runtime environment of the given service. 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 GetServiceRuntimeenvironmentEndpoint extends GetApiEndpoint<GetServiceRuntimeenvironmentRequest, GetServiceRuntimeenvironmentResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: GetServiceRuntimeenvironmentRequest) => string;
-    body: () => undefined;
-}

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

@@ -1,71 +0,0 @@
-import { ApiCallResponse, GetApiEndpoint } from '../../../api-endpoint';
-export declare type GetServiceRuntimeenvironmentdetailsResult = {
-    /** 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 GetServiceRuntimeenvironmentdetailsCall = (opts: GetServiceRuntimeenvironmentdetailsRequest) => Promise<ApiCallResponse<GetServiceRuntimeenvironmentdetailsResult>>;
-export declare type GetServiceRuntimeenvironmentdetailsRequest = {
-    parameters: GetServiceRuntimeenvironmentdetailsParameters;
-};
-export declare type GetServiceRuntimeenvironmentdetailsParameters = {
-    /** ID of the project */ 'projectId': string;
-    /** ID of the service */
-    'serviceId': string;
-};
-/** Get details about the runtime environment accessible by the given service. Also requires the permission 'Project > Secrets > General > Read' */
-export declare class GetServiceRuntimeenvironmentdetailsEndpoint extends GetApiEndpoint<GetServiceRuntimeenvironmentdetailsRequest, GetServiceRuntimeenvironmentdetailsResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: GetServiceRuntimeenvironmentdetailsRequest) => string;
-    body: () => undefined;
-}

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

@@ -1,211 +0,0 @@
-import { ApiCallResponse, GetApiEndpoint } from '../../api-endpoint';
-export declare type GetServiceResult = {
-    /** 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;
-    /** Type of the service (combined, build or deployment) Example: "combined" */
-    'serviceType': 'combined' | 'build' | 'deployment';
-    /** 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;
-    '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;
-        /** 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;
-            };
-        };
-    };
-    '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;
-        };
-    };
-    /** An array of ports of the service. */
-    'ports': {
-        /** The id used to identify the port across requests. Example: "eonyui" */
-        'id': string;
-        /** The name of the port used in the public url and UI. Example: "port-1" */
-        'name': string;
-        /** The port number. Example: 8080 */
-        'internalPort': number;
-        /** The protocol used by the port. Example: "HTTP" */
-        'protocol': 'HTTP' | 'HTTP/2' | 'TCP' | 'UDP';
-        /** If true, the port is exposed publicly. Example: true */
-        'public': boolean;
-        /** DNS entry for this port. Example: "port-1--example-service--default-service--user-abc1.salvo.code.run" */
-        'dns'?: string;
-        /** An array of domains that redirect to this port. */
-        'domains': {
-            /** The custom domain redirecting to this port. Example: "app.example.com" */
-            'name': string;
-            /** Details about the TLS certificate generation for this domain. */
-            'certificate': {
-                /** Is the certificate in the process of being generated? */
-                'inProgress'?: boolean;
-                /** The timestamp when the TLS certificate will expire. Example: "2022-04-26T09:25:02.000Z" */
-                'expiryDate'?: string;
-                /** The timestamp when a new TLS certificate will be generated. Example: "2022-03-27T09:25:02.000Z" */
-                'refreshDate'?: string;
-            };
-        }[];
-        /** Details about security settings for this port. */
-        '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';
-            }[];
-        };
-        /** Disable routing on the default code.run domain for public HTTP ports with custom domains. */
-        'disableNfDomain'?: boolean;
-    }[];
-};
-export declare type GetServiceCall = (opts: GetServiceRequest) => Promise<ApiCallResponse<GetServiceResult>>;
-export declare type GetServiceRequest = {
-    parameters: GetServiceParameters;
-};
-export declare type GetServiceParameters = {
-    /** ID of the project */ 'projectId': string;
-    /** ID of the service */
-    'serviceId': string;
-};
-/** Gets information about the given service. */
-export declare class GetServiceEndpoint extends GetApiEndpoint<GetServiceRequest, GetServiceResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: GetServiceRequest) => string;
-    body: () => undefined;
-}

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

@@ -1,30 +0,0 @@
-import { ApiCallResponse, GetApiEndpoint } from '../../api-endpoint';
-export declare type GetSubdomainResult = {
-    /** The record type to use for the DNS record to verify the subdomain - always CNAME for subdomains. Example: "CNAME" */
-    'recordType': string;
-    /** The subdomain. Example: "site" */
-    'name': string;
-    /** The full domain name with subdomain Example: "site.example.com" */
-    'fullName': string;
-    /** The content to set the DNS record to Example: "site.example.com.user-1234.dns.northflank.app" */
-    'content': string;
-    /** Whether the subdomain has been verified successfully and can be used. Example: true */
-    'verified': boolean;
-};
-export declare type GetSubdomainCall = (opts: GetSubdomainRequest) => Promise<ApiCallResponse<GetSubdomainResult>>;
-export declare type GetSubdomainRequest = {
-    parameters: GetSubdomainParameters;
-};
-export declare type GetSubdomainParameters = {
-    /** Name of the domain */ 'domain': string;
-    /** Name of the subdomain */
-    'subdomain': string;
-};
-/** Gets details about the given subdomain */
-export declare class GetSubdomainEndpoint extends GetApiEndpoint<GetSubdomainRequest, GetSubdomainResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: GetSubdomainRequest) => string;
-    body: () => undefined;
-}

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

@@ -1,61 +0,0 @@
-import { ApiCallResponse, GetApiEndpoint } from '../../api-endpoint';
-export declare type GetTemplateResult = {
-    /** ID of the template. Example: "example-template" */
-    'id': string;
-    /** Timestamp of when the template was created. Example: "2022-06-14 15:10:42.842Z" */
-    'createdAt': string;
-    /** Timestamp of when the template was last updated. Example: "2022-06-14 15:10:42.842Z" */
-    'updatedAt': string;
-    'content'?: {
-        /** Name of the template. Example: "Example Template" */
-        'name': string;
-        /** Description of the template. Example: "This is a sample template." */
-        'description'?: string;
-        /** The version of the Northflank API to run the template against. Example: "v1" */
-        'apiVersion': 'v1';
-        /** Details of the project the template will run in. */
-        'project': {
-            /** The ID of the project to use. */
-            'id': string;
-        } | {
-            /** Details about the project to create. */
-            'spec': {
-                /** The name of the project. Example: "New Project" */
-                'name': string;
-                /** The description of the project. Example: "This is a new project." */
-                'description'?: string;
-                /** The region the project will be hosted in. Example: "europe-west" */
-                'region'?: string;
-                /** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
-                'clusterId'?: string;
-                /** The color of the project in the Northflank App. Example: "#EF233C" */
-                'color'?: string;
-            };
-        };
-        'spec': any;
-    };
-};
-export declare type GetTemplateCall = (opts: GetTemplateRequest) => Promise<ApiCallResponse<GetTemplateResult>>;
-export declare type GetTemplateRequest = {
-    parameters: GetTemplateParameters;
-    options?: GetTemplateOptions;
-};
-export declare type GetTemplateParameters = {
-    /** ID of the template */ 'templateId': string;
-};
-export declare type GetTemplateOptions = {
-    /** 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;
-};
-/** Get information about the given template. */
-export declare class GetTemplateEndpoint extends GetApiEndpoint<GetTemplateRequest, GetTemplateResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: GetTemplateRequest) => string;
-    body: () => undefined;
-}

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

@@ -1,73 +0,0 @@
-import { ApiCallResponse, GetApiEndpoint } from '../../api-endpoint';
-export declare type GetTemplaterunResult = {
-    /** ID of the template run. Example: "501c1e03-a021-4659-9048-85f8f6ee2bc7" */
-    'id': string;
-    /** Timestamp of when the run was initiated. Example: "2022-06-14 15:10:42.842Z" */
-    'createdAt': string;
-    /** Timestamp of when the run was last updated. Example: "2022-06-14 15:10:42.842Z" */
-    'updatedAt': string;
-    /** Details about the template being run. */
-    'template': {
-        /** ID of the template Example: "example-template" */
-        'id': string;
-        /** The name of the template Example: "Example Template" */
-        'name': string;
-    };
-    /** Status of the template run. Example: "success" */
-    'status': 'waiting' | 'failure' | 'retrying' | 'success' | 'unknown';
-    /** Details about the template run. */
-    'content': {
-        /** Name of the template. Example: "Example Template" */
-        'name': string;
-        /** Description of the template. Example: "This is a sample template." */
-        'description'?: string;
-        /** The version of the Northflank API to run the template against. Example: "v1" */
-        'apiVersion': 'v1';
-        /** Details of the project the template will run in. */
-        'project': {
-            /** The ID of the project to use. */
-            'id': string;
-        } | {
-            /** Details about the project to create. */
-            'spec': {
-                /** The name of the project. Example: "New Project" */
-                'name': string;
-                /** The description of the project. Example: "This is a new project." */
-                'description'?: string;
-                /** The region the project will be hosted in. Example: "europe-west" */
-                'region'?: string;
-                /** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
-                'clusterId'?: string;
-                /** The color of the project in the Northflank App. Example: "#EF233C" */
-                'color'?: string;
-            };
-        };
-        'spec': any;
-    };
-};
-export declare type GetTemplaterunCall = (opts: GetTemplaterunRequest) => Promise<ApiCallResponse<GetTemplaterunResult>>;
-export declare type GetTemplaterunRequest = {
-    parameters: GetTemplaterunParameters;
-    options?: GetTemplaterunOptions;
-};
-export declare type GetTemplaterunParameters = {
-    /** ID of the template */ 'templateId': string;
-    /** ID of the template run */
-    'templateRunId': string;
-};
-export declare type GetTemplaterunOptions = {
-    /** 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;
-};
-/** Get information about the given template run. */
-export declare class GetTemplaterunEndpoint extends GetApiEndpoint<GetTemplaterunRequest, GetTemplaterunResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: GetTemplaterunRequest) => string;
-    body: () => undefined;
-}

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

@@ -1,49 +0,0 @@
-import { ApiCallResponse, GetApiEndpoint } from '../../api-endpoint';
-export declare type GetVolumeResult = {
-    /** Identifier for the volume Example: "example-volume" */
-    'id': string;
-    /** Volume name Example: "Example Volume" */
-    'name': string;
-    /** Information about the desired size and type of the volume. Storage class is only configurable with the relevant feature flag enabled for your account. */
-    'spec': {
-        /** The type of the storage. Example: "ssd" */
-        'storageClassName'?: 'ssd';
-        /** Storage size of the SSD. Example: 4096 */
-        'storageSize': number;
-    } | {
-        /** The type of the storage. Example: "hdd" */
-        'storageClassName': 'hdd';
-        /** Storage size of the HDD. Example: 40960 */
-        'storageSize': number;
-    };
-    /** The object to attach this volume to. */
-    'owningObject'?: {
-        /** The internal id of object to attach this volume to. Example: "example-service" */
-        'id': string;
-        /** The type of the object to attach this volume to. Example: "service" */
-        'type': 'service';
-    };
-    /** Status the volume is in on the cluster Example: "BOUND" */
-    'status': string;
-    /** The timestamp the volume was created at Example: "2021-01-01 12:00:00.000Z" */
-    'createdAt': string;
-    /** The timestamp the volume was last updated at Example: "2021-01-01 12:00:00.000Z" */
-    'updatedAt': string;
-};
-export declare type GetVolumeCall = (opts: GetVolumeRequest) => Promise<ApiCallResponse<GetVolumeResult>>;
-export declare type GetVolumeRequest = {
-    parameters: GetVolumeParameters;
-};
-export declare type GetVolumeParameters = {
-    /** ID of the project */ 'projectId': string;
-    /** ID of the volume */
-    'volumeId': string;
-};
-/** Retrieve a volume */
-export declare class GetVolumeEndpoint extends GetApiEndpoint<GetVolumeRequest, GetVolumeResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: GetVolumeRequest) => string;
-    body: () => undefined;
-}