@coscine/api-client 2.2.0 → 2.5.0

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

@@ -2,7 +2,7 @@
  * Coscine.Api.Project
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.8.4
+ * The version of the OpenAPI document: 4.0.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/types/Coscine.Api.Project/common.d.ts

@@ -2,7 +2,7 @@
  * Coscine.Api.Project
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.8.4
+ * The version of the OpenAPI document: 4.0.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/types/Coscine.Api.Project/configuration.d.ts

@@ -2,7 +2,7 @@
  * Coscine.Api.Project
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.8.4
+ * The version of the OpenAPI document: 4.0.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -2,7 +2,7 @@
  * Coscine.Api.Project
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.8.4
+ * The version of the OpenAPI document: 4.0.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -2,7 +2,7 @@
  * Coscine.Api.Resources
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.8.3
+ * The version of the OpenAPI document: 3.0.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -107,6 +107,38 @@ export interface MetadataView {
      */
     editableKey?: boolean;
 }
+/**
+ *
+ * @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"
+}
 /**
  *
  * @export
@@ -248,6 +280,43 @@ export interface ResourceObject {
      */
     archived?: boolean;
 }
+/**
+ *
+ * @export
+ * @interface ResourceQuotaReturnObject
+ */
+export interface ResourceQuotaReturnObject {
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceQuotaReturnObject
+     */
+    id?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceQuotaReturnObject
+     */
+    name?: string | null;
+    /**
+     *
+     * @type {QuotaDimObject}
+     * @memberof ResourceQuotaReturnObject
+     */
+    used?: QuotaDimObject | null;
+    /**
+     *
+     * @type {number}
+     * @memberof ResourceQuotaReturnObject
+     */
+    usedPercentage?: number;
+    /**
+     *
+     * @type {QuotaDimObject}
+     * @memberof ResourceQuotaReturnObject
+     */
+    reserved?: QuotaDimObject | null;
+}
 /**
  *
  * @export
@@ -278,18 +347,36 @@ export interface ResourceTypeInformation {
      * @memberof ResourceTypeInformation
      */
     canRead?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ResourceTypeInformation
+     */
+    canSetResourceReadonly?: boolean;
     /**
      *
      * @type {boolean}
      * @memberof ResourceTypeInformation
      */
     canUpdate?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ResourceTypeInformation
+     */
+    canUpdateResource?: boolean;
     /**
      *
      * @type {boolean}
      * @memberof ResourceTypeInformation
      */
     canDelete?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ResourceTypeInformation
+     */
+    canDeleteResource?: boolean;
     /**
      *
      * @type {boolean}
@@ -373,6 +460,19 @@ export declare enum ResourceTypeStatus {
     Hidden = "hidden",
     Active = "active"
 }
+/**
+ * Parameter object containing the update informations.
+ * @export
+ * @interface UpdateResourceObject
+ */
+export interface UpdateResourceObject {
+    /**
+     * New reserved quota value to set for the selected resource in GiB.
+     * @type {number}
+     * @memberof UpdateResourceObject
+     */
+    reservedGiB?: number;
+}
 /**
  *
  * @export
@@ -399,7 +499,7 @@ export interface VisibilityObject {
 export declare const ResourceApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
      *
-     * @summary This deletes the specified resource.
+     * @summary Deletes a resource.
      * @param {string} id A GUID as a string that identifies the resource.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -407,30 +507,30 @@ export declare const ResourceApiAxiosParamCreator: (configuration?: Configuratio
     resourceDelete: (id: string, options?: any) => Promise<RequestArgs>;
     /**
      *
-     * @summary This returns the resource for the specified id.
-     * @param {string} id A GUID as a string that identifies the resource.
+     * @summary Returns the resource with a specified id.
+     * @param {string} id The resource id.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     resourceGet: (id: string, options?: any) => Promise<RequestArgs>;
     /**
      *
-     * @summary This returns a list of all resources the current user has access to.
+     * @summary Returns a list of all resources the current user has access to.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     resourceIndex: (options?: any) => Promise<RequestArgs>;
     /**
      *
-     * @summary This returns if the current user is the creator of the specified resource.
-     * @param {string} id A GUID as a string that identifies the resource.
+     * @summary Returns whether or not the current user is creator of a specified resource.
+     * @param {string} id The resource id.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     resourceIsUserResourceCreator: (id: string, options?: any) => Promise<RequestArgs>;
     /**
      *
-     * @summary This returns the read only status of the given resource.
+     * @summary Sets a read only status of a given resource.
      * @param {string} id A GUID as a string that identifies the resource.
      * @param {boolean} [status] A boolean value that specifies if the resource is archived.
      * @param {*} [options] Override http request option.
@@ -439,7 +539,7 @@ export declare const ResourceApiAxiosParamCreator: (configuration?: Configuratio
     resourceSetResourceReadonly: (id: string, status?: boolean, options?: any) => Promise<RequestArgs>;
     /**
      *
-     * @summary This stores the provided resource object for the specified project.
+     * @summary Stores the provided resource object in a specified project.
      * @param {string} projectId A GUID as a string that identifies the resource.
      * @param {ResourceObject} resourceObject Entry representing the user
      * @param {*} [options] Override http request option.
@@ -448,8 +548,8 @@ export declare const ResourceApiAxiosParamCreator: (configuration?: Configuratio
     resourceStoreToProject: (projectId: string, resourceObject: ResourceObject, options?: any) => Promise<RequestArgs>;
     /**
      *
-     * @summary This returns if the current user is the creator of the specified resource.
-     * @param {string} id A GUID as a string that identifies the resource.
+     * @summary Updates a resource.
+     * @param {string} id The resource id.
      * @param {ResourceObject} resourceObject Entry representing the user
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -463,7 +563,7 @@ export declare const ResourceApiAxiosParamCreator: (configuration?: Configuratio
 export declare const ResourceApiFp: (configuration?: Configuration) => {
     /**
      *
-     * @summary This deletes the specified resource.
+     * @summary Deletes a resource.
      * @param {string} id A GUID as a string that identifies the resource.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -471,30 +571,30 @@ export declare const ResourceApiFp: (configuration?: Configuration) => {
     resourceDelete(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
     /**
      *
-     * @summary This returns the resource for the specified id.
-     * @param {string} id A GUID as a string that identifies the resource.
+     * @summary Returns the resource with a specified id.
+     * @param {string} id The resource id.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     resourceGet(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
     /**
      *
-     * @summary This returns a list of all resources the current user has access to.
+     * @summary Returns a list of all resources the current user has access to.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     resourceIndex(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
     /**
      *
-     * @summary This returns if the current user is the creator of the specified resource.
-     * @param {string} id A GUID as a string that identifies the resource.
+     * @summary Returns whether or not the current user is creator of a specified resource.
+     * @param {string} id The resource id.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     resourceIsUserResourceCreator(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
     /**
      *
-     * @summary This returns the read only status of the given resource.
+     * @summary Sets a read only status of a given resource.
      * @param {string} id A GUID as a string that identifies the resource.
      * @param {boolean} [status] A boolean value that specifies if the resource is archived.
      * @param {*} [options] Override http request option.
@@ -503,7 +603,7 @@ export declare const ResourceApiFp: (configuration?: Configuration) => {
     resourceSetResourceReadonly(id: string, status?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
     /**
      *
-     * @summary This stores the provided resource object for the specified project.
+     * @summary Stores the provided resource object in a specified project.
      * @param {string} projectId A GUID as a string that identifies the resource.
      * @param {ResourceObject} resourceObject Entry representing the user
      * @param {*} [options] Override http request option.
@@ -512,8 +612,8 @@ export declare const ResourceApiFp: (configuration?: Configuration) => {
     resourceStoreToProject(projectId: string, resourceObject: ResourceObject, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
     /**
      *
-     * @summary This returns if the current user is the creator of the specified resource.
-     * @param {string} id A GUID as a string that identifies the resource.
+     * @summary Updates a resource.
+     * @param {string} id The resource id.
      * @param {ResourceObject} resourceObject Entry representing the user
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -527,7 +627,7 @@ export declare const ResourceApiFp: (configuration?: Configuration) => {
 export declare const ResourceApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
      *
-     * @summary This deletes the specified resource.
+     * @summary Deletes a resource.
      * @param {string} id A GUID as a string that identifies the resource.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -535,30 +635,30 @@ export declare const ResourceApiFactory: (configuration?: Configuration, basePat
     resourceDelete(id: string, options?: any): AxiosPromise<any>;
     /**
      *
-     * @summary This returns the resource for the specified id.
-     * @param {string} id A GUID as a string that identifies the resource.
+     * @summary Returns the resource with a specified id.
+     * @param {string} id The resource id.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     resourceGet(id: string, options?: any): AxiosPromise<any>;
     /**
      *
-     * @summary This returns a list of all resources the current user has access to.
+     * @summary Returns a list of all resources the current user has access to.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     resourceIndex(options?: any): AxiosPromise<any>;
     /**
      *
-     * @summary This returns if the current user is the creator of the specified resource.
-     * @param {string} id A GUID as a string that identifies the resource.
+     * @summary Returns whether or not the current user is creator of a specified resource.
+     * @param {string} id The resource id.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     resourceIsUserResourceCreator(id: string, options?: any): AxiosPromise<any>;
     /**
      *
-     * @summary This returns the read only status of the given resource.
+     * @summary Sets a read only status of a given resource.
      * @param {string} id A GUID as a string that identifies the resource.
      * @param {boolean} [status] A boolean value that specifies if the resource is archived.
      * @param {*} [options] Override http request option.
@@ -567,7 +667,7 @@ export declare const ResourceApiFactory: (configuration?: Configuration, basePat
     resourceSetResourceReadonly(id: string, status?: boolean, options?: any): AxiosPromise<any>;
     /**
      *
-     * @summary This stores the provided resource object for the specified project.
+     * @summary Stores the provided resource object in a specified project.
      * @param {string} projectId A GUID as a string that identifies the resource.
      * @param {ResourceObject} resourceObject Entry representing the user
      * @param {*} [options] Override http request option.
@@ -576,8 +676,8 @@ export declare const ResourceApiFactory: (configuration?: Configuration, basePat
     resourceStoreToProject(projectId: string, resourceObject: ResourceObject, options?: any): AxiosPromise<any>;
     /**
      *
-     * @summary This returns if the current user is the creator of the specified resource.
-     * @param {string} id A GUID as a string that identifies the resource.
+     * @summary Updates a resource.
+     * @param {string} id The resource id.
      * @param {ResourceObject} resourceObject Entry representing the user
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -593,7 +693,7 @@ export declare const ResourceApiFactory: (configuration?: Configuration, basePat
 export declare class ResourceApi extends BaseAPI {
     /**
      *
-     * @summary This deletes the specified resource.
+     * @summary Deletes a resource.
      * @param {string} id A GUID as a string that identifies the resource.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -602,8 +702,8 @@ export declare class ResourceApi extends BaseAPI {
     resourceDelete(id: string, options?: any): Promise<import("axios").AxiosResponse<any>>;
     /**
      *
-     * @summary This returns the resource for the specified id.
-     * @param {string} id A GUID as a string that identifies the resource.
+     * @summary Returns the resource with a specified id.
+     * @param {string} id The resource id.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ResourceApi
@@ -611,7 +711,7 @@ export declare class ResourceApi extends BaseAPI {
     resourceGet(id: string, options?: any): Promise<import("axios").AxiosResponse<any>>;
     /**
      *
-     * @summary This returns a list of all resources the current user has access to.
+     * @summary Returns a list of all resources the current user has access to.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ResourceApi
@@ -619,8 +719,8 @@ export declare class ResourceApi extends BaseAPI {
     resourceIndex(options?: any): Promise<import("axios").AxiosResponse<any>>;
     /**
      *
-     * @summary This returns if the current user is the creator of the specified resource.
-     * @param {string} id A GUID as a string that identifies the resource.
+     * @summary Returns whether or not the current user is creator of a specified resource.
+     * @param {string} id The resource id.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ResourceApi
@@ -628,7 +728,7 @@ export declare class ResourceApi extends BaseAPI {
     resourceIsUserResourceCreator(id: string, options?: any): Promise<import("axios").AxiosResponse<any>>;
     /**
      *
-     * @summary This returns the read only status of the given resource.
+     * @summary Sets a read only status of a given resource.
      * @param {string} id A GUID as a string that identifies the resource.
      * @param {boolean} [status] A boolean value that specifies if the resource is archived.
      * @param {*} [options] Override http request option.
@@ -638,7 +738,7 @@ export declare class ResourceApi extends BaseAPI {
     resourceSetResourceReadonly(id: string, status?: boolean, options?: any): Promise<import("axios").AxiosResponse<any>>;
     /**
      *
-     * @summary This stores the provided resource object for the specified project.
+     * @summary Stores the provided resource object in a specified project.
      * @param {string} projectId A GUID as a string that identifies the resource.
      * @param {ResourceObject} resourceObject Entry representing the user
      * @param {*} [options] Override http request option.
@@ -648,8 +748,8 @@ export declare class ResourceApi extends BaseAPI {
     resourceStoreToProject(projectId: string, resourceObject: ResourceObject, options?: any): Promise<import("axios").AxiosResponse<any>>;
     /**
      *
-     * @summary This returns if the current user is the creator of the specified resource.
-     * @param {string} id A GUID as a string that identifies the resource.
+     * @summary Updates a resource.
+     * @param {string} id The resource id.
      * @param {ResourceObject} resourceObject Entry representing the user
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -657,6 +757,102 @@ export declare class ResourceApi extends BaseAPI {
      */
     resourceUpdate(id: string, resourceObject: ResourceObject, options?: any): Promise<import("axios").AxiosResponse<any>>;
 }
+/**
+ * ResourceQuotaApi - axios parameter creator
+ * @export
+ */
+export declare const ResourceQuotaApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Retrieves the resource quota for an individual resource.
+     * @param {string} id Id of the resource.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    resourceQuotaGetResourceQuota: (id: string, options?: any) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Updates the resource quota for an individual resource.
+     * @param {string} id Id of the resource.
+     * @param {UpdateResourceObject} updateResourceObject Contains the resource id and the new quota.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    resourceQuotaUpdateResourceQuota: (id: string, updateResourceObject: UpdateResourceObject, options?: any) => Promise<RequestArgs>;
+};
+/**
+ * ResourceQuotaApi - functional programming interface
+ * @export
+ */
+export declare const ResourceQuotaApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Retrieves the resource quota for an individual resource.
+     * @param {string} id Id of the resource.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    resourceQuotaGetResourceQuota(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResourceQuotaReturnObject>>;
+    /**
+     *
+     * @summary Updates the resource quota for an individual resource.
+     * @param {string} id Id of the resource.
+     * @param {UpdateResourceObject} updateResourceObject Contains the resource id and the new quota.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    resourceQuotaUpdateResourceQuota(id: string, updateResourceObject: UpdateResourceObject, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
+};
+/**
+ * ResourceQuotaApi - factory interface
+ * @export
+ */
+export declare const ResourceQuotaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Retrieves the resource quota for an individual resource.
+     * @param {string} id Id of the resource.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    resourceQuotaGetResourceQuota(id: string, options?: any): AxiosPromise<ResourceQuotaReturnObject>;
+    /**
+     *
+     * @summary Updates the resource quota for an individual resource.
+     * @param {string} id Id of the resource.
+     * @param {UpdateResourceObject} updateResourceObject Contains the resource id and the new quota.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    resourceQuotaUpdateResourceQuota(id: string, updateResourceObject: UpdateResourceObject, options?: any): AxiosPromise<any>;
+};
+/**
+ * ResourceQuotaApi - object-oriented interface
+ * @export
+ * @class ResourceQuotaApi
+ * @extends {BaseAPI}
+ */
+export declare class ResourceQuotaApi extends BaseAPI {
+    /**
+     *
+     * @summary Retrieves the resource quota for an individual resource.
+     * @param {string} id Id of the resource.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ResourceQuotaApi
+     */
+    resourceQuotaGetResourceQuota(id: string, options?: any): Promise<import("axios").AxiosResponse<ResourceQuotaReturnObject>>;
+    /**
+     *
+     * @summary Updates the resource quota for an individual resource.
+     * @param {string} id Id of the resource.
+     * @param {UpdateResourceObject} updateResourceObject Contains the resource id and the new quota.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ResourceQuotaApi
+     */
+    resourceQuotaUpdateResourceQuota(id: string, updateResourceObject: UpdateResourceObject, options?: any): Promise<import("axios").AxiosResponse<any>>;
+}
 /**
  * ResourceTypeApi - axios parameter creator
  * @export

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

@@ -2,7 +2,7 @@
  * Coscine.Api.Resources
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.8.3
+ * The version of the OpenAPI document: 3.0.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/types/Coscine.Api.Resources/common.d.ts

@@ -2,7 +2,7 @@
  * Coscine.Api.Resources
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.8.3
+ * The version of the OpenAPI document: 3.0.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/types/Coscine.Api.Resources/configuration.d.ts

@@ -2,7 +2,7 @@
  * Coscine.Api.Resources
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.8.3
+ * The version of the OpenAPI document: 3.0.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -2,7 +2,7 @@
  * Coscine.Api.Resources
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.8.3
+ * The version of the OpenAPI document: 3.0.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).