@coscine/api-client 3.0.0 → 3.2.0

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

@@ -1,233 +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.
- */
-import { Configuration } from './configuration';
-import { AxiosPromise, AxiosInstance } from 'axios';
-import { RequestArgs, BaseAPI } from './base';
-/**
- * Retuned when searching for a project. Contains basic informations and quotas.
- * @export
- * @interface AdminProjectObject
- */
-export interface AdminProjectObject {
-    /**
-     * Project Id
-     * @type {string}
-     * @memberof AdminProjectObject
-     */
-    id?: string;
-    /**
-     * Project Name (full project name)
-     * @type {string}
-     * @memberof AdminProjectObject
-     */
-    projectName?: string | null;
-    /**
-     * Project Display Name
-     * @type {string}
-     * @memberof AdminProjectObject
-     */
-    displayName?: string | null;
-    /**
-     * List of the admin quotas (AdminQuotaReturnObject)
-     * @type {Array<AdminQuotaReturnObject>}
-     * @memberof AdminProjectObject
-     */
-    quotas?: Array<AdminQuotaReturnObject> | null;
-}
-/**
- * Returned when searching for a project, as part of the AdminProjectObject. Contains quota informations.
- * @export
- * @interface AdminQuotaReturnObject
- */
-export interface AdminQuotaReturnObject {
-    /**
-     * Quota relation id (See Database, Table \'ProjectQuotas\', Column \'RelationId\').
-     * @type {string}
-     * @memberof AdminQuotaReturnObject
-     */
-    relationId?: string;
-    /**
-     * Which resource type the quota is referring to.
-     * @type {string}
-     * @memberof AdminQuotaReturnObject
-     */
-    resourceType?: string | null;
-    /**
-     * How much space is used by all files in all resources in total [Bytes].
-     * @type {QuotaDimObject}
-     * @memberof AdminQuotaReturnObject
-     */
-    totalUsed?: QuotaDimObject | null;
-    /**
-     * How much space is reserved by resources in total [GiB]. Is equal to the sum of all resource quota reserved values.
-     * @type {QuotaDimObject}
-     * @memberof AdminQuotaReturnObject
-     */
-    totalReserved?: QuotaDimObject | null;
-    /**
-     * How much space is currently allocated and is available to be taken by resources [GiB] (See Database, Table \'ProjectQuotas\', Column \'Quota\').
-     * @type {QuotaDimObject}
-     * @memberof AdminQuotaReturnObject
-     */
-    allocated?: QuotaDimObject | null;
-    /**
-     * How much maximum space is possible to be taken by resources [GiB] (See Database, Table \'ProjectQuotas\', Column \'MaxQuota\').
-     * @type {QuotaDimObject}
-     * @memberof AdminQuotaReturnObject
-     */
-    maximum?: QuotaDimObject | null;
-}
-/**
- *
- * @export
- * @interface QuotaDimObject
- */
-export interface QuotaDimObject {
-    /**
-     *
-     * @type {number}
-     * @memberof QuotaDimObject
-     */
-    value?: number;
-    /**
-     *
-     * @type {QuotaUnit}
-     * @memberof QuotaDimObject
-     */
-    unit?: QuotaUnit;
-}
-/**
- *
- * @export
- * @enum {string}
- */
-export declare enum QuotaUnit {
-    Byte = "https://qudt.org/vocab/unit/BYTE",
-    KibiByte = "https://qudt.org/vocab/unit/KibiBYTE",
-    MebiByte = "https://qudt.org/vocab/unit/MebiBYTE",
-    GibiByte = "https://qudt.org/vocab/unit/GibiBYTE",
-    TebiByte = "https://qudt.org/vocab/unit/TebiBYTE",
-    PebiByte = "https://qudt.org/vocab/unit/PebiBYTE"
-}
-/**
- * Data send to update the project quota.
- * @export
- * @interface UpdateQuotaParameterObject
- */
-export interface UpdateQuotaParameterObject {
-    /**
-     * The new maximum project quota value.
-     * @type {number}
-     * @memberof UpdateQuotaParameterObject
-     */
-    maximumGiB?: number;
-}
-/**
- * AdminApi - axios parameter creator
- * @export
- */
-export declare const AdminApiAxiosParamCreator: (configuration?: Configuration) => {
-    /**
-     *
-     * @summary Find the project related to the projectString(GUID or slug)
-     * @param {string} projectString The project id (GUID) or slug (from URL).
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    adminGetProject: (projectString: string, options?: any) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary Update a project maximum and allocated quota
-     * @param {string} projectId Id of the project
-     * @param {string} resourceTypeId Id of the resource type
-     * @param {UpdateQuotaParameterObject} updateQuotaParameterObject JSON object for updating the project maximum and allocated quota.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    adminUpdateQuota: (projectId: string, resourceTypeId: string, updateQuotaParameterObject: UpdateQuotaParameterObject, options?: any) => Promise<RequestArgs>;
-};
-/**
- * AdminApi - functional programming interface
- * @export
- */
-export declare const AdminApiFp: (configuration?: Configuration) => {
-    /**
-     *
-     * @summary Find the project related to the projectString(GUID or slug)
-     * @param {string} projectString The project id (GUID) or slug (from URL).
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    adminGetProject(projectString: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminProjectObject>>;
-    /**
-     *
-     * @summary Update a project maximum and allocated quota
-     * @param {string} projectId Id of the project
-     * @param {string} resourceTypeId Id of the resource type
-     * @param {UpdateQuotaParameterObject} updateQuotaParameterObject JSON object for updating the project maximum and allocated quota.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    adminUpdateQuota(projectId: string, resourceTypeId: string, updateQuotaParameterObject: UpdateQuotaParameterObject, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
-};
-/**
- * AdminApi - factory interface
- * @export
- */
-export declare const AdminApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
-    /**
-     *
-     * @summary Find the project related to the projectString(GUID or slug)
-     * @param {string} projectString The project id (GUID) or slug (from URL).
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    adminGetProject(projectString: string, options?: any): AxiosPromise<AdminProjectObject>;
-    /**
-     *
-     * @summary Update a project maximum and allocated quota
-     * @param {string} projectId Id of the project
-     * @param {string} resourceTypeId Id of the resource type
-     * @param {UpdateQuotaParameterObject} updateQuotaParameterObject JSON object for updating the project maximum and allocated quota.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    adminUpdateQuota(projectId: string, resourceTypeId: string, updateQuotaParameterObject: UpdateQuotaParameterObject, options?: any): AxiosPromise<any>;
-};
-/**
- * AdminApi - object-oriented interface
- * @export
- * @class AdminApi
- * @extends {BaseAPI}
- */
-export declare class AdminApi extends BaseAPI {
-    /**
-     *
-     * @summary Find the project related to the projectString(GUID or slug)
-     * @param {string} projectString The project id (GUID) or slug (from URL).
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof AdminApi
-     */
-    adminGetProject(projectString: string, options?: any): Promise<import("axios").AxiosResponse<AdminProjectObject>>;
-    /**
-     *
-     * @summary Update a project maximum and allocated quota
-     * @param {string} projectId Id of the project
-     * @param {string} resourceTypeId Id of the resource type
-     * @param {UpdateQuotaParameterObject} updateQuotaParameterObject JSON object for updating the project maximum and allocated quota.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof AdminApi
-     */
-    adminUpdateQuota(projectId: string, resourceTypeId: string, updateQuotaParameterObject: UpdateQuotaParameterObject, options?: any): Promise<import("axios").AxiosResponse<any>>;
-}

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

@@ -1,55 +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.
- */
-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.Admin/common.d.ts

@@ -1,65 +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.
- */
-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.Admin/configuration.d.ts

@@ -1,83 +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 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.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.Blob/api.d.ts

@@ -1,155 +0,0 @@
-/**
- * Coscine.Api.Blob
- * 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';
-/**
- * BlobApi - axios parameter creator
- * @export
- */
-export declare const BlobApiAxiosParamCreator: (configuration?: Configuration) => {
-    /**
-     *
-     * @summary This method deletes a given file
-     * @param {string} resourceId Id of the resource
-     * @param {string} [path] Path to the file
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    blobDeleteFileWithParameter: (resourceId: string, path?: string, options?: any) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary This method checks if the given file exists and returns it
-     * @param {string} resourceId Id of the resource
-     * @param {string} [path] Path to the file
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    blobGetFileWithParameter: (resourceId: string, path?: string, options?: any) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary This method uploads a given File
-     * @param {string} resourceId Id of the resource
-     * @param {string} [path] Path to the file
-     * @param {Array<any>} [files]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    blobUploadFileWithParameter: (resourceId: string, path?: string, files?: Array<any>, options?: any) => Promise<RequestArgs>;
-};
-/**
- * BlobApi - functional programming interface
- * @export
- */
-export declare const BlobApiFp: (configuration?: Configuration) => {
-    /**
-     *
-     * @summary This method deletes a given file
-     * @param {string} resourceId Id of the resource
-     * @param {string} [path] Path to the file
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    blobDeleteFileWithParameter(resourceId: string, path?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
-    /**
-     *
-     * @summary This method checks if the given file exists and returns it
-     * @param {string} resourceId Id of the resource
-     * @param {string} [path] Path to the file
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    blobGetFileWithParameter(resourceId: string, path?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
-    /**
-     *
-     * @summary This method uploads a given File
-     * @param {string} resourceId Id of the resource
-     * @param {string} [path] Path to the file
-     * @param {Array<any>} [files]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    blobUploadFileWithParameter(resourceId: string, path?: string, files?: Array<any>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
-};
-/**
- * BlobApi - factory interface
- * @export
- */
-export declare const BlobApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
-    /**
-     *
-     * @summary This method deletes a given file
-     * @param {string} resourceId Id of the resource
-     * @param {string} [path] Path to the file
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    blobDeleteFileWithParameter(resourceId: string, path?: string, options?: any): AxiosPromise<any>;
-    /**
-     *
-     * @summary This method checks if the given file exists and returns it
-     * @param {string} resourceId Id of the resource
-     * @param {string} [path] Path to the file
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    blobGetFileWithParameter(resourceId: string, path?: string, options?: any): AxiosPromise<any>;
-    /**
-     *
-     * @summary This method uploads a given File
-     * @param {string} resourceId Id of the resource
-     * @param {string} [path] Path to the file
-     * @param {Array<any>} [files]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    blobUploadFileWithParameter(resourceId: string, path?: string, files?: Array<any>, options?: any): AxiosPromise<any>;
-};
-/**
- * BlobApi - object-oriented interface
- * @export
- * @class BlobApi
- * @extends {BaseAPI}
- */
-export declare class BlobApi extends BaseAPI {
-    /**
-     *
-     * @summary This method deletes a given file
-     * @param {string} resourceId Id of the resource
-     * @param {string} [path] Path to the file
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof BlobApi
-     */
-    blobDeleteFileWithParameter(resourceId: string, path?: string, options?: any): Promise<import("axios").AxiosResponse<any>>;
-    /**
-     *
-     * @summary This method checks if the given file exists and returns it
-     * @param {string} resourceId Id of the resource
-     * @param {string} [path] Path to the file
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof BlobApi
-     */
-    blobGetFileWithParameter(resourceId: string, path?: string, options?: any): Promise<import("axios").AxiosResponse<any>>;
-    /**
-     *
-     * @summary This method uploads a given File
-     * @param {string} resourceId Id of the resource
-     * @param {string} [path] Path to the file
-     * @param {Array<any>} [files]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof BlobApi
-     */
-    blobUploadFileWithParameter(resourceId: string, path?: string, files?: Array<any>, options?: any): Promise<import("axios").AxiosResponse<any>>;
-}

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

@@ -1,55 +0,0 @@
-/**
- * Coscine.Api.Blob
- * 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);
-}