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

package/dist/esm/api.js

@@ -8616,6 +8616,246 @@ export class DeploymentApi extends BaseAPI {
         return DeploymentApiFp(this.configuration).startDeployment(payload, options).then((request) => request(this.axios, this.basePath));
     }
 }
+/**
+ * EmailOptInOutApi - axios parameter creator
+ * @export
+ */
+export const EmailOptInOutApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * Returns all email categories with the user\'s opt-in status. Categories without an explicit preference default to opted_in=true.
+         * @summary Get all email preferences for the authenticated user
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getEmailPreferencesForAUser: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
+            const localVarPath = `/auth/email/opt-out`;
+            // 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 = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication apiKey required
+            yield setApiKeyToObject(localVarHeaderParameter, "api_key", configuration);
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Sets opted_in to the given value for every non-required, non-deleted email category. Required categories are not affected.
+         * @summary Toggle all optional email preferences for the authenticated user
+         * @param {UpdateEmailPreferenceInput} payload
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        toggleAllOptionalEmailPreferencesForTheUser: (payload_1, ...args_1) => __awaiter(this, [payload_1, ...args_1], void 0, function* (payload, options = {}) {
+            // verify required parameter 'payload' is not null or undefined
+            assertParamExists('toggleAllOptionalEmailPreferencesForTheUser', 'payload', payload);
+            const localVarPath = `/auth/email/opt-out`;
+            // 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 = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication apiKey required
+            yield setApiKeyToObject(localVarHeaderParameter, "api_key", configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = serializeDataIfNeeded(payload, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Updates the opted_in status for the given email category slug. If the slug belongs to a parent category (email_category_id is null), all non-deleted child categories are updated. If the slug belongs to a child category, only that category is updated.
+         * @summary Update email preference opted_in status for a category slug
+         * @param {string} slug
+         * @param {UpdateEmailPreferenceInput} payload
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateEmailPreferenceForACategoryBySlug: (slug_1, payload_1, ...args_1) => __awaiter(this, [slug_1, payload_1, ...args_1], void 0, function* (slug, payload, options = {}) {
+            // verify required parameter 'slug' is not null or undefined
+            assertParamExists('updateEmailPreferenceForACategoryBySlug', 'slug', slug);
+            // verify required parameter 'payload' is not null or undefined
+            assertParamExists('updateEmailPreferenceForACategoryBySlug', 'payload', payload);
+            const localVarPath = `/auth/email/opt-out/{slug}`
+                .replace(`{${"slug"}}`, encodeURIComponent(String(slug)));
+            // 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 = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication apiKey required
+            yield setApiKeyToObject(localVarHeaderParameter, "api_key", configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = serializeDataIfNeeded(payload, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+/**
+ * EmailOptInOutApi - functional programming interface
+ * @export
+ */
+export const EmailOptInOutApiFp = function (configuration) {
+    const localVarAxiosParamCreator = EmailOptInOutApiAxiosParamCreator(configuration);
+    return {
+        /**
+         * Returns all email categories with the user\'s opt-in status. Categories without an explicit preference default to opted_in=true.
+         * @summary Get all email preferences for the authenticated user
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getEmailPreferencesForAUser(options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getEmailPreferencesForAUser(options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EmailOptInOutApi.getEmailPreferencesForAUser']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+        /**
+         * Sets opted_in to the given value for every non-required, non-deleted email category. Required categories are not affected.
+         * @summary Toggle all optional email preferences for the authenticated user
+         * @param {UpdateEmailPreferenceInput} payload
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        toggleAllOptionalEmailPreferencesForTheUser(payload, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.toggleAllOptionalEmailPreferencesForTheUser(payload, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EmailOptInOutApi.toggleAllOptionalEmailPreferencesForTheUser']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+        /**
+         * Updates the opted_in status for the given email category slug. If the slug belongs to a parent category (email_category_id is null), all non-deleted child categories are updated. If the slug belongs to a child category, only that category is updated.
+         * @summary Update email preference opted_in status for a category slug
+         * @param {string} slug
+         * @param {UpdateEmailPreferenceInput} payload
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateEmailPreferenceForACategoryBySlug(slug, payload, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.updateEmailPreferenceForACategoryBySlug(slug, payload, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EmailOptInOutApi.updateEmailPreferenceForACategoryBySlug']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+    };
+};
+/**
+ * EmailOptInOutApi - factory interface
+ * @export
+ */
+export const EmailOptInOutApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = EmailOptInOutApiFp(configuration);
+    return {
+        /**
+         * Returns all email categories with the user\'s opt-in status. Categories without an explicit preference default to opted_in=true.
+         * @summary Get all email preferences for the authenticated user
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getEmailPreferencesForAUser(options) {
+            return localVarFp.getEmailPreferencesForAUser(options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Sets opted_in to the given value for every non-required, non-deleted email category. Required categories are not affected.
+         * @summary Toggle all optional email preferences for the authenticated user
+         * @param {UpdateEmailPreferenceInput} payload
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        toggleAllOptionalEmailPreferencesForTheUser(payload, options) {
+            return localVarFp.toggleAllOptionalEmailPreferencesForTheUser(payload, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Updates the opted_in status for the given email category slug. If the slug belongs to a parent category (email_category_id is null), all non-deleted child categories are updated. If the slug belongs to a child category, only that category is updated.
+         * @summary Update email preference opted_in status for a category slug
+         * @param {string} slug
+         * @param {UpdateEmailPreferenceInput} payload
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateEmailPreferenceForACategoryBySlug(slug, payload, options) {
+            return localVarFp.updateEmailPreferenceForACategoryBySlug(slug, payload, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+/**
+ * EmailOptInOutApi - object-oriented interface
+ * @export
+ * @class EmailOptInOutApi
+ * @extends {BaseAPI}
+ */
+export class EmailOptInOutApi extends BaseAPI {
+    /**
+     * Returns all email categories with the user\'s opt-in status. Categories without an explicit preference default to opted_in=true.
+     * @summary Get all email preferences for the authenticated user
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof EmailOptInOutApi
+     */
+    getEmailPreferencesForAUser(options) {
+        return EmailOptInOutApiFp(this.configuration).getEmailPreferencesForAUser(options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Sets opted_in to the given value for every non-required, non-deleted email category. Required categories are not affected.
+     * @summary Toggle all optional email preferences for the authenticated user
+     * @param {UpdateEmailPreferenceInput} payload
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof EmailOptInOutApi
+     */
+    toggleAllOptionalEmailPreferencesForTheUser(payload, options) {
+        return EmailOptInOutApiFp(this.configuration).toggleAllOptionalEmailPreferencesForTheUser(payload, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Updates the opted_in status for the given email category slug. If the slug belongs to a parent category (email_category_id is null), all non-deleted child categories are updated. If the slug belongs to a child category, only that category is updated.
+     * @summary Update email preference opted_in status for a category slug
+     * @param {string} slug
+     * @param {UpdateEmailPreferenceInput} payload
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof EmailOptInOutApi
+     */
+    updateEmailPreferenceForACategoryBySlug(slug, payload, options) {
+        return EmailOptInOutApiFp(this.configuration).updateEmailPreferenceForACategoryBySlug(slug, payload, options).then((request) => request(this.axios, this.basePath));
+    }
+}
 /**
  * EnvironmentApi - axios parameter creator
  * @export
@@ -11047,6 +11287,33 @@ export const KeypairApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Retrieves the SSH public key types supported for import.
+         * @summary List supported key pair types
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listSupportedKeyPairTypes: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
+            const localVarPath = `/core/supported-keypairs`;
+            // 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 = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication apiKey required
+            yield setApiKeyToObject(localVarHeaderParameter, "api_key", configuration);
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Updates the name of a specified key pair. Provide the key pair ID in the path, and include the new `name` in the request body.
          * @summary Update key pair name
@@ -11142,6 +11409,21 @@ export const KeypairApiFp = function (configuration) {
                 return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * Retrieves the SSH public key types supported for import.
+         * @summary List supported key pair types
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listSupportedKeyPairTypes(options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.listSupportedKeyPairTypes(options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['KeypairApi.listSupportedKeyPairTypes']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
         /**
          * Updates the name of a specified key pair. Provide the key pair ID in the path, and include the new `name` in the request body.
          * @summary Update key pair name
@@ -11200,6 +11482,15 @@ export const KeypairApiFactory = function (configuration, basePath, axios) {
         listKeyPairs(page, pageSize, search, options) {
             return localVarFp.listKeyPairs(page, pageSize, search, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Retrieves the SSH public key types supported for import.
+         * @summary List supported key pair types
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listSupportedKeyPairTypes(options) {
+            return localVarFp.listSupportedKeyPairTypes(options).then((request) => request(axios, basePath));
+        },
         /**
          * Updates the name of a specified key pair. Provide the key pair ID in the path, and include the new `name` in the request body.
          * @summary Update key pair name
@@ -11255,6 +11546,16 @@ export class KeypairApi extends BaseAPI {
     listKeyPairs(page, pageSize, search, options) {
         return KeypairApiFp(this.configuration).listKeyPairs(page, pageSize, search, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Retrieves the SSH public key types supported for import.
+     * @summary List supported key pair types
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof KeypairApi
+     */
+    listSupportedKeyPairTypes(options) {
+        return KeypairApiFp(this.configuration).listSupportedKeyPairTypes(options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Updates the name of a specified key pair. Provide the key pair ID in the path, and include the new `name` in the request body.
      * @summary Update key pair name
@@ -14255,6 +14556,33 @@ export const UserApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Retrieve the list of allowed ISO 3166-1 alpha-2 country codes that can be used for billing information.
+         * @summary GET: Retrieve allowed country codes
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getAllowedCountryCodes: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
+            const localVarPath = `/billing/user/countries`;
+            // 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 = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication apiKey required
+            yield setApiKeyToObject(localVarHeaderParameter, "api_key", configuration);
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Retrieve the billing details associated with your user.
          * @summary GET: Retrieve billing info
@@ -14339,6 +14667,21 @@ export const UserApiFp = function (configuration) {
                 return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * Retrieve the list of allowed ISO 3166-1 alpha-2 country codes that can be used for billing information.
+         * @summary GET: Retrieve allowed country codes
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getAllowedCountryCodes(options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getAllowedCountryCodes(options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['UserApi.getAllowedCountryCodes']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
         /**
          * Retrieve the billing details associated with your user.
          * @summary GET: Retrieve billing info
@@ -14389,6 +14732,15 @@ export const UserApiFactory = function (configuration, basePath, axios) {
         addUserBillingInfo(payload, options) {
             return localVarFp.addUserBillingInfo(payload, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Retrieve the list of allowed ISO 3166-1 alpha-2 country codes that can be used for billing information.
+         * @summary GET: Retrieve allowed country codes
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getAllowedCountryCodes(options) {
+            return localVarFp.getAllowedCountryCodes(options).then((request) => request(axios, basePath));
+        },
         /**
          * Retrieve the billing details associated with your user.
          * @summary GET: Retrieve billing info
@@ -14428,6 +14780,16 @@ export class UserApi extends BaseAPI {
     addUserBillingInfo(payload, options) {
         return UserApiFp(this.configuration).addUserBillingInfo(payload, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Retrieve the list of allowed ISO 3166-1 alpha-2 country codes that can be used for billing information.
+     * @summary GET: Retrieve allowed country codes
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UserApi
+     */
+    getAllowedCountryCodes(options) {
+        return UserApiFp(this.configuration).getAllowedCountryCodes(options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Retrieve the billing details associated with your user.
      * @summary GET: Retrieve billing info

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nexgencloud/hyperstack-sdk-typescript",
-  "version": "v1.52.3-alpha",
+  "version": "v1.54.7-alpha",
   "description": "Leverage the Infrahub API and Hyperstack platform to easily create, manage, and scale powerful GPU virtual machines and their associated resources.   Access this SDK to automate the deployment of your workloads and streamline your infrastructure management.  To contribute, please raise an issue with a bug report, feature request, feedback, or general inquiry.",
   "author": "OpenAPI-Generator Contributors",
   "repository": {