@coscine/api-client 2.1.0 → 2.4.0

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

@@ -15,36 +15,490 @@ import { RequestArgs, BaseAPI } from './base';
 /**
  *
  * @export
- * @interface SearchResult
+ * @interface DisciplineObject
  */
-export interface SearchResult {
+export interface DisciplineObject {
     /**
      *
      * @type {string}
-     * @memberof SearchResult
+     * @memberof DisciplineObject
+     */
+    id?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof DisciplineObject
+     */
+    url?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof DisciplineObject
+     */
+    displayNameDe?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof DisciplineObject
+     */
+    displayNameEn?: string | null;
+}
+/**
+ * File Search Result Object
+ * @export
+ * @interface FileSearchResult
+ */
+export interface FileSearchResult {
+    /**
+     * Graph Name
+     * @type {string}
+     * @memberof FileSearchResult
      */
     graphName?: string | null;
+    /**
+     * ID of Project containing the file
+     * @type {string}
+     * @memberof FileSearchResult
+     */
+    projectId?: string | null;
+    /**
+     * ID of Resource containing the file
+     * @type {string}
+     * @memberof FileSearchResult
+     */
+    resourceId?: string | null;
+    /**
+     * Search result fields
+     * @type {any}
+     * @memberof FileSearchResult
+     */
+    source?: any | null;
+}
+/**
+ *
+ * @export
+ * @interface LicenseObject
+ */
+export interface LicenseObject {
     /**
      *
      * @type {string}
-     * @memberof SearchResult
+     * @memberof LicenseObject
+     */
+    id?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof LicenseObject
+     */
+    displayName?: string | null;
+}
+/**
+ *
+ * @export
+ * @interface OrganizationObject
+ */
+export interface OrganizationObject {
+    /**
+     *
+     * @type {string}
+     * @memberof OrganizationObject
+     */
+    url?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof OrganizationObject
+     */
+    displayName?: string | null;
+}
+/**
+ *
+ * @export
+ * @interface ProjectObject
+ */
+export interface ProjectObject {
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectObject
+     */
+    id?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectObject
+     */
+    description?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectObject
+     */
+    displayName?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectObject
+     */
+    startDate?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectObject
+     */
+    endDate?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectObject
+     */
+    keywords?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectObject
+     */
+    projectName?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectObject
+     */
+    principleInvestigators?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectObject
+     */
+    grantId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectObject
+     */
+    slug?: string | null;
+    /**
+     *
+     * @type {Array<DisciplineObject>}
+     * @memberof ProjectObject
+     */
+    disciplines?: Array<DisciplineObject> | null;
+    /**
+     *
+     * @type {Array<OrganizationObject>}
+     * @memberof ProjectObject
+     */
+    organizations?: Array<OrganizationObject> | null;
+    /**
+     *
+     * @type {VisibilityObject}
+     * @memberof ProjectObject
+     */
+    visibility?: VisibilityObject | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectObject
+     */
+    parentId?: string;
+}
+/**
+ *
+ * @export
+ * @interface ResourceObject
+ */
+export interface ResourceObject {
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceObject
+     */
+    id?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceObject
+     */
+    pid?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceObject
+     */
+    displayName?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceObject
+     */
+    resourceName?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceObject
+     */
+    description?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceObject
+     */
+    keywords?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceObject
      */
-    project?: string | null;
+    usageRights?: string | null;
+    /**
+     *
+     * @type {ResourceTypeObject}
+     * @memberof ResourceObject
+     */
+    type?: ResourceTypeObject | null;
+    /**
+     *
+     * @type {Array<DisciplineObject>}
+     * @memberof ResourceObject
+     */
+    disciplines?: Array<DisciplineObject> | null;
+    /**
+     *
+     * @type {VisibilityObject}
+     * @memberof ResourceObject
+     */
+    visibility?: VisibilityObject | null;
+    /**
+     *
+     * @type {LicenseObject}
+     * @memberof ResourceObject
+     */
+    license?: LicenseObject | null;
     /**
      *
      * @type {any}
+     * @memberof ResourceObject
+     */
+    resourceTypeOption?: any | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceObject
+     */
+    applicationProfile?: string | null;
+    /**
+     *
+     * @type {any}
+     * @memberof ResourceObject
+     */
+    fixedValues?: any | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceObject
+     */
+    creator?: string | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ResourceObject
+     */
+    archived?: boolean;
+}
+/**
+ *
+ * @export
+ * @interface ResourceSearchResult
+ */
+export interface ResourceSearchResult {
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceSearchResult
+     */
+    id?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceSearchResult
+     */
+    pid?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceSearchResult
+     */
+    displayName?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceSearchResult
+     */
+    resourceName?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceSearchResult
+     */
+    description?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceSearchResult
+     */
+    keywords?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceSearchResult
+     */
+    usageRights?: string | null;
+    /**
+     *
+     * @type {ResourceTypeObject}
+     * @memberof ResourceSearchResult
+     */
+    type?: ResourceTypeObject | null;
+    /**
+     *
+     * @type {Array<DisciplineObject>}
+     * @memberof ResourceSearchResult
+     */
+    disciplines?: Array<DisciplineObject> | null;
+    /**
+     *
+     * @type {VisibilityObject}
+     * @memberof ResourceSearchResult
+     */
+    visibility?: VisibilityObject | null;
+    /**
+     *
+     * @type {LicenseObject}
+     * @memberof ResourceSearchResult
+     */
+    license?: LicenseObject | null;
+    /**
+     *
+     * @type {any}
+     * @memberof ResourceSearchResult
+     */
+    resourceTypeOption?: any | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceSearchResult
+     */
+    applicationProfile?: string | null;
+    /**
+     *
+     * @type {any}
+     * @memberof ResourceSearchResult
+     */
+    fixedValues?: any | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceSearchResult
+     */
+    creator?: string | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ResourceSearchResult
+     */
+    archived?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceSearchResult
+     */
+    projectId?: string | null;
+}
+/**
+ *
+ * @export
+ * @interface ResourceSearchResultAllOf
+ */
+export interface ResourceSearchResultAllOf {
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceSearchResultAllOf
+     */
+    projectId?: string | null;
+}
+/**
+ *
+ * @export
+ * @interface ResourceTypeObject
+ */
+export interface ResourceTypeObject {
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceTypeObject
+     */
+    id?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceTypeObject
+     */
+    displayName?: string | null;
+}
+/**
+ * Search result return object
+ * @export
+ * @interface SearchResult
+ */
+export interface SearchResult {
+    /**
+     * Search result projects
+     * @type {Array<ProjectObject>}
      * @memberof SearchResult
      */
-    source?: any | null;
+    projects?: Array<ProjectObject> | null;
+    /**
+     * Search result resources
+     * @type {Array<ResourceSearchResult>}
+     * @memberof SearchResult
+     */
+    resources?: Array<ResourceSearchResult> | null;
+    /**
+     * Search result files
+     * @type {Array<FileSearchResult>}
+     * @memberof SearchResult
+     */
+    files?: Array<FileSearchResult> | null;
+}
+/**
+ *
+ * @export
+ * @interface VisibilityObject
+ */
+export interface VisibilityObject {
+    /**
+     *
+     * @type {string}
+     * @memberof VisibilityObject
+     */
+    id?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof VisibilityObject
+     */
+    displayName?: string | null;
 }
 /**
- * SemanticSearchApi - axios parameter creator
+ * SearchApi - axios parameter creator
  * @export
  */
-export declare const SemanticSearchApiAxiosParamCreator: (configuration?: Configuration) => {
+export declare const SearchApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
      *
-     * @summary Search with SemanticSearch;
+     * @summary Search
      * @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
@@ -52,16 +506,16 @@ export declare const SemanticSearchApiAxiosParamCreator: (configuration?: Config
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    semanticSearchSearch: (query?: string, user?: boolean, adv?: boolean, languages?: Array<string>, options?: any) => Promise<RequestArgs>;
+    searchSearch: (query?: string, user?: boolean, adv?: boolean, languages?: Array<string>, options?: any) => Promise<RequestArgs>;
 };
 /**
- * SemanticSearchApi - functional programming interface
+ * SearchApi - functional programming interface
  * @export
  */
-export declare const SemanticSearchApiFp: (configuration?: Configuration) => {
+export declare const SearchApiFp: (configuration?: Configuration) => {
     /**
      *
-     * @summary Search with SemanticSearch;
+     * @summary Search
      * @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
@@ -69,16 +523,16 @@ export declare const SemanticSearchApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    semanticSearchSearch(query?: string, user?: boolean, adv?: boolean, languages?: Array<string>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SearchResult>>>;
+    searchSearch(query?: string, user?: boolean, adv?: boolean, languages?: Array<string>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchResult>>;
 };
 /**
- * SemanticSearchApi - factory interface
+ * SearchApi - factory interface
  * @export
  */
-export declare const SemanticSearchApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+export declare const SearchApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
      *
-     * @summary Search with SemanticSearch;
+     * @summary Search
      * @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
@@ -86,25 +540,25 @@ export declare const SemanticSearchApiFactory: (configuration?: Configuration, b
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    semanticSearchSearch(query?: string, user?: boolean, adv?: boolean, languages?: Array<string>, options?: any): AxiosPromise<Array<SearchResult>>;
+    searchSearch(query?: string, user?: boolean, adv?: boolean, languages?: Array<string>, options?: any): AxiosPromise<SearchResult>;
 };
 /**
- * SemanticSearchApi - object-oriented interface
+ * SearchApi - object-oriented interface
  * @export
- * @class SemanticSearchApi
+ * @class SearchApi
  * @extends {BaseAPI}
  */
-export declare class SemanticSearchApi extends BaseAPI {
+export declare class SearchApi extends BaseAPI {
     /**
      *
-     * @summary Search with SemanticSearch;
+     * @summary Search
      * @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
      * @param {Array<string>} [languages] Set the used languages
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof SemanticSearchApi
+     * @memberof SearchApi
      */
-    semanticSearchSearch(query?: string, user?: boolean, adv?: boolean, languages?: Array<string>, options?: any): Promise<import("axios").AxiosResponse<SearchResult[]>>;
+    searchSearch(query?: string, user?: boolean, adv?: boolean, languages?: Array<string>, options?: any): Promise<import("axios").AxiosResponse<SearchResult>>;
 }

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.6.4
+ * The version of the OpenAPI document: 2.8.3
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -22,19 +22,21 @@ export declare const TreeApiAxiosParamCreator: (configuration?: Configuration) =
      * @summary This method retrieves the metadata
      * @param {string} resourceId Id of a resource
      * @param {string} [path] Path to the file
+     * @param {string} [mimeType] Requested MimeType of the metadata
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    treeGetMetadataWithParameter: (resourceId: string, path?: string, options?: any) => Promise<RequestArgs>;
+    treeGetMetadataWithParameter: (resourceId: string, path?: string, mimeType?: string, options?: any) => Promise<RequestArgs>;
     /**
      *
      * @summary This method stores the metadata of the file
      * @param {string} resourceId Id of the resource
      * @param {string} [path] Path to the file
+     * @param {string} [mimeType] Requested MimeType of the metadata
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    treeStoreMetadataForFileWithParameter: (resourceId: string, path?: string, options?: any) => Promise<RequestArgs>;
+    treeStoreMetadataForFileWithParameter: (resourceId: string, path?: string, mimeType?: string, options?: any) => Promise<RequestArgs>;
 };
 /**
  * TreeApi - functional programming interface
@@ -46,19 +48,21 @@ export declare const TreeApiFp: (configuration?: Configuration) => {
      * @summary This method retrieves the metadata
      * @param {string} resourceId Id of a resource
      * @param {string} [path] Path to the file
+     * @param {string} [mimeType] Requested MimeType of the metadata
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    treeGetMetadataWithParameter(resourceId: string, path?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
+    treeGetMetadataWithParameter(resourceId: string, path?: string, mimeType?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
     /**
      *
      * @summary This method stores the metadata of the file
      * @param {string} resourceId Id of the resource
      * @param {string} [path] Path to the file
+     * @param {string} [mimeType] Requested MimeType of the metadata
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    treeStoreMetadataForFileWithParameter(resourceId: string, path?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
+    treeStoreMetadataForFileWithParameter(resourceId: string, path?: string, mimeType?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
 };
 /**
  * TreeApi - factory interface
@@ -70,19 +74,21 @@ export declare const TreeApiFactory: (configuration?: Configuration, basePath?:
      * @summary This method retrieves the metadata
      * @param {string} resourceId Id of a resource
      * @param {string} [path] Path to the file
+     * @param {string} [mimeType] Requested MimeType of the metadata
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    treeGetMetadataWithParameter(resourceId: string, path?: string, options?: any): AxiosPromise<any>;
+    treeGetMetadataWithParameter(resourceId: string, path?: string, mimeType?: string, options?: any): AxiosPromise<any>;
     /**
      *
      * @summary This method stores the metadata of the file
      * @param {string} resourceId Id of the resource
      * @param {string} [path] Path to the file
+     * @param {string} [mimeType] Requested MimeType of the metadata
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    treeStoreMetadataForFileWithParameter(resourceId: string, path?: string, options?: any): AxiosPromise<any>;
+    treeStoreMetadataForFileWithParameter(resourceId: string, path?: string, mimeType?: string, options?: any): AxiosPromise<any>;
 };
 /**
  * TreeApi - object-oriented interface
@@ -96,19 +102,21 @@ export declare class TreeApi extends BaseAPI {
      * @summary This method retrieves the metadata
      * @param {string} resourceId Id of a resource
      * @param {string} [path] Path to the file
+     * @param {string} [mimeType] Requested MimeType of the metadata
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof TreeApi
      */
-    treeGetMetadataWithParameter(resourceId: string, path?: string, options?: any): Promise<import("axios").AxiosResponse<any>>;
+    treeGetMetadataWithParameter(resourceId: string, path?: string, mimeType?: string, options?: any): Promise<import("axios").AxiosResponse<any>>;
     /**
      *
      * @summary This method stores the metadata of the file
      * @param {string} resourceId Id of the resource
      * @param {string} [path] Path to the file
+     * @param {string} [mimeType] Requested MimeType of the metadata
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof TreeApi
      */
-    treeStoreMetadataForFileWithParameter(resourceId: string, path?: string, options?: any): Promise<import("axios").AxiosResponse<any>>;
+    treeStoreMetadataForFileWithParameter(resourceId: string, path?: string, mimeType?: string, options?: any): Promise<import("axios").AxiosResponse<any>>;
 }

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.6.4
+ * The version of the OpenAPI document: 2.8.3
  *
  *
  * 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.6.4
+ * The version of the OpenAPI document: 2.8.3
  *
  *
  * 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.6.4
+ * The version of the OpenAPI document: 2.8.3
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).