@coscine/api-client 3.3.1 → 3.4.0

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

@@ -0,0 +1,124 @@
+/**
+ * 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';
+/**
+ * MergeApi - axios parameter creator
+ * @export
+ */
+export declare const MergeApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @param {string | null} [returnUrl]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    mergeCallback: (returnUrl?: string | null, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {string | null} [returnUrl]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    mergeLogin: (returnUrl?: string | null, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * MergeApi - functional programming interface
+ * @export
+ */
+export declare const MergeApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @param {string | null} [returnUrl]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    mergeCallback(returnUrl?: string | null, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
+    /**
+     *
+     * @param {string | null} [returnUrl]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    mergeLogin(returnUrl?: string | null, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
+};
+/**
+ * MergeApi - factory interface
+ * @export
+ */
+export declare const MergeApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @param {MergeApiMergeCallbackRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    mergeCallback(requestParameters?: MergeApiMergeCallbackRequest, options?: AxiosRequestConfig): AxiosPromise<File>;
+    /**
+     *
+     * @param {MergeApiMergeLoginRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    mergeLogin(requestParameters?: MergeApiMergeLoginRequest, options?: AxiosRequestConfig): AxiosPromise<File>;
+};
+/**
+ * Request parameters for mergeCallback operation in MergeApi.
+ * @export
+ * @interface MergeApiMergeCallbackRequest
+ */
+export interface MergeApiMergeCallbackRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof MergeApiMergeCallback
+     */
+    readonly returnUrl?: string | null;
+}
+/**
+ * Request parameters for mergeLogin operation in MergeApi.
+ * @export
+ * @interface MergeApiMergeLoginRequest
+ */
+export interface MergeApiMergeLoginRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof MergeApiMergeLogin
+     */
+    readonly returnUrl?: string | null;
+}
+/**
+ * MergeApi - object-oriented interface
+ * @export
+ * @class MergeApi
+ * @extends {BaseAPI}
+ */
+export declare class MergeApi extends BaseAPI {
+    /**
+     *
+     * @param {MergeApiMergeCallbackRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MergeApi
+     */
+    mergeCallback(requestParameters?: MergeApiMergeCallbackRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
+    /**
+     *
+     * @param {MergeApiMergeLoginRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MergeApi
+     */
+    mergeLogin(requestParameters?: MergeApiMergeLoginRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
+}

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

@@ -0,0 +1,140 @@
+/**
+ * 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';
+/**
+ * ORCiDApi - axios parameter creator
+ * @export
+ */
+export declare const ORCiDApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary ORCiD Login Route
+     * @param {string | null} [returnUrl] URL to be redirected to
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    oRCiDLoginGET: (returnUrl?: string | null, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Execute ORCiD validation and login
+     * @param {string | null} [oRCiDJWT]
+     * @param {string | null} [returnUrl] URL to be redirected to
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    oRCiDLoginPOST: (oRCiDJWT?: string | null, returnUrl?: string | null, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ORCiDApi - functional programming interface
+ * @export
+ */
+export declare const ORCiDApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary ORCiD Login Route
+     * @param {string | null} [returnUrl] URL to be redirected to
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    oRCiDLoginGET(returnUrl?: string | null, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
+    /**
+     *
+     * @summary Execute ORCiD validation and login
+     * @param {string | null} [oRCiDJWT]
+     * @param {string | null} [returnUrl] URL to be redirected to
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    oRCiDLoginPOST(oRCiDJWT?: string | null, returnUrl?: string | null, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
+};
+/**
+ * ORCiDApi - factory interface
+ * @export
+ */
+export declare const ORCiDApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary ORCiD Login Route
+     * @param {ORCiDApiORCiDLoginGETRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    oRCiDLoginGET(requestParameters?: ORCiDApiORCiDLoginGETRequest, options?: AxiosRequestConfig): AxiosPromise<File>;
+    /**
+     *
+     * @summary Execute ORCiD validation and login
+     * @param {ORCiDApiORCiDLoginPOSTRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    oRCiDLoginPOST(requestParameters?: ORCiDApiORCiDLoginPOSTRequest, options?: AxiosRequestConfig): AxiosPromise<File>;
+};
+/**
+ * Request parameters for oRCiDLoginGET operation in ORCiDApi.
+ * @export
+ * @interface ORCiDApiORCiDLoginGETRequest
+ */
+export interface ORCiDApiORCiDLoginGETRequest {
+    /**
+     * URL to be redirected to
+     * @type {string}
+     * @memberof ORCiDApiORCiDLoginGET
+     */
+    readonly returnUrl?: string | null;
+}
+/**
+ * Request parameters for oRCiDLoginPOST operation in ORCiDApi.
+ * @export
+ * @interface ORCiDApiORCiDLoginPOSTRequest
+ */
+export interface ORCiDApiORCiDLoginPOSTRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof ORCiDApiORCiDLoginPOST
+     */
+    readonly oRCiDJWT?: string | null;
+    /**
+     * URL to be redirected to
+     * @type {string}
+     * @memberof ORCiDApiORCiDLoginPOST
+     */
+    readonly returnUrl?: string | null;
+}
+/**
+ * ORCiDApi - object-oriented interface
+ * @export
+ * @class ORCiDApi
+ * @extends {BaseAPI}
+ */
+export declare class ORCiDApi extends BaseAPI {
+    /**
+     *
+     * @summary ORCiD Login Route
+     * @param {ORCiDApiORCiDLoginGETRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ORCiDApi
+     */
+    oRCiDLoginGET(requestParameters?: ORCiDApiORCiDLoginGETRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
+    /**
+     *
+     * @summary Execute ORCiD validation and login
+     * @param {ORCiDApiORCiDLoginPOSTRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ORCiDApi
+     */
+    oRCiDLoginPOST(requestParameters?: ORCiDApiORCiDLoginPOSTRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
+}

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

@@ -0,0 +1,148 @@
+/**
+ * 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';
+/**
+ * ShibbolethApi - axios parameter creator
+ * @export
+ */
+export declare const ShibbolethApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Callback method to catch the login
+     * @param {string | null} [returnUrl] URL to be redirected to
+     * @param {string | null} [remoteError] Erros on remote login
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    shibbolethCallback: (returnUrl?: string | null, remoteError?: string | null, options?: AxiosRequestConfig) => 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 | null} [returnUrl] URL to be redirected to
+     * @param {string | null} [entityId] Specific Identitiy Provider to be redirect to
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    shibbolethLogin: (returnUrl?: string | null, entityId?: string | null, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ShibbolethApi - functional programming interface
+ * @export
+ */
+export declare const ShibbolethApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Callback method to catch the login
+     * @param {string | null} [returnUrl] URL to be redirected to
+     * @param {string | null} [remoteError] Erros on remote login
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    shibbolethCallback(returnUrl?: string | null, remoteError?: string | null, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
+    /**
+     *
+     * @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 | null} [returnUrl] URL to be redirected to
+     * @param {string | null} [entityId] Specific Identitiy Provider to be redirect to
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    shibbolethLogin(returnUrl?: string | null, entityId?: string | null, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
+};
+/**
+ * ShibbolethApi - factory interface
+ * @export
+ */
+export declare const ShibbolethApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Callback method to catch the login
+     * @param {ShibbolethApiShibbolethCallbackRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    shibbolethCallback(requestParameters?: ShibbolethApiShibbolethCallbackRequest, options?: AxiosRequestConfig): AxiosPromise<File>;
+    /**
+     *
+     * @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 {ShibbolethApiShibbolethLoginRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    shibbolethLogin(requestParameters?: ShibbolethApiShibbolethLoginRequest, options?: AxiosRequestConfig): AxiosPromise<File>;
+};
+/**
+ * Request parameters for shibbolethCallback operation in ShibbolethApi.
+ * @export
+ * @interface ShibbolethApiShibbolethCallbackRequest
+ */
+export interface ShibbolethApiShibbolethCallbackRequest {
+    /**
+     * URL to be redirected to
+     * @type {string}
+     * @memberof ShibbolethApiShibbolethCallback
+     */
+    readonly returnUrl?: string | null;
+    /**
+     * Erros on remote login
+     * @type {string}
+     * @memberof ShibbolethApiShibbolethCallback
+     */
+    readonly remoteError?: string | null;
+}
+/**
+ * Request parameters for shibbolethLogin operation in ShibbolethApi.
+ * @export
+ * @interface ShibbolethApiShibbolethLoginRequest
+ */
+export interface ShibbolethApiShibbolethLoginRequest {
+    /**
+     * URL to be redirected to
+     * @type {string}
+     * @memberof ShibbolethApiShibbolethLogin
+     */
+    readonly returnUrl?: string | null;
+    /**
+     * Specific Identitiy Provider to be redirect to
+     * @type {string}
+     * @memberof ShibbolethApiShibbolethLogin
+     */
+    readonly entityId?: string | null;
+}
+/**
+ * ShibbolethApi - object-oriented interface
+ * @export
+ * @class ShibbolethApi
+ * @extends {BaseAPI}
+ */
+export declare class ShibbolethApi extends BaseAPI {
+    /**
+     *
+     * @summary Callback method to catch the login
+     * @param {ShibbolethApiShibbolethCallbackRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ShibbolethApi
+     */
+    shibbolethCallback(requestParameters?: ShibbolethApiShibbolethCallbackRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<File, 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 {ShibbolethApiShibbolethLoginRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ShibbolethApi
+     */
+    shibbolethLogin(requestParameters?: ShibbolethApiShibbolethLoginRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
+}

package/dist/types/Coscine.Api.STS/@coscine/model/entity-id.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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
+ * @interface EntityId
+ */
+export interface EntityId {
+    /**
+     *
+     * @type {string}
+     * @memberof EntityId
+     */
+    'id'?: string | null;
+}

package/dist/types/Coscine.Api.STS/@coscine/model/index.d.ts

@@ -0,0 +1,2 @@
+export * from './entity-id';
+export * from './login-urls';

package/dist/types/Coscine.Api.STS/@coscine/model/login-urls.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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 { EntityId } from './entity-id';
+/**
+ *
+ * @export
+ * @interface LoginUrls
+ */
+export interface LoginUrls {
+    /**
+     *
+     * @type {string}
+     * @memberof LoginUrls
+     */
+    'orcidUrl'?: string | null;
+    /**
+     *
+     * @type {Array<EntityId>}
+     * @memberof LoginUrls
+     */
+    'identityProviders'?: Array<EntityId> | null;
+}