@coscine/api-client 3.3.1 → 3.3.2-package.0

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

@@ -1,465 +1,16 @@
-/**
- * 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>>;
-}
+/**
+ * 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.
+ */
+export * from './@coscine/api/account-api';
+export * from './@coscine/api/home-api';
+export * from './@coscine/api/merge-api';
+export * from './@coscine/api/orci-dapi';
+export * from './@coscine/api/shibboleth-api';

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

@@ -1,55 +1,66 @@
-/**
- * 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 { 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.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 { 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 {};