@coscine/api-client 2.5.0 → 2.6.0

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

@@ -0,0 +1,55 @@
+/**
+ * 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);
+}

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

@@ -0,0 +1,65 @@
+/**
+ * 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 { 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>>;

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

@@ -0,0 +1,83 @@
+/**
+ * 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 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;
+}

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

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

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

@@ -2,7 +2,7 @@
  * Coscine.Api.Search
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 1.4.0
+ * The version of the OpenAPI document: 1.5.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -67,7 +67,7 @@ export interface SearchResult {
 export declare const SearchApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
      *
-     * @summary Search
+     * @summary Search Elasticsearch
      * @param {string} [query] Elasticsearch query
      * @param {boolean} [user] Specify user or only public metadata records could be found
      * @param {boolean} [adv] Set true for advanced Elasticsearch search syntax
@@ -84,7 +84,7 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
 export declare const SearchApiFp: (configuration?: Configuration) => {
     /**
      *
-     * @summary Search
+     * @summary Search Elasticsearch
      * @param {string} [query] Elasticsearch query
      * @param {boolean} [user] Specify user or only public metadata records could be found
      * @param {boolean} [adv] Set true for advanced Elasticsearch search syntax
@@ -101,7 +101,7 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
 export declare const SearchApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
      *
-     * @summary Search
+     * @summary Search Elasticsearch
      * @param {string} [query] Elasticsearch query
      * @param {boolean} [user] Specify user or only public metadata records could be found
      * @param {boolean} [adv] Set true for advanced Elasticsearch search syntax
@@ -120,7 +120,7 @@ export declare const SearchApiFactory: (configuration?: Configuration, basePath?
 export declare class SearchApi extends BaseAPI {
     /**
      *
-     * @summary Search
+     * @summary Search Elasticsearch
      * @param {string} [query] Elasticsearch query
      * @param {boolean} [user] Specify user or only public metadata records could be found
      * @param {boolean} [adv] Set true for advanced Elasticsearch search syntax

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -2,7 +2,7 @@
  * Coscine.Api.User
  * 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.1.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -151,10 +151,10 @@ export interface TitleObject {
 export interface Tos {
     /**
      * The TOS version
-     * @type {string}
+     * @type {Array<string>}
      * @memberof Tos
      */
-    version?: string | null;
+    version?: Array<string> | null;
 }
 /**
  *
@@ -429,6 +429,13 @@ export declare const TOSApiAxiosParamCreator: (configuration?: Configuration) =>
      * @throws {RequiredError}
      */
     tOSAcceptCurrentTOSVersion: (options?: any) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Returns the TOS Versions accepted by the current user.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    tOSAcceptedTOSVersion: (options?: any) => Promise<RequestArgs>;
     /**
      *
      * @summary Returns the current TOS Version.
@@ -448,14 +455,21 @@ export declare const TOSApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    tOSAcceptCurrentTOSVersion(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<number>>;
+    tOSAcceptCurrentTOSVersion(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
+    /**
+     *
+     * @summary Returns the TOS Versions accepted by the current user.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    tOSAcceptedTOSVersion(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Tos>>;
     /**
      *
      * @summary Returns the current TOS Version.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    tOSGetCurrentTOSVersion(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Tos>>;
+    tOSGetCurrentTOSVersion(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
 };
 /**
  * TOSApi - factory interface
@@ -468,14 +482,21 @@ export declare const TOSApiFactory: (configuration?: Configuration, basePath?: s
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    tOSAcceptCurrentTOSVersion(options?: any): AxiosPromise<number>;
+    tOSAcceptCurrentTOSVersion(options?: any): AxiosPromise<string>;
+    /**
+     *
+     * @summary Returns the TOS Versions accepted by the current user.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    tOSAcceptedTOSVersion(options?: any): AxiosPromise<Tos>;
     /**
      *
      * @summary Returns the current TOS Version.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    tOSGetCurrentTOSVersion(options?: any): AxiosPromise<Tos>;
+    tOSGetCurrentTOSVersion(options?: any): AxiosPromise<string>;
 };
 /**
  * TOSApi - object-oriented interface
@@ -491,7 +512,15 @@ export declare class TOSApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof TOSApi
      */
-    tOSAcceptCurrentTOSVersion(options?: any): Promise<import("axios").AxiosResponse<number>>;
+    tOSAcceptCurrentTOSVersion(options?: any): Promise<import("axios").AxiosResponse<string>>;
+    /**
+     *
+     * @summary Returns the TOS Versions accepted by the current user.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TOSApi
+     */
+    tOSAcceptedTOSVersion(options?: any): Promise<import("axios").AxiosResponse<Tos>>;
     /**
      *
      * @summary Returns the current TOS Version.
@@ -499,7 +528,7 @@ export declare class TOSApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof TOSApi
      */
-    tOSGetCurrentTOSVersion(options?: any): Promise<import("axios").AxiosResponse<Tos>>;
+    tOSGetCurrentTOSVersion(options?: any): Promise<import("axios").AxiosResponse<string>>;
 }
 /**
  * TitleApi - axios parameter creator

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

@@ -2,7 +2,7 @@
  * Coscine.Api.User
  * 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.1.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -2,7 +2,7 @@
  * Coscine.Api.User
  * 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.1.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -2,7 +2,7 @@
  * Coscine.Api.User
  * 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.1.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -2,7 +2,7 @@
  * Coscine.Api.User
  * 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.1.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/types/apis.d.ts

@@ -1,5 +1,9 @@
 import { AxiosInstance } from 'axios';
 declare function implementations(axios?: AxiosInstance): {
+    AccountApi: {
+        accountGetLoginUrls(options?: any): import("axios").AxiosPromise<import("./Coscine.Api.STS/api").LoginUrls>;
+        accountLogout(options?: any): import("axios").AxiosPromise<any>;
+    };
     AdminApi: {
         adminGetProject(projectString: string, options?: any): import("axios").AxiosPromise<import("./Coscine.Api.Admin/api").AdminProjectObject>;
         adminUpdateQuota(projectId: string, resourceTypeId: string, updateQuotaParameterObject: import("./Coscine.Api.Admin/api").UpdateQuotaParameterObject, options?: any): import("axios").AxiosPromise<any>;
@@ -17,12 +21,19 @@ declare function implementations(axios?: AxiosInstance): {
     DisciplineApi: {
         disciplineIndex(options?: any): import("axios").AxiosPromise<import("./Coscine.Api.Project/api").DisciplineObject[]>;
     };
+    HomeApi: {
+        homeIndex(options?: any): import("axios").AxiosPromise<any>;
+    };
     LanguageApi: {
         languageIndex(options?: any): import("axios").AxiosPromise<import("./Coscine.Api.User/api").LanguageObject[]>;
     };
     LicenseApi: {
         licenseIndex(options?: any): import("axios").AxiosPromise<import("./Coscine.Api.Project/api").LicenseObject[]>;
     };
+    MergeApi: {
+        mergeCallback(returnUrl?: string, options?: any): import("axios").AxiosPromise<any>;
+        mergeLogin(returnUrl?: string, options?: any): import("axios").AxiosPromise<any>;
+    };
     MetadataApi: {
         metadataGetClassInstances(className: string, options?: any): import("axios").AxiosPromise<import("./Coscine.Api.Metadata/api").BilingualLabels>;
         metadataGetProfile(profile: string, options?: any): import("axios").AxiosPromise<any>;
@@ -35,6 +46,10 @@ declare function implementations(axios?: AxiosInstance): {
         noticeGetMaintenance(options?: any): import("axios").AxiosPromise<import("./Coscine.Api.Notices/api").MaintenanceReturnObject>;
         noticeGetNotice(documentSlug: string, language?: string, options?: any): import("axios").AxiosPromise<any>;
     };
+    ORCiDApi: {
+        oRCiDLoginGET(returnUrl?: string, options?: any): import("axios").AxiosPromise<any>;
+        oRCiDLoginPOST(oRCiDJWT?: string, returnUrl?: string, options?: any): import("axios").AxiosPromise<any>;
+    };
     OrganizationApi: {
         organizationGetOrganization(url: string, options?: any): import("axios").AxiosPromise<any>;
         organizationGetROR(filter?: string, options?: any): import("axios").AxiosPromise<any>;
@@ -97,6 +112,10 @@ declare function implementations(axios?: AxiosInstance): {
     SearchApi: {
         searchSearch(query?: string, user?: boolean, adv?: boolean, languages?: string[], options?: any): import("axios").AxiosPromise<import("./Coscine.Api.Search/api").SearchResult>;
     };
+    ShibbolethApi: {
+        shibbolethCallback(returnUrl?: string, remoteError?: string, options?: any): import("axios").AxiosPromise<any>;
+        shibbolethLogin(returnUrl?: string, entityId?: string, options?: any): import("axios").AxiosPromise<any>;
+    };
     SubProjectApi: {
         subProjectGet(parentId: string, options?: any): import("axios").AxiosPromise<any>;
         subProjectGetAccessibleParent(childId: string, options?: any): import("axios").AxiosPromise<any>;
@@ -112,8 +131,9 @@ declare function implementations(axios?: AxiosInstance): {
         tokenRevokeToken(tokenId: string, options?: any): import("axios").AxiosPromise<any>;
     };
     TOSApi: {
-        tOSAcceptCurrentTOSVersion(options?: any): import("axios").AxiosPromise<number>;
-        tOSGetCurrentTOSVersion(options?: any): import("axios").AxiosPromise<import("./Coscine.Api.User/api").Tos>;
+        tOSAcceptCurrentTOSVersion(options?: any): import("axios").AxiosPromise<string>;
+        tOSAcceptedTOSVersion(options?: any): import("axios").AxiosPromise<import("./Coscine.Api.User/api").Tos>;
+        tOSGetCurrentTOSVersion(options?: any): import("axios").AxiosPromise<string>;
     };
     TreeApi: {
         treeGetMetadataWithParameter(resourceId: string, path?: string, mimeType?: string, options?: any): import("axios").AxiosPromise<any>;