hcloud-sdk 0.0.15 → 14.13.2

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

@@ -0,0 +1,19 @@
+import { AxiosInstance } from "axios";
+import Base, { Options } from "../../../Base";
+import { User } from "../../../interfaces/idp/user";
+export declare class IdpInternal extends Base {
+    constructor(options: Options, axios: AxiosInstance);
+    /**
+     * Creates an agent user for an organization.
+     *
+     * This is an internal endpoint and requires HCloud admin credentials to use.
+     *
+     * @param orgName Name of the organization
+     * @returns the created user and a pat token
+     */
+    createAgentUser: (orgName: string) => Promise<{
+        user: User;
+        pat: string;
+    }>;
+    protected getEndpoint(endpoint: string): string;
+}

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

@@ -0,0 +1,34 @@
+"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 });
+exports.IdpInternal = void 0;
+const Base_1 = require("../../../Base");
+class IdpInternal extends Base_1.default {
+    constructor(options, axios) {
+        super(options, axios);
+        /**
+         * Creates an agent user for an organization.
+         *
+         * This is an internal endpoint and requires HCloud admin credentials to use.
+         *
+         * @param orgName Name of the organization
+         * @returns the created user and a pat token
+         */
+        this.createAgentUser = (orgName) => __awaiter(this, void 0, void 0, function* () {
+            const res = yield this.axios.post(this.getEndpoint(`/internal/v1/org/${orgName}/agent`));
+            return { user: res.data, pat: res.headers.authorization };
+        });
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/account${endpoint}`;
+    }
+}
+exports.IdpInternal = IdpInternal;

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

@@ -0,0 +1,45 @@
+import { AxiosInstance } from "axios";
+import Base, { Options } from "../../../Base";
+import { OAuthToken, OAuthTokenRequest } from "../../../interfaces/idp/oauth";
+import { OAuthApp } from "../../../interfaces/idp/organization/settings/oauthApp";
+export declare class IdpOAuth extends Base {
+    constructor(options: Options, axios: AxiosInstance);
+    /**
+     * 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,
+     * which can use the code for a back-channel request to get the access token.
+     * @param queryString expect the user's / browser's query string, containing the  response_type, client_id,
+     * redirect_uri, scopes and optionally state.
+     * @returns the entire redirect uri including the authorization code if successful
+     */
+    getAuthorizationCodeInsideRedirectUrl: (queryString: string, doNotRedirect?: boolean) => Promise<string>;
+    /**
+     * Attempt to get information about a certain OAuth app. If the user has already consented to all the scopes required
+     * this request will instead return the redirect URL.
+     *
+     * If the user has not consented the return of this function will be an OAuthApp. To consent the
+     * createScopesAndGetAuthorizationCodeInsideRedirectUrl method should be used.
+     * @see IdpOAuth.createScopesAndGetAuthorizationCodeInsideRedirectUrl
+     *
+     * @param queryString {string} - Query string containing the OAuth parameters: response_type, client_id, scope, state
+     * @param doNotRedirect [boolean] - Flag to make the request return a 200 instead of a 3xx status code
+     * @returns A string with the redirect URL if the user already consented to the specificied scope. Otherwise, an OAuthApp
+     * @see OAuthApp
+     */
+    getInfoOrAuthorizationCodeInsideRedirectUrl: (queryString: string, doNotRedirect?: boolean) => Promise<string | OAuthApp>;
+    /**
+     * createScopesAndGetAuthorizationCodeInsideRedirectUrl 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,
+     * which can use the code for a back-channel request to get the access token. It also adds the scopes for the user.
+     * @param queryString expect the user's / browser's query string, containing the  response_type, client_id,
+     * redirect_uri, scopes and optionally state.
+     * @returns the entire redirect uri including the authorization code if successful
+     */
+    createScopesAndGetAuthorizationCodeInsideRedirectUrl: (queryString: string, doNotRedirect?: boolean) => Promise<string>;
+    /**
+     * A valid code can be used to request a new API token.
+     * @param tokenRequest contains the code, client_id, client_secret and redirect_uri
+     */
+    exchangeCodeForToken: (tokenRequest: OAuthTokenRequest) => Promise<OAuthToken>;
+    protected getEndpoint(endpoint: string): string;
+}

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

@@ -0,0 +1,105 @@
+"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 });
+exports.IdpOAuth = void 0;
+const Base_1 = require("../../../Base");
+class IdpOAuth extends Base_1.default {
+    constructor(options, axios) {
+        super(options, axios);
+        /**
+         * 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,
+         * which can use the code for a back-channel request to get the access token.
+         * @param queryString expect the user's / browser's query string, containing the  response_type, client_id,
+         * redirect_uri, scopes and optionally state.
+         * @returns the entire redirect uri including the authorization code if successful
+         */
+        this.getAuthorizationCodeInsideRedirectUrl = (queryString, doNotRedirect) => __awaiter(this, void 0, void 0, function* () {
+            if (!queryString.startsWith("?")) {
+                queryString = `?${queryString}`;
+            }
+            if (doNotRedirect) {
+                queryString += "&no_redirect=true";
+            }
+            const response = yield this.axios.get(this.getEndpoint(`/v1/login/oauth/authorize${queryString}`), { maxRedirects: 0 });
+            if (doNotRedirect) {
+                return response.data.redirectUrl;
+            }
+            return response.headers.location;
+        });
+        /**
+         * Attempt to get information about a certain OAuth app. If the user has already consented to all the scopes required
+         * this request will instead return the redirect URL.
+         *
+         * If the user has not consented the return of this function will be an OAuthApp. To consent the
+         * createScopesAndGetAuthorizationCodeInsideRedirectUrl method should be used.
+         * @see IdpOAuth.createScopesAndGetAuthorizationCodeInsideRedirectUrl
+         *
+         * @param queryString {string} - Query string containing the OAuth parameters: response_type, client_id, scope, state
+         * @param doNotRedirect [boolean] - Flag to make the request return a 200 instead of a 3xx status code
+         * @returns A string with the redirect URL if the user already consented to the specificied scope. Otherwise, an OAuthApp
+         * @see OAuthApp
+         */
+        this.getInfoOrAuthorizationCodeInsideRedirectUrl = (queryString, doNotRedirect) => __awaiter(this, void 0, void 0, function* () {
+            if (!queryString.startsWith("?")) {
+                queryString = `?${queryString}`;
+            }
+            if (doNotRedirect) {
+                queryString += "&no_redirect=true";
+            }
+            const response = yield this.axios.get(this.getEndpoint(`/v1/login/oauth/info${queryString}`), {
+                maxRedirects: 0,
+            });
+            if (response.status < 300) {
+                if ("redirectUrl" in response.data) {
+                    return response.data.redirectUrl;
+                }
+                else {
+                    return response.data;
+                }
+            }
+            return response.headers.location;
+        });
+        /**
+         * createScopesAndGetAuthorizationCodeInsideRedirectUrl 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,
+         * which can use the code for a back-channel request to get the access token. It also adds the scopes for the user.
+         * @param queryString expect the user's / browser's query string, containing the  response_type, client_id,
+         * redirect_uri, scopes and optionally state.
+         * @returns the entire redirect uri including the authorization code if successful
+         */
+        this.createScopesAndGetAuthorizationCodeInsideRedirectUrl = (queryString, doNotRedirect) => __awaiter(this, void 0, void 0, function* () {
+            if (!queryString.startsWith("?")) {
+                queryString = `?${queryString}`;
+            }
+            if (doNotRedirect) {
+                queryString += "&no_redirect=true";
+            }
+            const response = yield this.axios.post(this.getEndpoint(`/v1/login/oauth/authorize${queryString}`));
+            if (doNotRedirect) {
+                return response.data.redirectUrl;
+            }
+            return response.data;
+        });
+        /**
+         * A valid code can be used to request a new API token.
+         * @param tokenRequest contains the code, client_id, client_secret and redirect_uri
+         */
+        this.exchangeCodeForToken = (tokenRequest) => __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.axios.post(this.getEndpoint(`/v1/login/oauth/access_token`), tokenRequest);
+            return response.data;
+        });
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/account${endpoint}`;
+    }
+}
+exports.IdpOAuth = IdpOAuth;

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

@@ -0,0 +1,54 @@
+import { AxiosInstance } from "axios";
+import Base, { Options } from "../../../Base";
+import { Organization, OrganizationQueryOptions } from "../../../interfaces/idp/organization";
+import { IdpOrganizationLicense } from "./license";
+import { IdpOrganizationMember } from "./member";
+import IdpOrganizationSettings from "./settings";
+import { IdpOrganizationTeams } from "./team";
+export declare class IdpOrganization extends Base {
+    /**
+     * Handles everything around organization members
+     */
+    member: IdpOrganizationMember;
+    /**
+     * Handles everything around organization settings
+     */
+    settings: IdpOrganizationSettings;
+    /**
+     * Handles everything around teams of organizations.
+     */
+    teams: IdpOrganizationTeams;
+    /**
+     * Handles everything around licenses.
+     */
+    license: IdpOrganizationLicense;
+    constructor(options: Options, axios: AxiosInstance);
+    /**
+     * Updates an Organization.
+     * @param orgName Current name of the Organization
+     * @param newName New name for the organization
+     * @param company (optional) New company name
+     * @returns The updated Organization
+     */
+    updateOrganization: (orgName: string, newName: string, company?: string) => Promise<Organization>;
+    /**
+     * Creates a new Organization.
+     * @param name Name of the new Organization
+     * @param company (optional) Company name for the new Organization
+     * @returns The created Organization
+     */
+    createOrganization: (name: string, company?: string) => Promise<Organization>;
+    /**
+     * Retrieves an Organization by its name.
+     * @param orgName Name of the Organization
+     * @param options Defines query options to retrieve additional properties in the response
+     * @returns The requested Organization
+     */
+    getOrganization(orgName: string, options?: OrganizationQueryOptions): Promise<Organization>;
+    /**
+     * Deletes an Organization. This will also delete all dependencies that the Organization has (Teams, Spaces, apps, ...).
+     * @param orgName Name of the Organization to be deleted
+     */
+    deleteOrganization: (orgName: string) => Promise<void>;
+    protected getEndpoint(endpoint: string): string;
+}

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

@@ -0,0 +1,79 @@
+"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 });
+exports.IdpOrganization = void 0;
+const Base_1 = require("../../../Base");
+const license_1 = require("./license");
+const member_1 = require("./member");
+const settings_1 = require("./settings");
+const team_1 = require("./team");
+class IdpOrganization extends Base_1.default {
+    constructor(options, axios) {
+        super(options, axios);
+        /**
+         * Updates an Organization.
+         * @param orgName Current name of the Organization
+         * @param newName New name for the organization
+         * @param company (optional) New company name
+         * @returns The updated Organization
+         */
+        this.updateOrganization = (orgName, newName, company) => __awaiter(this, void 0, void 0, function* () {
+            const organization = { name: newName, company: company };
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}`), organization);
+            return resp.data;
+        });
+        /**
+         * Creates a new Organization.
+         * @param name Name of the new Organization
+         * @param company (optional) Company name for the new Organization
+         * @returns The created Organization
+         */
+        this.createOrganization = (name, company) => __awaiter(this, void 0, void 0, function* () {
+            const organization = { name: name, company: company };
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org`), organization);
+            return resp.data;
+        });
+        /**
+         * Deletes an Organization. This will also delete all dependencies that the Organization has (Teams, Spaces, apps, ...).
+         * @param orgName Name of the Organization to be deleted
+         */
+        this.deleteOrganization = (orgName) => __awaiter(this, void 0, void 0, function* () {
+            yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}`));
+        });
+        this.member = new member_1.IdpOrganizationMember(this.options, this.axios);
+        this.teams = new team_1.IdpOrganizationTeams(this.options, this.axios);
+        this.settings = new settings_1.default(this.options, this.axios);
+        this.license = new license_1.IdpOrganizationLicense(this.options, this.axios);
+    }
+    /**
+     * Retrieves an Organization by its name.
+     * @param orgName Name of the Organization
+     * @param options Defines query options to retrieve additional properties in the response
+     * @returns The requested Organization
+     */
+    getOrganization(orgName, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}`), {
+                params: {
+                    teamsOfUser: options === null || options === void 0 ? void 0 : options.getTeamsOfUser,
+                    totalMemberCount: options === null || options === void 0 ? void 0 : options.getTotalMemberCount,
+                    membersSample: options === null || options === void 0 ? void 0 : options.getMembersSample,
+                    license: options === null || options === void 0 ? void 0 : options.getLicense,
+                },
+            });
+            return resp.data;
+        });
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/account${endpoint}`;
+    }
+}
+exports.IdpOrganization = IdpOrganization;

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

@@ -0,0 +1,7 @@
+import Base from "../../../../Base";
+import { License } from "../../../../interfaces/idp/organization/license";
+export declare class IdpOrganizationLicense extends Base {
+    getLicense: (orgName: string) => Promise<License>;
+    updateLicense: (orgName: string, token: string) => Promise<License>;
+    protected getEndpoint(endpoint: string): string;
+}

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

@@ -0,0 +1,30 @@
+"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 });
+exports.IdpOrganizationLicense = void 0;
+const Base_1 = require("../../../../Base");
+class IdpOrganizationLicense extends Base_1.default {
+    constructor() {
+        super(...arguments);
+        this.getLicense = (orgName) => __awaiter(this, void 0, void 0, function* () {
+            const res = yield this.axios.get(this.getEndpoint(`/org/${orgName}/license`));
+            return res.data;
+        });
+        this.updateLicense = (orgName, token) => __awaiter(this, void 0, void 0, function* () {
+            const res = yield this.axios.put(this.getEndpoint(`/org/${orgName}/license`), { identifier: token });
+            return res.data;
+        });
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/account/v1${endpoint}`;
+    }
+}
+exports.IdpOrganizationLicense = IdpOrganizationLicense;

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

@@ -0,0 +1,58 @@
+import { AxiosInstance } from "axios";
+import Base, { Options } from "../../../../Base";
+import { PaginatedResponse, SearchParams } from "../../../../interfaces/global";
+import { OrganizationMember, OrgMemberPatch } from "../../../../interfaces/idp/organization/member";
+import IdpOrganizationMemberInvitations from "./invitations";
+export declare class IdpOrganizationMember extends Base {
+    invitations: IdpOrganizationMemberInvitations;
+    constructor(options: Options, axios: AxiosInstance);
+    /**
+     * Retrieves all organization members that match the provided search filter(s). Will return all members of the organization if no search filter is provided.
+     * @param orgName Name of the Organization
+     * @param filters (optional) Array of search filters
+     * @param excludeTeamByName (optional) Name of a team whos members shall be excluded
+     * @param sorting (optional) Sorting object
+     * @param limit (optional) Max number of results (1-100; defaults to 25)
+     * @param page (optional) Page number to skip the first (page * limit) results (defaults to 0)
+     * @returns Object containing an array of Organization Members and the total number of results found in the database (independent of limit and page)
+     */
+    searchOrganizationMembers: ({ orgName, filters, excludeTeamByName, sorting, limit, page, }: SearchParams & {
+        orgName: string;
+        excludeTeamByName?: string;
+    }) => Promise<PaginatedResponse<OrganizationMember>>;
+    /**
+     * Retrieves an organization member by its user ID.
+     * @param orgName Name of the organization
+     * @param userId ID of the user
+     * @returns The requested Organization Member
+     */
+    getOrganizationMember: (orgName: string, userId: string) => Promise<OrganizationMember>;
+    /**
+     * Updates the role of a User in the specified Organization.
+     * @param orgName Name of the Organization
+     * @param userId ID of the User
+     * @param orgMemberPatch New role
+     * @returns The updated OrganizationMember
+     */
+    patchOrganizationMemberRole: (orgName: string, userId: string, orgMemberPatch: OrgMemberPatch) => Promise<OrganizationMember>;
+    /**
+     * Updates the executionTarget flag of a User in the specified Organization.
+     * @param orgName Name of the Organization
+     * @param userId ID of the User
+     * @param executionTarget Boolean value to set
+     * @returns The updated OrganizationMember
+     */
+    patchOrganizationExecutionTarget: (orgName: string, userId: string, executionTarget: boolean) => Promise<OrganizationMember>;
+    /**
+     * Removes a Member from an Organization.
+     * @param orgName Name of the Organization
+     * @param userId ID of the User
+     */
+    removeOrganizationMember: (orgName: string, userId: string) => Promise<void>;
+    /**
+     * Member leaves the organization independently.
+     * @param orgName Name of the Organization
+     */
+    leaveOrganization: (orgName: string) => Promise<void>;
+    protected getEndpoint(endpoint: string): string;
+}

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

@@ -0,0 +1,96 @@
+"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 });
+exports.IdpOrganizationMember = void 0;
+const Base_1 = require("../../../../Base");
+const paginatedResponseHelper_1 = require("../../../../helper/paginatedResponseHelper");
+const searchFilter_1 = require("../../../../helper/searchFilter");
+const invitations_1 = require("./invitations");
+class IdpOrganizationMember extends Base_1.default {
+    constructor(options, axios) {
+        super(options, axios);
+        /**
+         * Retrieves all organization members that match the provided search filter(s). Will return all members of the organization if no search filter is provided.
+         * @param orgName Name of the Organization
+         * @param filters (optional) Array of search filters
+         * @param excludeTeamByName (optional) Name of a team whos members shall be excluded
+         * @param sorting (optional) Sorting object
+         * @param limit (optional) Max number of results (1-100; defaults to 25)
+         * @param page (optional) Page number to skip the first (page * limit) results (defaults to 0)
+         * @returns Object containing an array of Organization Members and the total number of results found in the database (independent of limit and page)
+         */
+        this.searchOrganizationMembers = (_a) => __awaiter(this, [_a], void 0, function* ({ orgName, filters, excludeTeamByName, sorting, limit = 25, page = 0, }) {
+            const filtersDTO = filters === null || filters === void 0 ? void 0 : filters.map((f) => {
+                return new searchFilter_1.SearchFilterDTO(f);
+            });
+            const resp = yield this.axios.post(this.getEndpoint(`/${orgName}/members/search?limit=${limit}&page=${page}`), {
+                filters: filtersDTO,
+                sorting,
+                excludeTeamByName,
+            });
+            return (0, paginatedResponseHelper_1.createPaginatedResponse)(resp);
+        });
+        /**
+         * Retrieves an organization member by its user ID.
+         * @param orgName Name of the organization
+         * @param userId ID of the user
+         * @returns The requested Organization Member
+         */
+        this.getOrganizationMember = (orgName, userId) => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint(`/${orgName}/members/${userId}`));
+            return resp.data;
+        });
+        /**
+         * Updates the role of a User in the specified Organization.
+         * @param orgName Name of the Organization
+         * @param userId ID of the User
+         * @param orgMemberPatch New role
+         * @returns The updated OrganizationMember
+         */
+        this.patchOrganizationMemberRole = (orgName, userId, orgMemberPatch) => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.patch(this.getEndpoint(`/${orgName}/members/${userId}/role`), orgMemberPatch);
+            return resp.data;
+        });
+        /**
+         * Updates the executionTarget flag of a User in the specified Organization.
+         * @param orgName Name of the Organization
+         * @param userId ID of the User
+         * @param executionTarget Boolean value to set
+         * @returns The updated OrganizationMember
+         */
+        this.patchOrganizationExecutionTarget = (orgName, userId, executionTarget) => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.patch(this.getEndpoint(`/${orgName}/members/${userId}/executionTarget`), {
+                executionTarget,
+            });
+            return resp.data;
+        });
+        /**
+         * Removes a Member from an Organization.
+         * @param orgName Name of the Organization
+         * @param userId ID of the User
+         */
+        this.removeOrganizationMember = (orgName, userId) => __awaiter(this, void 0, void 0, function* () {
+            yield this.axios.delete(this.getEndpoint(`/${orgName}/members/${userId}`));
+        });
+        /**
+         * Member leaves the organization independently.
+         * @param orgName Name of the Organization
+         */
+        this.leaveOrganization = (orgName) => __awaiter(this, void 0, void 0, function* () {
+            yield this.axios.delete(this.getEndpoint(`/${orgName}/members`));
+        });
+        this.invitations = new invitations_1.default(options, axios);
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/account/v1/org${endpoint}`;
+    }
+}
+exports.IdpOrganizationMember = IdpOrganizationMember;

package/lib/service/idp/organization/member/invitations/index.d.ts

@@ -0,0 +1,79 @@
+import Base from "../../../../../Base";
+import { PaginatedResponse, SearchFilter, Sorting } from "../../../../../interfaces/global";
+import { OrganizationRole } from "../../../../../interfaces/idp";
+import { OrganizationMemberInvitation } from "../../../../../interfaces/idp/organization/member/invitations";
+export default class IdpOrganizationMemberInvitations extends Base {
+    /**
+     * 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: {
+        orgName: string;
+        filters: SearchFilter[];
+        sorting?: Sorting;
+        limit?: number;
+        page?: number;
+    }) => Promise<PaginatedResponse<OrganizationMemberInvitation>>;
+    /**
+     * 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: string, email: string, role: OrganizationRole, allowNonRegisteredUsers?: boolean, targetUrl?: string) => Promise<OrganizationMemberInvitation>;
+    /**
+     * Accept an invitation.
+     *
+     * Internally this calls respond.
+     *
+     * @param orgName Name of the Organization
+     * @param invitationId ID of the invitation
+     * @returns The patched invitation
+     */
+    accept: (orgName: string, invitationId: string) => Promise<OrganizationMemberInvitation>;
+    /**
+     * Reject an invitation.
+     *
+     * Internally this calls respond.
+     *
+     * @param orgName Name of the Organization
+     * @param invitationId ID of the invitation
+     * @returns The patched invitation
+     */
+    reject: (orgName: string, invitationId: string) => Promise<OrganizationMemberInvitation>;
+    /**
+     * Respond to an invitation.
+     *
+     * @param orgName Name of the Organization
+     * @param invitationId ID of the invitation
+     * @param accept Whether or not to accept the invitation
+     * @returns The patched invitation
+     */
+    respond: (orgName: string, invitationId: string, accept: boolean) => Promise<OrganizationMemberInvitation>;
+    /**
+     * Resends an invitation email.
+     *
+     * @param orgName Name of the Organization
+     * @param invitationId ID of the invitation
+     */
+    resendInvitationEmail: (orgName: string, invitationId: string) => Promise<void>;
+    /**
+     * Cancel/Delete an invitation.
+     *
+     * @param orgName Name of the Organization
+     * @param invitationId ID of the invitation
+     */
+    delete: (orgName: string, invitationId: string) => Promise<void>;
+    protected getEndpoint(endpoint: string): string;
+}