@coscine/api-client 2.9.2 → 2.11.0

package/dist/index.js

@@ -1849,7 +1849,7 @@ axios$2.exports.default = axios$1;
 var axios = axios$2.exports;
 
 /* tslint:disable */
-const BASE_PATH$c = "https://d-sp16.devlef.campus.rwth-aachen.de/coscine/api/Coscine.Api.Admin".replace(/\/+$/, "");
+const BASE_PATH$c = "https://d-sp12.devlef.campus.rwth-aachen.de/coscine/api/Coscine.Api.Admin".replace(/\/+$/, "");
 /**
  *
  * @export
@@ -2115,7 +2115,7 @@ const AdminApiFactory = function (configuration, basePath, axios) {
  * Coscine.Api.Admin
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 3.0.2
+ * The version of the OpenAPI document: 3.0.5
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2149,7 +2149,7 @@ class Configuration {
 }
 
 /* tslint:disable */
-const BASE_PATH$b = "https://d-sp16.devlef.campus.rwth-aachen.de/coscine/api/Coscine.Api.Blob".replace(/\/+$/, "");
+const BASE_PATH$b = "https://d-sp12.devlef.campus.rwth-aachen.de/coscine/api/Coscine.Api.Blob".replace(/\/+$/, "");
 /**
  *
  * @export
@@ -2453,7 +2453,7 @@ const BlobApiFactory = function (configuration, basePath, axios) {
 };
 
 /* tslint:disable */
-const BASE_PATH$a = "https://d-sp16.devlef.campus.rwth-aachen.de/coscine/api/Coscine.Api.Metadata".replace(/\/+$/, "");
+const BASE_PATH$a = "https://d-sp12.devlef.campus.rwth-aachen.de/coscine/api/Coscine.Api.Metadata".replace(/\/+$/, "");
 /**
  *
  * @export
@@ -2892,7 +2892,7 @@ const MetadataApiFactory = function (configuration, basePath, axios) {
 };
 
 /* tslint:disable */
-const BASE_PATH$9 = "https://d-sp16.devlef.campus.rwth-aachen.de/coscine/api/Coscine.Api.Notices".replace(/\/+$/, "");
+const BASE_PATH$9 = "https://d-sp12.devlef.campus.rwth-aachen.de/coscine/api/Coscine.Api.Notices".replace(/\/+$/, "");
 /**
  *
  * @export
@@ -3116,7 +3116,7 @@ const NoticeApiFactory = function (configuration, basePath, axios) {
 };
 
 /* tslint:disable */
-const BASE_PATH$8 = "https://d-sp23.devlef.campus.rwth-aachen.de/coscine/api/Coscine.Api.Organization".replace(/\/+$/, "");
+const BASE_PATH$8 = "https://d-sp12.devlef.campus.rwth-aachen.de/coscine/api/Coscine.Api.Organization".replace(/\/+$/, "");
 /**
  *
  * @export
@@ -3499,7 +3499,7 @@ const OrganizationApiFactory = function (configuration, basePath, axios) {
 };
 
 /* tslint:disable */
-const BASE_PATH$7 = "https://d-sp16.devlef.campus.rwth-aachen.de/coscine/api/Coscine.Api.Pid".replace(/\/+$/, "");
+const BASE_PATH$7 = "https://d-sp12.devlef.campus.rwth-aachen.de/coscine/api/Coscine.Api.Pid".replace(/\/+$/, "");
 /**
  *
  * @export
@@ -3734,7 +3734,7 @@ const PidApiFactory = function (configuration, basePath, axios) {
 };
 
 /* tslint:disable */
-const BASE_PATH$6 = "https://d-sp16.devlef.campus.rwth-aachen.de/coscine/api/Coscine.Api.Project".replace(/\/+$/, "");
+const BASE_PATH$6 = "https://d-sp12.devlef.campus.rwth-aachen.de/coscine/api/Coscine.Api.Project".replace(/\/+$/, "");
 /**
  *
  * @export
@@ -4002,7 +4002,7 @@ const ProjectApiAxiosParamCreator = function (configuration) {
     return {
         /**
          *
-         * @summary Call to analytics logger.
+         * @summary Creation of an Application Profile.
          * @param {string} projectId Project id of the project
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -4413,7 +4413,7 @@ const ProjectApiFp = function (configuration) {
     return {
         /**
          *
-         * @summary Call to analytics logger.
+         * @summary Creation of an Application Profile.
          * @param {string} projectId Project id of the project
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -4590,7 +4590,7 @@ const ProjectApiFactory = function (configuration, basePath, axios) {
     return {
         /**
          *
-         * @summary Call to analytics logger.
+         * @summary Creation of an Application Profile.
          * @param {string} projectId Project id of the project
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -5351,6 +5351,7 @@ const SubProjectApiAxiosParamCreator = function (configuration) {
          * @summary This method retrieves the accessible Parent
          * @param {string} childId Id of the child
          * @param {*} [options] Override http request option.
+         * @deprecated
          * @throws {RequiredError}
          */
         subProjectGetAccessibleParent: (childId, options = {}) => __awaiter(this, void 0, void 0, function* () {
@@ -5404,6 +5405,7 @@ const SubProjectApiFp = function (configuration) {
          * @summary This method retrieves the accessible Parent
          * @param {string} childId Id of the child
          * @param {*} [options] Override http request option.
+         * @deprecated
          * @throws {RequiredError}
          */
         subProjectGetAccessibleParent(childId, options) {
@@ -5436,6 +5438,7 @@ const SubProjectApiFactory = function (configuration, basePath, axios) {
          * @summary This method retrieves the accessible Parent
          * @param {string} childId Id of the child
          * @param {*} [options] Override http request option.
+         * @deprecated
          * @throws {RequiredError}
          */
         subProjectGetAccessibleParent(childId, options) {
@@ -5519,7 +5522,7 @@ const VisibilityApiFactory = function (configuration, basePath, axios) {
 };
 
 /* tslint:disable */
-const BASE_PATH$5 = "https://d-sp16.devlef.campus.rwth-aachen.de/coscine/api/Coscine.Api.Resources".replace(/\/+$/, "");
+const BASE_PATH$5 = "https://d-sp12.devlef.campus.rwth-aachen.de/coscine/api/Coscine.Api.Resources".replace(/\/+$/, "");
 /**
  *
  * @export
@@ -6296,7 +6299,7 @@ const ResourceQuotaApiAxiosParamCreator = function (configuration) {
     return {
         /**
          *
-         * @summary Retrieves the resource quota for an individual resource.
+         * @summary Retrieves the resource used and reserved quota for an individual resource.
          * @param {string} id Id of the resource.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -6372,7 +6375,7 @@ const ResourceQuotaApiFp = function (configuration) {
     return {
         /**
          *
-         * @summary Retrieves the resource quota for an individual resource.
+         * @summary Retrieves the resource used and reserved quota for an individual resource.
          * @param {string} id Id of the resource.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -6408,7 +6411,7 @@ const ResourceQuotaApiFactory = function (configuration, basePath, axios) {
     return {
         /**
          *
-         * @summary Retrieves the resource quota for an individual resource.
+         * @summary Retrieves the resource used and reserved quota for an individual resource.
          * @param {string} id Id of the resource.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -6462,10 +6465,41 @@ const ResourceTypeApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         *
+         * @summary Returns all enabled resource types according to user\'s affiliation and allocated quota in  the project.
+         * @param {string} id Id of the project
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        resourceTypeGetEnabledResourceTypesAll: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists$3('resourceTypeGetEnabledResourceTypesAll', 'id', id);
+            const localVarPath = `/ResourceType/types/{id}/-/enabled`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL$5);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication JWT token required
+            yield setApiKeyToObject$5(localVarHeaderParameter, "Authorization", configuration);
+            setSearchParams$5(localVarUrlObj, localVarQueryParameter, options.query);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString$5(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          *
          * @summary Returns all fields of the specified resource type.
-         * @param {string} id A guid as a string that identifies the resource.
+         * @param {string} id A GUID as a string that identifies the resource.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -6495,7 +6529,7 @@ const ResourceTypeApiAxiosParamCreator = function (configuration) {
         }),
         /**
          *
-         * @summary Returns all resource types.
+         * @summary Returns all resource types. Both hidden and active, regardless of user affiliation or quota.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -6541,10 +6575,23 @@ const ResourceTypeApiFp = function (configuration) {
                 return createRequestFunction$5(localVarAxiosArgs, axios, BASE_PATH$5, configuration);
             });
         },
+        /**
+         *
+         * @summary Returns all enabled resource types according to user\'s affiliation and allocated quota in  the project.
+         * @param {string} id Id of the project
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        resourceTypeGetEnabledResourceTypesAll(id, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.resourceTypeGetEnabledResourceTypesAll(id, options);
+                return createRequestFunction$5(localVarAxiosArgs, axios, BASE_PATH$5, configuration);
+            });
+        },
         /**
          *
          * @summary Returns all fields of the specified resource type.
-         * @param {string} id A guid as a string that identifies the resource.
+         * @param {string} id A GUID as a string that identifies the resource.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -6556,7 +6603,7 @@ const ResourceTypeApiFp = function (configuration) {
         },
         /**
          *
-         * @summary Returns all resource types.
+         * @summary Returns all resource types. Both hidden and active, regardless of user affiliation or quota.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -6584,10 +6631,20 @@ const ResourceTypeApiFactory = function (configuration, basePath, axios) {
         resourceTypeGetEnabledResourceTypes(options) {
             return localVarFp.resourceTypeGetEnabledResourceTypes(options).then((request) => request(axios, basePath));
         },
+        /**
+         *
+         * @summary Returns all enabled resource types according to user\'s affiliation and allocated quota in  the project.
+         * @param {string} id Id of the project
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        resourceTypeGetEnabledResourceTypesAll(id, options) {
+            return localVarFp.resourceTypeGetEnabledResourceTypesAll(id, options).then((request) => request(axios, basePath));
+        },
         /**
          *
          * @summary Returns all fields of the specified resource type.
-         * @param {string} id A guid as a string that identifies the resource.
+         * @param {string} id A GUID as a string that identifies the resource.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -6596,7 +6653,7 @@ const ResourceTypeApiFactory = function (configuration, basePath, axios) {
         },
         /**
          *
-         * @summary Returns all resource types.
+         * @summary Returns all resource types. Both hidden and active, regardless of user affiliation or quota.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -6669,6 +6726,18 @@ const createRequestFunction$4 = function (axiosArgs, globalAxios, BASE_PATH, con
 };
 
 /* tslint:disable */
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+var CategoryFilter;
+(function (CategoryFilter) {
+    CategoryFilter["None"] = "None";
+    CategoryFilter["Resource"] = "Resource";
+    CategoryFilter["Project"] = "Project";
+    CategoryFilter["Metadata"] = "Metadata";
+})(CategoryFilter || (CategoryFilter = {}));
 /**
  *
  * @export
@@ -6680,6 +6749,20 @@ var ItemType;
     ItemType["Project"] = "Project";
     ItemType["Resource"] = "Resource";
 })(ItemType || (ItemType = {}));
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+var OrderBy;
+(function (OrderBy) {
+    OrderBy["DateCreatedAsc"] = "Date_Created_Asc";
+    OrderBy["DateCreatedDesc"] = "Date_Created_Desc";
+    OrderBy["ScoreAsc"] = "Score_Asc";
+    OrderBy["ScoreDesc"] = "Score_Desc";
+    OrderBy["NameAsc"] = "Name_Asc";
+    OrderBy["NameDesc"] = "Name_Desc";
+})(OrderBy || (OrderBy = {}));
 /**
  * SearchApi - axios parameter creator
  * @export
@@ -6693,12 +6776,14 @@ const SearchApiAxiosParamCreator = function (configuration) {
          * @param {boolean} [includeUsers] Specify user or only public metadata records could be found
          * @param {boolean} [useAdvancedSyntax] Set true for advanced Elasticsearch search syntax
          * @param {Array<string>} [includedLanguages] Set the used languages
+         * @param {CategoryFilter} [categoryFilter] Set the category filter
+         * @param {OrderBy} [orderBy] Set the order for sorting
          * @param {number} [pageNumber] The requested page number
          * @param {number} [pageSize] The size of a page
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        searchSearch: (searchQuery, includeUsers, useAdvancedSyntax, includedLanguages, pageNumber, pageSize, options = {}) => __awaiter(this, void 0, void 0, function* () {
+        searchSearch: (searchQuery, includeUsers, useAdvancedSyntax, includedLanguages, categoryFilter, orderBy, pageNumber, pageSize, options = {}) => __awaiter(this, void 0, void 0, function* () {
             const localVarPath = `/Search`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL$4);
@@ -6723,6 +6808,12 @@ const SearchApiAxiosParamCreator = function (configuration) {
             if (includedLanguages) {
                 localVarQueryParameter['IncludedLanguages'] = includedLanguages;
             }
+            if (categoryFilter !== undefined) {
+                localVarQueryParameter['CategoryFilter'] = categoryFilter;
+            }
+            if (orderBy !== undefined) {
+                localVarQueryParameter['OrderBy'] = orderBy;
+            }
             if (pageNumber !== undefined) {
                 localVarQueryParameter['PageNumber'] = pageNumber;
             }
@@ -6753,14 +6844,16 @@ const SearchApiFp = function (configuration) {
          * @param {boolean} [includeUsers] Specify user or only public metadata records could be found
          * @param {boolean} [useAdvancedSyntax] Set true for advanced Elasticsearch search syntax
          * @param {Array<string>} [includedLanguages] Set the used languages
+         * @param {CategoryFilter} [categoryFilter] Set the category filter
+         * @param {OrderBy} [orderBy] Set the order for sorting
          * @param {number} [pageNumber] The requested page number
          * @param {number} [pageSize] The size of a page
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        searchSearch(searchQuery, includeUsers, useAdvancedSyntax, includedLanguages, pageNumber, pageSize, options) {
+        searchSearch(searchQuery, includeUsers, useAdvancedSyntax, includedLanguages, categoryFilter, orderBy, pageNumber, pageSize, options) {
             return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.searchSearch(searchQuery, includeUsers, useAdvancedSyntax, includedLanguages, pageNumber, pageSize, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.searchSearch(searchQuery, includeUsers, useAdvancedSyntax, includedLanguages, categoryFilter, orderBy, pageNumber, pageSize, options);
                 return createRequestFunction$4(localVarAxiosArgs, axios, BASE_PATH$4, configuration);
             });
         },
@@ -6780,19 +6873,21 @@ const SearchApiFactory = function (configuration, basePath, axios) {
          * @param {boolean} [includeUsers] Specify user or only public metadata records could be found
          * @param {boolean} [useAdvancedSyntax] Set true for advanced Elasticsearch search syntax
          * @param {Array<string>} [includedLanguages] Set the used languages
+         * @param {CategoryFilter} [categoryFilter] Set the category filter
+         * @param {OrderBy} [orderBy] Set the order for sorting
          * @param {number} [pageNumber] The requested page number
          * @param {number} [pageSize] The size of a page
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        searchSearch(searchQuery, includeUsers, useAdvancedSyntax, includedLanguages, pageNumber, pageSize, options) {
-            return localVarFp.searchSearch(searchQuery, includeUsers, useAdvancedSyntax, includedLanguages, pageNumber, pageSize, options).then((request) => request(axios, basePath));
+        searchSearch(searchQuery, includeUsers, useAdvancedSyntax, includedLanguages, categoryFilter, orderBy, pageNumber, pageSize, options) {
+            return localVarFp.searchSearch(searchQuery, includeUsers, useAdvancedSyntax, includedLanguages, categoryFilter, orderBy, pageNumber, pageSize, options).then((request) => request(axios, basePath));
         },
     };
 };
 
 /* tslint:disable */
-const BASE_PATH$3 = "https://d-sp16.devlef.campus.rwth-aachen.de/coscine/api/Coscine.Api.STS".replace(/\/+$/, "");
+const BASE_PATH$3 = "https://d-sp12.devlef.campus.rwth-aachen.de/coscine/api/Coscine.Api.STS".replace(/\/+$/, "");
 
 /* tslint:disable */
 /**
@@ -7466,7 +7561,7 @@ const ShibbolethApiFactory = function (configuration, basePath, axios) {
 };
 
 /* tslint:disable */
-const BASE_PATH$2 = "https://d-sp16.devlef.campus.rwth-aachen.de/coscine/api/Coscine.Api.Token".replace(/\/+$/, "");
+const BASE_PATH$2 = "https://d-sp12.devlef.campus.rwth-aachen.de/coscine/api/Coscine.Api.Token".replace(/\/+$/, "");
 /**
  *
  * @export
@@ -7851,7 +7946,7 @@ const TokenApiFactory = function (configuration, basePath, axios) {
 };
 
 /* tslint:disable */
-const BASE_PATH$1 = "https://d-sp16.devlef.campus.rwth-aachen.de/coscine/api/Coscine.Api.Tree".replace(/\/+$/, "");
+const BASE_PATH$1 = "https://d-sp12.devlef.campus.rwth-aachen.de/coscine/api/Coscine.Api.Tree".replace(/\/+$/, "");
 /**
  *
  * @export
@@ -8096,7 +8191,7 @@ const TreeApiFactory = function (configuration, basePath, axios) {
 };
 
 /* tslint:disable */
-const BASE_PATH = "https://d-sp16.devlef.campus.rwth-aachen.de/coscine/api/Coscine.Api.User".replace(/\/+$/, "");
+const BASE_PATH = "https://d-sp12.devlef.campus.rwth-aachen.de/coscine/api/Coscine.Api.User".replace(/\/+$/, "");
 /**
  *
  * @export