@coscine/api-client 3.24.0 → 3.26.0

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

@@ -1,21 +1,9 @@
-/**
- * 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@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, RawAxiosRequestConfig } from 'axios';
-import { type RequestArgs, BaseAPI } from '../../base';
-import type { PublicUserDtoIEnumerableResponse } from '../../@coscine/model';
+import { Configuration } from '../../configuration';
+import { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { RequestArgs, BaseAPI } from '../../base';
+import { PublicUserDtoIEnumerableResponse } from '../../@coscine/model';
 /**
  * UserApi - axios parameter creator
- * @export
  */
 export declare const UserApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
@@ -37,7 +25,6 @@ export declare const UserApiAxiosParamCreator: (configuration?: Configuration) =
 };
 /**
  * UserApi - functional programming interface
- * @export
  */
 export declare const UserApiFp: (configuration?: Configuration) => {
     /**
@@ -59,7 +46,6 @@ export declare const UserApiFp: (configuration?: Configuration) => {
 };
 /**
  * UserApi - factory interface
- * @export
  */
 export declare const UserApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
@@ -80,28 +66,19 @@ export declare const UserApiFactory: (configuration?: Configuration, basePath?:
 };
 /**
  * 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 {
     /**
@@ -109,16 +86,14 @@ 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?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    apiV2UsersOptions(options?: RawAxiosRequestConfig): 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?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PublicUserDtoIEnumerableResponse, any>>;
+    getUsers(requestParameters: UserApiGetUsersRequest, options?: RawAxiosRequestConfig): Promise<import('axios').AxiosResponse<PublicUserDtoIEnumerableResponse, any, {}>>;
 }

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

@@ -1,23 +1,9 @@
-/**
- * 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@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, RawAxiosRequestConfig } from 'axios';
-import { type RequestArgs, BaseAPI } from '../../base';
-import type { UserNotificationForCreationDto } from '../../@coscine/model';
-import type { UserNotificationOptOutDtoPagedResponse } from '../../@coscine/model';
-import type { UserNotificationOptOutDtoResponse } from '../../@coscine/model';
+import { Configuration } from '../../configuration';
+import { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { RequestArgs, BaseAPI } from '../../base';
+import { UserNotificationForCreationDto, UserNotificationOptOutDtoPagedResponse, UserNotificationOptOutDtoResponse } from '../../@coscine/model';
 /**
  * UserNotificationOptOutApi - axios parameter creator
- * @export
  */
 export declare const UserNotificationOptOutApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
@@ -54,9 +40,9 @@ export declare const UserNotificationOptOutApiAxiosParamCreator: (configuration?
     /**
      *
      * @summary Retrieves all user notification opt outs of the current 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 an order string.  Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.
+     * @param {number} [pageNumber] Gets or sets the desired page number. Should be greater than or equal to 1. Default is 1.
+     * @param {number} [pageSize] Gets or sets 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 an order string.  Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.  Can be used like this: \&quot;propertyA asc, propertyB desc\&quot;.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -64,7 +50,6 @@ export declare const UserNotificationOptOutApiAxiosParamCreator: (configuration?
 };
 /**
  * UserNotificationOptOutApi - functional programming interface
- * @export
  */
 export declare const UserNotificationOptOutApiFp: (configuration?: Configuration) => {
     /**
@@ -101,9 +86,9 @@ export declare const UserNotificationOptOutApiFp: (configuration?: Configuration
     /**
      *
      * @summary Retrieves all user notification opt outs of the current 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 an order string.  Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.
+     * @param {number} [pageNumber] Gets or sets the desired page number. Should be greater than or equal to 1. Default is 1.
+     * @param {number} [pageSize] Gets or sets 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 an order string.  Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.  Can be used like this: \&quot;propertyA asc, propertyB desc\&quot;.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -111,7 +96,6 @@ export declare const UserNotificationOptOutApiFp: (configuration?: Configuration
 };
 /**
  * UserNotificationOptOutApi - factory interface
- * @export
  */
 export declare const UserNotificationOptOutApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
@@ -156,73 +140,50 @@ export declare const UserNotificationOptOutApiFactory: (configuration?: Configur
 };
 /**
  * Request parameters for createUserNotification operation in UserNotificationOptOutApi.
- * @export
- * @interface UserNotificationOptOutApiCreateUserNotificationRequest
  */
 export interface UserNotificationOptOutApiCreateUserNotificationRequest {
     /**
      * The user notification opt out data for creation.
-     * @type {UserNotificationForCreationDto}
-     * @memberof UserNotificationOptOutApiCreateUserNotification
      */
     readonly userNotificationForCreationDto?: UserNotificationForCreationDto;
 }
 /**
  * Request parameters for deleteUserNotification operation in UserNotificationOptOutApi.
- * @export
- * @interface UserNotificationOptOutApiDeleteUserNotificationRequest
  */
 export interface UserNotificationOptOutApiDeleteUserNotificationRequest {
     /**
      * The Id of the user notification opt out.
-     * @type {string}
-     * @memberof UserNotificationOptOutApiDeleteUserNotification
      */
     readonly id: string;
 }
 /**
  * Request parameters for getUserNotification operation in UserNotificationOptOutApi.
- * @export
- * @interface UserNotificationOptOutApiGetUserNotificationRequest
  */
 export interface UserNotificationOptOutApiGetUserNotificationRequest {
     /**
      * The Id of the notification.
-     * @type {string}
-     * @memberof UserNotificationOptOutApiGetUserNotification
      */
     readonly notificationId: string;
 }
 /**
  * Request parameters for getUserNotifications operation in UserNotificationOptOutApi.
- * @export
- * @interface UserNotificationOptOutApiGetUserNotificationsRequest
  */
 export interface UserNotificationOptOutApiGetUserNotificationsRequest {
     /**
-     * The desired page number. Should be greater than or equal to 1. Default is 1.
-     * @type {number}
-     * @memberof UserNotificationOptOutApiGetUserNotifications
+     * Gets or sets the desired page number. Should be greater than or equal to 1. Default is 1.
      */
     readonly pageNumber?: number;
     /**
-     * The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
-     * @type {number}
-     * @memberof UserNotificationOptOutApiGetUserNotifications
+     * Gets or sets the desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
      */
     readonly pageSize?: number;
     /**
-     * Gets or sets the field name used for ordering the results.  The order is constructed by an 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 UserNotificationOptOutApiGetUserNotifications
+     * Gets or sets the field name used for ordering the results.  The order is constructed by an order string.  Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.  Can be used like this: \&quot;propertyA asc, propertyB desc\&quot;.
      */
     readonly orderBy?: string;
 }
 /**
  * UserNotificationOptOutApi - object-oriented interface
- * @export
- * @class UserNotificationOptOutApi
- * @extends {BaseAPI}
  */
 export declare class UserNotificationOptOutApi extends BaseAPI {
     /**
@@ -230,43 +191,38 @@ export declare class UserNotificationOptOutApi extends BaseAPI {
      * @summary Responds with the HTTP methods allowed for the endpoint.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof UserNotificationOptOutApi
      */
-    apiV2UserNotificationsOptions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    apiV2UserNotificationsOptions(options?: RawAxiosRequestConfig): Promise<import('axios').AxiosResponse<void, any, {}>>;
     /**
      *
      * @summary Creates a user notification opt out for a specified user.
      * @param {UserNotificationOptOutApiCreateUserNotificationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof UserNotificationOptOutApi
      */
-    createUserNotification(requestParameters?: UserNotificationOptOutApiCreateUserNotificationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserNotificationOptOutDtoResponse, any>>;
+    createUserNotification(requestParameters?: UserNotificationOptOutApiCreateUserNotificationRequest, options?: RawAxiosRequestConfig): Promise<import('axios').AxiosResponse<UserNotificationOptOutDtoResponse, any, {}>>;
     /**
      *
      * @summary Deletes a user notification opt out for a specified user.
      * @param {UserNotificationOptOutApiDeleteUserNotificationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof UserNotificationOptOutApi
      */
-    deleteUserNotification(requestParameters: UserNotificationOptOutApiDeleteUserNotificationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    deleteUserNotification(requestParameters: UserNotificationOptOutApiDeleteUserNotificationRequest, options?: RawAxiosRequestConfig): Promise<import('axios').AxiosResponse<void, any, {}>>;
     /**
      *
      * @summary Retrieves a user notification opt out for a specified notification.
      * @param {UserNotificationOptOutApiGetUserNotificationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof UserNotificationOptOutApi
      */
-    getUserNotification(requestParameters: UserNotificationOptOutApiGetUserNotificationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserNotificationOptOutDtoResponse, any>>;
+    getUserNotification(requestParameters: UserNotificationOptOutApiGetUserNotificationRequest, options?: RawAxiosRequestConfig): Promise<import('axios').AxiosResponse<UserNotificationOptOutDtoResponse, any, {}>>;
     /**
      *
      * @summary Retrieves all user notification opt outs of the current user.
      * @param {UserNotificationOptOutApiGetUserNotificationsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof UserNotificationOptOutApi
      */
-    getUserNotifications(requestParameters?: UserNotificationOptOutApiGetUserNotificationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserNotificationOptOutDtoPagedResponse, any>>;
+    getUserNotifications(requestParameters?: UserNotificationOptOutApiGetUserNotificationsRequest, options?: RawAxiosRequestConfig): Promise<import('axios').AxiosResponse<UserNotificationOptOutDtoPagedResponse, any, {}>>;
 }

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

@@ -1,22 +1,9 @@
-/**
- * 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@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, RawAxiosRequestConfig } from 'axios';
-import { type RequestArgs, BaseAPI } from '../../base';
-import type { VisibilityDtoPagedResponse } from '../../@coscine/model';
-import type { VisibilityDtoResponse } from '../../@coscine/model';
+import { Configuration } from '../../configuration';
+import { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { RequestArgs, BaseAPI } from '../../base';
+import { VisibilityDtoPagedResponse, VisibilityDtoResponse } from '../../@coscine/model';
 /**
  * VisibilityApi - axios parameter creator
- * @export
  */
 export declare const VisibilityApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
@@ -29,9 +16,9 @@ export declare const VisibilityApiAxiosParamCreator: (configuration?: Configurat
     /**
      *
      * @summary Retrieves all visibilities.
-     * @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 an order string.  Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.
+     * @param {number} [pageNumber] Gets or sets the desired page number. Should be greater than or equal to 1. Default is 1.
+     * @param {number} [pageSize] Gets or sets 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 an order string.  Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.  Can be used like this: \&quot;propertyA asc, propertyB desc\&quot;.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -47,7 +34,6 @@ export declare const VisibilityApiAxiosParamCreator: (configuration?: Configurat
 };
 /**
  * VisibilityApi - functional programming interface
- * @export
  */
 export declare const VisibilityApiFp: (configuration?: Configuration) => {
     /**
@@ -60,9 +46,9 @@ export declare const VisibilityApiFp: (configuration?: Configuration) => {
     /**
      *
      * @summary Retrieves all visibilities.
-     * @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 an order string.  Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.
+     * @param {number} [pageNumber] Gets or sets the desired page number. Should be greater than or equal to 1. Default is 1.
+     * @param {number} [pageSize] Gets or sets 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 an order string.  Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.  Can be used like this: \&quot;propertyA asc, propertyB desc\&quot;.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -78,7 +64,6 @@ export declare const VisibilityApiFp: (configuration?: Configuration) => {
 };
 /**
  * VisibilityApi - factory interface
- * @export
  */
 export declare const VisibilityApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
@@ -107,47 +92,32 @@ export declare const VisibilityApiFactory: (configuration?: Configuration, baseP
 };
 /**
  * Request parameters for getVisibilities operation in VisibilityApi.
- * @export
- * @interface VisibilityApiGetVisibilitiesRequest
  */
 export interface VisibilityApiGetVisibilitiesRequest {
     /**
-     * The desired page number. Should be greater than or equal to 1. Default is 1.
-     * @type {number}
-     * @memberof VisibilityApiGetVisibilities
+     * Gets or sets the desired page number. Should be greater than or equal to 1. Default is 1.
      */
     readonly pageNumber?: number;
     /**
-     * The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
-     * @type {number}
-     * @memberof VisibilityApiGetVisibilities
+     * Gets or sets the desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
      */
     readonly pageSize?: number;
     /**
-     * Gets or sets the field name used for ordering the results.  The order is constructed by an 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 VisibilityApiGetVisibilities
+     * Gets or sets the field name used for ordering the results.  The order is constructed by an order string.  Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.  Can be used like this: \&quot;propertyA asc, propertyB desc\&quot;.
      */
     readonly orderBy?: string;
 }
 /**
  * Request parameters for getVisibility operation in VisibilityApi.
- * @export
- * @interface VisibilityApiGetVisibilityRequest
  */
 export interface VisibilityApiGetVisibilityRequest {
     /**
      * The ID of the visibility.
-     * @type {string}
-     * @memberof VisibilityApiGetVisibility
      */
     readonly visibilityId: string;
 }
 /**
  * VisibilityApi - object-oriented interface
- * @export
- * @class VisibilityApi
- * @extends {BaseAPI}
  */
 export declare class VisibilityApi extends BaseAPI {
     /**
@@ -155,25 +125,22 @@ export declare class VisibilityApi extends BaseAPI {
      * @summary Responds with the HTTP methods allowed for the endpoint.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof VisibilityApi
      */
-    apiV2VisibilitiesOptions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    apiV2VisibilitiesOptions(options?: RawAxiosRequestConfig): Promise<import('axios').AxiosResponse<void, any, {}>>;
     /**
      *
      * @summary Retrieves all visibilities.
      * @param {VisibilityApiGetVisibilitiesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof VisibilityApi
      */
-    getVisibilities(requestParameters?: VisibilityApiGetVisibilitiesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VisibilityDtoPagedResponse, any>>;
+    getVisibilities(requestParameters?: VisibilityApiGetVisibilitiesRequest, options?: RawAxiosRequestConfig): Promise<import('axios').AxiosResponse<VisibilityDtoPagedResponse, any, {}>>;
     /**
      *
      * @summary Retrieves a visibility by ID.
      * @param {VisibilityApiGetVisibilityRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof VisibilityApi
      */
-    getVisibility(requestParameters: VisibilityApiGetVisibilityRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VisibilityDtoResponse, any>>;
+    getVisibility(requestParameters: VisibilityApiGetVisibilityRequest, options?: RawAxiosRequestConfig): Promise<import('axios').AxiosResponse<VisibilityDtoResponse, any, {}>>;
 }