hcloud-sdk 15.0.0 → 16.0.0

package/lib/service/high5/space/pool/index.d.ts

@@ -0,0 +1,97 @@
+import { AxiosInstance } from "axios";
+import Base, { Options } from "../../../../Base";
+import { PaginatedResponse, SearchParams } from "../../../../interfaces/global";
+import { Pool, PoolChange, PoolQueryOptions, PoolTargetPatch } from "../../../../interfaces/high5/space/pool";
+import { OrganizationMember } from "../../../../interfaces/idp";
+export default class High5Pool extends Base {
+    constructor(options: Options, axios: AxiosInstance);
+    /**
+     * Get a pool from a space
+     *
+     * @param orgName   - Name of the organization
+     * @param spaceName - Name of the space
+     * @param name      - Name of the pool
+     * @returns Pool
+     */
+    getPool(orgName: string, spaceName: string, name: string): Promise<Pool>;
+    /**
+     * Replace a pool of a space
+     *
+     * @param orgName   - Name of the organization
+     * @param spaceName - Name of the space
+     * @param poolName  - Name of the old/current pool
+     * @param name      - New name for the pool
+     * @param targets   - Execution targets that compromise the pool
+     * @returns The new Pool
+     */
+    replacePool(orgName: string, spaceName: string, poolName: string, name: string, targets: string[]): Promise<PoolChange>;
+    /**
+     * Patch a pool of a space
+     *
+     * @param orgName   - Name of the organization
+     * @param spaceName - Name of the space
+     * @param poolName  - Name of the pool
+     * @param name      - New name for the pool
+     * @param targets   - Execution targets that compromise the pool
+     * @returns The patched Pool
+     */
+    patchPool(orgName: string, spaceName: string, poolName: string, name?: string, targets?: PoolTargetPatch): Promise<PoolChange>;
+    /**
+     * Delete a pool of a space
+     *
+     * @param orgName   - Name of the organization
+     * @param spaceName - Name of the space
+     * @param poolName  - Name of the pool
+     */
+    deletePool(orgName: string, spaceName: string, poolName: string): Promise<void>;
+    /**
+     * Retrieves all pools of a High5 Space which match the provided search filter(s). Will return all pools of the Space if no filter is provided.
+     *
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param filters (optional) Array of search filters
+     * @param sorting (optional) Sorting object
+     * @param limit (optional) Max number of results (1-100; defaults to 25)
+     * @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
+     * @returns Object containing an array of Pool and the total number of results found in the database (independent of limit and page)
+     */
+    searchPools({ orgName, spaceName, filters, sorting, options, limit, page, }: SearchParams & {
+        orgName: string;
+        spaceName: string;
+        options?: PoolQueryOptions;
+    }): Promise<PaginatedResponse<Pool>>;
+    /**
+     * Add a pool to a space
+     *
+     * @param orgName   - Name of the organization
+     * @param spaceName - Name of the space
+     * @param name      - Name of the pool
+     * @param targets   - Execution targets that compromise the pool
+     * @returns The created Pool
+     */
+    addPool(orgName: string, spaceName: string, name: string, targets: string[]): Promise<PoolChange>;
+    /**
+     * Retrieves all the pools the current user is assigned to as an execution target
+     *
+     * @returns Array of pools the user is assigned to as execution target
+     */
+    getPools(): Promise<Pool[]>;
+    /**
+     * Retrieves all targets of a pool which match the provided search filter(s). Will return all targets of the pool if no filter is provided.
+     *
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param poolName Name of the pool
+     * @param filters (optional) Array of search filters
+     * @param sorting (optional) Sorting object
+     * @param limit (optional) Max number of results (1-100; defaults to 25)
+     * @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
+     * @returns Object containing an array of OrganizationMember and the total number of results found in the database (independent of limit and page)
+     */
+    searchTargetsOfPool({ orgName, spaceName, poolName, filters, sorting, limit, page, }: SearchParams & {
+        orgName: string;
+        spaceName: string;
+        poolName: string;
+    }): Promise<PaginatedResponse<OrganizationMember>>;
+    protected getEndpoint(endpoint: string): string;
+}

package/lib/service/high5/space/pool/index.js

@@ -0,0 +1,171 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Base_1 = require("../../../../Base");
+const paginatedResponseHelper_1 = require("../../../../helper/paginatedResponseHelper");
+const searchFilter_1 = require("../../../../helper/searchFilter");
+class High5Pool extends Base_1.default {
+    constructor(options, axios) {
+        super(options, axios);
+    }
+    /**
+     * Get a pool from a space
+     *
+     * @param orgName   - Name of the organization
+     * @param spaceName - Name of the space
+     * @param name      - Name of the pool
+     * @returns Pool
+     */
+    getPool(orgName, spaceName, name) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/pools/${name}`));
+            return resp.data;
+        });
+    }
+    /**
+     * Replace a pool of a space
+     *
+     * @param orgName   - Name of the organization
+     * @param spaceName - Name of the space
+     * @param poolName  - Name of the old/current pool
+     * @param name      - New name for the pool
+     * @param targets   - Execution targets that compromise the pool
+     * @returns The new Pool
+     */
+    replacePool(orgName, spaceName, poolName, name, targets) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.put(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/pools/${poolName}`), {
+                name,
+                targets,
+            });
+            return resp.data;
+        });
+    }
+    /**
+     * Patch a pool of a space
+     *
+     * @param orgName   - Name of the organization
+     * @param spaceName - Name of the space
+     * @param poolName  - Name of the pool
+     * @param name      - New name for the pool
+     * @param targets   - Execution targets that compromise the pool
+     * @returns The patched Pool
+     */
+    patchPool(orgName, spaceName, poolName, name, targets) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (name === undefined && targets === undefined) {
+                throw new Error("unable to patch pool when there are no arguments to send");
+            }
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/pools/${poolName}`), {
+                name,
+                targets,
+            });
+            return resp.data;
+        });
+    }
+    /**
+     * Delete a pool of a space
+     *
+     * @param orgName   - Name of the organization
+     * @param spaceName - Name of the space
+     * @param poolName  - Name of the pool
+     */
+    deletePool(orgName, spaceName, poolName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/pools/${poolName}`));
+        });
+    }
+    /**
+     * Retrieves all pools of a High5 Space which match the provided search filter(s). Will return all pools of the Space if no filter is provided.
+     *
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param filters (optional) Array of search filters
+     * @param sorting (optional) Sorting object
+     * @param limit (optional) Max number of results (1-100; defaults to 25)
+     * @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
+     * @returns Object containing an array of Pool and the total number of results found in the database (independent of limit and page)
+     */
+    searchPools(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ orgName, spaceName, filters, sorting, options, limit = 25, page = 0, }) {
+            const filtersDTO = filters === null || filters === void 0 ? void 0 : filters.map((f) => new searchFilter_1.SearchFilterDTO(f));
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/pools/search`), {
+                filters: filtersDTO,
+                sorting: sorting,
+            }, {
+                params: {
+                    limit,
+                    page,
+                    totalTargetCount: options === null || options === void 0 ? void 0 : options.getTotalTargetCount,
+                    targetsSample: options === null || options === void 0 ? void 0 : options.getTargetsSample,
+                },
+            });
+            return (0, paginatedResponseHelper_1.createPaginatedResponse)(resp);
+        });
+    }
+    /**
+     * Add a pool to a space
+     *
+     * @param orgName   - Name of the organization
+     * @param spaceName - Name of the space
+     * @param name      - Name of the pool
+     * @param targets   - Execution targets that compromise the pool
+     * @returns The created Pool
+     */
+    addPool(orgName, spaceName, name, targets) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/pools`), { name, targets });
+            return resp.data;
+        });
+    }
+    /**
+     * Retrieves all the pools the current user is assigned to as an execution target
+     *
+     * @returns Array of pools the user is assigned to as execution target
+     */
+    getPools() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint("/v1/pools"));
+            return resp.data;
+        });
+    }
+    /**
+     * Retrieves all targets of a pool which match the provided search filter(s). Will return all targets of the pool if no filter is provided.
+     *
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param poolName Name of the pool
+     * @param filters (optional) Array of search filters
+     * @param sorting (optional) Sorting object
+     * @param limit (optional) Max number of results (1-100; defaults to 25)
+     * @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
+     * @returns Object containing an array of OrganizationMember and the total number of results found in the database (independent of limit and page)
+     */
+    searchTargetsOfPool(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ orgName, spaceName, poolName, filters, sorting, limit = 25, page = 0, }) {
+            const filtersDTO = filters === null || filters === void 0 ? void 0 : filters.map((f) => new searchFilter_1.SearchFilterDTO(f));
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/pools/${poolName}/targets/search`), {
+                filters: filtersDTO,
+                sorting: sorting,
+            }, {
+                params: {
+                    page,
+                    limit,
+                },
+            });
+            return (0, paginatedResponseHelper_1.createPaginatedResponse)(resp);
+        });
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/high5${endpoint}`;
+    }
+}
+exports.default = High5Pool;

package/lib/service/high5/wave/s3/index.d.ts

@@ -1,6 +1,6 @@
 import { AxiosInstance } from "axios";
 import Base, { Options } from "../../../../Base";
-import { Catalog, CatalogRegistry, Engine, EngineRegistry, StreamNodeSpecifications, StreamNodeSpecificationWrappedWithEngineVersion } from "../../../../interfaces/high5";
+import { Catalog, CatalogRegistry, Engine, EngineRegistry, StreamNodeSpecifications, StreamNodeSpecificationWrappedWithEngineVersion, WildcardRegistry } from "../../../../interfaces/high5";
 /**
  * Class for reading the S3 bucket of a wave engine and catalogs
  */
@@ -30,6 +30,13 @@ export declare class S3 extends Base {
      * @returns index.json of catalog
      */
     getEngine(engineUrl: string): Promise<Engine>;
+    /**
+     * Get a list of available wildcards of a specific engine version from the S3 bucket
+     * @param engineUrl Public url of the engine
+     * @param engineVersion Version of the enigne
+     * @returns Wildcards.json list of available wildcards
+     */
+    getWildcardsOfEngine(engineUrl: string, engineVersion: string): Promise<WildcardRegistry>;
     /**
      * Get the node specifications of all nodes of a specific catalog version from the S3 bucket
      * @param catalogUrl Public url of the catalog

package/lib/service/high5/wave/s3/index.js

@@ -63,6 +63,20 @@ class S3 extends Base_1.default {
             return resp.data;
         });
     }
+    /**
+     * Get a list of available wildcards of a specific engine version from the S3 bucket
+     * @param engineUrl Public url of the engine
+     * @param engineVersion Version of the enigne
+     * @returns Wildcards.json list of available wildcards
+     */
+    getWildcardsOfEngine(engineUrl, engineVersion) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(`${engineUrl.replace("/index.json", "")}/${engineVersion}/wildcards.json`, {
+                headers: axios_1.disableCacheHeaders,
+            });
+            return resp.data;
+        });
+    }
     /**
      * Get the node specifications of all nodes of a specific catalog version from the S3 bucket
      * @param catalogUrl Public url of the catalog

package/lib/service/idp/oauth/index.d.ts

@@ -1,6 +1,6 @@
 import Base from "../../../Base";
 import { OAuthToken, OAuthTokenRequest } from "../../../interfaces/idp/oauth";
-import { OAuthAppWithConsent } from "../../../interfaces/idp/organization/settings/oauthApp";
+import { OAuthAppPublicInfo } from "../../../interfaces/idp/organization/settings/oauthApp";
 export declare class IdpOAuth extends Base {
     /**
      * getAuthorizationCodeInsideRedirectUrl throws for an invalid request (query params do not match OAuthApp).
@@ -44,6 +44,6 @@ export declare class IdpOAuth extends Base {
      * @param clientId {string} - Client ID of the OAuth app
      * @returns Public OAuth app information
      */
-    getOAuthAppInfo: (clientId: string) => Promise<OAuthAppWithConsent>;
+    getOAuthAppInfo(clientId: string): Promise<OAuthAppPublicInfo>;
     protected getEndpoint(endpoint: string): string;
 }

package/lib/service/idp/oauth/index.js

@@ -12,19 +12,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.IdpOAuth = void 0;
 const Base_1 = require("../../../Base");
 class IdpOAuth extends Base_1.default {
-    constructor() {
-        super(...arguments);
-        /**
-         * Get OAuth app public information via client ID
-         *
-         * @param clientId {string} - Client ID of the OAuth app
-         * @returns Public OAuth app information
-         */
-        this.getOAuthAppInfo = (clientId) => __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.axios.get(this.getEndpoint(`/v1/login/oauth/app/${clientId}`));
-            return response.data;
-        });
-    }
     /**
      * getAuthorizationCodeInsideRedirectUrl throws for an invalid request (query params do not match OAuthApp).
      * It returns the redirect URL with the code, which is used to redirect to the client application,
@@ -110,6 +97,18 @@ class IdpOAuth extends Base_1.default {
             return response.data;
         });
     }
+    /**
+     * Get OAuth app public information via client ID
+     *
+     * @param clientId {string} - Client ID of the OAuth app
+     * @returns Public OAuth app information
+     */
+    getOAuthAppInfo(clientId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.axios.get(this.getEndpoint(`/v1/login/oauth/app/${clientId}`));
+            return response.data;
+        });
+    }
     getEndpoint(endpoint) {
         return `${this.options.server}/api/account${endpoint}`;
     }

package/lib/service/idp/registration/index.d.ts

@@ -13,7 +13,7 @@ export declare class IdpRegistration extends Base {
      * @param regionId - Optional region id
      * @param targetUrl Optional url the link in the mail will point to
      */
-    register(name: string, email: string, password: string, captcha: string, company?: string, regionId?: string, targetUrl?: string): Promise<void>;
+    register(name: string, email: string, password: string, captcha: string, company?: string, regionId?: string, targetUrl?: string, validationCode?: string): Promise<void>;
     /**
      * Triggers the registration mail to be resend if the first one got lost
      * @param name - Name of the User

package/lib/service/idp/registration/index.js

@@ -24,7 +24,7 @@ class IdpRegistration extends Base_1.default {
      * @param regionId - Optional region id
      * @param targetUrl Optional url the link in the mail will point to
      */
-    register(name, email, password, captcha, company, regionId, targetUrl) {
+    register(name, email, password, captcha, company, regionId, targetUrl, validationCode) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.axios.post(this.getEndpoint("/v1/register"), {
                 name: name,
@@ -34,7 +34,7 @@ class IdpRegistration extends Base_1.default {
                 company,
                 regionId,
                 targetUrl,
-            });
+            }, { params: { validationCode } });
         });
     }
     /**

package/lib/service/idp/user/index.d.ts

@@ -79,5 +79,9 @@ export declare class IdpUser extends Base {
         limit?: number;
         page?: number;
     }): Promise<PaginatedResponse<OrganizationMemberInvitation>>;
+    /**
+     * Maintains a user's online status
+     */
+    ping(): Promise<void>;
     protected getEndpoint(endpoint: string): string;
 }

package/lib/service/idp/user/index.js

@@ -153,6 +153,14 @@ class IdpUser extends Base_1.default {
             return (0, paginatedResponseHelper_1.createPaginatedResponse)(resp);
         });
     }
+    /**
+     * Maintains a user's online status
+     */
+    ping() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.axios.get(this.getEndpoint("/v1/user/ping"));
+        });
+    }
     getEndpoint(endpoint) {
         return `${this.options.server}/api/account${endpoint}`;
     }

package/lib/service/idp/user/settings/twoFactor/totp/index.d.ts

@@ -3,7 +3,7 @@ import { ActivatedTotp, DeactivatedTotp, UserTotp } from "../../../../../../inte
 export declare class IdpTotp extends Base {
     /**
      * Creates a new TOTP for the requesting User.
-     * @returns A deactivated TOTP object containing a QR code and the OTPAuth URL
+     * @returns A deactivated TOTP object containing all necessary data to create a QR code
      */
     createTotp(): Promise<DeactivatedTotp>;
     /**

package/lib/service/idp/user/settings/twoFactor/totp/index.js

@@ -14,7 +14,7 @@ const Base_1 = require("../../../../../../Base");
 class IdpTotp extends Base_1.default {
     /**
      * Creates a new TOTP for the requesting User.
-     * @returns A deactivated TOTP object containing a QR code and the OTPAuth URL
+     * @returns A deactivated TOTP object containing all necessary data to create a QR code
      */
     createTotp() {
         return __awaiter(this, void 0, void 0, function* () {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hcloud-sdk",
-  "version": "15.0.0",
+  "version": "16.0.0",
   "description": "hcloud platform sdk",
   "main": "index.js",
   "types": "index.d.ts",