@coscine/api-client 1.1.1 → 1.2.0

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

@@ -0,0 +1,110 @@
+/**
+ * Coscine.Api.Search
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.1.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 SearchResult
+ */
+export interface SearchResult {
+    /**
+     *
+     * @type {string}
+     * @memberof SearchResult
+     */
+    graphName?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof SearchResult
+     */
+    project?: string | null;
+    /**
+     *
+     * @type {any}
+     * @memberof SearchResult
+     */
+    source?: any | null;
+}
+/**
+ * SemanticSearchApi - axios parameter creator
+ * @export
+ */
+export declare const SemanticSearchApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Search with SemanticSearch;
+     * @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}
+     */
+    semanticSearchSearch: (query?: string, user?: boolean, adv?: boolean, languages?: Array<string>, options?: any) => Promise<RequestArgs>;
+};
+/**
+ * SemanticSearchApi - functional programming interface
+ * @export
+ */
+export declare const SemanticSearchApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Search with SemanticSearch;
+     * @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}
+     */
+    semanticSearchSearch(query?: string, user?: boolean, adv?: boolean, languages?: Array<string>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SearchResult>>>;
+};
+/**
+ * SemanticSearchApi - factory interface
+ * @export
+ */
+export declare const SemanticSearchApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Search with SemanticSearch;
+     * @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}
+     */
+    semanticSearchSearch(query?: string, user?: boolean, adv?: boolean, languages?: Array<string>, options?: any): AxiosPromise<Array<SearchResult>>;
+};
+/**
+ * SemanticSearchApi - object-oriented interface
+ * @export
+ * @class SemanticSearchApi
+ * @extends {BaseAPI}
+ */
+export declare class SemanticSearchApi extends BaseAPI {
+    /**
+     *
+     * @summary Search with SemanticSearch;
+     * @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
+     */
+    semanticSearchSearch(query?: string, user?: boolean, adv?: boolean, languages?: Array<string>, options?: any): Promise<import("axios").AxiosResponse<SearchResult[]>>;
+}

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

@@ -0,0 +1,55 @@
+/**
+ * Coscine.Api.Search
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.1.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.Search/common.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Coscine.Api.Search
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.1.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.Search/configuration.d.ts

@@ -0,0 +1,83 @@
+/**
+ * Coscine.Api.Search
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.1.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.Search/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Coscine.Api.Search
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.1.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/apis.d.ts

@@ -105,6 +105,9 @@ declare function implementations(axios?: AxiosInstance): {
         searchSearchProject(projectId: string, encodedSearchWord: string, options?: any): import("axios").AxiosPromise<any>;
         searchSearchProjectNoFilter(projectId: string, options?: any): import("axios").AxiosPromise<any>;
     };
+    SemanticSearchApi: {
+        semanticSearchSearch(query?: string, user?: boolean, adv?: boolean, languages?: string[], options?: any): import("axios").AxiosPromise<import("./Coscine.Api.Search/api").SearchResult[]>;
+    };
     SubProjectApi: {
         subProjectGet(parentId: string, options?: any): import("axios").AxiosPromise<any>;
         subProjectGetAccessibleParent(childId: string, options?: any): import("axios").AxiosPromise<any>;

package/dist/types/index.d.ts

@@ -104,6 +104,9 @@ declare const apis: {
         searchSearchProject(projectId: string, encodedSearchWord: string, options?: any): import("axios").AxiosPromise<any>;
         searchSearchProjectNoFilter(projectId: string, options?: any): import("axios").AxiosPromise<any>;
     };
+    SemanticSearchApi: {
+        semanticSearchSearch(query?: string, user?: boolean, adv?: boolean, languages?: string[], options?: any): import("axios").AxiosPromise<import("./Coscine.Api.Search").SearchResult[]>;
+    };
     SubProjectApi: {
         subProjectGet(parentId: string, options?: any): import("axios").AxiosPromise<any>;
         subProjectGetAccessibleParent(childId: string, options?: any): import("axios").AxiosPromise<any>;
@@ -240,6 +243,9 @@ export declare const SearchApi: {
     searchSearchProject(projectId: string, encodedSearchWord: string, options?: any): import("axios").AxiosPromise<any>;
     searchSearchProjectNoFilter(projectId: string, options?: any): import("axios").AxiosPromise<any>;
 };
+export declare const SemanticSearchApi: {
+    semanticSearchSearch(query?: string, user?: boolean, adv?: boolean, languages?: string[], options?: any): import("axios").AxiosPromise<import("./Coscine.Api.Search").SearchResult[]>;
+};
 export declare const SubProjectApi: {
     subProjectGet(parentId: string, options?: any): import("axios").AxiosPromise<any>;
     subProjectGetAccessibleParent(childId: string, options?: any): import("axios").AxiosPromise<any>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coscine/api-client",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "This project contains the generated api connection classes.",
   "keywords": [
     "coscine",