@devopness/sdk-js 2.7.0 → 2.9.0

package/dist/api/generated/apis/teams-api.js

@@ -29,6 +29,22 @@ const Exceptions_1 = require("../../../common/Exceptions");
  * TeamsApiService - Auto-generated
  */
 class TeamsApiService extends ApiBaseService_1.ApiBaseService {
+    /**
+     *
+     * @summary Delete a given team
+     * @param {number} teamId Numeric ID of the team to be deleted
+     */
+    deleteTeam(teamId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (teamId === null || teamId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('teamId', 'deleteTeam');
+            }
+            let queryString = '';
+            const requestUrl = '/teams/{team_id}' + (queryString ? `?${queryString}` : '');
+            const response = yield this.delete(requestUrl.replace(`{${"team_id"}}`, encodeURIComponent(String(teamId))));
+            return new ApiResponse_1.ApiResponse(response);
+        });
+    }
     /**
      *
      * @summary Get a team by ID
@@ -45,5 +61,69 @@ class TeamsApiService extends ApiBaseService_1.ApiBaseService {
             return new ApiResponse_1.ApiResponse(response);
         });
     }
+    /**
+     *
+     * @summary Link team to a given environment
+     * @param {number} environmentId Numeric ID of the environment to link
+     * @param {number} teamId Numeric ID of the team to be linked
+     * @param {EnvironmentTeamLink} environmentTeamLink A JSON object containing the role ID
+     */
+    linkTeamToEnvironment(environmentId, teamId, environmentTeamLink) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (environmentId === null || environmentId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('environmentId', 'linkTeamToEnvironment');
+            }
+            if (teamId === null || teamId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('teamId', 'linkTeamToEnvironment');
+            }
+            if (environmentTeamLink === null || environmentTeamLink === undefined) {
+                throw new Exceptions_1.ArgumentNullException('environmentTeamLink', 'linkTeamToEnvironment');
+            }
+            let queryString = '';
+            const requestUrl = '/environments/{environment_id}/teams/{team_id}' + (queryString ? `?${queryString}` : '');
+            const response = yield this.post(requestUrl.replace(`{${"environment_id"}}`, encodeURIComponent(String(environmentId))).replace(`{${"team_id"}}`, encodeURIComponent(String(teamId))), environmentTeamLink);
+            return new ApiResponse_1.ApiResponse(response);
+        });
+    }
+    /**
+     *
+     * @summary Unlink team from the environment
+     * @param {number} environmentId Numeric ID of the environment to unlink
+     * @param {number} teamId Numeric ID of the team to be unlinked
+     */
+    unlinkTeamFromEnvironment(environmentId, teamId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (environmentId === null || environmentId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('environmentId', 'unlinkTeamFromEnvironment');
+            }
+            if (teamId === null || teamId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('teamId', 'unlinkTeamFromEnvironment');
+            }
+            let queryString = '';
+            const requestUrl = '/environments/{environment_id}/teams/{team_id}' + (queryString ? `?${queryString}` : '');
+            const response = yield this.delete(requestUrl.replace(`{${"environment_id"}}`, encodeURIComponent(String(environmentId))).replace(`{${"team_id"}}`, encodeURIComponent(String(teamId))));
+            return new ApiResponse_1.ApiResponse(response);
+        });
+    }
+    /**
+     *
+     * @summary Update an existing team
+     * @param {number} teamId Numeric ID of the team to be updated
+     * @param {TeamCreate} teamCreate A JSON object containing team data
+     */
+    updateTeam(teamId, teamCreate) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (teamId === null || teamId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('teamId', 'updateTeam');
+            }
+            if (teamCreate === null || teamCreate === undefined) {
+                throw new Exceptions_1.ArgumentNullException('teamCreate', 'updateTeam');
+            }
+            let queryString = '';
+            const requestUrl = '/teams/{team_id}' + (queryString ? `?${queryString}` : '');
+            const response = yield this.put(requestUrl.replace(`{${"team_id"}}`, encodeURIComponent(String(teamId))), teamCreate);
+            return new ApiResponse_1.ApiResponse(response);
+        });
+    }
 }
 exports.TeamsApiService = TeamsApiService;

package/dist/api/generated/apis/teams-invitations-api.d.ts

@@ -12,6 +12,7 @@
 import { ApiBaseService } from "../../../services/ApiBaseService";
 import { ApiResponse } from "../../../common/ApiResponse";
 import { Invitation } from '../../generated/models';
+import { InvitationCreate } from '../../generated/models';
 /**
  * TeamsInvitationsApiService - Auto-generated
  */
@@ -24,4 +25,11 @@ export declare class TeamsInvitationsApiService extends ApiBaseService {
      * @param {number} [perPage] Number of items returned per page
      */
     listTeamInvitations(teamId: number, page?: number, perPage?: number): Promise<ApiResponse<Array<Invitation>>>;
+    /**
+     *
+     * @summary Send invitation to user email to participate to a team
+     * @param {number} teamId Numeric ID of the team to invite an user
+     * @param {InvitationCreate} invitationCreate A JSON object containing the email to send the invitation
+     */
+    sendTeamInvitation(teamId: number, invitationCreate: InvitationCreate): Promise<ApiResponse<Invitation>>;
 }

package/dist/api/generated/apis/teams-invitations-api.js

@@ -54,5 +54,25 @@ class TeamsInvitationsApiService extends ApiBaseService_1.ApiBaseService {
             return new ApiResponse_1.ApiResponse(response);
         });
     }
+    /**
+     *
+     * @summary Send invitation to user email to participate to a team
+     * @param {number} teamId Numeric ID of the team to invite an user
+     * @param {InvitationCreate} invitationCreate A JSON object containing the email to send the invitation
+     */
+    sendTeamInvitation(teamId, invitationCreate) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (teamId === null || teamId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('teamId', 'sendTeamInvitation');
+            }
+            if (invitationCreate === null || invitationCreate === undefined) {
+                throw new Exceptions_1.ArgumentNullException('invitationCreate', 'sendTeamInvitation');
+            }
+            let queryString = '';
+            const requestUrl = '/teams/{team_id}/invitations' + (queryString ? `?${queryString}` : '');
+            const response = yield this.post(requestUrl.replace(`{${"team_id"}}`, encodeURIComponent(String(teamId))), invitationCreate);
+            return new ApiResponse_1.ApiResponse(response);
+        });
+    }
 }
 exports.TeamsInvitationsApiService = TeamsInvitationsApiService;

package/dist/api/generated/models/application-deployment.d.ts

@@ -22,6 +22,12 @@ export interface ApplicationDeployment {
      * @memberof ApplicationDeployment
      */
     type: DeploymentType;
+    /**
+     * The pipeline\'s ID to use for deployment
+     * @type {number}
+     * @memberof ApplicationDeployment
+     */
+    pipeline_id?: number;
     /**
      * The name of the branch from which the application source code will be retrieved and deployed. This parameter is ignored when `hash` is provided.
      * @type {string}

package/dist/api/generated/models/environment-member-profile.d.ts

@@ -0,0 +1,49 @@
+/**
+ * devopness API
+ * Devopness API - Painless essential DevOps to everyone
+ *
+ * The version of the OpenAPI document: latest
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { EnvironmentTeam } from './environment-team';
+/**
+ *
+ * @export
+ * @interface EnvironmentMemberProfile
+ */
+export interface EnvironmentMemberProfile {
+    /**
+     * The ID of the member
+     * @type {number}
+     * @memberof EnvironmentMemberProfile
+     */
+    id: number;
+    /**
+     * Member\'s full name
+     * @type {string}
+     * @memberof EnvironmentMemberProfile
+     */
+    name: string;
+    /**
+     * Member\'s email
+     * @type {string}
+     * @memberof EnvironmentMemberProfile
+     */
+    email: string;
+    /**
+     * Tells if the user is active or not
+     * @type {boolean}
+     * @memberof EnvironmentMemberProfile
+     */
+    active: boolean;
+    /**
+     *
+     * @type {Array<EnvironmentTeam>}
+     * @memberof EnvironmentMemberProfile
+     */
+    teams: Array<EnvironmentTeam>;
+}

package/dist/api/generated/models/environment-member-profile.js

@@ -0,0 +1,14 @@
+"use strict";
+/* eslint-disable */
+/**
+ * devopness API
+ * Devopness API - Painless essential DevOps to everyone
+ *
+ * The version of the OpenAPI document: latest
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/generated/models/environment-member.d.ts

@@ -0,0 +1,36 @@
+/**
+ * devopness API
+ * Devopness API - Painless essential DevOps to everyone
+ *
+ * The version of the OpenAPI document: latest
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface EnvironmentMember
+ */
+export interface EnvironmentMember {
+    /**
+     * The ID of the member
+     * @type {number}
+     * @memberof EnvironmentMember
+     */
+    id: number;
+    /**
+     * Member\'s full name
+     * @type {string}
+     * @memberof EnvironmentMember
+     */
+    name: string;
+    /**
+     * Member\'s email
+     * @type {string}
+     * @memberof EnvironmentMember
+     */
+    email: string;
+}

package/dist/api/generated/models/environment-member.js

@@ -0,0 +1,14 @@
+"use strict";
+/* eslint-disable */
+/**
+ * devopness API
+ * Devopness API - Painless essential DevOps to everyone
+ *
+ * The version of the OpenAPI document: latest
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/generated/models/environment-team-link.d.ts

@@ -0,0 +1,24 @@
+/**
+ * devopness API
+ * Devopness API - Painless essential DevOps to everyone
+ *
+ * The version of the OpenAPI document: latest
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface EnvironmentTeamLink
+ */
+export interface EnvironmentTeamLink {
+    /**
+     * The role\'s ID to use for this team on environment
+     * @type {number}
+     * @memberof EnvironmentTeamLink
+     */
+    role_id: number;
+}

package/dist/api/generated/models/environment-team-link.js

@@ -0,0 +1,14 @@
+"use strict";
+/* eslint-disable */
+/**
+ * devopness API
+ * Devopness API - Painless essential DevOps to everyone
+ *
+ * The version of the OpenAPI document: latest
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/generated/models/environment-team.d.ts

@@ -0,0 +1,61 @@
+/**
+ * devopness API
+ * Devopness API - Painless essential DevOps to everyone
+ *
+ * The version of the OpenAPI document: latest
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Role } from './role';
+/**
+ *
+ * @export
+ * @interface EnvironmentTeam
+ */
+export interface EnvironmentTeam {
+    /**
+     * The unique id of the given team
+     * @type {number}
+     * @memberof EnvironmentTeam
+     */
+    id: number;
+    /**
+     * The name of the given team
+     * @type {string}
+     * @memberof EnvironmentTeam
+     */
+    name: string;
+    /**
+     * The URL to team\'s image
+     * @type {string}
+     * @memberof EnvironmentTeam
+     */
+    photo_url: string | null;
+    /**
+     * The unique id of the role used on this environment
+     * @type {number}
+     * @memberof EnvironmentTeam
+     */
+    role_id?: number;
+    /**
+     *
+     * @type {Role}
+     * @memberof EnvironmentTeam
+     */
+    role: Role;
+    /**
+     * The date and time when the record was created
+     * @type {string}
+     * @memberof EnvironmentTeam
+     */
+    created_at?: string;
+    /**
+     * The date and time when the record was last updated
+     * @type {string}
+     * @memberof EnvironmentTeam
+     */
+    updated_at?: string;
+}

package/dist/api/generated/models/environment-team.js

@@ -0,0 +1,14 @@
+"use strict";
+/* eslint-disable */
+/**
+ * devopness API
+ * Devopness API - Painless essential DevOps to everyone
+ *
+ * The version of the OpenAPI document: latest
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/generated/models/environment.d.ts

@@ -103,6 +103,12 @@ export interface Environment {
      * @memberof Environment
      */
     created_by_user: UserRelation;
+    /**
+     * The list of permissions for this role
+     * @type {Array<string>}
+     * @memberof Environment
+     */
+    current_user_permissions?: Array<string>;
     /**
      * The date and time when the record was created
      * @type {string}

package/dist/api/generated/models/index.d.ts

@@ -69,9 +69,13 @@ export * from './environment-create';
 export * from './environment-id-request';
 export * from './environment-link-item';
 export * from './environment-link-server';
+export * from './environment-member';
+export * from './environment-member-profile';
 export * from './environment-option-type';
 export * from './environment-options';
 export * from './environment-relation';
+export * from './environment-team';
+export * from './environment-team-link';
 export * from './environment-type';
 export * from './environment-update';
 export * from './hook';
@@ -116,6 +120,8 @@ export * from './network-rule-type';
 export * from './network-rule-update';
 export * from './operating-system';
 export * from './operating-system-supported-versions';
+export * from './permission';
+export * from './permission-permissions';
 export * from './pipeline';
 export * from './pipeline-create';
 export * from './pipeline-step';
@@ -131,6 +137,9 @@ export * from './repository-branch';
 export * from './resource';
 export * from './resource-event';
 export * from './resource-type';
+export * from './role';
+export * from './role-create';
+export * from './role-update';
 export * from './script';
 export * from './script-create';
 export * from './script-runner';

package/dist/api/generated/models/index.js

@@ -85,9 +85,13 @@ __exportStar(require("./environment-create"), exports);
 __exportStar(require("./environment-id-request"), exports);
 __exportStar(require("./environment-link-item"), exports);
 __exportStar(require("./environment-link-server"), exports);
+__exportStar(require("./environment-member"), exports);
+__exportStar(require("./environment-member-profile"), exports);
 __exportStar(require("./environment-option-type"), exports);
 __exportStar(require("./environment-options"), exports);
 __exportStar(require("./environment-relation"), exports);
+__exportStar(require("./environment-team"), exports);
+__exportStar(require("./environment-team-link"), exports);
 __exportStar(require("./environment-type"), exports);
 __exportStar(require("./environment-update"), exports);
 __exportStar(require("./hook"), exports);
@@ -132,6 +136,8 @@ __exportStar(require("./network-rule-type"), exports);
 __exportStar(require("./network-rule-update"), exports);
 __exportStar(require("./operating-system"), exports);
 __exportStar(require("./operating-system-supported-versions"), exports);
+__exportStar(require("./permission"), exports);
+__exportStar(require("./permission-permissions"), exports);
 __exportStar(require("./pipeline"), exports);
 __exportStar(require("./pipeline-create"), exports);
 __exportStar(require("./pipeline-step"), exports);
@@ -147,6 +153,9 @@ __exportStar(require("./repository-branch"), exports);
 __exportStar(require("./resource"), exports);
 __exportStar(require("./resource-event"), exports);
 __exportStar(require("./resource-type"), exports);
+__exportStar(require("./role"), exports);
+__exportStar(require("./role-create"), exports);
+__exportStar(require("./role-update"), exports);
 __exportStar(require("./script"), exports);
 __exportStar(require("./script-create"), exports);
 __exportStar(require("./script-runner"), exports);

package/dist/api/generated/models/invitation.d.ts

@@ -36,12 +36,6 @@ export interface Invitation {
      * @memberof Invitation
      */
     status_human_readable?: string;
-    /**
-     * The role to be assigned to the invited user after the invitation is accepted
-     * @type {string}
-     * @memberof Invitation
-     */
-    role: string;
     /**
      * The email of the user that has been invited to team
      * @type {string}

package/dist/api/generated/models/permission-permissions.d.ts

@@ -0,0 +1,42 @@
+/**
+ * devopness API
+ * Devopness API - Painless essential DevOps to everyone
+ *
+ * The version of the OpenAPI document: latest
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface PermissionPermissions
+ */
+export interface PermissionPermissions {
+    /**
+     * Name of permission
+     * @type {string}
+     * @memberof PermissionPermissions
+     */
+    name: string;
+    /**
+     * Human readable permission name
+     * @type {string}
+     * @memberof PermissionPermissions
+     */
+    human_readable: string;
+    /**
+     * Description of what a role is allowed to do with a resource if she has this permission
+     * @type {string}
+     * @memberof PermissionPermissions
+     */
+    hint: string;
+    /**
+     * List of permissions the role must have before receiving this one
+     * @type {Array<string>}
+     * @memberof PermissionPermissions
+     */
+    required_permissions?: Array<string>;
+}

package/dist/api/generated/models/permission-permissions.js

@@ -0,0 +1,14 @@
+"use strict";
+/* eslint-disable */
+/**
+ * devopness API
+ * Devopness API - Painless essential DevOps to everyone
+ *
+ * The version of the OpenAPI document: latest
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/generated/models/permission.d.ts

@@ -0,0 +1,37 @@
+/**
+ * devopness API
+ * Devopness API - Painless essential DevOps to everyone
+ *
+ * The version of the OpenAPI document: latest
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { PermissionPermissions } from './permission-permissions';
+/**
+ *
+ * @export
+ * @interface Permission
+ */
+export interface Permission {
+    /**
+     * The type of resource this permission affects
+     * @type {string}
+     * @memberof Permission
+     */
+    resource_type: string;
+    /**
+     * Human readable resource name
+     * @type {string}
+     * @memberof Permission
+     */
+    human_readable: string;
+    /**
+     * List of permissions available for this resource
+     * @type {Array<PermissionPermissions>}
+     * @memberof Permission
+     */
+    permissions: Array<PermissionPermissions>;
+}

package/dist/api/generated/models/permission.js

@@ -0,0 +1,14 @@
+"use strict";
+/* eslint-disable */
+/**
+ * devopness API
+ * Devopness API - Painless essential DevOps to everyone
+ *
+ * The version of the OpenAPI document: latest
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/generated/models/role-create.d.ts

@@ -0,0 +1,36 @@
+/**
+ * devopness API
+ * Devopness API - Painless essential DevOps to everyone
+ *
+ * The version of the OpenAPI document: latest
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface RoleCreate
+ */
+export interface RoleCreate {
+    /**
+     * The role\'s name
+     * @type {string}
+     * @memberof RoleCreate
+     */
+    name: string;
+    /**
+     * Description of this role
+     * @type {string}
+     * @memberof RoleCreate
+     */
+    description?: string;
+    /**
+     * The list of permissions for this role
+     * @type {Array<string>}
+     * @memberof RoleCreate
+     */
+    permissions: Array<string>;
+}

package/dist/api/generated/models/role-create.js

@@ -0,0 +1,14 @@
+"use strict";
+/* eslint-disable */
+/**
+ * devopness API
+ * Devopness API - Painless essential DevOps to everyone
+ *
+ * The version of the OpenAPI document: latest
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });