@coscine/api-client 3.21.0 → 3.22.0

package/dist/types/Coscine.Api/@coscine/api/admin-api.d.ts

@@ -16,6 +16,7 @@ import type { ActivityLogDtoPagedResponse } from '../../@coscine/model';
 import type { CoscineHttpMethod } from '../../@coscine/model';
 import type { CreateDatasourceDtoResponse } from '../../@coscine/model';
 import type { DeployedGraphDtoPagedResponse } from '../../@coscine/model';
+import type { DsNrwReplicationGroup } from '../../@coscine/model';
 import type { MetadataUpdateAdminParameters } from '../../@coscine/model';
 import type { ProjectAdminDtoPagedResponse } from '../../@coscine/model';
 import type { RdfDefinitionDtoResponse } from '../../@coscine/model';
@@ -25,6 +26,7 @@ import type { ResourceAdminDtoPagedResponse } from '../../@coscine/model';
 import type { UserDtoPagedResponse } from '../../@coscine/model';
 /**
  * AdminApi - axios parameter creator
+ * @export
  */
 export declare const AdminApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
@@ -34,16 +36,25 @@ export declare const AdminApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     apiV2AdminOptions: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
+     * @summary Deletes the given user.
+     * @param {string} userId The id of the user.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2AdminUsersUserIdDelete: (userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
      * @summary Creates a new datasource for a specified resource and type.
      * @param {string} resourceId The unique identifier of the resource.
      * @param {string} typeId The unique identifier of the datasource type.
      * @param {number} [quota] The allocated quota for the datasource.
+     * @param {DsNrwReplicationGroup} [dsNrwReplicationGroup] The optional replication grouo for the datasource.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createDatasource: (resourceId: string, typeId: string, quota?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    createDatasource: (resourceId: string, typeId: string, quota?: number, dsNrwReplicationGroup?: DsNrwReplicationGroup, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
      * @summary Retrieves all activity logs.
@@ -148,6 +159,7 @@ export declare const AdminApiAxiosParamCreator: (configuration?: Configuration)
 };
 /**
  * AdminApi - functional programming interface
+ * @export
  */
 export declare const AdminApiFp: (configuration?: Configuration) => {
     /**
@@ -157,16 +169,25 @@ export declare const AdminApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     apiV2AdminOptions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
+     * @summary Deletes the given user.
+     * @param {string} userId The id of the user.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2AdminUsersUserIdDelete(userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
      * @summary Creates a new datasource for a specified resource and type.
      * @param {string} resourceId The unique identifier of the resource.
      * @param {string} typeId The unique identifier of the datasource type.
      * @param {number} [quota] The allocated quota for the datasource.
+     * @param {DsNrwReplicationGroup} [dsNrwReplicationGroup] The optional replication grouo for the datasource.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createDatasource(resourceId: string, typeId: string, quota?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDatasourceDtoResponse>>;
+    createDatasource(resourceId: string, typeId: string, quota?: number, dsNrwReplicationGroup?: DsNrwReplicationGroup, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDatasourceDtoResponse>>;
     /**
      * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
      * @summary Retrieves all activity logs.
@@ -271,6 +292,7 @@ export declare const AdminApiFp: (configuration?: Configuration) => {
 };
 /**
  * AdminApi - factory interface
+ * @export
  */
 export declare const AdminApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
@@ -280,6 +302,14 @@ export declare const AdminApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     apiV2AdminOptions(options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
+     * @summary Deletes the given user.
+     * @param {AdminApiApiV2AdminUsersUserIdDeleteRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2AdminUsersUserIdDelete(requestParameters: AdminApiApiV2AdminUsersUserIdDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
      * @summary Creates a new datasource for a specified resource and type.
@@ -361,224 +391,344 @@ export declare const AdminApiFactory: (configuration?: Configuration, basePath?:
      */
     updateResourceType(requestParameters: AdminApiUpdateResourceTypeRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
 };
+/**
+ * Request parameters for apiV2AdminUsersUserIdDelete operation in AdminApi.
+ * @export
+ * @interface AdminApiApiV2AdminUsersUserIdDeleteRequest
+ */
+export interface AdminApiApiV2AdminUsersUserIdDeleteRequest {
+    /**
+     * The id of the user.
+     * @type {string}
+     * @memberof AdminApiApiV2AdminUsersUserIdDelete
+     */
+    readonly userId: string;
+}
 /**
  * Request parameters for createDatasource operation in AdminApi.
+ * @export
+ * @interface AdminApiCreateDatasourceRequest
  */
 export interface AdminApiCreateDatasourceRequest {
     /**
      * The unique identifier of the resource.
+     * @type {string}
+     * @memberof AdminApiCreateDatasource
      */
     readonly resourceId: string;
     /**
      * The unique identifier of the datasource type.
+     * @type {string}
+     * @memberof AdminApiCreateDatasource
      */
     readonly typeId: string;
     /**
      * The allocated quota for the datasource.
+     * @type {number}
+     * @memberof AdminApiCreateDatasource
      */
     readonly quota?: number;
+    /**
+     * The optional replication grouo for the datasource.
+     * @type {DsNrwReplicationGroup}
+     * @memberof AdminApiCreateDatasource
+     */
+    readonly dsNrwReplicationGroup?: DsNrwReplicationGroup;
 }
 /**
  * Request parameters for getAllActivityLogs operation in AdminApi.
+ * @export
+ * @interface AdminApiGetAllActivityLogsRequest
  */
 export interface AdminApiGetAllActivityLogsRequest {
     /**
      * The activity timestamp date before which activity logs should be retrieved.
+     * @type {string}
+     * @memberof AdminApiGetAllActivityLogs
      */
     readonly activityTimestampBefore?: string;
     /**
      * The activity timestamp date after which activity logs should be retrieved.
+     * @type {string}
+     * @memberof AdminApiGetAllActivityLogs
      */
     readonly activityTimestampAfter?: string;
     /**
      * The GUID for which activity logs should be retrieved. Can be a project, resource or other ID.
+     * @type {string}
+     * @memberof AdminApiGetAllActivityLogs
      */
     readonly guid?: string;
     /**
      * The user ID for which activity logs should be retrieved.
+     * @type {string}
+     * @memberof AdminApiGetAllActivityLogs
      */
     readonly userId?: string;
     /**
      * The regular expression to filter activity logs\&#39; API path by. The regex must be a valid, already escaped string.
+     * @type {string}
+     * @memberof AdminApiGetAllActivityLogs
      */
     readonly regularExpression?: string;
     /**
      * The http method to filter activity logs by.
+     * @type {CoscineHttpMethod}
+     * @memberof AdminApiGetAllActivityLogs
      */
     readonly httpMethod?: CoscineHttpMethod;
     /**
      * The desired page number. Should be greater than or equal to 1. Default is 1.
+     * @type {number}
+     * @memberof AdminApiGetAllActivityLogs
      */
     readonly pageNumber?: number;
     /**
      * The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
+     * @type {number}
+     * @memberof AdminApiGetAllActivityLogs
      */
     readonly pageSize?: number;
     /**
      * Gets or sets the field name used for ordering the results.  The order is constructed by an order string.  Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.
+     * @type {string}
+     * @memberof AdminApiGetAllActivityLogs
      */
     readonly orderBy?: string;
 }
 /**
  * Request parameters for getAllProjects operation in AdminApi.
+ * @export
+ * @interface AdminApiGetAllProjectsRequest
  */
 export interface AdminApiGetAllProjectsRequest {
     /**
      * Gets or sets a value indicating whether to filter top-level projects.
+     * @type {boolean}
+     * @memberof AdminApiGetAllProjects
      */
     readonly topLevel?: boolean;
     /**
      * Gets or sets a value indicating whether to include deleted projects in the results.
+     * @type {boolean}
+     * @memberof AdminApiGetAllProjects
      */
     readonly includeDeleted?: boolean;
     /**
      * Gets or sets a value indicating whether to include quotas in the results.
+     * @type {boolean}
+     * @memberof AdminApiGetAllProjects
      */
     readonly includeQuotas?: boolean;
     /**
      * Gets or sets a value indicating whether to include project publication requests in the results.
+     * @type {boolean}
+     * @memberof AdminApiGetAllProjects
      */
     readonly includePublicationRequests?: boolean;
     /**
      * Number of items per page. The maximum number of items per page is &#x60;250&#x60;.
+     * @type {number}
+     * @memberof AdminApiGetAllProjects
      */
     readonly pageSize?: number;
     /**
      * The desired page number. Should be greater than or equal to 1. Default is 1.
+     * @type {number}
+     * @memberof AdminApiGetAllProjects
      */
     readonly pageNumber?: number;
     /**
      * Gets or sets the field name used for ordering the results.  The order is constructed by an order string.  Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.
+     * @type {string}
+     * @memberof AdminApiGetAllProjects
      */
     readonly orderBy?: string;
 }
 /**
  * Request parameters for getAllResources operation in AdminApi.
+ * @export
+ * @interface AdminApiGetAllResourcesRequest
  */
 export interface AdminApiGetAllResourcesRequest {
     /**
      * Value indicating whether to include deleted resources.
+     * @type {boolean}
+     * @memberof AdminApiGetAllResources
      */
     readonly includeDeleted?: boolean;
     /**
      * Value indicating whether to include individual resource quotas.
+     * @type {boolean}
+     * @memberof AdminApiGetAllResources
      */
     readonly includeQuotas?: boolean;
     /**
      * Number of items per page. The maximum number of items per page is &#x60;250&#x60;.
+     * @type {number}
+     * @memberof AdminApiGetAllResources
      */
     readonly pageSize?: number;
     /**
      * The desired page number. Should be greater than or equal to 1. Default is 1.
+     * @type {number}
+     * @memberof AdminApiGetAllResources
      */
     readonly pageNumber?: number;
     /**
      * Gets or sets the field name used for ordering the results.  The order is constructed by an order string.  Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.
+     * @type {string}
+     * @memberof AdminApiGetAllResources
      */
     readonly orderBy?: string;
 }
 /**
  * Request parameters for getAllUsers operation in AdminApi.
+ * @export
+ * @interface AdminApiGetAllUsersRequest
  */
 export interface AdminApiGetAllUsersRequest {
     /**
      * Gets or sets a value indicating whether the terms of service have been accepted by the user.
+     * @type {boolean}
+     * @memberof AdminApiGetAllUsers
      */
     readonly tosAccepted?: boolean;
     /**
      * Number of items per page. The maximum number of items per page is &#x60;250&#x60;.
+     * @type {number}
+     * @memberof AdminApiGetAllUsers
      */
     readonly pageSize?: number;
     /**
      * Gets or sets a value indicating whether the personal data processing consent have been granted by the user.
-     * @type {boolean}
-     * @memberof AdminApiGetAllUsers
      */
     readonly dataProcessingConsentGranted?: boolean;
     /**
      * The desired page number. Should be greater than or equal to 1. Default is 1.
+     * @type {number}
+     * @memberof AdminApiGetAllUsers
      */
     readonly pageNumber?: number;
     /**
      * Gets or sets the field name used for ordering the results.  The order is constructed by an order string.  Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.
+     * @type {string}
+     * @memberof AdminApiGetAllUsers
      */
     readonly orderBy?: string;
 }
 /**
  * Request parameters for getDeployedGraphs operation in AdminApi.
+ * @export
+ * @interface AdminApiGetDeployedGraphsRequest
  */
 export interface AdminApiGetDeployedGraphsRequest {
     /**
      * The desired page number. Should be greater than or equal to 1. Default is 1.
+     * @type {number}
+     * @memberof AdminApiGetDeployedGraphs
      */
     readonly pageNumber?: number;
     /**
      * The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
+     * @type {number}
+     * @memberof AdminApiGetDeployedGraphs
      */
     readonly pageSize?: number;
     /**
      * Gets or sets the field name used for ordering the results.  The order is constructed by an order string.  Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.
+     * @type {string}
+     * @memberof AdminApiGetDeployedGraphs
      */
     readonly orderBy?: string;
 }
 /**
  * Request parameters for getMetadataGraph operation in AdminApi.
+ * @export
+ * @interface AdminApiGetMetadataGraphRequest
  */
 export interface AdminApiGetMetadataGraphRequest {
     /**
      * The absolute URI of the graph to get.
+     * @type {string}
+     * @memberof AdminApiGetMetadataGraph
      */
     readonly graph: string;
     /**
      * Gets or sets the RDF format.
+     * @type {RdfFormat}
+     * @memberof AdminApiGetMetadataGraph
      */
     readonly format?: RdfFormat;
 }
 /**
  * Request parameters for patchMetadata operation in AdminApi.
+ * @export
+ * @interface AdminApiPatchMetadataRequest
  */
 export interface AdminApiPatchMetadataRequest {
     /**
      * The absolute URI of the graph to patch.
+     * @type {string}
+     * @memberof AdminApiPatchMetadata
      */
     readonly graph: string;
     /**
      * The well-formed RDF patch document containing the changes as operations to be applied to the graph.
+     * @type {RdfPatchDocumentDto}
+     * @memberof AdminApiPatchMetadata
      */
     readonly rdfPatchDocumentDto?: RdfPatchDocumentDto;
 }
 /**
  * Request parameters for updateMetadataGraph operation in AdminApi.
+ * @export
+ * @interface AdminApiUpdateMetadataGraphRequest
  */
 export interface AdminApiUpdateMetadataGraphRequest {
     /**
      * The absolute URI of the graph to update.
+     * @type {string}
+     * @memberof AdminApiUpdateMetadataGraph
      */
     readonly graph: string;
     /**
      * The metadata update admin parameters.
+     * @type {MetadataUpdateAdminParameters}
+     * @memberof AdminApiUpdateMetadataGraph
      */
     readonly metadataUpdateAdminParameters?: MetadataUpdateAdminParameters;
 }
 /**
  * Request parameters for updateResourceType operation in AdminApi.
+ * @export
+ * @interface AdminApiUpdateResourceTypeRequest
  */
 export interface AdminApiUpdateResourceTypeRequest {
     /**
      * The unique identifier of the resource to be updated.
+     * @type {string}
+     * @memberof AdminApiUpdateResourceType
      */
     readonly resourceId: string;
     /**
      * The unique identifier of the new resource type.
+     * @type {string}
+     * @memberof AdminApiUpdateResourceType
      */
     readonly typeId: string;
     /**
      * The unique identifier of the new resource type option.
+     * @type {string}
+     * @memberof AdminApiUpdateResourceType
      */
     readonly optionId?: string;
 }
 /**
  * AdminApi - object-oriented interface
+ * @export
+ * @class AdminApi
+ * @extends {BaseAPI}
  */
 export declare class AdminApi extends BaseAPI {
     /**
@@ -586,14 +736,25 @@ export declare class AdminApi extends BaseAPI {
      * @summary Responds with the HTTP methods allowed for the endpoint.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof AdminApi
      */
     apiV2AdminOptions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
+     * @summary Deletes the given user.
+     * @param {AdminApiApiV2AdminUsersUserIdDeleteRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AdminApi
+     */
+    apiV2AdminUsersUserIdDelete(requestParameters: AdminApiApiV2AdminUsersUserIdDeleteRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
      * @summary Creates a new datasource for a specified resource and type.
      * @param {AdminApiCreateDatasourceRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof AdminApi
      */
     createDatasource(requestParameters: AdminApiCreateDatasourceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateDatasourceDtoResponse, any>>;
     /**
@@ -602,6 +763,7 @@ export declare class AdminApi extends BaseAPI {
      * @param {AdminApiGetAllActivityLogsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof AdminApi
      */
     getAllActivityLogs(requestParameters?: AdminApiGetAllActivityLogsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ActivityLogDtoPagedResponse, any>>;
     /**
@@ -610,6 +772,7 @@ export declare class AdminApi extends BaseAPI {
      * @param {AdminApiGetAllProjectsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof AdminApi
      */
     getAllProjects(requestParameters?: AdminApiGetAllProjectsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProjectAdminDtoPagedResponse, any>>;
     /**
@@ -618,6 +781,7 @@ export declare class AdminApi extends BaseAPI {
      * @param {AdminApiGetAllResourcesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof AdminApi
      */
     getAllResources(requestParameters?: AdminApiGetAllResourcesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ResourceAdminDtoPagedResponse, any>>;
     /**
@@ -626,6 +790,7 @@ export declare class AdminApi extends BaseAPI {
      * @param {AdminApiGetAllUsersRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof AdminApi
      */
     getAllUsers(requestParameters?: AdminApiGetAllUsersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserDtoPagedResponse, any>>;
     /**
@@ -634,6 +799,7 @@ export declare class AdminApi extends BaseAPI {
      * @param {AdminApiGetDeployedGraphsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof AdminApi
      */
     getDeployedGraphs(requestParameters?: AdminApiGetDeployedGraphsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeployedGraphDtoPagedResponse, any>>;
     /**
@@ -642,6 +808,7 @@ export declare class AdminApi extends BaseAPI {
      * @param {AdminApiGetMetadataGraphRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof AdminApi
      */
     getMetadataGraph(requestParameters: AdminApiGetMetadataGraphRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RdfDefinitionDtoResponse, any>>;
     /**
@@ -650,6 +817,7 @@ export declare class AdminApi extends BaseAPI {
      * @param {AdminApiPatchMetadataRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof AdminApi
      */
     patchMetadata(requestParameters: AdminApiPatchMetadataRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
@@ -658,6 +826,7 @@ export declare class AdminApi extends BaseAPI {
      * @param {AdminApiUpdateMetadataGraphRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof AdminApi
      */
     updateMetadataGraph(requestParameters: AdminApiUpdateMetadataGraphRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
@@ -666,6 +835,7 @@ export declare class AdminApi extends BaseAPI {
      * @param {AdminApiUpdateResourceTypeRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof AdminApi
      */
     updateResourceType(requestParameters: AdminApiUpdateResourceTypeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
 }