/** * 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 { Application } from '../model/application'; import { ApplicationInput } from '../model/applicationInput'; import { ApplicationsResponse } from '../model/applicationsResponse'; import { DateHistoAnalytics, GroupByAnalytics, CountAnalytics } from '../model/models'; import { GenericNotificationConfig } from '../model/genericNotificationConfig'; import { Log } from '../model/log'; import { LogsResponse } from '../model/logsResponse'; import { Member } from '../model/member'; import { MemberInput } from '../model/memberInput'; import { MembersResponse } from '../model/membersResponse'; import { NotificationConfigsResponse } from '../model/notificationConfigsResponse'; import { PortalNotificationConfig } from '../model/portalNotificationConfig'; import { TransferOwnershipInput } from '../model/transferOwnershipInput'; import { Configuration } from '../configuration'; export interface CreateApplicationRequestParams { ApplicationInput?: ApplicationInput; } export interface CreateApplicationMemberRequestParams { applicationId: string; MemberInput?: MemberInput; } export interface CreateApplicationNotificationRequestParams { applicationId: string; GenericNotificationConfig?: GenericNotificationConfig; } export interface DeleteApplicationByApplicationIdRequestParams { applicationId: string; } export interface DeleteApplicationMemberRequestParams { applicationId: string; memberId: string; } export interface DeleteApplicationNotificationByNotificationIdRequestParams { applicationId: string; notificationId: string; } export interface ExportApplicationLogsByApplicationIdRequestParams { applicationId: string; page?: number; size?: number; from?: number; to?: number; query?: string; field?: string; order?: 'ASC' | 'DESC'; } export interface GetApplicationAnalyticsRequestParams { applicationId: string; page?: number; size?: number; from?: number; to?: number; interval?: number; query?: string; field?: string; type?: 'GROUP_BY' | 'DATE_HISTO' | 'COUNT'; range?: string; aggs?: string; order?: string; } export interface GetApplicationByApplicationIdRequestParams { applicationId: string; } export interface GetApplicationLogByApplicationIdAndLogIdRequestParams { applicationId: string; logId: string; timestamp?: number; } export interface GetApplicationLogsRequestParams { applicationId: string; page?: number; size?: number; from?: number; to?: number; query?: string; field?: string; order?: 'ASC' | 'DESC'; } export interface GetApplicationMemberByApplicationIdAndMemberIdRequestParams { applicationId: string; memberId: string; } export interface GetApplicationPictureByApplicationIdRequestParams { applicationId: string; } export interface GetApplicationsRequestParams { page?: number; size?: number; } export interface GetMembersByApplicationIdRequestParams { applicationId: string; page?: number; size?: number; } export interface GetNotificationsByApplicationIdRequestParams { applicationId: string; } export interface RenewApplicationSecretRequestParams { applicationId: string; } export interface TransferMemberOwnershipRequestParams { applicationId: string; TransferOwnershipInput?: TransferOwnershipInput; } export interface UpdateApplicationByApplicationIdRequestParams { applicationId: string; Application?: Application; } export interface UpdateApplicationMemberByApplicationIdAndMemberIdRequestParams { applicationId: string; memberId: string; MemberInput?: MemberInput; } export interface UpdateGenericApplicationNotificationRequestParams { applicationId: string; notificationId: string; GenericNotificationConfig?: GenericNotificationConfig; } export interface UpdatePortalApplicationNotificationRequestParams { applicationId: string; PortalNotificationConfig?: PortalNotificationConfig; } export declare class ApplicationsService { protected httpClient: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; encoder: HttpParameterCodec; constructor(httpClient: HttpClient, basePath: string, configuration: Configuration); /** * Create an application * Create an application. User must have MANAGEMENT_APPLICATION[CREATE] permission. * @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. */ createApplication(requestParameters: CreateApplicationRequestParams, observe?: 'body', reportProgress?: boolean): Observable; createApplication(requestParameters: CreateApplicationRequestParams, observe?: 'response', reportProgress?: boolean): Observable>; createApplication(requestParameters: CreateApplicationRequestParams, observe?: 'events', reportProgress?: boolean): Observable>; /** * Create an application member * Create an application member. User must have the APPLICATION_MEMBER[CREATE] permission. * @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. */ createApplicationMember(requestParameters: CreateApplicationMemberRequestParams, observe?: 'body', reportProgress?: boolean): Observable; createApplicationMember(requestParameters: CreateApplicationMemberRequestParams, observe?: 'response', reportProgress?: boolean): Observable>; createApplicationMember(requestParameters: CreateApplicationMemberRequestParams, observe?: 'events', reportProgress?: boolean): Observable>; /** * Create notification settings. * Create notification settings. User must have APPLICATION_NOTIFICATION[READ] permission to create a **portal** notification. User must have APPLICATION_NOTIFICATION[CREATE] permission to create a **generic** notification. * @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. */ createApplicationNotification(requestParameters: CreateApplicationNotificationRequestParams, observe?: 'body', reportProgress?: boolean): Observable; createApplicationNotification(requestParameters: CreateApplicationNotificationRequestParams, observe?: 'response', reportProgress?: boolean): Observable>; createApplicationNotification(requestParameters: CreateApplicationNotificationRequestParams, observe?: 'events', reportProgress?: boolean): Observable>; /** * Delete an application * Delete an application. User must have the APPLICATION_DEFINITION[DELETE] permission. * @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. */ deleteApplicationByApplicationId(requestParameters: DeleteApplicationByApplicationIdRequestParams, observe?: 'body', reportProgress?: boolean): Observable; deleteApplicationByApplicationId(requestParameters: DeleteApplicationByApplicationIdRequestParams, observe?: 'response', reportProgress?: boolean): Observable>; deleteApplicationByApplicationId(requestParameters: DeleteApplicationByApplicationIdRequestParams, observe?: 'events', reportProgress?: boolean): Observable>; /** * Remove an application member * Remove an application member. User must have the APPLICATION_MEMBER[DELETE] permission. * @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. */ deleteApplicationMember(requestParameters: DeleteApplicationMemberRequestParams, observe?: 'body', reportProgress?: boolean): Observable; deleteApplicationMember(requestParameters: DeleteApplicationMemberRequestParams, observe?: 'response', reportProgress?: boolean): Observable>; deleteApplicationMember(requestParameters: DeleteApplicationMemberRequestParams, observe?: 'events', reportProgress?: boolean): Observable>; /** * Delete a notification * Delete a notification. User must have APPLICATION_NOTIFICATION[DELETE] permission to delete a **generic** notification. * @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. */ deleteApplicationNotificationByNotificationId(requestParameters: DeleteApplicationNotificationByNotificationIdRequestParams, observe?: 'body', reportProgress?: boolean): Observable; deleteApplicationNotificationByNotificationId(requestParameters: DeleteApplicationNotificationByNotificationIdRequestParams, observe?: 'response', reportProgress?: boolean): Observable>; deleteApplicationNotificationByNotificationId(requestParameters: DeleteApplicationNotificationByNotificationIdRequestParams, observe?: 'events', reportProgress?: boolean): Observable>; /** * Export application logs as CSV * Export application logs as CSV. User must have the APPLICATION_LOG[READ] permission. * @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. */ exportApplicationLogsByApplicationId(requestParameters: ExportApplicationLogsByApplicationIdRequestParams, observe?: 'body', reportProgress?: boolean): Observable; exportApplicationLogsByApplicationId(requestParameters: ExportApplicationLogsByApplicationIdRequestParams, observe?: 'response', reportProgress?: boolean): Observable>; exportApplicationLogsByApplicationId(requestParameters: ExportApplicationLogsByApplicationIdRequestParams, observe?: 'events', reportProgress?: boolean): Observable>; /** * Get Application analytics * Get the application analytics. User must have the APPLICATION_ANALYTICS[READ] permission. * @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. */ getApplicationAnalytics(requestParameters: GetApplicationAnalyticsRequestParams, observe?: 'body', reportProgress?: boolean): Observable; getApplicationAnalytics(requestParameters: GetApplicationAnalyticsRequestParams, observe?: 'response', reportProgress?: boolean): Observable>; getApplicationAnalytics(requestParameters: GetApplicationAnalyticsRequestParams, observe?: 'events', reportProgress?: boolean): Observable>; /** * Get an application. * Get an application. User must have the APPLICATION_DEFINITION[READ] permission. * @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. */ getApplicationByApplicationId(requestParameters: GetApplicationByApplicationIdRequestParams, observe?: 'body', reportProgress?: boolean): Observable; getApplicationByApplicationId(requestParameters: GetApplicationByApplicationIdRequestParams, observe?: 'response', reportProgress?: boolean): Observable>; getApplicationByApplicationId(requestParameters: GetApplicationByApplicationIdRequestParams, observe?: 'events', reportProgress?: boolean): Observable>; /** * Get a specific log of an application * Get a specific log of an application. User must have the APPLICATION_LOG[READ] permission. * @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. */ getApplicationLogByApplicationIdAndLogId(requestParameters: GetApplicationLogByApplicationIdAndLogIdRequestParams, observe?: 'body', reportProgress?: boolean): Observable; getApplicationLogByApplicationIdAndLogId(requestParameters: GetApplicationLogByApplicationIdAndLogIdRequestParams, observe?: 'response', reportProgress?: boolean): Observable>; getApplicationLogByApplicationIdAndLogId(requestParameters: GetApplicationLogByApplicationIdAndLogIdRequestParams, observe?: 'events', reportProgress?: boolean): Observable>; /** * Get Application logs * Get the application logs. User must have the APPLICATION_LOG[READ] permission. * @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. */ getApplicationLogs(requestParameters: GetApplicationLogsRequestParams, observe?: 'body', reportProgress?: boolean): Observable; getApplicationLogs(requestParameters: GetApplicationLogsRequestParams, observe?: 'response', reportProgress?: boolean): Observable>; getApplicationLogs(requestParameters: GetApplicationLogsRequestParams, observe?: 'events', reportProgress?: boolean): Observable>; /** * Get an application member * Get an application member. User must have the APPLICATION_MEMBER[READ] permission. * @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. */ getApplicationMemberByApplicationIdAndMemberId(requestParameters: GetApplicationMemberByApplicationIdAndMemberIdRequestParams, observe?: 'body', reportProgress?: boolean): Observable; getApplicationMemberByApplicationIdAndMemberId(requestParameters: GetApplicationMemberByApplicationIdAndMemberIdRequestParams, observe?: 'response', reportProgress?: boolean): Observable>; getApplicationMemberByApplicationIdAndMemberId(requestParameters: GetApplicationMemberByApplicationIdAndMemberIdRequestParams, observe?: 'events', reportProgress?: boolean): Observable>; /** * Get the application\'s picture * Get the application\'s picture. User must have APPLICATION_DEFINITION[READ] permission. * @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. */ getApplicationPictureByApplicationId(requestParameters: GetApplicationPictureByApplicationIdRequestParams, observe?: 'body', reportProgress?: boolean): Observable; getApplicationPictureByApplicationId(requestParameters: GetApplicationPictureByApplicationIdRequestParams, observe?: 'response', reportProgress?: boolean): Observable>; getApplicationPictureByApplicationId(requestParameters: GetApplicationPictureByApplicationIdRequestParams, observe?: 'events', reportProgress?: boolean): Observable>; /** * List all the applications accessible to authenticated user. * List all the applications accessible to authenticated user. User must have MANAGEMENT_APPLICATION[READ] and PORTAL_APPLICATION[READ] permission. * @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. */ getApplications(requestParameters: GetApplicationsRequestParams, observe?: 'body', reportProgress?: boolean): Observable; getApplications(requestParameters: GetApplicationsRequestParams, observe?: 'response', reportProgress?: boolean): Observable>; getApplications(requestParameters: GetApplicationsRequestParams, observe?: 'events', reportProgress?: boolean): Observable>; /** * List application members * List application members. User must have the APPLICATION_MEMBER[READ] permission. * @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. */ getMembersByApplicationId(requestParameters: GetMembersByApplicationIdRequestParams, observe?: 'body', reportProgress?: boolean): Observable; getMembersByApplicationId(requestParameters: GetMembersByApplicationIdRequestParams, observe?: 'response', reportProgress?: boolean): Observable>; getMembersByApplicationId(requestParameters: GetMembersByApplicationIdRequestParams, observe?: 'events', reportProgress?: boolean): Observable>; /** * Get application notifications settings * Get application notifications settings. User must **at least** have APPLICATION_NOTIFICATION[READ] permission to get **portal** notification settings. User must **also** have APPLICATION_NOTIFICATION[CREATE | UPDATE | DELETE] permission to get **generic** notification settings. * @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. */ getNotificationsByApplicationId(requestParameters: GetNotificationsByApplicationIdRequestParams, observe?: 'body', reportProgress?: boolean): Observable; getNotificationsByApplicationId(requestParameters: GetNotificationsByApplicationIdRequestParams, observe?: 'response', reportProgress?: boolean): Observable>; getNotificationsByApplicationId(requestParameters: GetNotificationsByApplicationIdRequestParams, observe?: 'events', reportProgress?: boolean): Observable>; /** * Renew the client secret for an OAuth2 application * Renew the client secret for an OAuth2 application. User must have the APPLICATION_DEFINITION[UPDATE] permission. * @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. */ renewApplicationSecret(requestParameters: RenewApplicationSecretRequestParams, observe?: 'body', reportProgress?: boolean): Observable; renewApplicationSecret(requestParameters: RenewApplicationSecretRequestParams, observe?: 'response', reportProgress?: boolean): Observable>; renewApplicationSecret(requestParameters: RenewApplicationSecretRequestParams, observe?: 'events', reportProgress?: boolean): Observable>; /** * Transfer the ownership of the application * Transfer the ownership of the application. User must have the APPLICATION_MEMBER[UPDATE] permission. * @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. */ transferMemberOwnership(requestParameters: TransferMemberOwnershipRequestParams, observe?: 'body', reportProgress?: boolean): Observable; transferMemberOwnership(requestParameters: TransferMemberOwnershipRequestParams, observe?: 'response', reportProgress?: boolean): Observable>; transferMemberOwnership(requestParameters: TransferMemberOwnershipRequestParams, observe?: 'events', reportProgress?: boolean): Observable>; /** * Update an application. * Update an application. User must have APPLICATION_DEFINITION[UPDATE] permission. * @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. */ updateApplicationByApplicationId(requestParameters: UpdateApplicationByApplicationIdRequestParams, observe?: 'body', reportProgress?: boolean): Observable; updateApplicationByApplicationId(requestParameters: UpdateApplicationByApplicationIdRequestParams, observe?: 'response', reportProgress?: boolean): Observable>; updateApplicationByApplicationId(requestParameters: UpdateApplicationByApplicationIdRequestParams, observe?: 'events', reportProgress?: boolean): Observable>; /** * Update an application member. * Update an application member. User must have the APPLICATION_MEMBER[UPDATE] permission. * @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. */ updateApplicationMemberByApplicationIdAndMemberId(requestParameters: UpdateApplicationMemberByApplicationIdAndMemberIdRequestParams, observe?: 'body', reportProgress?: boolean): Observable; updateApplicationMemberByApplicationIdAndMemberId(requestParameters: UpdateApplicationMemberByApplicationIdAndMemberIdRequestParams, observe?: 'response', reportProgress?: boolean): Observable>; updateApplicationMemberByApplicationIdAndMemberId(requestParameters: UpdateApplicationMemberByApplicationIdAndMemberIdRequestParams, observe?: 'events', reportProgress?: boolean): Observable>; /** * Update a generic notification for an application. * Update a generic notification for an application. User must have APPLICATION_NOTIFICATION[UPDATE] permission to update a **generic** notification. * @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. */ updateGenericApplicationNotification(requestParameters: UpdateGenericApplicationNotificationRequestParams, observe?: 'body', reportProgress?: boolean): Observable; updateGenericApplicationNotification(requestParameters: UpdateGenericApplicationNotificationRequestParams, observe?: 'response', reportProgress?: boolean): Observable>; updateGenericApplicationNotification(requestParameters: UpdateGenericApplicationNotificationRequestParams, observe?: 'events', reportProgress?: boolean): Observable>; /** * Update a portal notification for an application. * Update a portal notification for an application. User must have APPLICATION_NOTIFICATION[READ] permission to update a **portal** notification. * @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. */ updatePortalApplicationNotification(requestParameters: UpdatePortalApplicationNotificationRequestParams, observe?: 'body', reportProgress?: boolean): Observable; updatePortalApplicationNotification(requestParameters: UpdatePortalApplicationNotificationRequestParams, observe?: 'response', reportProgress?: boolean): Observable>; updatePortalApplicationNotification(requestParameters: UpdatePortalApplicationNotificationRequestParams, observe?: 'events', reportProgress?: boolean): Observable>; }