@halo-dev/api-client 2.15.0 → 2.17.0

package/dist/src/api/plugin-v1alpha1-api.d.ts

@@ -0,0 +1,331 @@
+import { Configuration } from '../configuration';
+import { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { RequestArgs, BaseAPI } from '../base';
+import { JsonPatchInner, Plugin, PluginList } from '../models';
+
+/**
+ * PluginV1alpha1Api - axios parameter creator
+ * @export
+ */
+export declare const PluginV1alpha1ApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Create Plugin
+     * @param {Plugin} [plugin] Fresh plugin
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPlugin: (plugin?: Plugin, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Delete Plugin
+     * @param {string} name Name of plugin
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deletePlugin: (name: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get Plugin
+     * @param {string} name Name of plugin
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPlugin: (name: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List Plugin
+     * @param {number} [page] Page number. Default is 0.
+     * @param {number} [size] Size number. Default is 0.
+     * @param {Array<string>} [labelSelector] Label selector. e.g.: hidden!&#x3D;true
+     * @param {Array<string>} [fieldSelector] Field selector. e.g.: metadata.name&#x3D;&#x3D;halo
+     * @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPlugin: (page?: number, size?: number, labelSelector?: Array<string>, fieldSelector?: Array<string>, sort?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Patch Plugin
+     * @param {string} name Name of plugin
+     * @param {Array<JsonPatchInner>} [jsonPatchInner]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchPlugin: (name: string, jsonPatchInner?: Array<JsonPatchInner>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update Plugin
+     * @param {string} name Name of plugin
+     * @param {Plugin} [plugin] Updated plugin
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePlugin: (name: string, plugin?: Plugin, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * PluginV1alpha1Api - functional programming interface
+ * @export
+ */
+export declare const PluginV1alpha1ApiFp: (configuration?: Configuration) => {
+    /**
+     * Create Plugin
+     * @param {Plugin} [plugin] Fresh plugin
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPlugin(plugin?: Plugin, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Plugin>>;
+    /**
+     * Delete Plugin
+     * @param {string} name Name of plugin
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deletePlugin(name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Get Plugin
+     * @param {string} name Name of plugin
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPlugin(name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Plugin>>;
+    /**
+     * List Plugin
+     * @param {number} [page] Page number. Default is 0.
+     * @param {number} [size] Size number. Default is 0.
+     * @param {Array<string>} [labelSelector] Label selector. e.g.: hidden!&#x3D;true
+     * @param {Array<string>} [fieldSelector] Field selector. e.g.: metadata.name&#x3D;&#x3D;halo
+     * @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPlugin(page?: number, size?: number, labelSelector?: Array<string>, fieldSelector?: Array<string>, sort?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PluginList>>;
+    /**
+     * Patch Plugin
+     * @param {string} name Name of plugin
+     * @param {Array<JsonPatchInner>} [jsonPatchInner]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchPlugin(name: string, jsonPatchInner?: Array<JsonPatchInner>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Plugin>>;
+    /**
+     * Update Plugin
+     * @param {string} name Name of plugin
+     * @param {Plugin} [plugin] Updated plugin
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePlugin(name: string, plugin?: Plugin, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Plugin>>;
+};
+/**
+ * PluginV1alpha1Api - factory interface
+ * @export
+ */
+export declare const PluginV1alpha1ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Create Plugin
+     * @param {PluginV1alpha1ApiCreatePluginRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPlugin(requestParameters?: PluginV1alpha1ApiCreatePluginRequest, options?: RawAxiosRequestConfig): AxiosPromise<Plugin>;
+    /**
+     * Delete Plugin
+     * @param {PluginV1alpha1ApiDeletePluginRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deletePlugin(requestParameters: PluginV1alpha1ApiDeletePluginRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Get Plugin
+     * @param {PluginV1alpha1ApiGetPluginRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPlugin(requestParameters: PluginV1alpha1ApiGetPluginRequest, options?: RawAxiosRequestConfig): AxiosPromise<Plugin>;
+    /**
+     * List Plugin
+     * @param {PluginV1alpha1ApiListPluginRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPlugin(requestParameters?: PluginV1alpha1ApiListPluginRequest, options?: RawAxiosRequestConfig): AxiosPromise<PluginList>;
+    /**
+     * Patch Plugin
+     * @param {PluginV1alpha1ApiPatchPluginRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchPlugin(requestParameters: PluginV1alpha1ApiPatchPluginRequest, options?: RawAxiosRequestConfig): AxiosPromise<Plugin>;
+    /**
+     * Update Plugin
+     * @param {PluginV1alpha1ApiUpdatePluginRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePlugin(requestParameters: PluginV1alpha1ApiUpdatePluginRequest, options?: RawAxiosRequestConfig): AxiosPromise<Plugin>;
+};
+/**
+ * Request parameters for createPlugin operation in PluginV1alpha1Api.
+ * @export
+ * @interface PluginV1alpha1ApiCreatePluginRequest
+ */
+export interface PluginV1alpha1ApiCreatePluginRequest {
+    /**
+     * Fresh plugin
+     * @type {Plugin}
+     * @memberof PluginV1alpha1ApiCreatePlugin
+     */
+    readonly plugin?: Plugin;
+}
+/**
+ * Request parameters for deletePlugin operation in PluginV1alpha1Api.
+ * @export
+ * @interface PluginV1alpha1ApiDeletePluginRequest
+ */
+export interface PluginV1alpha1ApiDeletePluginRequest {
+    /**
+     * Name of plugin
+     * @type {string}
+     * @memberof PluginV1alpha1ApiDeletePlugin
+     */
+    readonly name: string;
+}
+/**
+ * Request parameters for getPlugin operation in PluginV1alpha1Api.
+ * @export
+ * @interface PluginV1alpha1ApiGetPluginRequest
+ */
+export interface PluginV1alpha1ApiGetPluginRequest {
+    /**
+     * Name of plugin
+     * @type {string}
+     * @memberof PluginV1alpha1ApiGetPlugin
+     */
+    readonly name: string;
+}
+/**
+ * Request parameters for listPlugin operation in PluginV1alpha1Api.
+ * @export
+ * @interface PluginV1alpha1ApiListPluginRequest
+ */
+export interface PluginV1alpha1ApiListPluginRequest {
+    /**
+     * Page number. Default is 0.
+     * @type {number}
+     * @memberof PluginV1alpha1ApiListPlugin
+     */
+    readonly page?: number;
+    /**
+     * Size number. Default is 0.
+     * @type {number}
+     * @memberof PluginV1alpha1ApiListPlugin
+     */
+    readonly size?: number;
+    /**
+     * Label selector. e.g.: hidden!&#x3D;true
+     * @type {Array<string>}
+     * @memberof PluginV1alpha1ApiListPlugin
+     */
+    readonly labelSelector?: Array<string>;
+    /**
+     * Field selector. e.g.: metadata.name&#x3D;&#x3D;halo
+     * @type {Array<string>}
+     * @memberof PluginV1alpha1ApiListPlugin
+     */
+    readonly fieldSelector?: Array<string>;
+    /**
+     * Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
+     * @type {Array<string>}
+     * @memberof PluginV1alpha1ApiListPlugin
+     */
+    readonly sort?: Array<string>;
+}
+/**
+ * Request parameters for patchPlugin operation in PluginV1alpha1Api.
+ * @export
+ * @interface PluginV1alpha1ApiPatchPluginRequest
+ */
+export interface PluginV1alpha1ApiPatchPluginRequest {
+    /**
+     * Name of plugin
+     * @type {string}
+     * @memberof PluginV1alpha1ApiPatchPlugin
+     */
+    readonly name: string;
+    /**
+     *
+     * @type {Array<JsonPatchInner>}
+     * @memberof PluginV1alpha1ApiPatchPlugin
+     */
+    readonly jsonPatchInner?: Array<JsonPatchInner>;
+}
+/**
+ * Request parameters for updatePlugin operation in PluginV1alpha1Api.
+ * @export
+ * @interface PluginV1alpha1ApiUpdatePluginRequest
+ */
+export interface PluginV1alpha1ApiUpdatePluginRequest {
+    /**
+     * Name of plugin
+     * @type {string}
+     * @memberof PluginV1alpha1ApiUpdatePlugin
+     */
+    readonly name: string;
+    /**
+     * Updated plugin
+     * @type {Plugin}
+     * @memberof PluginV1alpha1ApiUpdatePlugin
+     */
+    readonly plugin?: Plugin;
+}
+/**
+ * PluginV1alpha1Api - object-oriented interface
+ * @export
+ * @class PluginV1alpha1Api
+ * @extends {BaseAPI}
+ */
+export declare class PluginV1alpha1Api extends BaseAPI {
+    /**
+     * Create Plugin
+     * @param {PluginV1alpha1ApiCreatePluginRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PluginV1alpha1Api
+     */
+    createPlugin(requestParameters?: PluginV1alpha1ApiCreatePluginRequest, options?: RawAxiosRequestConfig): Promise<import('axios').AxiosResponse<Plugin, any>>;
+    /**
+     * Delete Plugin
+     * @param {PluginV1alpha1ApiDeletePluginRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PluginV1alpha1Api
+     */
+    deletePlugin(requestParameters: PluginV1alpha1ApiDeletePluginRequest, options?: RawAxiosRequestConfig): Promise<import('axios').AxiosResponse<void, any>>;
+    /**
+     * Get Plugin
+     * @param {PluginV1alpha1ApiGetPluginRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PluginV1alpha1Api
+     */
+    getPlugin(requestParameters: PluginV1alpha1ApiGetPluginRequest, options?: RawAxiosRequestConfig): Promise<import('axios').AxiosResponse<Plugin, any>>;
+    /**
+     * List Plugin
+     * @param {PluginV1alpha1ApiListPluginRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PluginV1alpha1Api
+     */
+    listPlugin(requestParameters?: PluginV1alpha1ApiListPluginRequest, options?: RawAxiosRequestConfig): Promise<import('axios').AxiosResponse<PluginList, any>>;
+    /**
+     * Patch Plugin
+     * @param {PluginV1alpha1ApiPatchPluginRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PluginV1alpha1Api
+     */
+    patchPlugin(requestParameters: PluginV1alpha1ApiPatchPluginRequest, options?: RawAxiosRequestConfig): Promise<import('axios').AxiosResponse<Plugin, any>>;
+    /**
+     * Update Plugin
+     * @param {PluginV1alpha1ApiUpdatePluginRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PluginV1alpha1Api
+     */
+    updatePlugin(requestParameters: PluginV1alpha1ApiUpdatePluginRequest, options?: RawAxiosRequestConfig): Promise<import('axios').AxiosResponse<Plugin, any>>;
+}