/** * 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 { Api } from '../model/api'; import { ApisResponse } from '../model/apisResponse'; import { CategoryApiQuery } from '../model/categoryApiQuery'; import { Page } from '../model/page'; import { PagesResponse } from '../model/pagesResponse'; import { PlansResponse } from '../model/plansResponse'; import { Rating } from '../model/rating'; import { RatingInput } from '../model/ratingInput'; import { RatingsResponse } from '../model/ratingsResponse'; import { Configuration } from '../configuration'; export interface CreateApiRatingForApiRequestParams { apiId: string; RatingInput?: RatingInput; } export interface GetApiByApiIdRequestParams { apiId: string; include?: Array<'pages' | 'plans'>; } export interface GetApiPlansByApiIdRequestParams { apiId: string; page?: number; size?: number; } export interface GetApiRatingsByApiIdRequestParams { apiId: string; page?: number; size?: number; } export interface GetApisRequestParams { page?: number; size?: number; context_path?: string; label?: string; version?: string; name?: string; view?: string; cat?: CategoryApiQuery; } export interface GetPageByApiIdAndPageIdRequestParams { apiId: string; pageId: string; } export interface GetPagesByApiIdRequestParams { apiId: string; page?: number; size?: number; homepage?: boolean; parent?: string; } export interface GetPictureByApiIdRequestParams { apiId: string; } export declare class ApiService { protected httpClient: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; encoder: HttpParameterCodec; constructor(httpClient: HttpClient, basePath: string, configuration: Configuration); /** * Create a rating for an API * Create a rating for an API. This API has to be accessible by the current user, otherwise a 404 will be returned. The current must have API_RATING[CREATE] permission to create a rating. * @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. */ createApiRatingForApi(requestParameters: CreateApiRatingForApiRequestParams, observe?: 'body', reportProgress?: boolean): Observable; createApiRatingForApi(requestParameters: CreateApiRatingForApiRequestParams, observe?: 'response', reportProgress?: boolean): Observable>; createApiRatingForApi(requestParameters: CreateApiRatingForApiRequestParams, observe?: 'events', reportProgress?: boolean): Observable>; /** * Get the API definition * Get the detail 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. */ getApiByApiId(requestParameters: GetApiByApiIdRequestParams, observe?: 'body', reportProgress?: boolean): Observable; getApiByApiId(requestParameters: GetApiByApiIdRequestParams, observe?: 'response', reportProgress?: boolean): Observable>; getApiByApiId(requestParameters: GetApiByApiIdRequestParams, observe?: 'events', reportProgress?: boolean): Observable>; /** * List plans for an API * List plans for 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. */ getApiPlansByApiId(requestParameters: GetApiPlansByApiIdRequestParams, observe?: 'body', reportProgress?: boolean): Observable; getApiPlansByApiId(requestParameters: GetApiPlansByApiIdRequestParams, observe?: 'response', reportProgress?: boolean): Observable>; getApiPlansByApiId(requestParameters: GetApiPlansByApiIdRequestParams, observe?: 'events', reportProgress?: boolean): Observable>; /** * List ratings for an API * List ratings for 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. */ getApiRatingsByApiId(requestParameters: GetApiRatingsByApiIdRequestParams, observe?: 'body', reportProgress?: boolean): Observable; getApiRatingsByApiId(requestParameters: GetApiRatingsByApiIdRequestParams, observe?: 'response', reportProgress?: boolean): Observable>; getApiRatingsByApiId(requestParameters: GetApiRatingsByApiIdRequestParams, observe?: 'events', reportProgress?: boolean): Observable>; /** * List APIs * List public APIs for anonymous requests. List all the APIs the current user is allowed to view for authenticated requests. The list can be filtered according to query parameters. By default the list is sorted by alphabetic order. If a **cat** query param is sent, a specific sorting can be applied. Please refer to **cat** description for detail. * @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. */ getApis(requestParameters: GetApisRequestParams, observe?: 'body', reportProgress?: boolean): Observable; getApis(requestParameters: GetApisRequestParams, observe?: 'response', reportProgress?: boolean): Observable>; getApis(requestParameters: GetApisRequestParams, observe?: 'events', reportProgress?: boolean): Observable>; /** * 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>; /** * 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>; /** * Get the API\'s picture * Get the API\'s picture. 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. */ getPictureByApiId(requestParameters: GetPictureByApiIdRequestParams, observe?: 'body', reportProgress?: boolean): Observable; getPictureByApiId(requestParameters: GetPictureByApiIdRequestParams, observe?: 'response', reportProgress?: boolean): Observable>; getPictureByApiId(requestParameters: GetPictureByApiIdRequestParams, observe?: 'events', reportProgress?: boolean): Observable>; }