@coscine/api-client 3.8.0 → 3.10.0

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

@@ -0,0 +1,219 @@
+/**
+ * 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, RawAxiosRequestConfig } from 'axios';
+import { type RequestArgs, BaseAPI } from '../../base';
+/**
+ * SelfSessionApi - axios parameter creator
+ * @export
+ */
+export declare const SelfSessionApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Initiate the Log out workflow.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2SelfSessionLogoutPost: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2SelfSessionOptions: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Initiate the login workflow with the default (NFDI4Ing AAI) provider.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    login: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Initiate the login workflow with specific provider.
+     * @param {string} externalAuthenticatorId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    loginWithProvider: (externalAuthenticatorId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Initiate the merge workflow with specific provider.
+     * @param {string} externalAuthenticatorId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    merge: (externalAuthenticatorId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * SelfSessionApi - functional programming interface
+ * @export
+ */
+export declare const SelfSessionApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Initiate the Log out workflow.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2SelfSessionLogoutPost(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2SelfSessionOptions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Initiate the login workflow with the default (NFDI4Ing AAI) provider.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    login(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Initiate the login workflow with specific provider.
+     * @param {string} externalAuthenticatorId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    loginWithProvider(externalAuthenticatorId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Initiate the merge workflow with specific provider.
+     * @param {string} externalAuthenticatorId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    merge(externalAuthenticatorId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+};
+/**
+ * SelfSessionApi - factory interface
+ * @export
+ */
+export declare const SelfSessionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Initiate the Log out workflow.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2SelfSessionLogoutPost(options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2SelfSessionOptions(options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Initiate the login workflow with the default (NFDI4Ing AAI) provider.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    login(options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Initiate the login workflow with specific provider.
+     * @param {SelfSessionApiLoginWithProviderRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    loginWithProvider(requestParameters: SelfSessionApiLoginWithProviderRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Initiate the merge workflow with specific provider.
+     * @param {SelfSessionApiMergeRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    merge(requestParameters: SelfSessionApiMergeRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+};
+/**
+ * Request parameters for loginWithProvider operation in SelfSessionApi.
+ * @export
+ * @interface SelfSessionApiLoginWithProviderRequest
+ */
+export interface SelfSessionApiLoginWithProviderRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof SelfSessionApiLoginWithProvider
+     */
+    readonly externalAuthenticatorId: string;
+}
+/**
+ * Request parameters for merge operation in SelfSessionApi.
+ * @export
+ * @interface SelfSessionApiMergeRequest
+ */
+export interface SelfSessionApiMergeRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof SelfSessionApiMerge
+     */
+    readonly externalAuthenticatorId: string;
+}
+/**
+ * SelfSessionApi - object-oriented interface
+ * @export
+ * @class SelfSessionApi
+ * @extends {BaseAPI}
+ */
+export declare class SelfSessionApi extends BaseAPI {
+    /**
+     *
+     * @summary Initiate the Log out workflow.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SelfSessionApi
+     */
+    apiV2SelfSessionLogoutPost(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SelfSessionApi
+     */
+    apiV2SelfSessionOptions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     *
+     * @summary Initiate the login workflow with the default (NFDI4Ing AAI) provider.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SelfSessionApi
+     */
+    login(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     *
+     * @summary Initiate the login workflow with specific provider.
+     * @param {SelfSessionApiLoginWithProviderRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SelfSessionApi
+     */
+    loginWithProvider(requestParameters: SelfSessionApiLoginWithProviderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     *
+     * @summary Initiate the merge workflow with specific provider.
+     * @param {SelfSessionApiMergeRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SelfSessionApi
+     */
+    merge(requestParameters: SelfSessionApiMergeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+}

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

@@ -10,10 +10,10 @@
  * Do not edit the class manually.
  */
 import type { Configuration } from '../../configuration';
-import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
-import { RequestArgs, BaseAPI } from '../../base';
-import { TitleDtoIEnumerableResponse } from '../../@coscine/model';
-import { TitleDtoResponse } from '../../@coscine/model';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { type RequestArgs, BaseAPI } from '../../base';
+import type { TitleDtoIEnumerableResponse } from '../../@coscine/model';
+import type { TitleDtoResponse } from '../../@coscine/model';
 /**
  * TitleApi - axios parameter creator
  * @export
@@ -25,7 +25,7 @@ export declare const TitleApiAxiosParamCreator: (configuration?: Configuration)
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    apiV2TitlesOptions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    apiV2TitlesOptions: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Retrieves a title by ID.
@@ -33,7 +33,7 @@ export declare const TitleApiAxiosParamCreator: (configuration?: Configuration)
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getTitle: (titleId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getTitle: (titleId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Retrieves all titles.
@@ -43,7 +43,7 @@ export declare const TitleApiAxiosParamCreator: (configuration?: Configuration)
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getTitles: (pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getTitles: (pageNumber?: number, pageSize?: number, orderBy?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * TitleApi - functional programming interface
@@ -56,7 +56,7 @@ export declare const TitleApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    apiV2TitlesOptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    apiV2TitlesOptions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      *
      * @summary Retrieves a title by ID.
@@ -64,7 +64,7 @@ export declare const TitleApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getTitle(titleId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TitleDtoResponse>>;
+    getTitle(titleId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TitleDtoResponse>>;
     /**
      *
      * @summary Retrieves all titles.
@@ -74,7 +74,7 @@ export declare const TitleApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getTitles(pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TitleDtoIEnumerableResponse>>;
+    getTitles(pageNumber?: number, pageSize?: number, orderBy?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TitleDtoIEnumerableResponse>>;
 };
 /**
  * TitleApi - factory interface
@@ -87,7 +87,7 @@ export declare const TitleApiFactory: (configuration?: Configuration, basePath?:
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    apiV2TitlesOptions(options?: AxiosRequestConfig): AxiosPromise<void>;
+    apiV2TitlesOptions(options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      *
      * @summary Retrieves a title by ID.
@@ -95,7 +95,7 @@ export declare const TitleApiFactory: (configuration?: Configuration, basePath?:
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getTitle(requestParameters: TitleApiGetTitleRequest, options?: AxiosRequestConfig): AxiosPromise<TitleDtoResponse>;
+    getTitle(requestParameters: TitleApiGetTitleRequest, options?: RawAxiosRequestConfig): AxiosPromise<TitleDtoResponse>;
     /**
      *
      * @summary Retrieves all titles.
@@ -103,7 +103,7 @@ export declare const TitleApiFactory: (configuration?: Configuration, basePath?:
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getTitles(requestParameters?: TitleApiGetTitlesRequest, options?: AxiosRequestConfig): AxiosPromise<TitleDtoIEnumerableResponse>;
+    getTitles(requestParameters?: TitleApiGetTitlesRequest, options?: RawAxiosRequestConfig): AxiosPromise<TitleDtoIEnumerableResponse>;
 };
 /**
  * Request parameters for getTitle operation in TitleApi.
@@ -157,7 +157,7 @@ export declare class TitleApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof TitleApi
      */
-    apiV2TitlesOptions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    apiV2TitlesOptions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      *
      * @summary Retrieves a title by ID.
@@ -166,7 +166,7 @@ export declare class TitleApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof TitleApi
      */
-    getTitle(requestParameters: TitleApiGetTitleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TitleDtoResponse, any>>;
+    getTitle(requestParameters: TitleApiGetTitleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TitleDtoResponse, any>>;
     /**
      *
      * @summary Retrieves all titles.
@@ -175,5 +175,5 @@ export declare class TitleApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof TitleApi
      */
-    getTitles(requestParameters?: TitleApiGetTitlesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TitleDtoIEnumerableResponse, any>>;
+    getTitles(requestParameters?: TitleApiGetTitlesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TitleDtoIEnumerableResponse, any>>;
 }

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

@@ -10,9 +10,9 @@
  * Do not edit the class manually.
  */
 import type { Configuration } from '../../configuration';
-import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
-import { RequestArgs, BaseAPI } from '../../base';
-import { TermsOfServiceDtoResponse } from '../../@coscine/model';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { type RequestArgs, BaseAPI } from '../../base';
+import type { TermsOfServiceDtoResponse } from '../../@coscine/model';
 /**
  * TosApi - axios parameter creator
  * @export
@@ -24,14 +24,14 @@ export declare const TosApiAxiosParamCreator: (configuration?: Configuration) =>
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    apiV2TosOptions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    apiV2TosOptions: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Retrieves the current Terms of Service version.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getTos: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getTos: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * TosApi - functional programming interface
@@ -44,14 +44,14 @@ export declare const TosApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    apiV2TosOptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    apiV2TosOptions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      *
      * @summary Retrieves the current Terms of Service version.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getTos(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TermsOfServiceDtoResponse>>;
+    getTos(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TermsOfServiceDtoResponse>>;
 };
 /**
  * TosApi - factory interface
@@ -64,14 +64,14 @@ export declare const TosApiFactory: (configuration?: Configuration, basePath?: s
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    apiV2TosOptions(options?: AxiosRequestConfig): AxiosPromise<void>;
+    apiV2TosOptions(options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      *
      * @summary Retrieves the current Terms of Service version.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getTos(options?: AxiosRequestConfig): AxiosPromise<TermsOfServiceDtoResponse>;
+    getTos(options?: RawAxiosRequestConfig): AxiosPromise<TermsOfServiceDtoResponse>;
 };
 /**
  * TosApi - object-oriented interface
@@ -87,7 +87,7 @@ export declare class TosApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof TosApi
      */
-    apiV2TosOptions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    apiV2TosOptions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      *
      * @summary Retrieves the current Terms of Service version.
@@ -95,5 +95,5 @@ export declare class TosApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof TosApi
      */
-    getTos(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TermsOfServiceDtoResponse, any>>;
+    getTos(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TermsOfServiceDtoResponse, any>>;
 }