@coscine/api-client 3.3.1 → 3.4.0

package/dist/types/Coscine.Api/@coscine/api/tree-api.d.ts

@@ -0,0 +1,404 @@
+/**
+ * Coscine Web API
+ * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project.
+ *
+ * The version of the OpenAPI document: 2.0
+ * Contact: servicedesk@itc.rwth-aachen.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from '../../configuration';
+import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { RequestArgs, BaseAPI } from '../../base';
+import { FileTreeDtoPagedResponse } from '../../@coscine/model';
+import { MetadataTreeDtoPagedResponse } from '../../@coscine/model';
+import { MetadataTreeDtoResponse } from '../../@coscine/model';
+import { MetadataTreeForCreationDto } from '../../@coscine/model';
+import { MetadataTreeForUpdateDto } from '../../@coscine/model';
+import { RdfFormat } from '../../@coscine/model';
+/**
+ * TreeApi - axios parameter creator
+ * @export
+ */
+export declare const TreeApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {string} projectId
+     * @param {string} resourceId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2ProjectsProjectIdResourcesResourceIdTreesOptions: (projectId: string, resourceId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Creates a new metadata tree for a resource.
+     * @param {string} projectId The unique identifier or slug of the project.
+     * @param {string} resourceId The unique identifier of the resource.
+     * @param {MetadataTreeForCreationDto} [metadataTreeForCreationDto] The metadata tree data for creation.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createMetadataTree: (projectId: string, resourceId: string, metadataTreeForCreationDto?: MetadataTreeForCreationDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * The `OrderBy` query is currently not supported.
+     * @summary Retrieves the file tree associated with a resource.
+     * @param {string} projectId The unique identifier or slug of the project.
+     * @param {string} resourceId The unique identifier of the resource.
+     * @param {string} [path] Gets or sets the path of the file tree.
+     * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
+     * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
+     * @param {string} [orderBy] Gets or sets the field name used for ordering the results.  The order is constructed by a order string.  Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFileTree: (projectId: string, resourceId: string, path?: string, pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Retrieves the metadata tree associated with a resource.
+     * @param {string} projectId The unique identifier or slug of the project.
+     * @param {string} resourceId The unique identifier of the resource.
+     * @param {string} [path] Gets or sets the path of the metadata tree.
+     * @param {RdfFormat} [format] Gets or sets the format of the RDF data.
+     * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
+     * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
+     * @param {string} [orderBy] Gets or sets the field name used for ordering the results.  The order is constructed by a order string.  Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMetadataTree: (projectId: string, resourceId: string, path?: string, format?: RdfFormat, pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Updates an existing metadata tree of a resource.
+     * @param {string} projectId The unique identifier or slug of the project.
+     * @param {string} resourceId The unique identifier of the resource.
+     * @param {MetadataTreeForUpdateDto} [metadataTreeForUpdateDto] The updated metadata tree data.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateMetadataTree: (projectId: string, resourceId: string, metadataTreeForUpdateDto?: MetadataTreeForUpdateDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * TreeApi - functional programming interface
+ * @export
+ */
+export declare const TreeApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {string} projectId
+     * @param {string} resourceId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2ProjectsProjectIdResourcesResourceIdTreesOptions(projectId: string, resourceId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Creates a new metadata tree for a resource.
+     * @param {string} projectId The unique identifier or slug of the project.
+     * @param {string} resourceId The unique identifier of the resource.
+     * @param {MetadataTreeForCreationDto} [metadataTreeForCreationDto] The metadata tree data for creation.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createMetadataTree(projectId: string, resourceId: string, metadataTreeForCreationDto?: MetadataTreeForCreationDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetadataTreeDtoResponse>>;
+    /**
+     * The `OrderBy` query is currently not supported.
+     * @summary Retrieves the file tree associated with a resource.
+     * @param {string} projectId The unique identifier or slug of the project.
+     * @param {string} resourceId The unique identifier of the resource.
+     * @param {string} [path] Gets or sets the path of the file tree.
+     * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
+     * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
+     * @param {string} [orderBy] Gets or sets the field name used for ordering the results.  The order is constructed by a order string.  Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFileTree(projectId: string, resourceId: string, path?: string, pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTreeDtoPagedResponse>>;
+    /**
+     *
+     * @summary Retrieves the metadata tree associated with a resource.
+     * @param {string} projectId The unique identifier or slug of the project.
+     * @param {string} resourceId The unique identifier of the resource.
+     * @param {string} [path] Gets or sets the path of the metadata tree.
+     * @param {RdfFormat} [format] Gets or sets the format of the RDF data.
+     * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
+     * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
+     * @param {string} [orderBy] Gets or sets the field name used for ordering the results.  The order is constructed by a order string.  Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMetadataTree(projectId: string, resourceId: string, path?: string, format?: RdfFormat, pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetadataTreeDtoPagedResponse>>;
+    /**
+     *
+     * @summary Updates an existing metadata tree of a resource.
+     * @param {string} projectId The unique identifier or slug of the project.
+     * @param {string} resourceId The unique identifier of the resource.
+     * @param {MetadataTreeForUpdateDto} [metadataTreeForUpdateDto] The updated metadata tree data.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateMetadataTree(projectId: string, resourceId: string, metadataTreeForUpdateDto?: MetadataTreeForUpdateDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+};
+/**
+ * TreeApi - factory interface
+ * @export
+ */
+export declare const TreeApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {TreeApiApiV2ProjectsProjectIdResourcesResourceIdTreesOptionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2ProjectsProjectIdResourcesResourceIdTreesOptions(requestParameters: TreeApiApiV2ProjectsProjectIdResourcesResourceIdTreesOptionsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Creates a new metadata tree for a resource.
+     * @param {TreeApiCreateMetadataTreeRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createMetadataTree(requestParameters: TreeApiCreateMetadataTreeRequest, options?: AxiosRequestConfig): AxiosPromise<MetadataTreeDtoResponse>;
+    /**
+     * The `OrderBy` query is currently not supported.
+     * @summary Retrieves the file tree associated with a resource.
+     * @param {TreeApiGetFileTreeRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFileTree(requestParameters: TreeApiGetFileTreeRequest, options?: AxiosRequestConfig): AxiosPromise<FileTreeDtoPagedResponse>;
+    /**
+     *
+     * @summary Retrieves the metadata tree associated with a resource.
+     * @param {TreeApiGetMetadataTreeRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMetadataTree(requestParameters: TreeApiGetMetadataTreeRequest, options?: AxiosRequestConfig): AxiosPromise<MetadataTreeDtoPagedResponse>;
+    /**
+     *
+     * @summary Updates an existing metadata tree of a resource.
+     * @param {TreeApiUpdateMetadataTreeRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateMetadataTree(requestParameters: TreeApiUpdateMetadataTreeRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
+};
+/**
+ * Request parameters for apiV2ProjectsProjectIdResourcesResourceIdTreesOptions operation in TreeApi.
+ * @export
+ * @interface TreeApiApiV2ProjectsProjectIdResourcesResourceIdTreesOptionsRequest
+ */
+export interface TreeApiApiV2ProjectsProjectIdResourcesResourceIdTreesOptionsRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof TreeApiApiV2ProjectsProjectIdResourcesResourceIdTreesOptions
+     */
+    readonly projectId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TreeApiApiV2ProjectsProjectIdResourcesResourceIdTreesOptions
+     */
+    readonly resourceId: string;
+}
+/**
+ * Request parameters for createMetadataTree operation in TreeApi.
+ * @export
+ * @interface TreeApiCreateMetadataTreeRequest
+ */
+export interface TreeApiCreateMetadataTreeRequest {
+    /**
+     * The unique identifier or slug of the project.
+     * @type {string}
+     * @memberof TreeApiCreateMetadataTree
+     */
+    readonly projectId: string;
+    /**
+     * The unique identifier of the resource.
+     * @type {string}
+     * @memberof TreeApiCreateMetadataTree
+     */
+    readonly resourceId: string;
+    /**
+     * The metadata tree data for creation.
+     * @type {MetadataTreeForCreationDto}
+     * @memberof TreeApiCreateMetadataTree
+     */
+    readonly metadataTreeForCreationDto?: MetadataTreeForCreationDto;
+}
+/**
+ * Request parameters for getFileTree operation in TreeApi.
+ * @export
+ * @interface TreeApiGetFileTreeRequest
+ */
+export interface TreeApiGetFileTreeRequest {
+    /**
+     * The unique identifier or slug of the project.
+     * @type {string}
+     * @memberof TreeApiGetFileTree
+     */
+    readonly projectId: string;
+    /**
+     * The unique identifier of the resource.
+     * @type {string}
+     * @memberof TreeApiGetFileTree
+     */
+    readonly resourceId: string;
+    /**
+     * Gets or sets the path of the file tree.
+     * @type {string}
+     * @memberof TreeApiGetFileTree
+     */
+    readonly path?: string;
+    /**
+     * The desired page number. Should be greater than or equal to 1. Default is 1.
+     * @type {number}
+     * @memberof TreeApiGetFileTree
+     */
+    readonly pageNumber?: number;
+    /**
+     * The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
+     * @type {number}
+     * @memberof TreeApiGetFileTree
+     */
+    readonly pageSize?: number;
+    /**
+     * Gets or sets the field name used for ordering the results.  The order is constructed by a order string.  Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.
+     * @type {string}
+     * @memberof TreeApiGetFileTree
+     */
+    readonly orderBy?: string;
+}
+/**
+ * Request parameters for getMetadataTree operation in TreeApi.
+ * @export
+ * @interface TreeApiGetMetadataTreeRequest
+ */
+export interface TreeApiGetMetadataTreeRequest {
+    /**
+     * The unique identifier or slug of the project.
+     * @type {string}
+     * @memberof TreeApiGetMetadataTree
+     */
+    readonly projectId: string;
+    /**
+     * The unique identifier of the resource.
+     * @type {string}
+     * @memberof TreeApiGetMetadataTree
+     */
+    readonly resourceId: string;
+    /**
+     * Gets or sets the path of the metadata tree.
+     * @type {string}
+     * @memberof TreeApiGetMetadataTree
+     */
+    readonly path?: string;
+    /**
+     * Gets or sets the format of the RDF data.
+     * @type {RdfFormat}
+     * @memberof TreeApiGetMetadataTree
+     */
+    readonly format?: RdfFormat;
+    /**
+     * The desired page number. Should be greater than or equal to 1. Default is 1.
+     * @type {number}
+     * @memberof TreeApiGetMetadataTree
+     */
+    readonly pageNumber?: number;
+    /**
+     * The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
+     * @type {number}
+     * @memberof TreeApiGetMetadataTree
+     */
+    readonly pageSize?: number;
+    /**
+     * Gets or sets the field name used for ordering the results.  The order is constructed by a order string.  Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.
+     * @type {string}
+     * @memberof TreeApiGetMetadataTree
+     */
+    readonly orderBy?: string;
+}
+/**
+ * Request parameters for updateMetadataTree operation in TreeApi.
+ * @export
+ * @interface TreeApiUpdateMetadataTreeRequest
+ */
+export interface TreeApiUpdateMetadataTreeRequest {
+    /**
+     * The unique identifier or slug of the project.
+     * @type {string}
+     * @memberof TreeApiUpdateMetadataTree
+     */
+    readonly projectId: string;
+    /**
+     * The unique identifier of the resource.
+     * @type {string}
+     * @memberof TreeApiUpdateMetadataTree
+     */
+    readonly resourceId: string;
+    /**
+     * The updated metadata tree data.
+     * @type {MetadataTreeForUpdateDto}
+     * @memberof TreeApiUpdateMetadataTree
+     */
+    readonly metadataTreeForUpdateDto?: MetadataTreeForUpdateDto;
+}
+/**
+ * TreeApi - object-oriented interface
+ * @export
+ * @class TreeApi
+ * @extends {BaseAPI}
+ */
+export declare class TreeApi extends BaseAPI {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {TreeApiApiV2ProjectsProjectIdResourcesResourceIdTreesOptionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TreeApi
+     */
+    apiV2ProjectsProjectIdResourcesResourceIdTreesOptions(requestParameters: TreeApiApiV2ProjectsProjectIdResourcesResourceIdTreesOptionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     *
+     * @summary Creates a new metadata tree for a resource.
+     * @param {TreeApiCreateMetadataTreeRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TreeApi
+     */
+    createMetadataTree(requestParameters: TreeApiCreateMetadataTreeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<MetadataTreeDtoResponse, any>>;
+    /**
+     * The `OrderBy` query is currently not supported.
+     * @summary Retrieves the file tree associated with a resource.
+     * @param {TreeApiGetFileTreeRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TreeApi
+     */
+    getFileTree(requestParameters: TreeApiGetFileTreeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTreeDtoPagedResponse, any>>;
+    /**
+     *
+     * @summary Retrieves the metadata tree associated with a resource.
+     * @param {TreeApiGetMetadataTreeRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TreeApi
+     */
+    getMetadataTree(requestParameters: TreeApiGetMetadataTreeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<MetadataTreeDtoPagedResponse, any>>;
+    /**
+     *
+     * @summary Updates an existing metadata tree of a resource.
+     * @param {TreeApiUpdateMetadataTreeRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TreeApi
+     */
+    updateMetadataTree(requestParameters: TreeApiUpdateMetadataTreeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+}

package/dist/types/Coscine.Api/@coscine/api/user-api.d.ts

@@ -0,0 +1,124 @@
+/**
+ * Coscine Web API
+ * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project.
+ *
+ * The version of the OpenAPI document: 2.0
+ * Contact: servicedesk@itc.rwth-aachen.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from '../../configuration';
+import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { RequestArgs, BaseAPI } from '../../base';
+import { PublicUserDtoIEnumerableResponse } from '../../@coscine/model';
+/**
+ * UserApi - axios parameter creator
+ * @export
+ */
+export declare const UserApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2UsersOptions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Retrieves all users.
+     * @param {string} searchTerm Gets or sets the search term.
+     * @param {string} [orderBy] Gets or sets the field by which the search results are ordered. Defaults to \&quot;firstName\&quot;.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUsers: (searchTerm: string, orderBy?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * UserApi - functional programming interface
+ * @export
+ */
+export declare const UserApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2UsersOptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Retrieves all users.
+     * @param {string} searchTerm Gets or sets the search term.
+     * @param {string} [orderBy] Gets or sets the field by which the search results are ordered. Defaults to \&quot;firstName\&quot;.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUsers(searchTerm: string, orderBy?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicUserDtoIEnumerableResponse>>;
+};
+/**
+ * UserApi - factory interface
+ * @export
+ */
+export declare const UserApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2UsersOptions(options?: AxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Retrieves all users.
+     * @param {UserApiGetUsersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUsers(requestParameters: UserApiGetUsersRequest, options?: AxiosRequestConfig): AxiosPromise<PublicUserDtoIEnumerableResponse>;
+};
+/**
+ * Request parameters for getUsers operation in UserApi.
+ * @export
+ * @interface UserApiGetUsersRequest
+ */
+export interface UserApiGetUsersRequest {
+    /**
+     * Gets or sets the search term.
+     * @type {string}
+     * @memberof UserApiGetUsers
+     */
+    readonly searchTerm: string;
+    /**
+     * Gets or sets the field by which the search results are ordered. Defaults to \&quot;firstName\&quot;.
+     * @type {string}
+     * @memberof UserApiGetUsers
+     */
+    readonly orderBy?: string;
+}
+/**
+ * UserApi - object-oriented interface
+ * @export
+ * @class UserApi
+ * @extends {BaseAPI}
+ */
+export declare class UserApi extends BaseAPI {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UserApi
+     */
+    apiV2UsersOptions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     *
+     * @summary Retrieves all users.
+     * @param {UserApiGetUsersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UserApi
+     */
+    getUsers(requestParameters: UserApiGetUsersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PublicUserDtoIEnumerableResponse, any>>;
+}