/** * Gravitee.io Portal Rest API * API dedicated to the devportal part of Gravitee * * The version of the OpenAPI document: 3.0.0 * Contact: contact@graviteesource.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec } from '@angular/common/http'; import { Observable } from 'rxjs'; import { Page } from '../model/page'; import { PagesResponse } from '../model/pagesResponse'; import { Configuration } from '../configuration'; export interface GetPageByApiIdAndPageIdRequestParams { apiId: string; pageId: string; } export interface GetPageByPageIdRequestParams { pageId: string; } export interface GetPagesRequestParams { page?: number; size?: number; homepage?: boolean; parent?: string; } export interface GetPagesByApiIdRequestParams { apiId: string; page?: number; size?: number; homepage?: boolean; parent?: string; } export declare class DocumentationService { protected httpClient: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; encoder: HttpParameterCodec; constructor(httpClient: HttpClient, basePath: string, configuration: Configuration); /** * Get an API page * Get an API page. This API has to be accessible by the current user, otherwise a 404 will be returned. * @param requestParameters * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ getPageByApiIdAndPageId(requestParameters: GetPageByApiIdAndPageIdRequestParams, observe?: 'body', reportProgress?: boolean): Observable; getPageByApiIdAndPageId(requestParameters: GetPageByApiIdAndPageIdRequestParams, observe?: 'response', reportProgress?: boolean): Observable>; getPageByApiIdAndPageId(requestParameters: GetPageByApiIdAndPageIdRequestParams, observe?: 'events', reportProgress?: boolean): Observable>; /** * Get a portal page * Get a specific portal documentation page. * @param requestParameters * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ getPageByPageId(requestParameters: GetPageByPageIdRequestParams, observe?: 'body', reportProgress?: boolean): Observable; getPageByPageId(requestParameters: GetPageByPageIdRequestParams, observe?: 'response', reportProgress?: boolean): Observable>; getPageByPageId(requestParameters: GetPageByPageIdRequestParams, observe?: 'events', reportProgress?: boolean): Observable>; /** * List portal pages * List all portal documentation pages * @param requestParameters * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ getPages(requestParameters: GetPagesRequestParams, observe?: 'body', reportProgress?: boolean): Observable; getPages(requestParameters: GetPagesRequestParams, observe?: 'response', reportProgress?: boolean): Observable>; getPages(requestParameters: GetPagesRequestParams, observe?: 'events', reportProgress?: boolean): Observable>; /** * List API pages * List all documentation pages of an API. This API has to be accessible by the current user, otherwise a 404 will be returned. * @param requestParameters * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ getPagesByApiId(requestParameters: GetPagesByApiIdRequestParams, observe?: 'body', reportProgress?: boolean): Observable; getPagesByApiId(requestParameters: GetPagesByApiIdRequestParams, observe?: 'response', reportProgress?: boolean): Observable>; getPagesByApiId(requestParameters: GetPagesByApiIdRequestParams, observe?: 'events', reportProgress?: boolean): Observable>; }