@devopness/sdk-js/dist/api/generated/apis/organizations-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 { Organization } from '../../generated/models';
import { OrganizationActivity } from '../../generated/models';
import { OrganizationCreate } from '../../generated/models';
import { OrganizationRelation } from '../../generated/models';
import { OrganizationUpdate } from '../../generated/models';
/**
 * OrganizationsApiService - Auto-generated
 */
export declare class OrganizationsApiService extends ApiBaseService {
    /**
     *
     * @summary Create a new organization
     * @param {OrganizationCreate} organizationCreate A JSON object containing the resource data
     */
    addOrganization(organizationCreate: OrganizationCreate): Promise<ApiResponse<Organization>>;
    /**
     *
     * @summary Get an organization by ID or URL Slug
     * @param {string} organizationId The numeric ID or URL Slug of an organization.
     */
    getOrganization(organizationId: string): Promise<ApiResponse<Organization>>;
    /**
     *
     * @summary Get activity information for an organization
     * @param {string} organizationId The numeric ID or URL Slug of an organization.
     */
    getOrganizationActivity(organizationId: string): Promise<ApiResponse<OrganizationActivity>>;
    /**
     *
     * @summary List all organizations of authenticated user
     * @param {number} [page] Number of the page to be retrieved
     * @param {number} [perPage] Number of items returned per page
     */
    listOrganizations(page?: number, perPage?: number): Promise<ApiResponse<Array<OrganizationRelation>>>;
    /**
     *
     * @summary Update an existing organization
     * @param {string} organizationId The numeric ID or URL Slug of an organization.
     * @param {OrganizationUpdate} organizationUpdate A JSON object containing the resource data
     */
    updateOrganization(organizationId: string, organizationUpdate: OrganizationUpdate): Promise<ApiResponse<void>>;
}