@coscine/api-client 3.1.0 → 3.2.0

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

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

@@ -1,160 +0,0 @@
-/**
- * Coscine.Api.Search
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: 1.7.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
- * @enum {string}
- */
-export declare enum CategoryFilter {
-    None = "None",
-    Resource = "Resource",
-    Project = "Project",
-    Metadata = "Metadata"
-}
-/**
- * Item Search Result Object
- * @export
- * @interface ItemSearchResult
- */
-export interface ItemSearchResult {
-    /**
-     * Graph Name
-     * @type {string}
-     * @memberof ItemSearchResult
-     */
-    graphName?: string;
-    /**
-     * Graph Name
-     * @type {ItemType}
-     * @memberof ItemSearchResult
-     */
-    type?: ItemType;
-    /**
-     * Search result fields
-     * @type {any}
-     * @memberof ItemSearchResult
-     */
-    source?: any | null;
-}
-/**
- *
- * @export
- * @enum {string}
- */
-export declare enum ItemType {
-    Metadata = "Metadata",
-    Project = "Project",
-    Resource = "Resource"
-}
-/**
- *
- * @export
- * @enum {string}
- */
-export declare enum OrderBy {
-    DateCreatedAsc = "Date_Created_Asc",
-    DateCreatedDesc = "Date_Created_Desc",
-    ScoreAsc = "Score_Asc",
-    ScoreDesc = "Score_Desc",
-    NameAsc = "Name_Asc",
-    NameDesc = "Name_Desc"
-}
-/**
- * SearchApi - axios parameter creator
- * @export
- */
-export declare const SearchApiAxiosParamCreator: (configuration?: Configuration) => {
-    /**
-     *
-     * @summary Search Elasticsearch
-     * @param {string} [searchQuery] The actual search query
-     * @param {boolean} [includeUsers] Specify user or only public metadata records could be found
-     * @param {boolean} [useAdvancedSyntax] Set true for advanced Elasticsearch search syntax
-     * @param {Array<string>} [includedLanguages] Set the used languages
-     * @param {CategoryFilter} [categoryFilter] Set the category filter
-     * @param {OrderBy} [orderBy] Set the order for sorting
-     * @param {number} [pageNumber] The requested page number
-     * @param {number} [pageSize] The size of a page
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    searchSearch: (searchQuery?: string, includeUsers?: boolean, useAdvancedSyntax?: boolean, includedLanguages?: Array<string>, categoryFilter?: CategoryFilter, orderBy?: OrderBy, pageNumber?: number, pageSize?: number, options?: any) => Promise<RequestArgs>;
-};
-/**
- * SearchApi - functional programming interface
- * @export
- */
-export declare const SearchApiFp: (configuration?: Configuration) => {
-    /**
-     *
-     * @summary Search Elasticsearch
-     * @param {string} [searchQuery] The actual search query
-     * @param {boolean} [includeUsers] Specify user or only public metadata records could be found
-     * @param {boolean} [useAdvancedSyntax] Set true for advanced Elasticsearch search syntax
-     * @param {Array<string>} [includedLanguages] Set the used languages
-     * @param {CategoryFilter} [categoryFilter] Set the category filter
-     * @param {OrderBy} [orderBy] Set the order for sorting
-     * @param {number} [pageNumber] The requested page number
-     * @param {number} [pageSize] The size of a page
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    searchSearch(searchQuery?: string, includeUsers?: boolean, useAdvancedSyntax?: boolean, includedLanguages?: Array<string>, categoryFilter?: CategoryFilter, orderBy?: OrderBy, pageNumber?: number, pageSize?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ItemSearchResult>>>;
-};
-/**
- * SearchApi - factory interface
- * @export
- */
-export declare const SearchApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
-    /**
-     *
-     * @summary Search Elasticsearch
-     * @param {string} [searchQuery] The actual search query
-     * @param {boolean} [includeUsers] Specify user or only public metadata records could be found
-     * @param {boolean} [useAdvancedSyntax] Set true for advanced Elasticsearch search syntax
-     * @param {Array<string>} [includedLanguages] Set the used languages
-     * @param {CategoryFilter} [categoryFilter] Set the category filter
-     * @param {OrderBy} [orderBy] Set the order for sorting
-     * @param {number} [pageNumber] The requested page number
-     * @param {number} [pageSize] The size of a page
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    searchSearch(searchQuery?: string, includeUsers?: boolean, useAdvancedSyntax?: boolean, includedLanguages?: Array<string>, categoryFilter?: CategoryFilter, orderBy?: OrderBy, pageNumber?: number, pageSize?: number, options?: any): AxiosPromise<Array<ItemSearchResult>>;
-};
-/**
- * SearchApi - object-oriented interface
- * @export
- * @class SearchApi
- * @extends {BaseAPI}
- */
-export declare class SearchApi extends BaseAPI {
-    /**
-     *
-     * @summary Search Elasticsearch
-     * @param {string} [searchQuery] The actual search query
-     * @param {boolean} [includeUsers] Specify user or only public metadata records could be found
-     * @param {boolean} [useAdvancedSyntax] Set true for advanced Elasticsearch search syntax
-     * @param {Array<string>} [includedLanguages] Set the used languages
-     * @param {CategoryFilter} [categoryFilter] Set the category filter
-     * @param {OrderBy} [orderBy] Set the order for sorting
-     * @param {number} [pageNumber] The requested page number
-     * @param {number} [pageSize] The size of a page
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof SearchApi
-     */
-    searchSearch(searchQuery?: string, includeUsers?: boolean, useAdvancedSyntax?: boolean, includedLanguages?: Array<string>, categoryFilter?: CategoryFilter, orderBy?: OrderBy, pageNumber?: number, pageSize?: number, options?: any): Promise<import("axios").AxiosResponse<ItemSearchResult[]>>;
-}

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

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

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

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

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