@coscine/api-client 2.12.0 → 3.1.0

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

@@ -1,299 +0,0 @@
-/**
- * Coscine.Api.Metadata
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: 3.2.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';
-/**
- * Parameter object containing the application profile informations.
- * @export
- * @interface ApplicationProfile
- */
-export interface ApplicationProfile {
-    /**
-     * Name of the application profile
-     * @type {string}
-     * @memberof ApplicationProfile
-     */
-    name?: string | null;
-    /**
-     * Base URL of the application profile
-     * @type {string}
-     * @memberof ApplicationProfile
-     */
-    base_url?: string | null;
-    /**
-     * Definition of the application profile
-     * @type {string}
-     * @memberof ApplicationProfile
-     */
-    definition?: string | null;
-    /**
-     * Mime type of the application profile
-     * @type {string}
-     * @memberof ApplicationProfile
-     */
-    mimeType?: string | null;
-}
-/**
- * Bilingual labels
- * @export
- * @interface BilingualLabels
- */
-export interface BilingualLabels {
-    /**
-     * English labels
-     * @type {Array<Label>}
-     * @memberof BilingualLabels
-     */
-    en?: Array<Label> | null;
-    /**
-     * German labels
-     * @type {Array<Label>}
-     * @memberof BilingualLabels
-     */
-    de?: Array<Label> | null;
-}
-/**
- * Label of a vocabulary entry
- * @export
- * @interface Label
- */
-export interface Label {
-    /**
-     * Name of the application profile
-     * @type {string}
-     * @memberof Label
-     */
-    name?: string | null;
-    /**
-     * Name of the application profile
-     * @type {string}
-     * @memberof Label
-     */
-    value?: string | null;
-}
-/**
- * MetadataApi - axios parameter creator
- * @export
- */
-export declare const MetadataApiAxiosParamCreator: (configuration?: Configuration) => {
-    /**
-     *
-     * @summary This method returns instances.
-     * @param {string} className class name
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    metadataGetClassInstances: (className: string, options?: any) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary This method returns the application profile for the given profileUrl.
-     * @param {string} profile Url of the application profile
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    metadataGetProfile: (profile: string, options?: any) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary This method returns all application profiles.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    metadataGetProfiles: (options?: any) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary This method returns a list of all vocabularies.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    metadataGetVocabularies: (options?: any) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary This method returns a specific vocabulary.
-     * @param {string} path Url of the vocabulary
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    metadataGetVocabulary: (path: string, options?: any) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary Create a request for storing a given application profile.
-     * @param {ApplicationProfile} applicationProfile Object describing the application profile
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    metadataSaveApplicationProfile: (applicationProfile: ApplicationProfile, options?: any) => Promise<RequestArgs>;
-};
-/**
- * MetadataApi - functional programming interface
- * @export
- */
-export declare const MetadataApiFp: (configuration?: Configuration) => {
-    /**
-     *
-     * @summary This method returns instances.
-     * @param {string} className class name
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    metadataGetClassInstances(className: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BilingualLabels>>;
-    /**
-     *
-     * @summary This method returns the application profile for the given profileUrl.
-     * @param {string} profile Url of the application profile
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    metadataGetProfile(profile: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
-    /**
-     *
-     * @summary This method returns all application profiles.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    metadataGetProfiles(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
-    /**
-     *
-     * @summary This method returns a list of all vocabularies.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    metadataGetVocabularies(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
-    /**
-     *
-     * @summary This method returns a specific vocabulary.
-     * @param {string} path Url of the vocabulary
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    metadataGetVocabulary(path: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BilingualLabels>>;
-    /**
-     *
-     * @summary Create a request for storing a given application profile.
-     * @param {ApplicationProfile} applicationProfile Object describing the application profile
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    metadataSaveApplicationProfile(applicationProfile: ApplicationProfile, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
-};
-/**
- * MetadataApi - factory interface
- * @export
- */
-export declare const MetadataApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
-    /**
-     *
-     * @summary This method returns instances.
-     * @param {string} className class name
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    metadataGetClassInstances(className: string, options?: any): AxiosPromise<BilingualLabels>;
-    /**
-     *
-     * @summary This method returns the application profile for the given profileUrl.
-     * @param {string} profile Url of the application profile
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    metadataGetProfile(profile: string, options?: any): AxiosPromise<any>;
-    /**
-     *
-     * @summary This method returns all application profiles.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    metadataGetProfiles(options?: any): AxiosPromise<Array<string>>;
-    /**
-     *
-     * @summary This method returns a list of all vocabularies.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    metadataGetVocabularies(options?: any): AxiosPromise<Array<string>>;
-    /**
-     *
-     * @summary This method returns a specific vocabulary.
-     * @param {string} path Url of the vocabulary
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    metadataGetVocabulary(path: string, options?: any): AxiosPromise<BilingualLabels>;
-    /**
-     *
-     * @summary Create a request for storing a given application profile.
-     * @param {ApplicationProfile} applicationProfile Object describing the application profile
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    metadataSaveApplicationProfile(applicationProfile: ApplicationProfile, options?: any): AxiosPromise<any>;
-};
-/**
- * MetadataApi - object-oriented interface
- * @export
- * @class MetadataApi
- * @extends {BaseAPI}
- */
-export declare class MetadataApi extends BaseAPI {
-    /**
-     *
-     * @summary This method returns instances.
-     * @param {string} className class name
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof MetadataApi
-     */
-    metadataGetClassInstances(className: string, options?: any): Promise<import("axios").AxiosResponse<BilingualLabels>>;
-    /**
-     *
-     * @summary This method returns the application profile for the given profileUrl.
-     * @param {string} profile Url of the application profile
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof MetadataApi
-     */
-    metadataGetProfile(profile: string, options?: any): Promise<import("axios").AxiosResponse<any>>;
-    /**
-     *
-     * @summary This method returns all application profiles.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof MetadataApi
-     */
-    metadataGetProfiles(options?: any): Promise<import("axios").AxiosResponse<string[]>>;
-    /**
-     *
-     * @summary This method returns a list of all vocabularies.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof MetadataApi
-     */
-    metadataGetVocabularies(options?: any): Promise<import("axios").AxiosResponse<string[]>>;
-    /**
-     *
-     * @summary This method returns a specific vocabulary.
-     * @param {string} path Url of the vocabulary
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof MetadataApi
-     */
-    metadataGetVocabulary(path: string, options?: any): Promise<import("axios").AxiosResponse<BilingualLabels>>;
-    /**
-     *
-     * @summary Create a request for storing a given application profile.
-     * @param {ApplicationProfile} applicationProfile Object describing the application profile
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof MetadataApi
-     */
-    metadataSaveApplicationProfile(applicationProfile: ApplicationProfile, options?: any): Promise<import("axios").AxiosResponse<any>>;
-}

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

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

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

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

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

@@ -1,153 +0,0 @@
-/**
- * Coscine.Api.Notices
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: 2.4.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';
-/**
- * This class represents a maintenance with its significant properties, which is returned from the api.
- * @export
- * @interface MaintenanceReturnObject
- */
-export interface MaintenanceReturnObject {
-    /**
-     * Maintenance title.
-     * @type {string}
-     * @memberof MaintenanceReturnObject
-     */
-    displayName?: string | null;
-    /**
-     * Maintenance url.
-     * @type {string}
-     * @memberof MaintenanceReturnObject
-     */
-    url?: string | null;
-    /**
-     * Maintenance type.
-     * @type {string}
-     * @memberof MaintenanceReturnObject
-     */
-    type?: string | null;
-    /**
-     * Maintenance description.
-     * @type {string}
-     * @memberof MaintenanceReturnObject
-     */
-    body?: string | null;
-    /**
-     * Maintenance start.
-     * @type {string}
-     * @memberof MaintenanceReturnObject
-     */
-    startsDate?: string | null;
-    /**
-     * Maintenance end.
-     * @type {string}
-     * @memberof MaintenanceReturnObject
-     */
-    endsDate?: string | null;
-}
-/**
- * NoticeApi - axios parameter creator
- * @export
- */
-export declare const NoticeApiAxiosParamCreator: (configuration?: Configuration) => {
-    /**
-     *
-     * @summary Returns defined properties of the first entry of the rss feed
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    noticeGetMaintenance: (options?: any) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary Returns a notice
-     * @param {string} documentSlug Slug defining a configured notice
-     * @param {string} [language] Language (e.g. \&quot;en\&quot; or \&quot;de\&quot;)
-     * @param {*} [options] Override http request option.
-     * @deprecated
-     * @throws {RequiredError}
-     */
-    noticeGetNotice: (documentSlug: string, language?: string, options?: any) => Promise<RequestArgs>;
-};
-/**
- * NoticeApi - functional programming interface
- * @export
- */
-export declare const NoticeApiFp: (configuration?: Configuration) => {
-    /**
-     *
-     * @summary Returns defined properties of the first entry of the rss feed
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    noticeGetMaintenance(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MaintenanceReturnObject>>;
-    /**
-     *
-     * @summary Returns a notice
-     * @param {string} documentSlug Slug defining a configured notice
-     * @param {string} [language] Language (e.g. \&quot;en\&quot; or \&quot;de\&quot;)
-     * @param {*} [options] Override http request option.
-     * @deprecated
-     * @throws {RequiredError}
-     */
-    noticeGetNotice(documentSlug: string, language?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
-};
-/**
- * NoticeApi - factory interface
- * @export
- */
-export declare const NoticeApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
-    /**
-     *
-     * @summary Returns defined properties of the first entry of the rss feed
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    noticeGetMaintenance(options?: any): AxiosPromise<MaintenanceReturnObject>;
-    /**
-     *
-     * @summary Returns a notice
-     * @param {string} documentSlug Slug defining a configured notice
-     * @param {string} [language] Language (e.g. \&quot;en\&quot; or \&quot;de\&quot;)
-     * @param {*} [options] Override http request option.
-     * @deprecated
-     * @throws {RequiredError}
-     */
-    noticeGetNotice(documentSlug: string, language?: string, options?: any): AxiosPromise<any>;
-};
-/**
- * NoticeApi - object-oriented interface
- * @export
- * @class NoticeApi
- * @extends {BaseAPI}
- */
-export declare class NoticeApi extends BaseAPI {
-    /**
-     *
-     * @summary Returns defined properties of the first entry of the rss feed
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof NoticeApi
-     */
-    noticeGetMaintenance(options?: any): Promise<import("axios").AxiosResponse<MaintenanceReturnObject>>;
-    /**
-     *
-     * @summary Returns a notice
-     * @param {string} documentSlug Slug defining a configured notice
-     * @param {string} [language] Language (e.g. \&quot;en\&quot; or \&quot;de\&quot;)
-     * @param {*} [options] Override http request option.
-     * @deprecated
-     * @throws {RequiredError}
-     * @memberof NoticeApi
-     */
-    noticeGetNotice(documentSlug: string, language?: string, options?: any): Promise<import("axios").AxiosResponse<any>>;
-}