@halo-dev/api-client 2.16.0 → 2.18.0

package/dist/src/api/user-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, User, UserList } from '../models';
+
+/**
+ * UserV1alpha1Api - axios parameter creator
+ * @export
+ */
+export declare const UserV1alpha1ApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Create User
+     * @param {User} [user] Fresh user
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createUser: (user?: User, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Delete User
+     * @param {string} name Name of user
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteUser: (name: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get User
+     * @param {string} name Name of user
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUser: (name: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List User
+     * @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}
+     */
+    listUser: (page?: number, size?: number, labelSelector?: Array<string>, fieldSelector?: Array<string>, sort?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Patch User
+     * @param {string} name Name of user
+     * @param {Array<JsonPatchInner>} [jsonPatchInner]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchUser: (name: string, jsonPatchInner?: Array<JsonPatchInner>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update User
+     * @param {string} name Name of user
+     * @param {User} [user] Updated user
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateUser: (name: string, user?: User, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * UserV1alpha1Api - functional programming interface
+ * @export
+ */
+export declare const UserV1alpha1ApiFp: (configuration?: Configuration) => {
+    /**
+     * Create User
+     * @param {User} [user] Fresh user
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createUser(user?: User, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User>>;
+    /**
+     * Delete User
+     * @param {string} name Name of user
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteUser(name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Get User
+     * @param {string} name Name of user
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUser(name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User>>;
+    /**
+     * List User
+     * @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}
+     */
+    listUser(page?: number, size?: number, labelSelector?: Array<string>, fieldSelector?: Array<string>, sort?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserList>>;
+    /**
+     * Patch User
+     * @param {string} name Name of user
+     * @param {Array<JsonPatchInner>} [jsonPatchInner]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchUser(name: string, jsonPatchInner?: Array<JsonPatchInner>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User>>;
+    /**
+     * Update User
+     * @param {string} name Name of user
+     * @param {User} [user] Updated user
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateUser(name: string, user?: User, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User>>;
+};
+/**
+ * UserV1alpha1Api - factory interface
+ * @export
+ */
+export declare const UserV1alpha1ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Create User
+     * @param {UserV1alpha1ApiCreateUserRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createUser(requestParameters?: UserV1alpha1ApiCreateUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<User>;
+    /**
+     * Delete User
+     * @param {UserV1alpha1ApiDeleteUserRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteUser(requestParameters: UserV1alpha1ApiDeleteUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Get User
+     * @param {UserV1alpha1ApiGetUserRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUser(requestParameters: UserV1alpha1ApiGetUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<User>;
+    /**
+     * List User
+     * @param {UserV1alpha1ApiListUserRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listUser(requestParameters?: UserV1alpha1ApiListUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<UserList>;
+    /**
+     * Patch User
+     * @param {UserV1alpha1ApiPatchUserRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchUser(requestParameters: UserV1alpha1ApiPatchUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<User>;
+    /**
+     * Update User
+     * @param {UserV1alpha1ApiUpdateUserRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateUser(requestParameters: UserV1alpha1ApiUpdateUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<User>;
+};
+/**
+ * Request parameters for createUser operation in UserV1alpha1Api.
+ * @export
+ * @interface UserV1alpha1ApiCreateUserRequest
+ */
+export interface UserV1alpha1ApiCreateUserRequest {
+    /**
+     * Fresh user
+     * @type {User}
+     * @memberof UserV1alpha1ApiCreateUser
+     */
+    readonly user?: User;
+}
+/**
+ * Request parameters for deleteUser operation in UserV1alpha1Api.
+ * @export
+ * @interface UserV1alpha1ApiDeleteUserRequest
+ */
+export interface UserV1alpha1ApiDeleteUserRequest {
+    /**
+     * Name of user
+     * @type {string}
+     * @memberof UserV1alpha1ApiDeleteUser
+     */
+    readonly name: string;
+}
+/**
+ * Request parameters for getUser operation in UserV1alpha1Api.
+ * @export
+ * @interface UserV1alpha1ApiGetUserRequest
+ */
+export interface UserV1alpha1ApiGetUserRequest {
+    /**
+     * Name of user
+     * @type {string}
+     * @memberof UserV1alpha1ApiGetUser
+     */
+    readonly name: string;
+}
+/**
+ * Request parameters for listUser operation in UserV1alpha1Api.
+ * @export
+ * @interface UserV1alpha1ApiListUserRequest
+ */
+export interface UserV1alpha1ApiListUserRequest {
+    /**
+     * Page number. Default is 0.
+     * @type {number}
+     * @memberof UserV1alpha1ApiListUser
+     */
+    readonly page?: number;
+    /**
+     * Size number. Default is 0.
+     * @type {number}
+     * @memberof UserV1alpha1ApiListUser
+     */
+    readonly size?: number;
+    /**
+     * Label selector. e.g.: hidden!&#x3D;true
+     * @type {Array<string>}
+     * @memberof UserV1alpha1ApiListUser
+     */
+    readonly labelSelector?: Array<string>;
+    /**
+     * Field selector. e.g.: metadata.name&#x3D;&#x3D;halo
+     * @type {Array<string>}
+     * @memberof UserV1alpha1ApiListUser
+     */
+    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 UserV1alpha1ApiListUser
+     */
+    readonly sort?: Array<string>;
+}
+/**
+ * Request parameters for patchUser operation in UserV1alpha1Api.
+ * @export
+ * @interface UserV1alpha1ApiPatchUserRequest
+ */
+export interface UserV1alpha1ApiPatchUserRequest {
+    /**
+     * Name of user
+     * @type {string}
+     * @memberof UserV1alpha1ApiPatchUser
+     */
+    readonly name: string;
+    /**
+     *
+     * @type {Array<JsonPatchInner>}
+     * @memberof UserV1alpha1ApiPatchUser
+     */
+    readonly jsonPatchInner?: Array<JsonPatchInner>;
+}
+/**
+ * Request parameters for updateUser operation in UserV1alpha1Api.
+ * @export
+ * @interface UserV1alpha1ApiUpdateUserRequest
+ */
+export interface UserV1alpha1ApiUpdateUserRequest {
+    /**
+     * Name of user
+     * @type {string}
+     * @memberof UserV1alpha1ApiUpdateUser
+     */
+    readonly name: string;
+    /**
+     * Updated user
+     * @type {User}
+     * @memberof UserV1alpha1ApiUpdateUser
+     */
+    readonly user?: User;
+}
+/**
+ * UserV1alpha1Api - object-oriented interface
+ * @export
+ * @class UserV1alpha1Api
+ * @extends {BaseAPI}
+ */
+export declare class UserV1alpha1Api extends BaseAPI {
+    /**
+     * Create User
+     * @param {UserV1alpha1ApiCreateUserRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UserV1alpha1Api
+     */
+    createUser(requestParameters?: UserV1alpha1ApiCreateUserRequest, options?: RawAxiosRequestConfig): Promise<import('axios').AxiosResponse<User, any>>;
+    /**
+     * Delete User
+     * @param {UserV1alpha1ApiDeleteUserRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UserV1alpha1Api
+     */
+    deleteUser(requestParameters: UserV1alpha1ApiDeleteUserRequest, options?: RawAxiosRequestConfig): Promise<import('axios').AxiosResponse<void, any>>;
+    /**
+     * Get User
+     * @param {UserV1alpha1ApiGetUserRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UserV1alpha1Api
+     */
+    getUser(requestParameters: UserV1alpha1ApiGetUserRequest, options?: RawAxiosRequestConfig): Promise<import('axios').AxiosResponse<User, any>>;
+    /**
+     * List User
+     * @param {UserV1alpha1ApiListUserRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UserV1alpha1Api
+     */
+    listUser(requestParameters?: UserV1alpha1ApiListUserRequest, options?: RawAxiosRequestConfig): Promise<import('axios').AxiosResponse<UserList, any>>;
+    /**
+     * Patch User
+     * @param {UserV1alpha1ApiPatchUserRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UserV1alpha1Api
+     */
+    patchUser(requestParameters: UserV1alpha1ApiPatchUserRequest, options?: RawAxiosRequestConfig): Promise<import('axios').AxiosResponse<User, any>>;
+    /**
+     * Update User
+     * @param {UserV1alpha1ApiUpdateUserRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UserV1alpha1Api
+     */
+    updateUser(requestParameters: UserV1alpha1ApiUpdateUserRequest, options?: RawAxiosRequestConfig): Promise<import('axios').AxiosResponse<User, any>>;
+}