@coscine/api-client 2.11.0 → 3.0.0

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

@@ -1,256 +0,0 @@
-/**
- * Coscine.Api.Organization
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: 2.2.1
- *
- *
- * 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';
-/**
- * Object for representing the isMember relationship
- * @export
- * @interface IsMemberObject
- */
-export interface IsMemberObject {
-    /**
-     * Is Member of requested organization
-     * @type {boolean}
-     * @memberof IsMemberObject
-     */
-    isMember?: boolean;
-}
-/**
- * Information about an Organization
- * @export
- * @interface OrganizationObject
- */
-export interface OrganizationObject {
-    /**
-     * Name of the Organization
-     * @type {string}
-     * @memberof OrganizationObject
-     */
-    displayName?: string | null;
-    /**
-     * ROR Id of the Organization
-     * @type {string}
-     * @memberof OrganizationObject
-     */
-    url?: string | null;
-    /**
-     * Optional: Contact E-Mail
-     * @type {string}
-     * @memberof OrganizationObject
-     */
-    email?: string | null;
-}
-/**
- * Wrapping the request (to stay compatible to the old implementation)
- * @export
- * @interface WrapperObject
- */
-export interface WrapperObject {
-    /**
-     * Wrapper list to stay compatible to the old implementation
-     * @type {Array<OrganizationObject>}
-     * @memberof WrapperObject
-     */
-    data?: Array<OrganizationObject> | null;
-}
-/**
- * OrganizationApi - axios parameter creator
- * @export
- */
-export declare const OrganizationApiAxiosParamCreator: (configuration?: Configuration) => {
-    /**
-     *
-     * @summary Returns a specific organization.
-     * @param {string} url Url of the organization.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    organizationGetOrganization: (url: string, options?: any) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary Returns all labels and urls from the ror graph.
-     * @param {string} [filter]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    organizationGetROR: (filter?: string, options?: any) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary Returns all organizations that match the provided criterea.
-     * @param {number} [member] Filtering organizations that the user is member of.
-     * @param {string} [filter] Searchterm to filter the results by.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    organizationIndex: (member?: number, filter?: string, options?: any) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary Returns true if the current user is a member of the given organization.
-     * @param {string} url Url of the organization.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    organizationIsMember: (url: string, options?: any) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary Returns a list of organizations in which the current user is a member.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    organizationIsMember2: (options?: any) => Promise<RequestArgs>;
-};
-/**
- * OrganizationApi - functional programming interface
- * @export
- */
-export declare const OrganizationApiFp: (configuration?: Configuration) => {
-    /**
-     *
-     * @summary Returns a specific organization.
-     * @param {string} url Url of the organization.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    organizationGetOrganization(url: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WrapperObject>>;
-    /**
-     *
-     * @summary Returns all labels and urls from the ror graph.
-     * @param {string} [filter]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    organizationGetROR(filter?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WrapperObject>>;
-    /**
-     *
-     * @summary Returns all organizations that match the provided criterea.
-     * @param {number} [member] Filtering organizations that the user is member of.
-     * @param {string} [filter] Searchterm to filter the results by.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    organizationIndex(member?: number, filter?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WrapperObject>>;
-    /**
-     *
-     * @summary Returns true if the current user is a member of the given organization.
-     * @param {string} url Url of the organization.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    organizationIsMember(url: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IsMemberObject>>;
-    /**
-     *
-     * @summary Returns a list of organizations in which the current user is a member.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    organizationIsMember2(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WrapperObject>>;
-};
-/**
- * OrganizationApi - factory interface
- * @export
- */
-export declare const OrganizationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
-    /**
-     *
-     * @summary Returns a specific organization.
-     * @param {string} url Url of the organization.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    organizationGetOrganization(url: string, options?: any): AxiosPromise<WrapperObject>;
-    /**
-     *
-     * @summary Returns all labels and urls from the ror graph.
-     * @param {string} [filter]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    organizationGetROR(filter?: string, options?: any): AxiosPromise<WrapperObject>;
-    /**
-     *
-     * @summary Returns all organizations that match the provided criterea.
-     * @param {number} [member] Filtering organizations that the user is member of.
-     * @param {string} [filter] Searchterm to filter the results by.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    organizationIndex(member?: number, filter?: string, options?: any): AxiosPromise<WrapperObject>;
-    /**
-     *
-     * @summary Returns true if the current user is a member of the given organization.
-     * @param {string} url Url of the organization.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    organizationIsMember(url: string, options?: any): AxiosPromise<IsMemberObject>;
-    /**
-     *
-     * @summary Returns a list of organizations in which the current user is a member.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    organizationIsMember2(options?: any): AxiosPromise<WrapperObject>;
-};
-/**
- * OrganizationApi - object-oriented interface
- * @export
- * @class OrganizationApi
- * @extends {BaseAPI}
- */
-export declare class OrganizationApi extends BaseAPI {
-    /**
-     *
-     * @summary Returns a specific organization.
-     * @param {string} url Url of the organization.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof OrganizationApi
-     */
-    organizationGetOrganization(url: string, options?: any): Promise<import("axios").AxiosResponse<WrapperObject>>;
-    /**
-     *
-     * @summary Returns all labels and urls from the ror graph.
-     * @param {string} [filter]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof OrganizationApi
-     */
-    organizationGetROR(filter?: string, options?: any): Promise<import("axios").AxiosResponse<WrapperObject>>;
-    /**
-     *
-     * @summary Returns all organizations that match the provided criterea.
-     * @param {number} [member] Filtering organizations that the user is member of.
-     * @param {string} [filter] Searchterm to filter the results by.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof OrganizationApi
-     */
-    organizationIndex(member?: number, filter?: string, options?: any): Promise<import("axios").AxiosResponse<WrapperObject>>;
-    /**
-     *
-     * @summary Returns true if the current user is a member of the given organization.
-     * @param {string} url Url of the organization.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof OrganizationApi
-     */
-    organizationIsMember(url: string, options?: any): Promise<import("axios").AxiosResponse<IsMemberObject>>;
-    /**
-     *
-     * @summary Returns a list of organizations in which the current user is a member.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof OrganizationApi
-     */
-    organizationIsMember2(options?: any): Promise<import("axios").AxiosResponse<WrapperObject>>;
-}

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

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

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

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

@@ -1,149 +0,0 @@
-/**
- * Coscine.Api.Pid
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: 2.4.1
- *
- *
- * 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';
-/**
- * Message Object.
- * @export
- * @interface MessageObject
- */
-export interface MessageObject {
-    /**
-     * Name of the requester.
-     * @type {string}
-     * @memberof MessageObject
-     */
-    name?: string | null;
-    /**
-     * Email address of the requester.
-     * @type {string}
-     * @memberof MessageObject
-     */
-    email?: string | null;
-    /**
-     * Message Text.
-     * @type {string}
-     * @memberof MessageObject
-     */
-    message?: string | null;
-    /**
-     * Send copy to requester.
-     * @type {boolean}
-     * @memberof MessageObject
-     */
-    sendCopy?: boolean;
-    /**
-     * Pid of the resource.
-     * @type {string}
-     * @memberof MessageObject
-     */
-    pid?: string | null;
-    /**
-     * Message Object.
-     * @type {string}
-     * @memberof MessageObject
-     */
-    guid?: string | null;
-}
-/**
- * PidApi - axios parameter creator
- * @export
- */
-export declare const PidApiAxiosParamCreator: (configuration?: Configuration) => {
-    /**
-     *
-     * @summary Returns a 200, if a PID is valid.
-     * @param {string} pid PID
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    pidIsValid: (pid: string, options?: any) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary Sends a request to the pid owner.
-     * @param {MessageObject} messageObject Entry with the information for the email to the pid owner.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    pidSendMailToOwner: (messageObject: MessageObject, options?: any) => Promise<RequestArgs>;
-};
-/**
- * PidApi - functional programming interface
- * @export
- */
-export declare const PidApiFp: (configuration?: Configuration) => {
-    /**
-     *
-     * @summary Returns a 200, if a PID is valid.
-     * @param {string} pid PID
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    pidIsValid(pid: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
-    /**
-     *
-     * @summary Sends a request to the pid owner.
-     * @param {MessageObject} messageObject Entry with the information for the email to the pid owner.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    pidSendMailToOwner(messageObject: MessageObject, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
-};
-/**
- * PidApi - factory interface
- * @export
- */
-export declare const PidApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
-    /**
-     *
-     * @summary Returns a 200, if a PID is valid.
-     * @param {string} pid PID
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    pidIsValid(pid: string, options?: any): AxiosPromise<any>;
-    /**
-     *
-     * @summary Sends a request to the pid owner.
-     * @param {MessageObject} messageObject Entry with the information for the email to the pid owner.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    pidSendMailToOwner(messageObject: MessageObject, options?: any): AxiosPromise<any>;
-};
-/**
- * PidApi - object-oriented interface
- * @export
- * @class PidApi
- * @extends {BaseAPI}
- */
-export declare class PidApi extends BaseAPI {
-    /**
-     *
-     * @summary Returns a 200, if a PID is valid.
-     * @param {string} pid PID
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof PidApi
-     */
-    pidIsValid(pid: string, options?: any): Promise<import("axios").AxiosResponse<any>>;
-    /**
-     *
-     * @summary Sends a request to the pid owner.
-     * @param {MessageObject} messageObject Entry with the information for the email to the pid owner.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof PidApi
-     */
-    pidSendMailToOwner(messageObject: MessageObject, options?: any): Promise<import("axios").AxiosResponse<any>>;
-}

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

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

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