@coscine/api-client 3.3.1 → 3.4.0

package/dist/types/Coscine.Api/base.d.ts

@@ -1,55 +1,66 @@
-/**
- * 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 { Configuration } from "./configuration";
-import { AxiosInstance } from 'axios';
-export declare const BASE_PATH: string;
-/**
- *
- * @export
- */
-export declare const COLLECTION_FORMATS: {
-    csv: string;
-    ssv: string;
-    tsv: string;
-    pipes: string;
-};
-/**
- *
- * @export
- * @interface RequestArgs
- */
-export interface RequestArgs {
-    url: string;
-    options: any;
-}
-/**
- *
- * @export
- * @class BaseAPI
- */
-export declare class BaseAPI {
-    protected basePath: string;
-    protected axios: AxiosInstance;
-    protected configuration: Configuration | undefined;
-    constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
-}
-/**
- *
- * @export
- * @class RequiredError
- * @extends {Error}
- */
-export declare class RequiredError extends Error {
-    field: string;
-    name: "RequiredError";
-    constructor(field: string, msg?: string);
-}
+/**
+ * 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 { AxiosInstance, AxiosRequestConfig } from 'axios';
+export declare const BASE_PATH: string;
+/**
+ *
+ * @export
+ */
+export declare const COLLECTION_FORMATS: {
+    csv: string;
+    ssv: string;
+    tsv: string;
+    pipes: string;
+};
+/**
+ *
+ * @export
+ * @interface RequestArgs
+ */
+export interface RequestArgs {
+    url: string;
+    options: AxiosRequestConfig;
+}
+/**
+ *
+ * @export
+ * @class BaseAPI
+ */
+export declare class BaseAPI {
+    protected basePath: string;
+    protected axios: AxiosInstance;
+    protected configuration: Configuration | undefined;
+    constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
+}
+/**
+ *
+ * @export
+ * @class RequiredError
+ * @extends {Error}
+ */
+export declare class RequiredError extends Error {
+    field: string;
+    constructor(field: string, msg?: string);
+}
+interface ServerMap {
+    [key: string]: {
+        url: string;
+        description: string;
+    }[];
+}
+/**
+ *
+ * @export
+ */
+export declare const operationServerMap: ServerMap;
+export {};

package/dist/types/Coscine.Api/common.d.ts

@@ -1,65 +1,65 @@
-/**
- * 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 { Configuration } from "./configuration";
-import { RequestArgs } from "./base";
-import { AxiosInstance } from 'axios';
-/**
- *
- * @export
- */
-export declare const DUMMY_BASE_URL = "https://example.com";
-/**
- *
- * @throws {RequiredError}
- * @export
- */
-export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
-/**
- *
- * @export
- */
-export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
-/**
- *
- * @export
- */
-export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
-/**
- *
- * @export
- */
-export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
-/**
- *
- * @export
- */
-export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
-/**
- *
- * @export
- */
-export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
-/**
- *
- * @export
- */
-export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
-/**
- *
- * @export
- */
-export declare const toPathString: (url: URL) => string;
-/**
- *
- * @export
- */
-export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => (axios?: AxiosInstance, basePath?: string) => Promise<import("axios").AxiosResponse<any>>;
+/**
+ * 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 { RequestArgs } from "./base";
+import type { AxiosInstance, AxiosResponse } from 'axios';
+/**
+ *
+ * @export
+ */
+export declare const DUMMY_BASE_URL = "https://example.com";
+/**
+ *
+ * @throws {RequiredError}
+ * @export
+ */
+export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
+/**
+ *
+ * @export
+ */
+export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
+/**
+ *
+ * @export
+ */
+export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
+/**
+ *
+ * @export
+ */
+export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
+/**
+ *
+ * @export
+ */
+export declare const toPathString: (url: URL) => string;
+/**
+ *
+ * @export
+ */
+export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T, any>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;

package/dist/types/Coscine.Api/configuration.d.ts

@@ -1,83 +1,91 @@
-/**
- * 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.
- */
-export interface ConfigurationParameters {
-    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
-    username?: string;
-    password?: string;
-    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
-    basePath?: string;
-    baseOptions?: any;
-    formDataCtor?: new () => any;
-}
-export declare class Configuration {
-    /**
-     * parameter for apiKey security
-     * @param name security name
-     * @memberof Configuration
-     */
-    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
-    /**
-     * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
-     */
-    username?: string;
-    /**
-     * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
-     */
-    password?: string;
-    /**
-     * parameter for oauth2 security
-     * @param name security name
-     * @param scopes oauth2 scope
-     * @memberof Configuration
-     */
-    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
-    /**
-     * override base path
-     *
-     * @type {string}
-     * @memberof Configuration
-     */
-    basePath?: string;
-    /**
-     * base options for axios calls
-     *
-     * @type {any}
-     * @memberof Configuration
-     */
-    baseOptions?: any;
-    /**
-     * The FormData constructor that will be used to create multipart form data
-     * requests. You can inject this here so that execution environments that
-     * do not support the FormData class can still run the generated client.
-     *
-     * @type {new () => FormData}
-     */
-    formDataCtor?: new () => any;
-    constructor(param?: ConfigurationParameters);
-    /**
-     * Check if the given MIME is a JSON MIME.
-     * JSON MIME examples:
-     *   application/json
-     *   application/json; charset=UTF8
-     *   APPLICATION/JSON
-     *   application/vnd.company+json
-     * @param mime - MIME (Multipurpose Internet Mail Extensions)
-     * @return True if the given MIME is JSON, false otherwise.
-     */
-    isJsonMime(mime: string): boolean;
-}
+/**
+ * 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.
+ */
+export interface ConfigurationParameters {
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    username?: string;
+    password?: string;
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    basePath?: string;
+    serverIndex?: number;
+    baseOptions?: any;
+    formDataCtor?: new () => any;
+}
+export declare class Configuration {
+    /**
+     * parameter for apiKey security
+     * @param name security name
+     * @memberof Configuration
+     */
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    username?: string;
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    password?: string;
+    /**
+     * parameter for oauth2 security
+     * @param name security name
+     * @param scopes oauth2 scope
+     * @memberof Configuration
+     */
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    /**
+     * override base path
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    basePath?: string;
+    /**
+     * override server index
+     *
+     * @type {number}
+     * @memberof Configuration
+     */
+    serverIndex?: number;
+    /**
+     * base options for axios calls
+     *
+     * @type {any}
+     * @memberof Configuration
+     */
+    baseOptions?: any;
+    /**
+     * The FormData constructor that will be used to create multipart form data
+     * requests. You can inject this here so that execution environments that
+     * do not support the FormData class can still run the generated client.
+     *
+     * @type {new () => FormData}
+     */
+    formDataCtor?: new () => any;
+    constructor(param?: ConfigurationParameters);
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    isJsonMime(mime: string): boolean;
+}

package/dist/types/Coscine.Api/index.d.ts

@@ -1,13 +1,14 @@
-/**
- * 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.
- */
-export * from "./api";
-export * from "./configuration";
+/**
+ * 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.
+ */
+export * from "./api";
+export * from "./configuration";
+export * from "./@coscine/model";

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

@@ -0,0 +1,99 @@
+/**
+ * Coscine.Api.STS
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 0.0.0
+ *
+ *
+ * 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 { LoginUrls } from '../../@coscine/model';
+/**
+ * AccountApi - axios parameter creator
+ * @export
+ */
+export declare const AccountApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Return relevant URLs for logging the user in
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    accountGetLoginUrls: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Route for logging the user out of Coscine
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    accountLogout: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * AccountApi - functional programming interface
+ * @export
+ */
+export declare const AccountApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Return relevant URLs for logging the user in
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    accountGetLoginUrls(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LoginUrls>>;
+    /**
+     *
+     * @summary Route for logging the user out of Coscine
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    accountLogout(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
+};
+/**
+ * AccountApi - factory interface
+ * @export
+ */
+export declare const AccountApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Return relevant URLs for logging the user in
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    accountGetLoginUrls(options?: AxiosRequestConfig): AxiosPromise<LoginUrls>;
+    /**
+     *
+     * @summary Route for logging the user out of Coscine
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    accountLogout(options?: AxiosRequestConfig): AxiosPromise<File>;
+};
+/**
+ * AccountApi - object-oriented interface
+ * @export
+ * @class AccountApi
+ * @extends {BaseAPI}
+ */
+export declare class AccountApi extends BaseAPI {
+    /**
+     *
+     * @summary Return relevant URLs for logging the user in
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountApi
+     */
+    accountGetLoginUrls(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LoginUrls, any>>;
+    /**
+     *
+     * @summary Route for logging the user out of Coscine
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountApi
+     */
+    accountLogout(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
+}

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

@@ -0,0 +1,69 @@
+/**
+ * Coscine.Api.STS
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 0.0.0
+ *
+ *
+ * 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';
+/**
+ * HomeApi - axios parameter creator
+ * @export
+ */
+export declare const HomeApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary The controller that the user is automatically entering when accesing the route .../coscine/api/Coscine.STS/
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    homeIndex: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * HomeApi - functional programming interface
+ * @export
+ */
+export declare const HomeApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary The controller that the user is automatically entering when accesing the route .../coscine/api/Coscine.STS/
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    homeIndex(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
+};
+/**
+ * HomeApi - factory interface
+ * @export
+ */
+export declare const HomeApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary The controller that the user is automatically entering when accesing the route .../coscine/api/Coscine.STS/
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    homeIndex(options?: AxiosRequestConfig): AxiosPromise<File>;
+};
+/**
+ * HomeApi - object-oriented interface
+ * @export
+ * @class HomeApi
+ * @extends {BaseAPI}
+ */
+export declare class HomeApi extends BaseAPI {
+    /**
+     *
+     * @summary The controller that the user is automatically entering when accesing the route .../coscine/api/Coscine.STS/
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof HomeApi
+     */
+    homeIndex(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
+}