import Base, { MaybeRaw } from "../../../../../Base"; import { PaginatedResponse, SearchParams } from "../../../../../interfaces/global"; import { OAuthApp, OAuthAppCreate } from "../../../../../interfaces/idp/organization/settings/oauthApp"; export declare class IdpOAuthApp extends Base { /** * Retrieves all OAuth apps of the specified Organization matching the provided search filter(s). Will return all OAuth apps if no search filter is provided. * @param orgName Name of the Organization * @param filters (optional) Array of search filters * @param sorting (optional) Sorting object * @param limit (optional) Max number of results (1-100; defaults to 25) * @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0) * @returns Object containing an array of OAuth apps and the total number of results found in the database (independent of limit and page) */ searchOauthAppsOfOrganization({ organizationName, filters, sorting, limit, page }: SearchParams & { organizationName: string; }, raw?: { raw: R; }): Promise>>; /** * Retrieves an OAuthApp by its ID. * @param orgName Name of the Organization * @param oauthAppId ID of the OAuthApp * @returns the requested OAuthApp */ getOAuthApp(orgName: string, oauthAppId: string, raw?: { raw: R; }): Promise>; /** * Creates a new OAuth app in the specified Organization. * @param orgName Name of the Organization * @param oAuthAppCreate Object containing the app's name, secretName, callback and optionally a base64 encoded avatar and a description * @returns The created OAuth app */ createOAuthApp(orgName: string, oAuthAppCreate: OAuthAppCreate, raw?: { raw: R; }): Promise>; /** * Updates an existing OAuth app. * @param orgName Name of the Organization * @param oauthAppId ID of the OAuth app to be updated * @param oAuthAppCreate Object containing the app's name, secretName, callback and optionally a base64 encoded avatar and a description * @returns the updated OAuth app */ updateOAuthApp(orgName: string, oauthAppId: string, oAuthAppCreate: OAuthAppCreate, raw?: { raw: R; }): Promise>; /** * Deletes an OAuthApp by its ID. * @param orgName Name of the Organization * @param oauthAppId ID of the OAuthApp */ deleteOAuthApp(orgName: string, oauthAppId: string, raw?: { raw: R; }): Promise>; /** * Creates a new secret for an existing OAuthApp. * @param orgName Name of the Organization * @param oauthAppId ID of the OAuthApp * @param secretName Name of the Secret * @returns the updated OAuth app */ createOAuthAppSecret(orgName: string, oauthAppId: string, secretName: string, raw?: { raw: R; }): Promise>; /** * Deletes the specified OAuthApp secret. * @param orgName Name of the Organization * @param oauthAppId ID of the OAuthApp * @param secret Name of the secret that shall be deleted * @returns the updated OAuthApp */ deleteOAuthAppSecret(orgName: string, oauthAppId: string, secret: string, raw?: { raw: R; }): Promise>; /** * Updates the avatar of the specified OAuth App * @param orgName Name of the organization * @param oauthAppId ID of the OAuthApp * @param file Image as Javascript File * @returns OAuth App details with updated avatar */ updateAvatar(orgName: string, oauthAppId: string, file: File, raw?: { raw: R; }): Promise>; protected getEndpoint(endpoint: string): string; }