@herd/angular-client/dist/api/userNamespaceAuthorization.service.d.ts

Swagger generated client for @herd/angular-client

/**
 * herd
 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 *
 * OpenAPI spec version: 0.219.0-SNAPSHOT
 *
 *
 * 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 } from '@angular/common/http';
import { Observable } from 'rxjs';
import { UserNamespaceAuthorization } from '../model/userNamespaceAuthorization';
import { UserNamespaceAuthorizationCreateRequest } from '../model/userNamespaceAuthorizationCreateRequest';
import { UserNamespaceAuthorizationUpdateRequest } from '../model/userNamespaceAuthorizationUpdateRequest';
import { UserNamespaceAuthorizations } from '../model/userNamespaceAuthorizations';
import { Configuration } from '../configuration';
export declare class UserNamespaceAuthorizationService {
    protected httpClient: HttpClient;
    protected basePath: string;
    defaultHeaders: HttpHeaders;
    configuration: Configuration;
    constructor(httpClient: HttpClient, basePath: string, configuration: Configuration);
    /**
     * @param consumes string[] mime-types
     * @return true: consumes contains 'multipart/form-data', false: otherwise
     */
    private canConsumeForm;
    /**
     * createUserNamespaceAuthorization
     * <p>Creates a new user namespace authorization.</p> <p>The user ID field may be prefixed with a wildcard token character \"*\" to authorize multiple users access to the namespace. The wildcard only works for as a prefix to match the suffix of the user ID. If the wildcard appears anywhere other than the prefix, the user ID must match as-is. For example:</p> <ul> <li>john.doe@domain.com - only authorizes user with ID \"john.doe@domain.com\"</li> <li>*@domain.com - authorizes users that has the suffix \"@domain.com\"</li> <li>* - authorizes all users</li> <li>john.doe* - only authorizes user with ID \"john.doe*\"</li> </ul> <p>Requires GRANT permission on namespace</p>
     * @param userNamespaceAuthorizationCreateRequest the information needed to create the user namespace authorization
     * @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.
     */
    userNamespaceAuthorizationCreateUserNamespaceAuthorization(userNamespaceAuthorizationCreateRequest: UserNamespaceAuthorizationCreateRequest, observe?: 'body', reportProgress?: boolean): Observable<UserNamespaceAuthorization>;
    userNamespaceAuthorizationCreateUserNamespaceAuthorization(userNamespaceAuthorizationCreateRequest: UserNamespaceAuthorizationCreateRequest, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<UserNamespaceAuthorization>>;
    userNamespaceAuthorizationCreateUserNamespaceAuthorization(userNamespaceAuthorizationCreateRequest: UserNamespaceAuthorizationCreateRequest, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<UserNamespaceAuthorization>>;
    /**
     * deleteUserNamespaceAuthorization
     * Deletes an existing user namespace authorization by key. &lt;p&gt;Requires GRANT permission on namespace&lt;/p&gt;
     * @param userId the user id
     * @param namespace the namespace
     * @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.
     */
    userNamespaceAuthorizationDeleteUserNamespaceAuthorization(userId: string, namespace: string, observe?: 'body', reportProgress?: boolean): Observable<UserNamespaceAuthorization>;
    userNamespaceAuthorizationDeleteUserNamespaceAuthorization(userId: string, namespace: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<UserNamespaceAuthorization>>;
    userNamespaceAuthorizationDeleteUserNamespaceAuthorization(userId: string, namespace: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<UserNamespaceAuthorization>>;
    /**
     * deleteUserNamespaceAuthorizationsByNamespace
     * Deletes all existing user namespace authorizations for the namespace.
     * @param namespace the namespace
     * @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.
     */
    userNamespaceAuthorizationDeleteUserNamespaceAuthorizationsByNamespace(namespace: string, observe?: 'body', reportProgress?: boolean): Observable<UserNamespaceAuthorizations>;
    userNamespaceAuthorizationDeleteUserNamespaceAuthorizationsByNamespace(namespace: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<UserNamespaceAuthorizations>>;
    userNamespaceAuthorizationDeleteUserNamespaceAuthorizationsByNamespace(namespace: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<UserNamespaceAuthorizations>>;
    /**
     * deleteUserNamespaceAuthorizationsByUserId
     * Deletes all existing user namespace authorizations for the specified user.
     * @param userId the user id
     * @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.
     */
    userNamespaceAuthorizationDeleteUserNamespaceAuthorizationsByUserId(userId: string, observe?: 'body', reportProgress?: boolean): Observable<UserNamespaceAuthorizations>;
    userNamespaceAuthorizationDeleteUserNamespaceAuthorizationsByUserId(userId: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<UserNamespaceAuthorizations>>;
    userNamespaceAuthorizationDeleteUserNamespaceAuthorizationsByUserId(userId: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<UserNamespaceAuthorizations>>;
    /**
     * getUserNamespaceAuthorization
     * Gets an existing user namespace authorization by key. &lt;p&gt;Requires READ permission on namespace&lt;/p&gt;
     * @param userId the user id
     * @param namespace the namespace
     * @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.
     */
    userNamespaceAuthorizationGetUserNamespaceAuthorization(userId: string, namespace: string, observe?: 'body', reportProgress?: boolean): Observable<UserNamespaceAuthorization>;
    userNamespaceAuthorizationGetUserNamespaceAuthorization(userId: string, namespace: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<UserNamespaceAuthorization>>;
    userNamespaceAuthorizationGetUserNamespaceAuthorization(userId: string, namespace: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<UserNamespaceAuthorization>>;
    /**
     * getUserNamespaceAuthorizationsByNamespace
     * Gets a list of user namespace authorizations for the specified namespace.
     * @param namespace the namespace
     * @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.
     */
    userNamespaceAuthorizationGetUserNamespaceAuthorizationsByNamespace(namespace: string, observe?: 'body', reportProgress?: boolean): Observable<UserNamespaceAuthorizations>;
    userNamespaceAuthorizationGetUserNamespaceAuthorizationsByNamespace(namespace: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<UserNamespaceAuthorizations>>;
    userNamespaceAuthorizationGetUserNamespaceAuthorizationsByNamespace(namespace: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<UserNamespaceAuthorizations>>;
    /**
     * getUserNamespaceAuthorizationsByUserId
     * Gets a list of user namespace authorizations for the specified user.
     * @param userId the user id
     * @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.
     */
    userNamespaceAuthorizationGetUserNamespaceAuthorizationsByUserId(userId: string, observe?: 'body', reportProgress?: boolean): Observable<UserNamespaceAuthorizations>;
    userNamespaceAuthorizationGetUserNamespaceAuthorizationsByUserId(userId: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<UserNamespaceAuthorizations>>;
    userNamespaceAuthorizationGetUserNamespaceAuthorizationsByUserId(userId: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<UserNamespaceAuthorizations>>;
    /**
     * updateUserNamespaceAuthorization
     * Updates an existing user namespace authorization by key. &lt;p&gt;Requires GRANT permission on namespace&lt;/p&gt;
     * @param userId the user id
     * @param namespace the namespace
     * @param userNamespaceAuthorizationUpdateRequest the information needed to update the user namespace authorization
     * @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.
     */
    userNamespaceAuthorizationUpdateUserNamespaceAuthorization(userId: string, namespace: string, userNamespaceAuthorizationUpdateRequest: UserNamespaceAuthorizationUpdateRequest, observe?: 'body', reportProgress?: boolean): Observable<UserNamespaceAuthorization>;
    userNamespaceAuthorizationUpdateUserNamespaceAuthorization(userId: string, namespace: string, userNamespaceAuthorizationUpdateRequest: UserNamespaceAuthorizationUpdateRequest, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<UserNamespaceAuthorization>>;
    userNamespaceAuthorizationUpdateUserNamespaceAuthorization(userId: string, namespace: string, userNamespaceAuthorizationUpdateRequest: UserNamespaceAuthorizationUpdateRequest, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<UserNamespaceAuthorization>>;
}