@nexgencloud/hyperstack-sdk-typescript 1.48.0-alpha → 1.50.0-alpha

package/README.md

@@ -1,4 +1,4 @@
-## @nexgencloud/hyperstack-sdk-typescript@v1.48.0-alpha
+## @nexgencloud/hyperstack-sdk-typescript@v1.50.0-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.48.0-alpha --save
+npm install @nexgencloud/hyperstack-sdk-typescript@v1.50.0-alpha --save
 ```
 
 _unPublished (not recommended):_

package/api.ts

@@ -1572,6 +1572,43 @@ export interface CommonResponseModel {
      */
     'status'?: boolean;
 }
+/**
+ * 
+ * @export
+ * @interface CompatibleFlavor
+ */
+export interface CompatibleFlavor {
+    /**
+     * JSON constraints object
+     * @type {object}
+     * @memberof CompatibleFlavor
+     */
+    'constraints'?: object;
+    /**
+     * 
+     * @type {number}
+     * @memberof CompatibleFlavor
+     */
+    'flavor_id'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof CompatibleFlavor
+     */
+    'flavor_name'?: string;
+    /**
+     * Either \'hard\' or \'soft\'
+     * @type {string}
+     * @memberof CompatibleFlavor
+     */
+    'link_type'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CompatibleFlavor
+     */
+    'reason'?: string;
+}
 /**
  * 
  * @export
@@ -3719,6 +3756,31 @@ export interface FlavorObjectFields {
      */
     'ram'?: number;
 }
+/**
+ * 
+ * @export
+ * @interface FlavorRestrictions
+ */
+export interface FlavorRestrictions {
+    /**
+     * List of compatible flavors with their link metadata
+     * @type {Array<CompatibleFlavor>}
+     * @memberof FlavorRestrictions
+     */
+    'compatible_flavors'?: Array<CompatibleFlavor>;
+    /**
+     * Whether the image has any flavor restrictions
+     * @type {boolean}
+     * @memberof FlavorRestrictions
+     */
+    'has_flavor_restrictions'?: boolean;
+    /**
+     * Either \'hard\', \'soft\', or null if no restrictions
+     * @type {string}
+     * @memberof FlavorRestrictions
+     */
+    'restriction_type'?: string;
+}
 /**
  * 
  * @export
@@ -4169,6 +4231,12 @@ export interface ImageFields {
      * @memberof ImageFields
      */
     'display_size'?: string;
+    /**
+     * Flavor compatibility restrictions for this image
+     * @type {FlavorRestrictions}
+     * @memberof ImageFields
+     */
+    'flavor_restrictions'?: FlavorRestrictions;
     /**
      * 
      * @type {number}
@@ -9431,6 +9499,55 @@ export interface UsersInfoListResponse {
      */
     'users_info'?: UsersInfoFields;
 }
+/**
+ * 
+ * @export
+ * @interface VMQuota
+ */
+export interface VMQuota {
+    /**
+     * 
+     * @type {number}
+     * @memberof VMQuota
+     */
+    'available_vms'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof VMQuota
+     */
+    'cidr'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof VMQuota
+     */
+    'current_vms'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof VMQuota
+     */
+    'max_vms'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof VMQuota
+     */
+    'message'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof VMQuota
+     */
+    'percentage_used'?: number;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof VMQuota
+     */
+    'status'?: boolean;
+}
 /**
  * 
  * @export
@@ -9873,6 +9990,24 @@ export interface Voucher {
      * @memberof Voucher
      */
     'id': number;
+    /**
+     * Max redemption count for a General Voucher
+     * @type {number}
+     * @memberof Voucher
+     */
+    'max_redemption_count'?: number;
+    /**
+     * Current redemption count for a General Voucher
+     * @type {number}
+     * @memberof Voucher
+     */
+    'redemption_count'?: number;
+    /**
+     * Remaining redemptions
+     * @type {number}
+     * @memberof Voucher
+     */
+    'remaining_redemptions'?: number;
     /**
      * Voucher status
      * @type {string}
@@ -18531,6 +18666,43 @@ export const EnvironmentApiAxiosParamCreator = function (configuration?: Configu
 
 
     
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Retrieves VM quota information for a specific environment, including current VM count, maximum VMs allowed, available VMs, and percentage used in an environment before reaching the subnet IP limit.
+         * @summary Get environment VM quota
+         * @param {number} id 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getEnvironmentVMQuota: async (id: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('getEnvironmentVMQuota', 'id', id)
+            const localVarPath = `/core/environments/{id}/vm-quota`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)));
+            // 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: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication apiKey required
+            await setApiKeyToObject(localVarHeaderParameter, "api_key", configuration)
+
+
+    
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -18693,6 +18865,19 @@ export const EnvironmentApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['EnvironmentApi.getEnvironment']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Retrieves VM quota information for a specific environment, including current VM count, maximum VMs allowed, available VMs, and percentage used in an environment before reaching the subnet IP limit.
+         * @summary Get environment VM quota
+         * @param {number} id 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getEnvironmentVMQuota(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VMQuota>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getEnvironmentVMQuota(id, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['EnvironmentApi.getEnvironmentVMQuota']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Returns a list of your existing environments, providing the following details for each; environment ID, name, [**region**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/), and the date and time of creation. For more information on environments, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/).
          * @summary List environments
@@ -18772,6 +18957,16 @@ export const EnvironmentApiFactory = function (configuration?: Configuration, ba
         getEnvironment(id: number, options?: RawAxiosRequestConfig): AxiosPromise<Environment> {
             return localVarFp.getEnvironment(id, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Retrieves VM quota information for a specific environment, including current VM count, maximum VMs allowed, available VMs, and percentage used in an environment before reaching the subnet IP limit.
+         * @summary Get environment VM quota
+         * @param {number} id 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getEnvironmentVMQuota(id: number, options?: RawAxiosRequestConfig): AxiosPromise<VMQuota> {
+            return localVarFp.getEnvironmentVMQuota(id, options).then((request) => request(axios, basePath));
+        },
         /**
          * Returns a list of your existing environments, providing the following details for each; environment ID, name, [**region**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/), and the date and time of creation. For more information on environments, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/).
          * @summary List environments
@@ -18853,6 +19048,18 @@ export class EnvironmentApi extends BaseAPI {
         return EnvironmentApiFp(this.configuration).getEnvironment(id, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Retrieves VM quota information for a specific environment, including current VM count, maximum VMs allowed, available VMs, and percentage used in an environment before reaching the subnet IP limit.
+     * @summary Get environment VM quota
+     * @param {number} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof EnvironmentApi
+     */
+    public getEnvironmentVMQuota(id: number, options?: RawAxiosRequestConfig) {
+        return EnvironmentApiFp(this.configuration).getEnvironmentVMQuota(id, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Returns a list of your existing environments, providing the following details for each; environment ID, name, [**region**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/), and the date and time of creation. For more information on environments, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/).
      * @summary List environments
@@ -24987,10 +25194,11 @@ export const VirtualMachineApiAxiosParamCreator = function (configuration?: Conf
          * Check if a Virtual Machine name is available
          * @summary Fetch virtual machine name availability
          * @param {string} name 
+         * @param {string} [count] Nr of instances to handle (optional, default: 1)
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        checkVMNameAvailability: async (name: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        checkVMNameAvailability: async (name: string, count?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'name' is not null or undefined
             assertParamExists('checkVMNameAvailability', 'name', name)
             const localVarPath = `/core/virtual-machines/name-availability/{name}`
@@ -25009,6 +25217,10 @@ export const VirtualMachineApiAxiosParamCreator = function (configuration?: Conf
             // authentication apiKey required
             await setApiKeyToObject(localVarHeaderParameter, "api_key", configuration)
 
+            if (count !== undefined) {
+                localVarQueryParameter['count'] = count;
+            }
+
 
     
             setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -25485,10 +25697,11 @@ export const VirtualMachineApiAxiosParamCreator = function (configuration?: Conf
          * @param {string} [search] 
          * @param {string} [environment] 
          * @param {Array<number>} [excludeFirewalls] Comma-separated list of Security Group IDs to ignore instances attached
+         * @param {boolean} [exactEnvironmentMatch] Flag to filter environment by exact match instead of partial match
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listVMs: async (page?: number, pageSize?: number, search?: string, environment?: string, excludeFirewalls?: Array<number>, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        listVMs: async (page?: number, pageSize?: number, search?: string, environment?: string, excludeFirewalls?: Array<number>, exactEnvironmentMatch?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             const localVarPath = `/core/virtual-machines`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -25524,6 +25737,10 @@ export const VirtualMachineApiAxiosParamCreator = function (configuration?: Conf
                 localVarQueryParameter['exclude_firewalls'] = excludeFirewalls;
             }
 
+            if (exactEnvironmentMatch !== undefined) {
+                localVarQueryParameter['exact_environment_match'] = exactEnvironmentMatch;
+            }
+
 
     
             setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -25774,11 +25991,12 @@ export const VirtualMachineApiFp = function(configuration?: Configuration) {
          * Check if a Virtual Machine name is available
          * @summary Fetch virtual machine name availability
          * @param {string} name 
+         * @param {string} [count] Nr of instances to handle (optional, default: 1)
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async checkVMNameAvailability(name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameAvailableModel>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.checkVMNameAvailability(name, options);
+        async checkVMNameAvailability(name: string, count?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameAvailableModel>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.checkVMNameAvailability(name, count, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['VirtualMachineApi.checkVMNameAvailability']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -25943,11 +26161,12 @@ export const VirtualMachineApiFp = function(configuration?: Configuration) {
          * @param {string} [search] 
          * @param {string} [environment] 
          * @param {Array<number>} [excludeFirewalls] Comma-separated list of Security Group IDs to ignore instances attached
+         * @param {boolean} [exactEnvironmentMatch] Flag to filter environment by exact match instead of partial match
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async listVMs(page?: number, pageSize?: number, search?: string, environment?: string, excludeFirewalls?: Array<number>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Instances>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.listVMs(page, pageSize, search, environment, excludeFirewalls, options);
+        async listVMs(page?: number, pageSize?: number, search?: string, environment?: string, excludeFirewalls?: Array<number>, exactEnvironmentMatch?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Instances>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listVMs(page, pageSize, search, environment, excludeFirewalls, exactEnvironmentMatch, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['VirtualMachineApi.listVMs']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -26055,11 +26274,12 @@ export const VirtualMachineApiFactory = function (configuration?: Configuration,
          * Check if a Virtual Machine name is available
          * @summary Fetch virtual machine name availability
          * @param {string} name 
+         * @param {string} [count] Nr of instances to handle (optional, default: 1)
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        checkVMNameAvailability(name: string, options?: RawAxiosRequestConfig): AxiosPromise<NameAvailableModel> {
-            return localVarFp.checkVMNameAvailability(name, options).then((request) => request(axios, basePath));
+        checkVMNameAvailability(name: string, count?: string, options?: RawAxiosRequestConfig): AxiosPromise<NameAvailableModel> {
+            return localVarFp.checkVMNameAvailability(name, count, options).then((request) => request(axios, basePath));
         },
         /**
          * Creates a firewall rule for a virtual machine. Include the virtual machine ID in the path, and provide the firewall rule configuration in the request body, as detailed below. For additional information on firewall rules, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/virtual-machines/vm-firewall-rules/add-firewall-rule-to-vm).
@@ -26188,11 +26408,12 @@ export const VirtualMachineApiFactory = function (configuration?: Configuration,
          * @param {string} [search] 
          * @param {string} [environment] 
          * @param {Array<number>} [excludeFirewalls] Comma-separated list of Security Group IDs to ignore instances attached
+         * @param {boolean} [exactEnvironmentMatch] Flag to filter environment by exact match instead of partial match
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listVMs(page?: number, pageSize?: number, search?: string, environment?: string, excludeFirewalls?: Array<number>, options?: RawAxiosRequestConfig): AxiosPromise<Instances> {
-            return localVarFp.listVMs(page, pageSize, search, environment, excludeFirewalls, options).then((request) => request(axios, basePath));
+        listVMs(page?: number, pageSize?: number, search?: string, environment?: string, excludeFirewalls?: Array<number>, exactEnvironmentMatch?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<Instances> {
+            return localVarFp.listVMs(page, pageSize, search, environment, excludeFirewalls, exactEnvironmentMatch, options).then((request) => request(axios, basePath));
         },
         /**
          * Request console logs for a virtual machine
@@ -26286,12 +26507,13 @@ export class VirtualMachineApi extends BaseAPI {
      * Check if a Virtual Machine name is available
      * @summary Fetch virtual machine name availability
      * @param {string} name 
+     * @param {string} [count] Nr of instances to handle (optional, default: 1)
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof VirtualMachineApi
      */
-    public checkVMNameAvailability(name: string, options?: RawAxiosRequestConfig) {
-        return VirtualMachineApiFp(this.configuration).checkVMNameAvailability(name, options).then((request) => request(this.axios, this.basePath));
+    public checkVMNameAvailability(name: string, count?: string, options?: RawAxiosRequestConfig) {
+        return VirtualMachineApiFp(this.configuration).checkVMNameAvailability(name, count, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**
@@ -26443,12 +26665,13 @@ export class VirtualMachineApi extends BaseAPI {
      * @param {string} [search] 
      * @param {string} [environment] 
      * @param {Array<number>} [excludeFirewalls] Comma-separated list of Security Group IDs to ignore instances attached
+     * @param {boolean} [exactEnvironmentMatch] Flag to filter environment by exact match instead of partial match
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof VirtualMachineApi
      */
-    public listVMs(page?: number, pageSize?: number, search?: string, environment?: string, excludeFirewalls?: Array<number>, options?: RawAxiosRequestConfig) {
-        return VirtualMachineApiFp(this.configuration).listVMs(page, pageSize, search, environment, excludeFirewalls, options).then((request) => request(this.axios, this.basePath));
+    public listVMs(page?: number, pageSize?: number, search?: string, environment?: string, excludeFirewalls?: Array<number>, exactEnvironmentMatch?: boolean, options?: RawAxiosRequestConfig) {
+        return VirtualMachineApiFp(this.configuration).listVMs(page, pageSize, search, environment, excludeFirewalls, exactEnvironmentMatch, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**