@devopness/sdk-js/dist/api/generated/apis/projects-api.d.ts

Devopness API JS/TS SDK - Painless essential DevOps to everyone

/**
 * 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 { ApiBaseService } from "../../../services/ApiBaseService";
import { ApiResponse } from "../../../common/ApiResponse";
import { Project } from '../../generated/models';
import { ProjectOrganizationCreate } from '../../generated/models';
import { ProjectRelation } from '../../generated/models';
import { ProjectUpdate } from '../../generated/models';
/**
 * ProjectsApiService - Auto-generated
 */
export declare class ProjectsApiService extends ApiBaseService {
    /**
     *
     * @summary Create a project to a given organization
     * @param {string} organizationId The numeric ID or URL Slug of an organization.
     * @param {ProjectOrganizationCreate} projectOrganizationCreate A JSON object containing the resource data
     */
    addOrganizationProject(organizationId: string, projectOrganizationCreate: ProjectOrganizationCreate): Promise<ApiResponse<Project>>;
    /**
     *
     * @deprecated
     * @summary Create a project for the authenticated user
     */
    addProject(): Promise<ApiResponse<Project>>;
    /**
     *
     * @summary Delete a given project
     * @param {number} projectId The ID of the project.
     */
    deleteProject(projectId: number): Promise<ApiResponse<void>>;
    /**
     *
     * @summary Get a Project by ID
     * @param {number} projectId The ID of the project.
     */
    getProject(projectId: number): Promise<ApiResponse<Project>>;
    /**
     *
     * @summary Return a list of projects
     * @param {number} [page] Number of the page to be retrieved
     * @param {number} [perPage] Number of items returned per page
     * @param {string} [owner] Filter by project\&#39;s owner ID or URL Slug. If not provided, projects accessible by currently authenticated user are returned.
     */
    listProjects(page?: number, perPage?: number, owner?: string): Promise<ApiResponse<Array<ProjectRelation>>>;
    /**
     *
     * @summary Update an existing Project
     * @param {number} projectId The ID of the project.
     * @param {ProjectUpdate} projectUpdate A JSON object containing the resource data
     */
    updateProject(projectId: number, projectUpdate: ProjectUpdate): Promise<ApiResponse<void>>;
}