@coscine/api-client 3.3.1 → 3.3.2-package.0

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

@@ -0,0 +1,393 @@
+/**
+ * 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 { MetadataUpdateAdminParameters } from '../../@coscine/model';
+import { ProjectAdminDtoIEnumerablePagedResponse } from '../../@coscine/model';
+import { RdfDefinitionDtoResponse } from '../../@coscine/model';
+import { RdfFormat } from '../../@coscine/model';
+import { ResourceAdminDtoIEnumerablePagedResponse } from '../../@coscine/model';
+import { UserDtoIEnumerablePagedResponse } from '../../@coscine/model';
+/**
+ * AdminApi - axios parameter creator
+ * @export
+ */
+export declare const AdminApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2AdminOptions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Retrieves all projects.
+     * @param {boolean} [topLevel] Gets or sets a value indicating whether to filter top-level projects.
+     * @param {boolean} [includeDeleted] Gets or sets a value indicating whether to include deleted projects in the results.
+     * @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}
+     */
+    getAllProjects: (topLevel?: boolean, includeDeleted?: boolean, pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Retrieves all resources.
+     * @param {boolean} [includeDeleted] Gets or sets a value indicating whether to include deleted resources.
+     * @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}
+     */
+    getAllResources: (includeDeleted?: boolean, pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Retrieves all users.
+     * @param {boolean} [tosAccepted] Gets or sets a value indicating whether the terms of service have been accepted by the user.
+     * @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}
+     */
+    getAllUsers: (tosAccepted?: boolean, pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Gets a metadata graph.
+     * @param {string} graphUri Gets or initializes the URI of the graph.
+     * @param {RdfFormat} [format] Gets or sets the RDF format.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMetadataGraph: (graphUri: string, format?: RdfFormat, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Updates a metadata graph.
+     * @param {MetadataUpdateAdminParameters} [metadataUpdateAdminParameters] The metadata update admin parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateMetadataGraph: (metadataUpdateAdminParameters?: MetadataUpdateAdminParameters, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * AdminApi - functional programming interface
+ * @export
+ */
+export declare const AdminApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2AdminOptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Retrieves all projects.
+     * @param {boolean} [topLevel] Gets or sets a value indicating whether to filter top-level projects.
+     * @param {boolean} [includeDeleted] Gets or sets a value indicating whether to include deleted projects in the results.
+     * @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}
+     */
+    getAllProjects(topLevel?: boolean, includeDeleted?: boolean, pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProjectAdminDtoIEnumerablePagedResponse>>;
+    /**
+     *
+     * @summary Retrieves all resources.
+     * @param {boolean} [includeDeleted] Gets or sets a value indicating whether to include deleted resources.
+     * @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}
+     */
+    getAllResources(includeDeleted?: boolean, pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResourceAdminDtoIEnumerablePagedResponse>>;
+    /**
+     *
+     * @summary Retrieves all users.
+     * @param {boolean} [tosAccepted] Gets or sets a value indicating whether the terms of service have been accepted by the user.
+     * @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}
+     */
+    getAllUsers(tosAccepted?: boolean, pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDtoIEnumerablePagedResponse>>;
+    /**
+     *
+     * @summary Gets a metadata graph.
+     * @param {string} graphUri Gets or initializes the URI of the graph.
+     * @param {RdfFormat} [format] Gets or sets the RDF format.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMetadataGraph(graphUri: string, format?: RdfFormat, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RdfDefinitionDtoResponse>>;
+    /**
+     *
+     * @summary Updates a metadata graph.
+     * @param {MetadataUpdateAdminParameters} [metadataUpdateAdminParameters] The metadata update admin parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateMetadataGraph(metadataUpdateAdminParameters?: MetadataUpdateAdminParameters, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+};
+/**
+ * AdminApi - factory interface
+ * @export
+ */
+export declare const AdminApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2AdminOptions(options?: AxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Retrieves all projects.
+     * @param {AdminApiGetAllProjectsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAllProjects(requestParameters?: AdminApiGetAllProjectsRequest, options?: AxiosRequestConfig): AxiosPromise<ProjectAdminDtoIEnumerablePagedResponse>;
+    /**
+     *
+     * @summary Retrieves all resources.
+     * @param {AdminApiGetAllResourcesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAllResources(requestParameters?: AdminApiGetAllResourcesRequest, options?: AxiosRequestConfig): AxiosPromise<ResourceAdminDtoIEnumerablePagedResponse>;
+    /**
+     *
+     * @summary Retrieves all users.
+     * @param {AdminApiGetAllUsersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAllUsers(requestParameters?: AdminApiGetAllUsersRequest, options?: AxiosRequestConfig): AxiosPromise<UserDtoIEnumerablePagedResponse>;
+    /**
+     *
+     * @summary Gets a metadata graph.
+     * @param {AdminApiGetMetadataGraphRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMetadataGraph(requestParameters: AdminApiGetMetadataGraphRequest, options?: AxiosRequestConfig): AxiosPromise<RdfDefinitionDtoResponse>;
+    /**
+     *
+     * @summary Updates a metadata graph.
+     * @param {AdminApiUpdateMetadataGraphRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateMetadataGraph(requestParameters?: AdminApiUpdateMetadataGraphRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
+};
+/**
+ * Request parameters for getAllProjects operation in AdminApi.
+ * @export
+ * @interface AdminApiGetAllProjectsRequest
+ */
+export interface AdminApiGetAllProjectsRequest {
+    /**
+     * Gets or sets a value indicating whether to filter top-level projects.
+     * @type {boolean}
+     * @memberof AdminApiGetAllProjects
+     */
+    readonly topLevel?: boolean;
+    /**
+     * Gets or sets a value indicating whether to include deleted projects in the results.
+     * @type {boolean}
+     * @memberof AdminApiGetAllProjects
+     */
+    readonly includeDeleted?: boolean;
+    /**
+     * The desired page number. Should be greater than or equal to 1. Default is 1.
+     * @type {number}
+     * @memberof AdminApiGetAllProjects
+     */
+    readonly pageNumber?: number;
+    /**
+     * The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
+     * @type {number}
+     * @memberof AdminApiGetAllProjects
+     */
+    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 AdminApiGetAllProjects
+     */
+    readonly orderBy?: string;
+}
+/**
+ * Request parameters for getAllResources operation in AdminApi.
+ * @export
+ * @interface AdminApiGetAllResourcesRequest
+ */
+export interface AdminApiGetAllResourcesRequest {
+    /**
+     * Gets or sets a value indicating whether to include deleted resources.
+     * @type {boolean}
+     * @memberof AdminApiGetAllResources
+     */
+    readonly includeDeleted?: boolean;
+    /**
+     * The desired page number. Should be greater than or equal to 1. Default is 1.
+     * @type {number}
+     * @memberof AdminApiGetAllResources
+     */
+    readonly pageNumber?: number;
+    /**
+     * The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
+     * @type {number}
+     * @memberof AdminApiGetAllResources
+     */
+    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 AdminApiGetAllResources
+     */
+    readonly orderBy?: string;
+}
+/**
+ * Request parameters for getAllUsers operation in AdminApi.
+ * @export
+ * @interface AdminApiGetAllUsersRequest
+ */
+export interface AdminApiGetAllUsersRequest {
+    /**
+     * Gets or sets a value indicating whether the terms of service have been accepted by the user.
+     * @type {boolean}
+     * @memberof AdminApiGetAllUsers
+     */
+    readonly tosAccepted?: boolean;
+    /**
+     * The desired page number. Should be greater than or equal to 1. Default is 1.
+     * @type {number}
+     * @memberof AdminApiGetAllUsers
+     */
+    readonly pageNumber?: number;
+    /**
+     * The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
+     * @type {number}
+     * @memberof AdminApiGetAllUsers
+     */
+    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 AdminApiGetAllUsers
+     */
+    readonly orderBy?: string;
+}
+/**
+ * Request parameters for getMetadataGraph operation in AdminApi.
+ * @export
+ * @interface AdminApiGetMetadataGraphRequest
+ */
+export interface AdminApiGetMetadataGraphRequest {
+    /**
+     * Gets or initializes the URI of the graph.
+     * @type {string}
+     * @memberof AdminApiGetMetadataGraph
+     */
+    readonly graphUri: string;
+    /**
+     * Gets or sets the RDF format.
+     * @type {RdfFormat}
+     * @memberof AdminApiGetMetadataGraph
+     */
+    readonly format?: RdfFormat;
+}
+/**
+ * Request parameters for updateMetadataGraph operation in AdminApi.
+ * @export
+ * @interface AdminApiUpdateMetadataGraphRequest
+ */
+export interface AdminApiUpdateMetadataGraphRequest {
+    /**
+     * The metadata update admin parameters.
+     * @type {MetadataUpdateAdminParameters}
+     * @memberof AdminApiUpdateMetadataGraph
+     */
+    readonly metadataUpdateAdminParameters?: MetadataUpdateAdminParameters;
+}
+/**
+ * AdminApi - object-oriented interface
+ * @export
+ * @class AdminApi
+ * @extends {BaseAPI}
+ */
+export declare class AdminApi extends BaseAPI {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AdminApi
+     */
+    apiV2AdminOptions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     *
+     * @summary Retrieves all projects.
+     * @param {AdminApiGetAllProjectsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AdminApi
+     */
+    getAllProjects(requestParameters?: AdminApiGetAllProjectsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProjectAdminDtoIEnumerablePagedResponse, any>>;
+    /**
+     *
+     * @summary Retrieves all resources.
+     * @param {AdminApiGetAllResourcesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AdminApi
+     */
+    getAllResources(requestParameters?: AdminApiGetAllResourcesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ResourceAdminDtoIEnumerablePagedResponse, any>>;
+    /**
+     *
+     * @summary Retrieves all users.
+     * @param {AdminApiGetAllUsersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AdminApi
+     */
+    getAllUsers(requestParameters?: AdminApiGetAllUsersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UserDtoIEnumerablePagedResponse, any>>;
+    /**
+     *
+     * @summary Gets a metadata graph.
+     * @param {AdminApiGetMetadataGraphRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AdminApi
+     */
+    getMetadataGraph(requestParameters: AdminApiGetMetadataGraphRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RdfDefinitionDtoResponse, any>>;
+    /**
+     *
+     * @summary Updates a metadata graph.
+     * @param {AdminApiUpdateMetadataGraphRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AdminApi
+     */
+    updateMetadataGraph(requestParameters?: AdminApiUpdateMetadataGraphRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+}