hcloud-sdk 14.13.2 → 16.0.0

package/lib/service/idp/organization/member/invitations/index.js

@@ -15,49 +15,6 @@ const searchFilter_1 = require("../../../../../helper/searchFilter");
 class IdpOrganizationMemberInvitations extends Base_1.default {
     constructor() {
         super(...arguments);
-        /**
-         * Retrieves all invitations sent out by the organization that match the provided search filter(s). Returns all invitations if no search filter is provided.
-         * @param orgName Name of the organization
-         * @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 invitations and the total number of results found in the database (independent of limit and page)
-         */
-        this.search = (params) => __awaiter(this, void 0, void 0, function* () {
-            const limit = params.limit || 25;
-            const page = params.page || 0;
-            // convert SearchFilters to DTO
-            const filtersDTO = params.filters.map((f) => {
-                return new searchFilter_1.SearchFilterDTO(f);
-            });
-            const resp = yield this.axios.post(this.getEndpoint(`/${params.orgName}/members/invitations/search?limit=${limit}&page=${page}`), {
-                filters: filtersDTO,
-                sorting: params.sorting,
-            });
-            return (0, paginatedResponseHelper_1.createPaginatedResponse)(resp);
-        });
-        /**
-         * Invites a User to an Organization.
-         *
-         * @param orgName Name of the Organization
-         * @param email Email of the person to be invited
-         * @param role The role they will have within the organization if they accept the invitation
-         * @param allowNonRegisteredUsers Flag to determine if the invitation should go through in the case that the email is not bound to an Helmut Cloud user.
-         *                                If this is set to true and the email is unbound, then an email will be sent asking the person to register.
-         *                                When they do they will automatically join the organization.
-         * @param targetUrl Optional url the link in the mail will point to
-         * @returns The created invitation
-         */
-        this.create = (orgName_1, email_1, role_1, ...args_1) => __awaiter(this, [orgName_1, email_1, role_1, ...args_1], void 0, function* (orgName, email, role, allowNonRegisteredUsers = false, targetUrl) {
-            const resp = yield this.axios.post(this.getEndpoint(`/${orgName}/members/invitations`), {
-                email,
-                role,
-                allowNonRegisteredUsers,
-                targetUrl,
-            });
-            return resp.data;
-        });
         /**
          * Accept an invitation.
          *
@@ -111,6 +68,53 @@ class IdpOrganizationMemberInvitations extends Base_1.default {
             yield this.axios.delete(this.getEndpoint(`/${orgName}/members/invitations/${invitationId}`));
         });
     }
+    /**
+     * Retrieves all invitations sent out by the organization that match the provided search filter(s). Returns all invitations if no search filter is provided.
+     * @param orgName Name of the organization
+     * @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 invitations and the total number of results found in the database (independent of limit and page)
+     */
+    search(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const limit = params.limit || 25;
+            const page = params.page || 0;
+            // convert SearchFilters to DTO
+            const filtersDTO = params.filters.map((f) => {
+                return new searchFilter_1.SearchFilterDTO(f);
+            });
+            const resp = yield this.axios.post(this.getEndpoint(`/${params.orgName}/members/invitations/search?limit=${limit}&page=${page}`), {
+                filters: filtersDTO,
+                sorting: params.sorting,
+            });
+            return (0, paginatedResponseHelper_1.createPaginatedResponse)(resp);
+        });
+    }
+    /**
+     * Invites a User to an Organization.
+     *
+     * @param orgName Name of the Organization
+     * @param email Email of the person to be invited
+     * @param role The role they will have within the organization if they accept the invitation
+     * @param allowNonRegisteredUsers Flag to determine if the invitation should go through in the case that the email is not bound to an Helmut Cloud user.
+     *                                If this is set to true and the email is unbound, then an email will be sent asking the person to register.
+     *                                When they do they will automatically join the organization.
+     * @param targetUrl Optional url the link in the mail will point to
+     * @returns The created invitation
+     */
+    create(orgName_1, email_1, role_1) {
+        return __awaiter(this, arguments, void 0, function* (orgName, email, role, allowNonRegisteredUsers = false, targetUrl) {
+            const resp = yield this.axios.post(this.getEndpoint(`/${orgName}/members/invitations`), {
+                email,
+                role,
+                allowNonRegisteredUsers,
+                targetUrl,
+            });
+            return resp.data;
+        });
+    }
     getEndpoint(endpoint) {
         return `${this.options.server}/api/account/v1/org${endpoint}`;
     }

package/lib/service/idp/organization/settings/domain/index.d.ts

@@ -1,38 +1,37 @@
-import { AxiosInstance } from "axios";
-import Base, { Options } from "../../../../../Base";
+import Base from "../../../../../Base";
 import { Domain } from "../../../../../interfaces/idp/organization/settings/domain";
 import { IdpSAMLProvider } from "./saml";
 export declare class IdpDomain extends Base {
     /**
      * Handles everything around a SAML provider of a domain.
      */
-    samlProvider: IdpSAMLProvider;
-    constructor(options: Options, axios: AxiosInstance);
+    get samlProvider(): IdpSAMLProvider;
+    private _samlProvider?;
     /**
      * Retrieves all the Domains associated with a given Organization.
      * @param orgName Name of Organization
      * @returns Array of Domains
      */
-    getDomains: (orgName: string) => Promise<Domain[]>;
+    getDomains(orgName: string): Promise<Domain[]>;
     /**
      * Creates a new Domain for the given Organization
      * @param orgName Name of the Organization
      * @param domainName Name of the Domain
      * @returns the created Domain
      */
-    createDomain: (orgName: string, domainName: string) => Promise<Domain>;
+    createDomain(orgName: string, domainName: string): Promise<Domain>;
     /**
      * Verifies the provided Domain.
      * @param orgName Name of the organization
      * @param domainName Name of the Domain
      * @returns Domain object with domain.verified set to 'true' if verification was succesful.
      */
-    verifyDomain: (orgName: string, domainName: string) => Promise<Domain>;
+    verifyDomain(orgName: string, domainName: string): Promise<Domain>;
     /**
      * Deletes a domain.
      * @param orgName Name of the organization
      * @param domainName Name of the domain
      */
-    deleteDomain: (orgName: string, domainName: string) => Promise<void>;
+    deleteDomain(orgName: string, domainName: string): Promise<void>;
     protected getEndpoint(endpoint: string): string;
 }

package/lib/service/idp/organization/settings/domain/index.js

@@ -13,48 +13,61 @@ exports.IdpDomain = void 0;
 const Base_1 = require("../../../../../Base");
 const saml_1 = require("./saml");
 class IdpDomain extends Base_1.default {
-    constructor(options, axios) {
-        super(options, axios);
-        /**
-         * Retrieves all the Domains associated with a given Organization.
-         * @param orgName Name of Organization
-         * @returns Array of Domains
-         */
-        this.getDomains = (orgName) => __awaiter(this, void 0, void 0, function* () {
+    /**
+     * Handles everything around a SAML provider of a domain.
+     */
+    get samlProvider() {
+        if (this._samlProvider === undefined) {
+            this._samlProvider = new saml_1.IdpSAMLProvider(this.options, this.axios);
+        }
+        return this._samlProvider;
+    }
+    /**
+     * Retrieves all the Domains associated with a given Organization.
+     * @param orgName Name of Organization
+     * @returns Array of Domains
+     */
+    getDomains(orgName) {
+        return __awaiter(this, void 0, void 0, function* () {
             const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/settings/domains`));
             return resp.data;
         });
-        /**
-         * Creates a new Domain for the given Organization
-         * @param orgName Name of the Organization
-         * @param domainName Name of the Domain
-         * @returns the created Domain
-         */
-        this.createDomain = (orgName, domainName) => __awaiter(this, void 0, void 0, function* () {
+    }
+    /**
+     * Creates a new Domain for the given Organization
+     * @param orgName Name of the Organization
+     * @param domainName Name of the Domain
+     * @returns the created Domain
+     */
+    createDomain(orgName, domainName) {
+        return __awaiter(this, void 0, void 0, function* () {
             const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/settings/domains`), {
                 name: domainName,
             });
             return resp.data;
         });
-        /**
-         * Verifies the provided Domain.
-         * @param orgName Name of the organization
-         * @param domainName Name of the Domain
-         * @returns Domain object with domain.verified set to 'true' if verification was succesful.
-         */
-        this.verifyDomain = (orgName, domainName) => __awaiter(this, void 0, void 0, function* () {
+    }
+    /**
+     * Verifies the provided Domain.
+     * @param orgName Name of the organization
+     * @param domainName Name of the Domain
+     * @returns Domain object with domain.verified set to 'true' if verification was succesful.
+     */
+    verifyDomain(orgName, domainName) {
+        return __awaiter(this, void 0, void 0, function* () {
             const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/settings/domains/${domainName}/verify`));
             return resp.data;
         });
-        /**
-         * Deletes a domain.
-         * @param orgName Name of the organization
-         * @param domainName Name of the domain
-         */
-        this.deleteDomain = (orgName, domainName) => __awaiter(this, void 0, void 0, function* () {
+    }
+    /**
+     * Deletes a domain.
+     * @param orgName Name of the organization
+     * @param domainName Name of the domain
+     */
+    deleteDomain(orgName, domainName) {
+        return __awaiter(this, void 0, void 0, function* () {
             yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/settings/domains/${domainName}`));
         });
-        this.samlProvider = new saml_1.IdpSAMLProvider(this.options, this.axios);
     }
     getEndpoint(endpoint) {
         return `${this.options.server}/api/account${endpoint}`;

package/lib/service/idp/organization/settings/domain/saml/index.d.ts

@@ -6,7 +6,7 @@ export declare class IdpSAMLProvider extends Base {
      * @param orgName Name of the Organization
      * @returns Array of SAML providers
      */
-    getAllSAMLProvidersOfOrganization: (orgName: string) => Promise<FullSAMLProvider[]>;
+    getAllSAMLProvidersOfOrganization(orgName: string): Promise<FullSAMLProvider[]>;
     /**
      * Creates a new SAML provider for the specified domain.
      * @param orgName Name of the Organization
@@ -14,7 +14,7 @@ export declare class IdpSAMLProvider extends Base {
      * @param provider SAML provider object containing the login URL, logout URL, certificates and a boolean to allow unencrypted assertion
      * @returns The created SAML provider
      */
-    createProvider: (orgName: string, domainName: string, provider: SAMLProviderCreateDto) => Promise<SAMLProvider>;
+    createProvider(orgName: string, domainName: string, provider: SAMLProviderCreateDto): Promise<SAMLProvider>;
     /**
      * Updates a SAML provider for the specified domain
      * @param orgName Name of the Organization
@@ -22,7 +22,7 @@ export declare class IdpSAMLProvider extends Base {
      * @param provider SAML provider object containing the login URL, logout URL, certificates and a boolean to allow unencrypted assertion
      * @returns The updated SAML provider
      */
-    updateProvider: (orgName: string, domainName: string, provider: SAMLProviderCreateDto) => Promise<SAMLProvider>;
+    updateProvider(orgName: string, domainName: string, provider: SAMLProviderCreateDto): Promise<SAMLProvider>;
     /**
      * Adds certificates to a SAML provider
      * @param orgName Name of the Organization
@@ -30,13 +30,13 @@ export declare class IdpSAMLProvider extends Base {
      * @param certificates Certificates to add
      * @returns The updated SAML provider
      */
-    addCertificatesToProvider: (orgName: string, domainName: string, certificates: string[]) => Promise<SAMLProvider>;
+    addCertificatesToProvider(orgName: string, domainName: string, certificates: string[]): Promise<SAMLProvider>;
     /**
      * Removes a SAML provider from the specified domain
      * @param orgName Name of the Organization
      * @param domainName Name of the Domain
      */
-    deleteProvider: (orgName: string, domainName: string) => Promise<void>;
+    deleteProvider(orgName: string, domainName: string): Promise<void>;
     private convertProviderToFormData;
     private createFileFromString;
     protected getEndpoint(endpoint: string): string;

package/lib/service/idp/organization/settings/domain/saml/index.js

@@ -14,72 +14,82 @@ const Base_1 = require("../../../../../../Base");
 class IdpSAMLProvider extends Base_1.default {
     constructor() {
         super(...arguments);
-        /**
-         * Retrieves all SAML providers associated with a given Organization.
-         * @param orgName Name of the Organization
-         * @returns Array of SAML providers
-         */
-        this.getAllSAMLProvidersOfOrganization = (orgName) => __awaiter(this, void 0, void 0, function* () {
+        this.convertProviderToFormData = (provider) => {
+            const formData = new FormData();
+            formData.append("ssoLoginURL", provider.ssoLoginURL);
+            formData.append("ssoLogoutURL", provider.ssoLogoutURL);
+            provider.certificates.forEach(c => formData.append("certificate", this.createFileFromString(c)));
+            provider.allowUnencryptedAssertion && formData.append("allowUnencryptedAssertion", provider.allowUnencryptedAssertion.toString());
+            return formData;
+        };
+        this.createFileFromString = (certificate) => {
+            const blob = new Blob([certificate]);
+            return new File([blob], "certificate");
+        };
+    }
+    /**
+     * Retrieves all SAML providers associated with a given Organization.
+     * @param orgName Name of the Organization
+     * @returns Array of SAML providers
+     */
+    getAllSAMLProvidersOfOrganization(orgName) {
+        return __awaiter(this, void 0, void 0, function* () {
             const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/settings/domains/saml`));
             return resp.data;
         });
-        /**
-         * Creates a new SAML provider for the specified domain.
-         * @param orgName Name of the Organization
-         * @param domainName Name of the Domain
-         * @param provider SAML provider object containing the login URL, logout URL, certificates and a boolean to allow unencrypted assertion
-         * @returns The created SAML provider
-         */
-        this.createProvider = (orgName, domainName, provider) => __awaiter(this, void 0, void 0, function* () {
+    }
+    /**
+     * Creates a new SAML provider for the specified domain.
+     * @param orgName Name of the Organization
+     * @param domainName Name of the Domain
+     * @param provider SAML provider object containing the login URL, logout URL, certificates and a boolean to allow unencrypted assertion
+     * @returns The created SAML provider
+     */
+    createProvider(orgName, domainName, provider) {
+        return __awaiter(this, void 0, void 0, function* () {
             const formData = this.convertProviderToFormData(provider);
             const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/settings/domains/${domainName}/saml`), formData);
             return resp.data;
         });
-        /**
-         * Updates a SAML provider for the specified domain
-         * @param orgName Name of the Organization
-         * @param domainName Name of the Domain
-         * @param provider SAML provider object containing the login URL, logout URL, certificates and a boolean to allow unencrypted assertion
-         * @returns The updated SAML provider
-         */
-        this.updateProvider = (orgName, domainName, provider) => __awaiter(this, void 0, void 0, function* () {
+    }
+    /**
+     * Updates a SAML provider for the specified domain
+     * @param orgName Name of the Organization
+     * @param domainName Name of the Domain
+     * @param provider SAML provider object containing the login URL, logout URL, certificates and a boolean to allow unencrypted assertion
+     * @returns The updated SAML provider
+     */
+    updateProvider(orgName, domainName, provider) {
+        return __awaiter(this, void 0, void 0, function* () {
             const formData = this.convertProviderToFormData(provider);
             const resp = yield this.axios.put(this.getEndpoint(`/v1/org/${orgName}/settings/domains/${domainName}/saml`), formData);
             return resp.data;
         });
-        /**
-         * Adds certificates to a SAML provider
-         * @param orgName Name of the Organization
-         * @param domainName Name of the Domain
-         * @param certificates Certificates to add
-         * @returns The updated SAML provider
-         */
-        this.addCertificatesToProvider = (orgName, domainName, certificates) => __awaiter(this, void 0, void 0, function* () {
+    }
+    /**
+     * Adds certificates to a SAML provider
+     * @param orgName Name of the Organization
+     * @param domainName Name of the Domain
+     * @param certificates Certificates to add
+     * @returns The updated SAML provider
+     */
+    addCertificatesToProvider(orgName, domainName, certificates) {
+        return __awaiter(this, void 0, void 0, function* () {
             const formData = new FormData();
             certificates.forEach(c => formData.append("certificate", this.createFileFromString(c)));
             const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/settings/domains/${domainName}/saml/certificates`), formData);
             return resp.data;
         });
-        /**
-         * Removes a SAML provider from the specified domain
-         * @param orgName Name of the Organization
-         * @param domainName Name of the Domain
-         */
-        this.deleteProvider = (orgName, domainName) => __awaiter(this, void 0, void 0, function* () {
+    }
+    /**
+     * Removes a SAML provider from the specified domain
+     * @param orgName Name of the Organization
+     * @param domainName Name of the Domain
+     */
+    deleteProvider(orgName, domainName) {
+        return __awaiter(this, void 0, void 0, function* () {
             yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/settings/domains/${domainName}/saml`));
         });
-        this.convertProviderToFormData = (provider) => {
-            const formData = new FormData();
-            formData.append("ssoLoginURL", provider.ssoLoginURL);
-            formData.append("ssoLogoutURL", provider.ssoLogoutURL);
-            provider.certificates.forEach(c => formData.append("certificate", this.createFileFromString(c)));
-            provider.allowUnencryptedAssertion && formData.append("allowUnencryptedAssertion", provider.allowUnencryptedAssertion.toString());
-            return formData;
-        };
-        this.createFileFromString = (certificate) => {
-            const blob = new Blob([certificate]);
-            return new File([blob], "certificate");
-        };
     }
     getEndpoint(endpoint) {
         return `${this.options.server}/api/account${endpoint}`;

package/lib/service/idp/organization/settings/index.d.ts

@@ -1,16 +1,16 @@
-import { AxiosInstance } from "axios";
-import Base, { Options } from "../../../../Base";
+import Base from "../../../../Base";
 import { IdpDomain } from "./domain";
 import { IdpOAuthApp } from "./oauth";
 export default class IdpOrganizationSettings extends Base {
     /**
      * Handles everything around open authorization applications
      */
-    oAuthApp: IdpOAuthApp;
+    get oAuthApp(): IdpOAuthApp;
+    private _oAuthApp?;
     /**
      * Handles everything around domains of organizations.
      */
-    domains: IdpDomain;
-    constructor(options: Options, axios: AxiosInstance);
+    get domains(): IdpDomain;
+    private _domains?;
     protected getEndpoint(): string;
 }

package/lib/service/idp/organization/settings/index.js

@@ -4,10 +4,23 @@ const Base_1 = require("../../../../Base");
 const domain_1 = require("./domain");
 const oauth_1 = require("./oauth");
 class IdpOrganizationSettings extends Base_1.default {
-    constructor(options, axios) {
-        super(options, axios);
-        this.domains = new domain_1.IdpDomain(this.options, this.axios);
-        this.oAuthApp = new oauth_1.IdpOAuthApp(this.options, this.axios);
+    /**
+     * Handles everything around open authorization applications
+     */
+    get oAuthApp() {
+        if (this._oAuthApp === undefined) {
+            this._oAuthApp = new oauth_1.IdpOAuthApp(this.options, this.axios);
+        }
+        return this._oAuthApp;
+    }
+    /**
+     * Handles everything around domains of organizations.
+     */
+    get domains() {
+        if (this._domains === undefined) {
+            this._domains = new domain_1.IdpDomain(this.options, this.axios);
+        }
+        return this._domains;
     }
     getEndpoint() {
         throw new Error("Method not implemented.");

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

@@ -1,9 +1,7 @@
-import { AxiosInstance } from "axios";
-import Base, { Options } from "../../../../../Base";
+import Base from "../../../../../Base";
 import { PaginatedResponse, SearchParams } from "../../../../../interfaces/global";
 import { OAuthApp, OAuthAppCreate } from "../../../../../interfaces/idp/organization/settings/oauthApp";
 export declare class IdpOAuthApp extends Base {
-    constructor(options: Options, axios: AxiosInstance);
     /**
      * Retrieves all OAuth apps of the specified Organization matching the provided search filter(s). Will return all OAuth apps if no search filter is provided.
      * @param orgName Name of the Organization
@@ -13,23 +11,23 @@ export declare class IdpOAuthApp extends Base {
      * @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
      * @returns Object containing an array of OAuth apps and the total number of results found in the database (independent of limit and page)
      */
-    searchOauthAppsOfOrganization: ({ organizationName, filters, sorting, limit, page, }: SearchParams & {
+    searchOauthAppsOfOrganization({ organizationName, filters, sorting, limit, page, }: SearchParams & {
         organizationName: string;
-    }) => Promise<PaginatedResponse<OAuthApp>>;
+    }): Promise<PaginatedResponse<OAuthApp>>;
     /**
      * Retrieves an OAuthApp by its ID.
      * @param orgName Name of the Organization
      * @param oauthAppId ID of the OAuthApp
      * @returns the requested OAuthApp
      */
-    getOAuthApp: (orgName: string, oauthAppId: string) => Promise<OAuthApp>;
+    getOAuthApp(orgName: string, oauthAppId: string): Promise<OAuthApp>;
     /**
      * Creates a new OAuth app in the specified Organization.
      * @param orgName Name of the Organization
      * @param oAuthAppCreate Object containing the app's name, secretName, callback and optionally a base64 encoded avatar and a description
      * @returns The created OAuth app
      */
-    createOAuthApp: (orgName: string, oAuthAppCreate: OAuthAppCreate) => Promise<OAuthApp>;
+    createOAuthApp(orgName: string, oAuthAppCreate: OAuthAppCreate): Promise<OAuthApp>;
     /**
      * Updates an existing OAuth app.
      * @param orgName Name of the Organization
@@ -37,13 +35,13 @@ export declare class IdpOAuthApp extends Base {
      * @param oAuthAppCreate Object containing the app's name, secretName, callback and optionally a base64 encoded avatar and a description
      * @returns the updated OAuth app
      */
-    updateOAuthApp: (orgName: string, oauthAppId: string, oAuthAppCreate: OAuthAppCreate) => Promise<OAuthApp>;
+    updateOAuthApp(orgName: string, oauthAppId: string, oAuthAppCreate: OAuthAppCreate): Promise<OAuthApp>;
     /**
      * Deletes an OAuthApp by its ID.
      * @param orgName Name of the Organization
      * @param oauthAppId ID of the OAuthApp
      */
-    deleteOAuthApp: (orgName: string, oauthAppId: string) => Promise<void>;
+    deleteOAuthApp(orgName: string, oauthAppId: string): Promise<void>;
     /**
      * Creates a new secret for an existing OAuthApp.
      * @param orgName Name of the Organization
@@ -51,7 +49,7 @@ export declare class IdpOAuthApp extends Base {
      * @param secretName Name of the Secret
      * @returns the updated OAuth app
      */
-    createOAuthAppSecret: (orgName: string, oauthAppId: string, secretName: string) => Promise<OAuthApp>;
+    createOAuthAppSecret(orgName: string, oauthAppId: string, secretName: string): Promise<OAuthApp>;
     /**
      * Deletes the specified OAuthApp secret.
      * @param orgName Name of the Organization
@@ -59,6 +57,6 @@ export declare class IdpOAuthApp extends Base {
      * @param secret Name of the secret that shall be deleted
      * @returns the updated OAuthApp
      */
-    deleteOAuthAppSecret: (orgName: string, oauthAppId: string, secret: string) => Promise<OAuthApp>;
+    deleteOAuthAppSecret(orgName: string, oauthAppId: string, secret: string): Promise<OAuthApp>;
     protected getEndpoint(endpoint: string): string;
 }