@nexgencloud/hyperstack-sdk-typescript 1.54.7-alpha → 1.55.4-alpha

package/README.md

@@ -1,4 +1,4 @@
-## @nexgencloud/hyperstack-sdk-typescript@v1.54.7-alpha
+## @nexgencloud/hyperstack-sdk-typescript@v1.55.4-alpha
 
 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @nexgencloud/hyperstack-sdk-typescript@v1.54.7-alpha --save
+npm install @nexgencloud/hyperstack-sdk-typescript@v1.55.4-alpha --save
 ```
 
 _unPublished (not recommended):_

package/api.ts

@@ -1783,6 +1783,43 @@ export interface CompatibleFlavor {
      */
     'reason'?: string;
 }
+/**
+ * 
+ * @export
+ * @interface CompatibleImage
+ */
+export interface CompatibleImage {
+    /**
+     * JSON constraints object
+     * @type {object}
+     * @memberof CompatibleImage
+     */
+    'constraints'?: object;
+    /**
+     * 
+     * @type {number}
+     * @memberof CompatibleImage
+     */
+    'image_id'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof CompatibleImage
+     */
+    'image_name'?: string;
+    /**
+     * Either \'hard\' or \'soft\'
+     * @type {string}
+     * @memberof CompatibleImage
+     */
+    'link_type'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CompatibleImage
+     */
+    'reason'?: string;
+}
 /**
  * 
  * @export
@@ -2696,6 +2733,12 @@ export interface CreateInstancesPayload {
      * @memberof CreateInstancesPayload
      */
     'enable_port_randomization'?: boolean;
+    /**
+     * When true, the Hyperstack VM Agent is opted in for this VM and metrics ingestion is allowed by the prom-gateway. The agent must still be installed on the VM (typically via user_data cloud-init).
+     * @type {boolean}
+     * @memberof CreateInstancesPayload
+     */
+    'enhanced_monitoring_enabled'?: boolean;
     /**
      * The name of the [environment](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/) in which the virtual machine is to be created.
      * @type {string}
@@ -4091,6 +4134,12 @@ export interface FlavorFields {
      * @memberof FlavorFields
      */
     'id'?: number;
+    /**
+     * Image compatibility restrictions for this flavor (flavor → image links)
+     * @type {ImageRestrictions}
+     * @memberof FlavorFields
+     */
+    'image_restrictions'?: ImageRestrictions;
     /**
      * 
      * @type {Array<LableResonse>}
@@ -4839,6 +4888,31 @@ export interface ImageGetResponse {
      */
     'type'?: string;
 }
+/**
+ * 
+ * @export
+ * @interface ImageRestrictions
+ */
+export interface ImageRestrictions {
+    /**
+     * List of images this flavor is allowed to launch, with link metadata
+     * @type {Array<CompatibleImage>}
+     * @memberof ImageRestrictions
+     */
+    'compatible_images'?: Array<CompatibleImage>;
+    /**
+     * Whether the flavor is restricted to a set of images
+     * @type {boolean}
+     * @memberof ImageRestrictions
+     */
+    'has_image_restrictions'?: boolean;
+    /**
+     * Either \'hard\', \'soft\', or null if no restrictions
+     * @type {string}
+     * @memberof ImageRestrictions
+     */
+    'restriction_type'?: string;
+}
 /**
  * 
  * @export
@@ -4994,6 +5068,19 @@ export interface Instance {
      */
     'status'?: boolean;
 }
+/**
+ * 
+ * @export
+ * @interface InstanceEnhancedMetricsFields
+ */
+export interface InstanceEnhancedMetricsFields {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof InstanceEnhancedMetricsFields
+     */
+    'enabled'?: boolean;
+}
 /**
  * 
  * @export
@@ -5135,6 +5222,12 @@ export interface InstanceFields {
      * @memberof InstanceFields
      */
     'created_at'?: string;
+    /**
+     * 
+     * @type {InstanceEnhancedMetricsFields}
+     * @memberof InstanceFields
+     */
+    'enhanced_metrics'?: InstanceEnhancedMetricsFields;
     /**
      * 
      * @type {InstanceEnvironmentFields}
@@ -10200,6 +10293,63 @@ export interface UserDefaultChoicesForUserResponse {
      */
     'user_default_choices'?: Array<UserDefaultChoiceForUserFields>;
 }
+/**
+ * 
+ * @export
+ * @interface UserEnhancedMetricsPayload
+ */
+export interface UserEnhancedMetricsPayload {
+    /**
+     * Set to true to opt this VM into Enhanced Metrics, false to opt out.
+     * @type {boolean}
+     * @memberof UserEnhancedMetricsPayload
+     */
+    'enabled': boolean;
+}
+/**
+ * 
+ * @export
+ * @interface UserEnhancedMetricsResponse
+ */
+export interface UserEnhancedMetricsResponse {
+    /**
+     * One-liner the user can run inside the VM to install the agent when enabling. Omitted when disabling.
+     * @type {string}
+     * @memberof UserEnhancedMetricsResponse
+     */
+    'install_command'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof UserEnhancedMetricsResponse
+     */
+    'message'?: string;
+    /**
+     * 
+     * @type {UserEnhancedMetricsResponseFields}
+     * @memberof UserEnhancedMetricsResponse
+     */
+    'metrics'?: UserEnhancedMetricsResponseFields;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof UserEnhancedMetricsResponse
+     */
+    'status'?: boolean;
+}
+/**
+ * 
+ * @export
+ * @interface UserEnhancedMetricsResponseFields
+ */
+export interface UserEnhancedMetricsResponseFields {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof UserEnhancedMetricsResponseFields
+     */
+    'enabled'?: boolean;
+}
 /**
  * 
  * @export
@@ -28441,6 +28591,49 @@ export const VirtualMachineApiAxiosParamCreator = function (configuration?: Conf
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
 
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Enable or disable the Hyperstack VM Agent (Enhanced Metrics) for an existing virtual machine. The agent itself must be installed/removed manually inside the VM — the response includes the install command when enabling.
+         * @summary Enable or disable Enhanced Metrics for a virtual machine
+         * @param {number} vmId 
+         * @param {UserEnhancedMetricsPayload} payload 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        toggleEnhancedMetricsForAVM: async (vmId: number, payload: UserEnhancedMetricsPayload, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'vmId' is not null or undefined
+            assertParamExists('toggleEnhancedMetricsForAVM', 'vmId', vmId)
+            // verify required parameter 'payload' is not null or undefined
+            assertParamExists('toggleEnhancedMetricsForAVM', 'payload', payload)
+            const localVarPath = `/core/virtual-machines/{vm_id}/enhanced-metrics`
+                .replace(`{${"vm_id"}}`, encodeURIComponent(String(vmId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication apiKey required
+            await setApiKeyToObject(localVarHeaderParameter, "api_key", configuration)
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(payload, localVarRequestOptions, configuration)
+
             return {
                 url: toPathString(localVarUrlObj),
                 options: localVarRequestOptions,
@@ -28735,6 +28928,20 @@ export const VirtualMachineApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['VirtualMachineApi.stopVM']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Enable or disable the Hyperstack VM Agent (Enhanced Metrics) for an existing virtual machine. The agent itself must be installed/removed manually inside the VM — the response includes the install command when enabling.
+         * @summary Enable or disable Enhanced Metrics for a virtual machine
+         * @param {number} vmId 
+         * @param {UserEnhancedMetricsPayload} payload 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async toggleEnhancedMetricsForAVM(vmId: number, payload: UserEnhancedMetricsPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserEnhancedMetricsResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.toggleEnhancedMetricsForAVM(vmId, payload, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['VirtualMachineApi.toggleEnhancedMetricsForAVM']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
     }
 };
 
@@ -28964,6 +29171,17 @@ export const VirtualMachineApiFactory = function (configuration?: Configuration,
         stopVM(vmId: number, options?: RawAxiosRequestConfig): AxiosPromise<ResponseModel> {
             return localVarFp.stopVM(vmId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Enable or disable the Hyperstack VM Agent (Enhanced Metrics) for an existing virtual machine. The agent itself must be installed/removed manually inside the VM — the response includes the install command when enabling.
+         * @summary Enable or disable Enhanced Metrics for a virtual machine
+         * @param {number} vmId 
+         * @param {UserEnhancedMetricsPayload} payload 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        toggleEnhancedMetricsForAVM(vmId: number, payload: UserEnhancedMetricsPayload, options?: RawAxiosRequestConfig): AxiosPromise<UserEnhancedMetricsResponse> {
+            return localVarFp.toggleEnhancedMetricsForAVM(vmId, payload, options).then((request) => request(axios, basePath));
+        },
     };
 };
 
@@ -29232,6 +29450,19 @@ export class VirtualMachineApi extends BaseAPI {
     public stopVM(vmId: number, options?: RawAxiosRequestConfig) {
         return VirtualMachineApiFp(this.configuration).stopVM(vmId, options).then((request) => request(this.axios, this.basePath));
     }
+
+    /**
+     * Enable or disable the Hyperstack VM Agent (Enhanced Metrics) for an existing virtual machine. The agent itself must be installed/removed manually inside the VM — the response includes the install command when enabling.
+     * @summary Enable or disable Enhanced Metrics for a virtual machine
+     * @param {number} vmId 
+     * @param {UserEnhancedMetricsPayload} payload 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VirtualMachineApi
+     */
+    public toggleEnhancedMetricsForAVM(vmId: number, payload: UserEnhancedMetricsPayload, options?: RawAxiosRequestConfig) {
+        return VirtualMachineApiFp(this.configuration).toggleEnhancedMetricsForAVM(vmId, payload, options).then((request) => request(this.axios, this.basePath));
+    }
 }
 
 /**

package/common.ts

@@ -16,7 +16,7 @@
 import type { Configuration } from "./configuration";
 import type { RequestArgs } from "./base";
 import type { AxiosInstance, AxiosResponse } from 'axios';
-import { RequiredError } from "./base";
+import { RequiredError } from "./base"; import { applyHyperstackHeaders } from "./hyperstackHeaders";
 
 /**
  *
@@ -144,7 +144,7 @@ export const toPathString = function (url: URL) {
  */
 export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) {
     return <T = unknown, R = AxiosResponse<T>>(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH): Promise<R> => {
-        const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url};
+        const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url}; applyHyperstackHeaders(axiosRequestArgs);
         return axios.request<T, R>(axiosRequestArgs) as Promise<R>;
     };
 }

package/dist/api.d.ts

@@ -1767,6 +1767,43 @@ export interface CompatibleFlavor {
      */
     'reason'?: string;
 }
+/**
+ *
+ * @export
+ * @interface CompatibleImage
+ */
+export interface CompatibleImage {
+    /**
+     * JSON constraints object
+     * @type {object}
+     * @memberof CompatibleImage
+     */
+    'constraints'?: object;
+    /**
+     *
+     * @type {number}
+     * @memberof CompatibleImage
+     */
+    'image_id'?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof CompatibleImage
+     */
+    'image_name'?: string;
+    /**
+     * Either \'hard\' or \'soft\'
+     * @type {string}
+     * @memberof CompatibleImage
+     */
+    'link_type'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CompatibleImage
+     */
+    'reason'?: string;
+}
 /**
  *
  * @export
@@ -2665,6 +2702,12 @@ export interface CreateInstancesPayload {
      * @memberof CreateInstancesPayload
      */
     'enable_port_randomization'?: boolean;
+    /**
+     * When true, the Hyperstack VM Agent is opted in for this VM and metrics ingestion is allowed by the prom-gateway. The agent must still be installed on the VM (typically via user_data cloud-init).
+     * @type {boolean}
+     * @memberof CreateInstancesPayload
+     */
+    'enhanced_monitoring_enabled'?: boolean;
     /**
      * The name of the [environment](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/) in which the virtual machine is to be created.
      * @type {string}
@@ -4056,6 +4099,12 @@ export interface FlavorFields {
      * @memberof FlavorFields
      */
     'id'?: number;
+    /**
+     * Image compatibility restrictions for this flavor (flavor → image links)
+     * @type {ImageRestrictions}
+     * @memberof FlavorFields
+     */
+    'image_restrictions'?: ImageRestrictions;
     /**
      *
      * @type {Array<LableResonse>}
@@ -4804,6 +4853,31 @@ export interface ImageGetResponse {
      */
     'type'?: string;
 }
+/**
+ *
+ * @export
+ * @interface ImageRestrictions
+ */
+export interface ImageRestrictions {
+    /**
+     * List of images this flavor is allowed to launch, with link metadata
+     * @type {Array<CompatibleImage>}
+     * @memberof ImageRestrictions
+     */
+    'compatible_images'?: Array<CompatibleImage>;
+    /**
+     * Whether the flavor is restricted to a set of images
+     * @type {boolean}
+     * @memberof ImageRestrictions
+     */
+    'has_image_restrictions'?: boolean;
+    /**
+     * Either \'hard\', \'soft\', or null if no restrictions
+     * @type {string}
+     * @memberof ImageRestrictions
+     */
+    'restriction_type'?: string;
+}
 /**
  *
  * @export
@@ -4959,6 +5033,19 @@ export interface Instance {
      */
     'status'?: boolean;
 }
+/**
+ *
+ * @export
+ * @interface InstanceEnhancedMetricsFields
+ */
+export interface InstanceEnhancedMetricsFields {
+    /**
+     *
+     * @type {boolean}
+     * @memberof InstanceEnhancedMetricsFields
+     */
+    'enabled'?: boolean;
+}
 /**
  *
  * @export
@@ -5100,6 +5187,12 @@ export interface InstanceFields {
      * @memberof InstanceFields
      */
     'created_at'?: string;
+    /**
+     *
+     * @type {InstanceEnhancedMetricsFields}
+     * @memberof InstanceFields
+     */
+    'enhanced_metrics'?: InstanceEnhancedMetricsFields;
     /**
      *
      * @type {InstanceEnvironmentFields}
@@ -10140,6 +10233,63 @@ export interface UserDefaultChoicesForUserResponse {
      */
     'user_default_choices'?: Array<UserDefaultChoiceForUserFields>;
 }
+/**
+ *
+ * @export
+ * @interface UserEnhancedMetricsPayload
+ */
+export interface UserEnhancedMetricsPayload {
+    /**
+     * Set to true to opt this VM into Enhanced Metrics, false to opt out.
+     * @type {boolean}
+     * @memberof UserEnhancedMetricsPayload
+     */
+    'enabled': boolean;
+}
+/**
+ *
+ * @export
+ * @interface UserEnhancedMetricsResponse
+ */
+export interface UserEnhancedMetricsResponse {
+    /**
+     * One-liner the user can run inside the VM to install the agent when enabling. Omitted when disabling.
+     * @type {string}
+     * @memberof UserEnhancedMetricsResponse
+     */
+    'install_command'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UserEnhancedMetricsResponse
+     */
+    'message'?: string;
+    /**
+     *
+     * @type {UserEnhancedMetricsResponseFields}
+     * @memberof UserEnhancedMetricsResponse
+     */
+    'metrics'?: UserEnhancedMetricsResponseFields;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserEnhancedMetricsResponse
+     */
+    'status'?: boolean;
+}
+/**
+ *
+ * @export
+ * @interface UserEnhancedMetricsResponseFields
+ */
+export interface UserEnhancedMetricsResponseFields {
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserEnhancedMetricsResponseFields
+     */
+    'enabled'?: boolean;
+}
 /**
  *
  * @export
@@ -19085,6 +19235,15 @@ export declare const VirtualMachineApiAxiosParamCreator: (configuration?: Config
      * @throws {RequiredError}
      */
     stopVM: (vmId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Enable or disable the Hyperstack VM Agent (Enhanced Metrics) for an existing virtual machine. The agent itself must be installed/removed manually inside the VM — the response includes the install command when enabling.
+     * @summary Enable or disable Enhanced Metrics for a virtual machine
+     * @param {number} vmId
+     * @param {UserEnhancedMetricsPayload} payload
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    toggleEnhancedMetricsForAVM: (vmId: number, payload: UserEnhancedMetricsPayload, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * VirtualMachineApi - functional programming interface
@@ -19270,6 +19429,15 @@ export declare const VirtualMachineApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     stopVM(vmId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResponseModel>>;
+    /**
+     * Enable or disable the Hyperstack VM Agent (Enhanced Metrics) for an existing virtual machine. The agent itself must be installed/removed manually inside the VM — the response includes the install command when enabling.
+     * @summary Enable or disable Enhanced Metrics for a virtual machine
+     * @param {number} vmId
+     * @param {UserEnhancedMetricsPayload} payload
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    toggleEnhancedMetricsForAVM(vmId: number, payload: UserEnhancedMetricsPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserEnhancedMetricsResponse>>;
 };
 /**
  * VirtualMachineApi - factory interface
@@ -19455,6 +19623,15 @@ export declare const VirtualMachineApiFactory: (configuration?: Configuration, b
      * @throws {RequiredError}
      */
     stopVM(vmId: number, options?: RawAxiosRequestConfig): AxiosPromise<ResponseModel>;
+    /**
+     * Enable or disable the Hyperstack VM Agent (Enhanced Metrics) for an existing virtual machine. The agent itself must be installed/removed manually inside the VM — the response includes the install command when enabling.
+     * @summary Enable or disable Enhanced Metrics for a virtual machine
+     * @param {number} vmId
+     * @param {UserEnhancedMetricsPayload} payload
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    toggleEnhancedMetricsForAVM(vmId: number, payload: UserEnhancedMetricsPayload, options?: RawAxiosRequestConfig): AxiosPromise<UserEnhancedMetricsResponse>;
 };
 /**
  * VirtualMachineApi - object-oriented interface
@@ -19662,6 +19839,16 @@ export declare class VirtualMachineApi extends BaseAPI {
      * @memberof VirtualMachineApi
      */
     stopVM(vmId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ResponseModel, any, {}, any>>;
+    /**
+     * Enable or disable the Hyperstack VM Agent (Enhanced Metrics) for an existing virtual machine. The agent itself must be installed/removed manually inside the VM — the response includes the install command when enabling.
+     * @summary Enable or disable Enhanced Metrics for a virtual machine
+     * @param {number} vmId
+     * @param {UserEnhancedMetricsPayload} payload
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VirtualMachineApi
+     */
+    toggleEnhancedMetricsForAVM(vmId: number, payload: UserEnhancedMetricsPayload, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserEnhancedMetricsResponse, any, {}, any>>;
 }
 /**
  * @export