@northflank/js-client 0.6.0 → 0.6.3-beta.0

package/dist/cjs/endpoints/list/services.d.ts

@@ -0,0 +1,65 @@
+import { ApiCallResponse, GetApiEndpoint } from '../../api-endpoint';
+export declare type ListServicesResult = {
+    /** An array of services. */
+    '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;
+        /** ID of the project the service belongs to. Example: "default-project" */
+        'projectId': string;
+        /** Service name 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';
+        /** Whether Continuous Integration is disabled */
+        'disabledCI': boolean;
+        /** Whether Continuous Deployment is disabled */
+        'disabledCD': boolean;
+        /** 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;
+            };
+        };
+    }[];
+};
+export declare type ListServicesCall = (opts: ListServicesRequest) => Promise<ApiCallResponse<ListServicesResult>>;
+export declare type ListServicesRequest = {
+    parameters: ListServicesParameters;
+    options?: ListServicesOptions;
+};
+export declare type ListServicesParameters = {
+    /** ID of the project */ 'projectId': string;
+};
+export declare type ListServicesOptions = {
+    /** 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 services belonging to the project */
+export declare class ListServicesEndpoint extends GetApiEndpoint<ListServicesRequest, ListServicesResult> {
+    description: string;
+    withAuth: boolean;
+    requiredPermissions: string;
+    endpointUrl: (opts: ListServicesRequest) => string;
+    body: () => undefined;
+}

package/dist/cjs/endpoints/list/templateRuns.d.ts

@@ -0,0 +1,54 @@
+import { ApiCallResponse, GetApiEndpoint } from '../../api-endpoint';
+export declare type ListTemplaterunsResult = {
+    /** An array of template run objects. */
+    'templateRuns': {
+        /** 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;
+        };
+        /** 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';
+        };
+        /** Status of the template run. Example: "success" */
+        'status': 'waiting' | 'failure' | 'retrying' | 'success' | 'unknown';
+    }[];
+};
+export declare type ListTemplaterunsCall = (opts: ListTemplaterunsRequest) => Promise<ApiCallResponse<ListTemplaterunsResult>>;
+export declare type ListTemplaterunsRequest = {
+    parameters: ListTemplaterunsParameters;
+    options?: ListTemplaterunsOptions;
+};
+export declare type ListTemplaterunsParameters = {
+    /** ID of the template */ 'templateId': string;
+};
+export declare type ListTemplaterunsOptions = {
+    /** 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 a list of template runs */
+export declare class ListTemplaterunsEndpoint extends GetApiEndpoint<ListTemplaterunsRequest, ListTemplaterunsResult> {
+    description: string;
+    withAuth: boolean;
+    requiredPermissions: string;
+    endpointUrl: (opts: ListTemplaterunsRequest) => string;
+    body: () => undefined;
+}

package/dist/cjs/endpoints/list/templates.d.ts

@@ -0,0 +1,41 @@
+import { ApiCallResponse, GetApiEndpoint } from '../../api-endpoint';
+export declare type ListTemplatesResult = {
+    /** An array of template objects. */
+    'templates': {
+        /** 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;
+        /** Details about the template. */
+        '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';
+        };
+    }[];
+};
+export declare type ListTemplatesCall = (opts: ListTemplatesRequest) => Promise<ApiCallResponse<ListTemplatesResult>>;
+export declare type ListTemplatesRequest = {
+    options?: ListTemplatesOptions;
+};
+export declare type ListTemplatesOptions = {
+    /** 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 a list of templates */
+export declare class ListTemplatesEndpoint extends GetApiEndpoint<ListTemplatesRequest, ListTemplatesResult> {
+    description: string;
+    withAuth: boolean;
+    requiredPermissions: string;
+    endpointUrl: (opts: ListTemplatesRequest) => string;
+    body: () => undefined;
+}

package/dist/cjs/endpoints/list/vcs.d.ts

@@ -0,0 +1,32 @@
+import { ApiCallResponse, GetApiEndpoint } from '../../api-endpoint';
+export declare type ListVcsResult = {
+    /** The version control accounts linked to this Northflank account. */
+    'vcsAccountLinks': {
+        /** The type of version control provider the account is linked to. Example: "self-hosted" */
+        'vcsService': 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
+        /** The email of the account linked with this provider. Example: "email@example.com" */
+        'email': string;
+        /** The username of the account linked with this provider. Example: "vcs-user" */
+        'login': string;
+        /** The name of the version control provider. Only returned for self-hosted links. Example: "Self-hosted VCS" */
+        'name'?: string;
+        /** The url of the version control provider. Only returned for self-hosted links. Example: "https://git.example.com" */
+        'vcsUrl'?: string;
+        /** The type of the self-hosted vcs provider. Only returned for self-hosted links. Example: "gitlab-ee" */
+        'vcsType'?: 'gitlab-ee';
+        /** The ID of the self-hosted vcs provider. Only returned for self-hosted links. Example: "example-team/self-hosted-vcs" */
+        'internalId'?: string;
+        /** The name of the team the self-hosted vcs belongs to. Only returned for self-hosted links. Example: "Example Team" */
+        'entityName'?: string;
+    }[];
+};
+export declare type ListVcsCall = (opts: ListVcsRequest) => Promise<ApiCallResponse<ListVcsResult>>;
+export declare type ListVcsRequest = {};
+/** Lists linked version control providers */
+export declare class ListVcsEndpoint extends GetApiEndpoint<ListVcsRequest, ListVcsResult> {
+    description: string;
+    withAuth: boolean;
+    requiredPermissions: string;
+    endpointUrl: (opts: ListVcsRequest) => string;
+    body: () => undefined;
+}

package/dist/cjs/endpoints/list/volumes.d.ts

@@ -0,0 +1,47 @@
+import { ApiCallResponse, GetApiEndpoint } from '../../api-endpoint';
+export declare type ListVolumesResult = {
+    /** 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 ListVolumesCall = (opts: ListVolumesRequest) => Promise<ApiCallResponse<ListVolumesResult>>;
+export declare type ListVolumesRequest = {
+    parameters: ListVolumesParameters;
+};
+export declare type ListVolumesParameters = {
+    /** ID of the project */ 'projectId': string;
+};
+/** Gets a list of volumes belonging to the project */
+export declare class ListVolumesEndpoint extends GetApiEndpoint<ListVolumesRequest, ListVolumesResult> {
+    description: string;
+    withAuth: boolean;
+    requiredPermissions: string;
+    endpointUrl: (opts: ListVolumesRequest) => string;
+    body: () => undefined;
+}

package/dist/cjs/endpoints/pause/addon.d.ts

@@ -0,0 +1,19 @@
+import { ApiCallResponse, PostApiEndpoint } from '../../api-endpoint';
+export declare type PauseAddonResult = any;
+export declare type PauseAddonCall = (opts: PauseAddonRequest) => Promise<ApiCallResponse<PauseAddonResult>>;
+export declare type PauseAddonRequest = {
+    parameters: PauseAddonParameters;
+};
+export declare type PauseAddonParameters = {
+    /** ID of the project */ 'projectId': string;
+    /** ID of the addon */
+    'addonId': string;
+};
+/** Pause the given addon. */
+export declare class PauseAddonEndpoint extends PostApiEndpoint<PauseAddonRequest, PauseAddonResult> {
+    description: string;
+    withAuth: boolean;
+    requiredPermissions: string;
+    endpointUrl: (opts: PauseAddonRequest) => string;
+    body: () => undefined;
+}

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

@@ -0,0 +1,19 @@
+import { ApiCallResponse, PostApiEndpoint } from '../../api-endpoint';
+export declare type PauseJobResult = any;
+export declare type PauseJobCall = (opts: PauseJobRequest) => Promise<ApiCallResponse<PauseJobResult>>;
+export declare type PauseJobRequest = {
+    parameters: PauseJobParameters;
+};
+export declare type PauseJobParameters = {
+    /** ID of the project */ 'projectId': string;
+    /** ID of the job */
+    'jobId': string;
+};
+/** Pause the given job. */
+export declare class PauseJobEndpoint extends PostApiEndpoint<PauseJobRequest, PauseJobResult> {
+    description: string;
+    withAuth: boolean;
+    requiredPermissions: string;
+    endpointUrl: (opts: PauseJobRequest) => string;
+    body: () => undefined;
+}

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

@@ -0,0 +1,19 @@
+import { ApiCallResponse, PostApiEndpoint } from '../../api-endpoint';
+export declare type PauseServiceResult = any;
+export declare type PauseServiceCall = (opts: PauseServiceRequest) => Promise<ApiCallResponse<PauseServiceResult>>;
+export declare type PauseServiceRequest = {
+    parameters: PauseServiceParameters;
+};
+export declare type PauseServiceParameters = {
+    /** ID of the project */ 'projectId': string;
+    /** ID of the service */
+    'serviceId': string;
+};
+/** Pause the given service. */
+export declare class PauseServiceEndpoint extends PostApiEndpoint<PauseServiceRequest, PauseServiceResult> {
+    description: string;
+    withAuth: boolean;
+    requiredPermissions: string;
+    endpointUrl: (opts: PauseServiceRequest) => string;
+    body: () => undefined;
+}

package/dist/cjs/endpoints/restart/addon.d.ts

@@ -0,0 +1,19 @@
+import { ApiCallResponse, PostApiEndpoint } from '../../api-endpoint';
+export declare type RestartAddonResult = any;
+export declare type RestartAddonCall = (opts: RestartAddonRequest) => Promise<ApiCallResponse<RestartAddonResult>>;
+export declare type RestartAddonRequest = {
+    parameters: RestartAddonParameters;
+};
+export declare type RestartAddonParameters = {
+    /** ID of the project */ 'projectId': string;
+    /** ID of the addon */
+    'addonId': string;
+};
+/** Restart the given addon. */
+export declare class RestartAddonEndpoint extends PostApiEndpoint<RestartAddonRequest, RestartAddonResult> {
+    description: string;
+    withAuth: boolean;
+    requiredPermissions: string;
+    endpointUrl: (opts: RestartAddonRequest) => string;
+    body: () => undefined;
+}

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

@@ -0,0 +1,19 @@
+import { ApiCallResponse, PostApiEndpoint } from '../../api-endpoint';
+export declare type RestartServiceResult = any;
+export declare type RestartServiceCall = (opts: RestartServiceRequest) => Promise<ApiCallResponse<RestartServiceResult>>;
+export declare type RestartServiceRequest = {
+    parameters: RestartServiceParameters;
+};
+export declare type RestartServiceParameters = {
+    /** ID of the project */ 'projectId': string;
+    /** ID of the service */
+    'serviceId': string;
+};
+/** Restarts the given service. */
+export declare class RestartServiceEndpoint extends PostApiEndpoint<RestartServiceRequest, RestartServiceResult> {
+    description: string;
+    withAuth: boolean;
+    requiredPermissions: string;
+    endpointUrl: (opts: RestartServiceRequest) => string;
+    body: () => undefined;
+}

package/dist/cjs/endpoints/restore/addon/backup.d.ts

@@ -0,0 +1,24 @@
+import { ApiCallResponse, PostApiEndpoint } from '../../../api-endpoint';
+export declare type RestoreAddonBackupResult = {
+    /** The ID of the initiated restore. Example: "1611305397038" */
+    'restoreId': string;
+};
+export declare type RestoreAddonBackupCall = (opts: RestoreAddonBackupRequest) => Promise<ApiCallResponse<RestoreAddonBackupResult>>;
+export declare type RestoreAddonBackupRequest = {
+    parameters: RestoreAddonBackupParameters;
+};
+export declare type RestoreAddonBackupParameters = {
+    /** ID of the project */ 'projectId': string;
+    /** ID of the addon */
+    'addonId': string;
+    /** ID of the backup */
+    'backupId': string;
+};
+/** Restores the given addon to the given backup state. */
+export declare class RestoreAddonBackupEndpoint extends PostApiEndpoint<RestoreAddonBackupRequest, RestoreAddonBackupResult> {
+    description: string;
+    withAuth: boolean;
+    requiredPermissions: string;
+    endpointUrl: (opts: RestoreAddonBackupRequest) => string;
+    body: () => undefined;
+}

package/dist/cjs/endpoints/resume/addon.d.ts

@@ -0,0 +1,19 @@
+import { ApiCallResponse, PostApiEndpoint } from '../../api-endpoint';
+export declare type ResumeAddonResult = any;
+export declare type ResumeAddonCall = (opts: ResumeAddonRequest) => Promise<ApiCallResponse<ResumeAddonResult>>;
+export declare type ResumeAddonRequest = {
+    parameters: ResumeAddonParameters;
+};
+export declare type ResumeAddonParameters = {
+    /** ID of the project */ 'projectId': string;
+    /** ID of the addon */
+    'addonId': string;
+};
+/** Resume the given addon if it is paused. */
+export declare class ResumeAddonEndpoint extends PostApiEndpoint<ResumeAddonRequest, ResumeAddonResult> {
+    description: string;
+    withAuth: boolean;
+    requiredPermissions: string;
+    endpointUrl: (opts: ResumeAddonRequest) => string;
+    body: () => undefined;
+}

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

@@ -0,0 +1,28 @@
+import { ApiCallResponse, PostApiEndpoint } from '../../api-endpoint';
+export declare type ResumeJobResult = any | any;
+export declare type ResumeJobCall = (opts: ResumeJobRequest) => Promise<ApiCallResponse<ResumeJobResult>>;
+export declare type ResumeJobRequest = {
+    parameters: ResumeJobParameters;
+    data: ResumeJobData;
+};
+export declare type ResumeJobParameters = {
+    /** ID of the project */ 'projectId': string;
+    /** ID of the job */
+    'jobId': string;
+};
+export declare type ResumeJobData = {
+    /** In the case of cron jobs, whether scheduling should be paused. */
+    'suspended'?: boolean;
+    /** Whether CI should be disabled */
+    'disabledCI'?: boolean;
+    /** Whether CD should be disabled */
+    'disabledCD'?: boolean;
+};
+/** Resumes the given job. Optionally takes several arguments to override resumed settings. */
+export declare class ResumeJobEndpoint extends PostApiEndpoint<ResumeJobRequest, ResumeJobResult> {
+    description: string;
+    withAuth: boolean;
+    requiredPermissions: string;
+    endpointUrl: (opts: ResumeJobRequest) => string;
+    body: (payload: ResumeJobRequest) => string;
+}

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

@@ -0,0 +1,28 @@
+import { ApiCallResponse, PostApiEndpoint } from '../../api-endpoint';
+export declare type ResumeServiceResult = any | any;
+export declare type ResumeServiceCall = (opts: ResumeServiceRequest) => Promise<ApiCallResponse<ResumeServiceResult>>;
+export declare type ResumeServiceRequest = {
+    parameters: ResumeServiceParameters;
+    data: ResumeServiceData;
+};
+export declare type ResumeServiceParameters = {
+    /** ID of the project */ 'projectId': string;
+    /** ID of the service */
+    'serviceId': string;
+};
+export declare type ResumeServiceData = {
+    /** The number of instances to scale the service to upon resuming Example: 1 */
+    'instances'?: number;
+    /** Whether CI should be disabled */
+    'disabledCI'?: boolean;
+    /** Whether CD should be disabled */
+    'disabledCD'?: boolean;
+};
+/** Resumes the given service. Optionally takes several arguments to override resumed settings. */
+export declare class ResumeServiceEndpoint extends PostApiEndpoint<ResumeServiceRequest, ResumeServiceResult> {
+    description: string;
+    withAuth: boolean;
+    requiredPermissions: string;
+    endpointUrl: (opts: ResumeServiceRequest) => string;
+    body: (payload: ResumeServiceRequest) => string;
+}

package/dist/cjs/endpoints/retain/addon/backup.d.ts

@@ -0,0 +1,21 @@
+import { ApiCallResponse, PostApiEndpoint } from '../../../api-endpoint';
+export declare type RetainAddonBackupResult = any;
+export declare type RetainAddonBackupCall = (opts: RetainAddonBackupRequest) => Promise<ApiCallResponse<RetainAddonBackupResult>>;
+export declare type RetainAddonBackupRequest = {
+    parameters: RetainAddonBackupParameters;
+};
+export declare type RetainAddonBackupParameters = {
+    /** ID of the project */ 'projectId': string;
+    /** ID of the addon */
+    'addonId': string;
+    /** ID of the backup */
+    'backupId': string;
+};
+/** Flags a temporary backup generated by a backup schedule to be retained indefinitely rather than being deleted after the expiry date. */
+export declare class RetainAddonBackupEndpoint extends PostApiEndpoint<RetainAddonBackupRequest, RetainAddonBackupResult> {
+    description: string;
+    withAuth: boolean;
+    requiredPermissions: string;
+    endpointUrl: (opts: RetainAddonBackupRequest) => string;
+    body: () => undefined;
+}

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

@@ -0,0 +1,62 @@
+import { ApiCallResponse, PostApiEndpoint } from '../../api-endpoint';
+export declare type RunTemplateResult = {
+    /** 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 RunTemplateCall = (opts: RunTemplateRequest) => Promise<ApiCallResponse<RunTemplateResult>>;
+export declare type RunTemplateRequest = {
+    parameters: RunTemplateParameters;
+};
+export declare type RunTemplateParameters = {
+    /** ID of the template */ 'templateId': string;
+};
+/** Run a template */
+export declare class RunTemplateEndpoint extends PostApiEndpoint<RunTemplateRequest, RunTemplateResult> {
+    description: string;
+    withAuth: boolean;
+    requiredPermissions: string;
+    endpointUrl: (opts: RunTemplateRequest) => string;
+    body: () => undefined;
+}

package/dist/cjs/endpoints/scale/addon.d.ts

@@ -0,0 +1,28 @@
+import { ApiCallResponse, PostApiEndpoint } from '../../api-endpoint';
+export declare type ScaleAddonResult = any;
+export declare type ScaleAddonCall = (opts: ScaleAddonRequest) => Promise<ApiCallResponse<ScaleAddonResult>>;
+export declare type ScaleAddonRequest = {
+    parameters: ScaleAddonParameters;
+    data: ScaleAddonData;
+};
+export declare type ScaleAddonParameters = {
+    /** ID of the project */ 'projectId': string;
+    /** ID of the addon */
+    'addonId': string;
+};
+export declare type ScaleAddonData = {
+    /** The ID of the deployment plan to use. Example: "nf-compute-20" */
+    'deploymentPlan'?: string;
+    /** The size of the addon storage, in megabytes. Example: 1024 */
+    'storage'?: number;
+    /** The number of addon replicas to run. Example: 1 */
+    'replicas'?: number;
+};
+/** Modifies the allocated resources for the given addon. */
+export declare class ScaleAddonEndpoint extends PostApiEndpoint<ScaleAddonRequest, ScaleAddonResult> {
+    description: string;
+    withAuth: boolean;
+    requiredPermissions: string;
+    endpointUrl: (opts: ScaleAddonRequest) => string;
+    body: (payload: ScaleAddonRequest) => string;
+}

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

@@ -0,0 +1,30 @@
+import { ApiCallResponse, PostApiEndpoint } from '../../api-endpoint';
+export declare type ScaleJobResult = any;
+export declare type ScaleJobCall = (opts: ScaleJobRequest) => Promise<ApiCallResponse<ScaleJobResult>>;
+export declare type ScaleJobRequest = {
+    parameters: ScaleJobParameters;
+    data: ScaleJobData;
+};
+export declare type ScaleJobParameters = {
+    /** ID of the project */ 'projectId': string;
+    /** ID of the job */
+    'jobId': string;
+};
+export declare type ScaleJobData = {
+    /** ID of the deployment plan to switch to. Example: "nf-compute-20" */
+    'deploymentPlan'?: string;
+    'storage'?: {
+        'ephemeralStorage'?: {
+            /** Ephemeral storage per container in MB Example: 1024 */
+            'storageSize'?: number;
+        };
+    };
+};
+/** Modifies the scaling settings for the given job. */
+export declare class ScaleJobEndpoint extends PostApiEndpoint<ScaleJobRequest, ScaleJobResult> {
+    description: string;
+    withAuth: boolean;
+    requiredPermissions: string;
+    endpointUrl: (opts: ScaleJobRequest) => string;
+    body: (payload: ScaleJobRequest) => string;
+}

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

@@ -0,0 +1,32 @@
+import { ApiCallResponse, PostApiEndpoint } from '../../api-endpoint';
+export declare type ScaleServiceResult = any;
+export declare type ScaleServiceCall = (opts: ScaleServiceRequest) => Promise<ApiCallResponse<ScaleServiceResult>>;
+export declare type ScaleServiceRequest = {
+    parameters: ScaleServiceParameters;
+    data: ScaleServiceData;
+};
+export declare type ScaleServiceParameters = {
+    /** ID of the project */ 'projectId': string;
+    /** ID of the service */
+    'serviceId': string;
+};
+export declare type ScaleServiceData = {
+    /** The number of instances to scale the service to Example: 1 */
+    'instances'?: number;
+    /** ID of the deployment plan to switch to. Example: "nf-compute-20" */
+    'deploymentPlan'?: string;
+    'storage'?: {
+        'ephemeralStorage'?: {
+            /** Ephemeral storage per container in MB Example: 1024 */
+            'storageSize'?: number;
+        };
+    };
+};
+/** Modifies the scaling settings for the given service. */
+export declare class ScaleServiceEndpoint extends PostApiEndpoint<ScaleServiceRequest, ScaleServiceResult> {
+    description: string;
+    withAuth: boolean;
+    requiredPermissions: string;
+    endpointUrl: (opts: ScaleServiceRequest) => string;
+    body: (payload: ScaleServiceRequest) => string;
+}