@redhat-cloud-services/notifications-client 2.2.3 → 2.3.0

package/utils/base.d.ts

@@ -1,85 +0,0 @@
-import type { Configuration } from './configuration';
-import type { AxiosResponse, AxiosInstance, AxiosRequestConfig } from 'axios';
-export declare const BASE_PATH: string;
-/**
- *
- * @export
- */
-export declare const COLLECTION_FORMATS: {
-    csv: string;
-    ssv: string;
-    tsv: string;
-    pipes: string;
-};
-/**
- *
- * @export
- * @interface RequestArgs
- */
-export interface RequestArgs {
-    urlObj: URL;
-    options: AxiosRequestConfig;
-    auth?: {
-        authType: AuthTypeEnum;
-        authKey?: string | [string, string[]];
-    }[];
-    serializeData?: unknown;
-}
-export interface ApiConfig {
-    axios: AxiosInstance;
-    configuration?: Configuration;
-}
-export declare const AuthTypeEnum: {
-    readonly Basic: "basic";
-    readonly Bearer: "bearer";
-    readonly Oauth: "oath";
-    readonly InHeader: "inHeader";
-    readonly InQuery: "inQuery";
-};
-export declare type AuthTypeEnum = typeof AuthTypeEnum[keyof typeof AuthTypeEnum];
-export declare type ActionType = (...config: any) => Promise<RequestArgs>;
-/**
- * Base API to store config, basepath and axios instance.
- * @export
- * @class BaseAPI
- */
-export declare class BaseAPI {
-    protected basePath: string;
-    protected configuration: Configuration | undefined;
-    protected axios: AxiosInstance;
-    /**
-     * Constructor to create baseAPI.
-     * @param { string } basePath basePath of api requests.
-     * @param { { axios: AxiosInstance, configuration: Configuration } } config to be passed down to axios.
-     */
-    constructor(basePath?: string, config?: ApiConfig);
-    private authConfig;
-    /**
-    * Send axios request
-    * @param {Promise<RequestArgs>} request to be send trough axios.
-    * @param {AxiosInstance} axios optional axios instance.
-    * @returns {Promise<AxiosResponse<T>>} promisable axios response.
-    */
-    sendRequest<T>(request: Promise<RequestArgs>, axios?: AxiosInstance, basePath?: string): Promise<AxiosResponse<T>>;
-}
-/**
- *
- * Factory for creating API with option to add enpoints to the API.
- * @param basePath basePath of api requests.
- * @param { { axios: AxiosInstance, configuration: Configuration } } config to be passed down to axios.
- * @param actions object with actions to send with axios.
- * @returns created base API.
- */
-export declare const APIFactory: <T extends Record<string, ActionType>>(basePath: string | undefined, config: ApiConfig | undefined, actions: T) => BaseAPI & T;
-export default APIFactory;
-/**
- *
- * @export
- * @class RequiredError
- * @extends {Error}
- */
-export declare class RequiredError extends Error {
-    field: string;
-    constructor(field: string, msg?: string);
-}
-//# sourceMappingURL=base.d.ts.map

package/utils/common.d.ts

@@ -1,55 +0,0 @@
-import type { Configuration } from "./configuration";
-import type { RequestArgs } from "./base";
-import type { AxiosInstance, AxiosResponse } from 'axios';
-/**
- *
- * @export
- */
-export declare const DUMMY_BASE_URL = "https://example.com";
-/**
- *
- * @throws {RequiredError}
- * @export
- */
-export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
-/**
- *
- * @export
- */
-export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
-/**
- *
- * @export
- */
-export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
-/**
- *
- * @export
- */
-export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
-/**
- *
- * @export
- */
-export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
-/**
- *
- * @export
- */
-export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
-/**
- *
- * @export
- */
-export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
-/**
- *
- * @export
- */
-export declare const toPathString: (url: URL) => string;
-/**
- *
- * @export
- */
-export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T, any>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
-//# sourceMappingURL=common.d.ts.map

package/utils/configuration.d.ts

@@ -1,73 +0,0 @@
-export interface ConfigurationParameters {
-    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
-    username?: string;
-    password?: string;
-    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
-    basePath?: string;
-    baseOptions?: any;
-    formDataCtor?: new () => any;
-}
-export declare class Configuration {
-    /**
-     * parameter for apiKey security
-     * @param name security name
-     * @memberof Configuration
-     */
-    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
-    /**
-     * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
-     */
-    username?: string;
-    /**
-     * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
-     */
-    password?: string;
-    /**
-     * parameter for oauth2 security
-     * @param name security name
-     * @param scopes oauth2 scope
-     * @memberof Configuration
-     */
-    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
-    /**
-     * override base path
-     *
-     * @type {string}
-     * @memberof Configuration
-     */
-    basePath?: string;
-    /**
-     * base options for axios calls
-     *
-     * @type {any}
-     * @memberof Configuration
-     */
-    baseOptions?: any;
-    /**
-     * The FormData constructor that will be used to create multipart form data
-     * requests. You can inject this here so that execution environments that
-     * do not support the FormData class can still run the generated client.
-     *
-     * @type {new () => FormData}
-     */
-    formDataCtor?: new () => any;
-    constructor(param?: ConfigurationParameters);
-    /**
-     * Check if the given MIME is a JSON MIME.
-     * JSON MIME examples:
-     *   application/json
-     *   application/json; charset=UTF8
-     *   APPLICATION/JSON
-     *   application/vnd.company+json
-     * @param mime - MIME (Multipurpose Internet Mail Extensions)
-     * @return True if the given MIME is JSON, false otherwise.
-     */
-    isJsonMime(mime: string): boolean;
-}
-//# sourceMappingURL=configuration.d.ts.map