@coscine/api-client 2.5.0 → 2.6.0

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

@@ -2,7 +2,7 @@
  * Coscine.Api.Notices
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.3.2
+ * The version of the OpenAPI document: 2.4.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -2,7 +2,7 @@
  * Coscine.Api.Notices
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.3.2
+ * The version of the OpenAPI document: 2.4.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/types/Coscine.Api.Pid/api.d.ts

@@ -2,7 +2,7 @@
  * Coscine.Api.Pid
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.3.2
+ * The version of the OpenAPI document: 2.4.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -2,7 +2,7 @@
  * Coscine.Api.Pid
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.3.2
+ * The version of the OpenAPI document: 2.4.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -2,7 +2,7 @@
  * Coscine.Api.Pid
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.3.2
+ * The version of the OpenAPI document: 2.4.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -2,7 +2,7 @@
  * Coscine.Api.Pid
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.3.2
+ * The version of the OpenAPI document: 2.4.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -2,7 +2,7 @@
  * Coscine.Api.Pid
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.3.2
+ * The version of the OpenAPI document: 2.4.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/types/Coscine.Api.Project/api.d.ts

@@ -2,7 +2,7 @@
  * Coscine.Api.Project
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 4.0.0
+ * The version of the OpenAPI document: 4.1.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -2,7 +2,7 @@
  * Coscine.Api.Project
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 4.0.0
+ * The version of the OpenAPI document: 4.1.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -2,7 +2,7 @@
  * Coscine.Api.Project
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 4.0.0
+ * The version of the OpenAPI document: 4.1.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -2,7 +2,7 @@
  * Coscine.Api.Project
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 4.0.0
+ * The version of the OpenAPI document: 4.1.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -2,7 +2,7 @@
  * Coscine.Api.Project
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 4.0.0
+ * The version of the OpenAPI document: 4.1.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/types/Coscine.Api.Resources/api.d.ts

@@ -2,7 +2,7 @@
  * Coscine.Api.Resources
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 3.0.0
+ * The version of the OpenAPI document: 3.0.7
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -2,7 +2,7 @@
  * Coscine.Api.Resources
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 3.0.0
+ * The version of the OpenAPI document: 3.0.7
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -2,7 +2,7 @@
  * Coscine.Api.Resources
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 3.0.0
+ * The version of the OpenAPI document: 3.0.7
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -2,7 +2,7 @@
  * Coscine.Api.Resources
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 3.0.0
+ * The version of the OpenAPI document: 3.0.7
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -2,7 +2,7 @@
  * Coscine.Api.Resources
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 3.0.0
+ * The version of the OpenAPI document: 3.0.7
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/types/Coscine.Api.STS/api.d.ts

@@ -0,0 +1,465 @@
+/**
+ * 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 { Configuration } from './configuration';
+import { AxiosPromise, AxiosInstance } from 'axios';
+import { RequestArgs, BaseAPI } from './base';
+/**
+ *
+ * @export
+ * @interface EntityId
+ */
+export interface EntityId {
+    /**
+     *
+     * @type {string}
+     * @memberof EntityId
+     */
+    id?: string | null;
+}
+/**
+ *
+ * @export
+ * @interface LoginUrls
+ */
+export interface LoginUrls {
+    /**
+     *
+     * @type {string}
+     * @memberof LoginUrls
+     */
+    orcidUrl?: string | null;
+    /**
+     *
+     * @type {Array<EntityId>}
+     * @memberof LoginUrls
+     */
+    identityProviders?: Array<EntityId> | null;
+}
+/**
+ * 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?: any) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Route for logging the user out of Coscine
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    accountLogout: (options?: any) => 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?: any): 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?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
+};
+/**
+ * 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?: any): AxiosPromise<LoginUrls>;
+    /**
+     *
+     * @summary Route for logging the user out of Coscine
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    accountLogout(options?: any): AxiosPromise<any>;
+};
+/**
+ * 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?: any): Promise<import("axios").AxiosResponse<LoginUrls>>;
+    /**
+     *
+     * @summary Route for logging the user out of Coscine
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountApi
+     */
+    accountLogout(options?: any): Promise<import("axios").AxiosResponse<any>>;
+}
+/**
+ * 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?: any) => 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?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
+};
+/**
+ * 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?: any): AxiosPromise<any>;
+};
+/**
+ * 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?: any): Promise<import("axios").AxiosResponse<any>>;
+}
+/**
+ * MergeApi - axios parameter creator
+ * @export
+ */
+export declare const MergeApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @param {string} [returnUrl]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    mergeCallback: (returnUrl?: string, options?: any) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {string} [returnUrl]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    mergeLogin: (returnUrl?: string, options?: any) => Promise<RequestArgs>;
+};
+/**
+ * MergeApi - functional programming interface
+ * @export
+ */
+export declare const MergeApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @param {string} [returnUrl]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    mergeCallback(returnUrl?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
+    /**
+     *
+     * @param {string} [returnUrl]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    mergeLogin(returnUrl?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
+};
+/**
+ * MergeApi - factory interface
+ * @export
+ */
+export declare const MergeApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @param {string} [returnUrl]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    mergeCallback(returnUrl?: string, options?: any): AxiosPromise<any>;
+    /**
+     *
+     * @param {string} [returnUrl]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    mergeLogin(returnUrl?: string, options?: any): AxiosPromise<any>;
+};
+/**
+ * MergeApi - object-oriented interface
+ * @export
+ * @class MergeApi
+ * @extends {BaseAPI}
+ */
+export declare class MergeApi extends BaseAPI {
+    /**
+     *
+     * @param {string} [returnUrl]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MergeApi
+     */
+    mergeCallback(returnUrl?: string, options?: any): Promise<import("axios").AxiosResponse<any>>;
+    /**
+     *
+     * @param {string} [returnUrl]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MergeApi
+     */
+    mergeLogin(returnUrl?: string, options?: any): Promise<import("axios").AxiosResponse<any>>;
+}
+/**
+ * ORCiDApi - axios parameter creator
+ * @export
+ */
+export declare const ORCiDApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary ORCiD Login Route
+     * @param {string} [returnUrl] URL to be redirected to
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    oRCiDLoginGET: (returnUrl?: string, options?: any) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Execute ORCiD validation and login
+     * @param {string} [oRCiDJWT]
+     * @param {string} [returnUrl] URL to be redirected to
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    oRCiDLoginPOST: (oRCiDJWT?: string, returnUrl?: string, options?: any) => Promise<RequestArgs>;
+};
+/**
+ * ORCiDApi - functional programming interface
+ * @export
+ */
+export declare const ORCiDApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary ORCiD Login Route
+     * @param {string} [returnUrl] URL to be redirected to
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    oRCiDLoginGET(returnUrl?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
+    /**
+     *
+     * @summary Execute ORCiD validation and login
+     * @param {string} [oRCiDJWT]
+     * @param {string} [returnUrl] URL to be redirected to
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    oRCiDLoginPOST(oRCiDJWT?: string, returnUrl?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
+};
+/**
+ * ORCiDApi - factory interface
+ * @export
+ */
+export declare const ORCiDApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary ORCiD Login Route
+     * @param {string} [returnUrl] URL to be redirected to
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    oRCiDLoginGET(returnUrl?: string, options?: any): AxiosPromise<any>;
+    /**
+     *
+     * @summary Execute ORCiD validation and login
+     * @param {string} [oRCiDJWT]
+     * @param {string} [returnUrl] URL to be redirected to
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    oRCiDLoginPOST(oRCiDJWT?: string, returnUrl?: string, options?: any): AxiosPromise<any>;
+};
+/**
+ * ORCiDApi - object-oriented interface
+ * @export
+ * @class ORCiDApi
+ * @extends {BaseAPI}
+ */
+export declare class ORCiDApi extends BaseAPI {
+    /**
+     *
+     * @summary ORCiD Login Route
+     * @param {string} [returnUrl] URL to be redirected to
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ORCiDApi
+     */
+    oRCiDLoginGET(returnUrl?: string, options?: any): Promise<import("axios").AxiosResponse<any>>;
+    /**
+     *
+     * @summary Execute ORCiD validation and login
+     * @param {string} [oRCiDJWT]
+     * @param {string} [returnUrl] URL to be redirected to
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ORCiDApi
+     */
+    oRCiDLoginPOST(oRCiDJWT?: string, returnUrl?: string, options?: any): Promise<import("axios").AxiosResponse<any>>;
+}
+/**
+ * ShibbolethApi - axios parameter creator
+ * @export
+ */
+export declare const ShibbolethApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Callback method to catch the login
+     * @param {string} [returnUrl] URL to be redirected to
+     * @param {string} [remoteError] Erros on remote login
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    shibbolethCallback: (returnUrl?: string, remoteError?: string, options?: any) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary This method is the central route for logging into an identity provider. On default, the user is redirected to the WAFY of the DFN-AAI. Setting the \"entityId\" parameter allows the application to redirect to a specific identity provider defined by DFN-AAI.
+     * @param {string} [returnUrl] URL to be redirected to
+     * @param {string} [entityId] Specific Identitiy Provider to be redirect to
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    shibbolethLogin: (returnUrl?: string, entityId?: string, options?: any) => Promise<RequestArgs>;
+};
+/**
+ * ShibbolethApi - functional programming interface
+ * @export
+ */
+export declare const ShibbolethApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Callback method to catch the login
+     * @param {string} [returnUrl] URL to be redirected to
+     * @param {string} [remoteError] Erros on remote login
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    shibbolethCallback(returnUrl?: string, remoteError?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
+    /**
+     *
+     * @summary This method is the central route for logging into an identity provider. On default, the user is redirected to the WAFY of the DFN-AAI. Setting the \"entityId\" parameter allows the application to redirect to a specific identity provider defined by DFN-AAI.
+     * @param {string} [returnUrl] URL to be redirected to
+     * @param {string} [entityId] Specific Identitiy Provider to be redirect to
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    shibbolethLogin(returnUrl?: string, entityId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
+};
+/**
+ * ShibbolethApi - factory interface
+ * @export
+ */
+export declare const ShibbolethApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Callback method to catch the login
+     * @param {string} [returnUrl] URL to be redirected to
+     * @param {string} [remoteError] Erros on remote login
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    shibbolethCallback(returnUrl?: string, remoteError?: string, options?: any): AxiosPromise<any>;
+    /**
+     *
+     * @summary This method is the central route for logging into an identity provider. On default, the user is redirected to the WAFY of the DFN-AAI. Setting the \"entityId\" parameter allows the application to redirect to a specific identity provider defined by DFN-AAI.
+     * @param {string} [returnUrl] URL to be redirected to
+     * @param {string} [entityId] Specific Identitiy Provider to be redirect to
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    shibbolethLogin(returnUrl?: string, entityId?: string, options?: any): AxiosPromise<any>;
+};
+/**
+ * ShibbolethApi - object-oriented interface
+ * @export
+ * @class ShibbolethApi
+ * @extends {BaseAPI}
+ */
+export declare class ShibbolethApi extends BaseAPI {
+    /**
+     *
+     * @summary Callback method to catch the login
+     * @param {string} [returnUrl] URL to be redirected to
+     * @param {string} [remoteError] Erros on remote login
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ShibbolethApi
+     */
+    shibbolethCallback(returnUrl?: string, remoteError?: string, options?: any): Promise<import("axios").AxiosResponse<any>>;
+    /**
+     *
+     * @summary This method is the central route for logging into an identity provider. On default, the user is redirected to the WAFY of the DFN-AAI. Setting the \"entityId\" parameter allows the application to redirect to a specific identity provider defined by DFN-AAI.
+     * @param {string} [returnUrl] URL to be redirected to
+     * @param {string} [entityId] Specific Identitiy Provider to be redirect to
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ShibbolethApi
+     */
+    shibbolethLogin(returnUrl?: string, entityId?: string, options?: any): Promise<import("axios").AxiosResponse<any>>;
+}