@coscine/api-client 3.3.1 → 3.4.0

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

@@ -0,0 +1,187 @@
+/**
+ * Coscine Web API
+ * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project.
+ *
+ * The version of the OpenAPI document: 2.0
+ * Contact: servicedesk@itc.rwth-aachen.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from '../../configuration';
+import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { RequestArgs, BaseAPI } from '../../base';
+import { OrganizationDtoPagedResponse } from '../../@coscine/model';
+import { OrganizationDtoResponse } from '../../@coscine/model';
+/**
+ * OrganizationApi - axios parameter creator
+ * @export
+ */
+export declare const OrganizationApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2OrganizationsOptions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Retrieves an organization.
+     * @param {string} organizationRorUri The parameters for organization filtering and pagination.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrganization: (organizationRorUri: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Retrieves all organizations.
+     * @param {string} [searchTerm] Gets or sets the search term used to filter organizations.
+     * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
+     * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
+     * @param {string} [orderBy] Gets or sets the field name used for ordering the results.  The order is constructed by a order string.  Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrganizations: (searchTerm?: string, pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * OrganizationApi - functional programming interface
+ * @export
+ */
+export declare const OrganizationApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2OrganizationsOptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Retrieves an organization.
+     * @param {string} organizationRorUri The parameters for organization filtering and pagination.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrganization(organizationRorUri: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrganizationDtoResponse>>;
+    /**
+     *
+     * @summary Retrieves all organizations.
+     * @param {string} [searchTerm] Gets or sets the search term used to filter organizations.
+     * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
+     * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
+     * @param {string} [orderBy] Gets or sets the field name used for ordering the results.  The order is constructed by a order string.  Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrganizations(searchTerm?: string, pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrganizationDtoPagedResponse>>;
+};
+/**
+ * OrganizationApi - factory interface
+ * @export
+ */
+export declare const OrganizationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2OrganizationsOptions(options?: AxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Retrieves an organization.
+     * @param {OrganizationApiGetOrganizationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrganization(requestParameters: OrganizationApiGetOrganizationRequest, options?: AxiosRequestConfig): AxiosPromise<OrganizationDtoResponse>;
+    /**
+     *
+     * @summary Retrieves all organizations.
+     * @param {OrganizationApiGetOrganizationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrganizations(requestParameters?: OrganizationApiGetOrganizationsRequest, options?: AxiosRequestConfig): AxiosPromise<OrganizationDtoPagedResponse>;
+};
+/**
+ * Request parameters for getOrganization operation in OrganizationApi.
+ * @export
+ * @interface OrganizationApiGetOrganizationRequest
+ */
+export interface OrganizationApiGetOrganizationRequest {
+    /**
+     * The parameters for organization filtering and pagination.
+     * @type {string}
+     * @memberof OrganizationApiGetOrganization
+     */
+    readonly organizationRorUri: string;
+}
+/**
+ * Request parameters for getOrganizations operation in OrganizationApi.
+ * @export
+ * @interface OrganizationApiGetOrganizationsRequest
+ */
+export interface OrganizationApiGetOrganizationsRequest {
+    /**
+     * Gets or sets the search term used to filter organizations.
+     * @type {string}
+     * @memberof OrganizationApiGetOrganizations
+     */
+    readonly searchTerm?: string;
+    /**
+     * The desired page number. Should be greater than or equal to 1. Default is 1.
+     * @type {number}
+     * @memberof OrganizationApiGetOrganizations
+     */
+    readonly pageNumber?: number;
+    /**
+     * The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
+     * @type {number}
+     * @memberof OrganizationApiGetOrganizations
+     */
+    readonly pageSize?: number;
+    /**
+     * Gets or sets the field name used for ordering the results.  The order is constructed by a 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 OrganizationApiGetOrganizations
+     */
+    readonly orderBy?: string;
+}
+/**
+ * OrganizationApi - object-oriented interface
+ * @export
+ * @class OrganizationApi
+ * @extends {BaseAPI}
+ */
+export declare class OrganizationApi extends BaseAPI {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrganizationApi
+     */
+    apiV2OrganizationsOptions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     *
+     * @summary Retrieves an organization.
+     * @param {OrganizationApiGetOrganizationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrganizationApi
+     */
+    getOrganization(requestParameters: OrganizationApiGetOrganizationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrganizationDtoResponse, any>>;
+    /**
+     *
+     * @summary Retrieves all organizations.
+     * @param {OrganizationApiGetOrganizationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrganizationApi
+     */
+    getOrganizations(requestParameters?: OrganizationApiGetOrganizationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrganizationDtoPagedResponse, any>>;
+}

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

@@ -0,0 +1,187 @@
+/**
+ * Coscine Web API
+ * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project.
+ *
+ * The version of the OpenAPI document: 2.0
+ * Contact: servicedesk@itc.rwth-aachen.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from '../../configuration';
+import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { RequestArgs, BaseAPI } from '../../base';
+import { PidRequestDto } from '../../@coscine/model';
+import { PidValidationDtoResponse } from '../../@coscine/model';
+/**
+ * PidApi - axios parameter creator
+ * @export
+ */
+export declare const PidApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2PidsOptions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Sends an inquiry to the owner of the given PID.
+     * @param {string} prefix The PID prefix of a project or a resource to validate
+     * @param {string} id The PID body of a project or a resource to validate
+     * @param {PidRequestDto} [pidRequestDto] The data transfer object containing the inquiry details.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    sendRequestToOwner: (prefix: string, id: string, pidRequestDto?: PidRequestDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Validates the given PID.
+     * @param {string} prefix The PID prefix of a project or a resource to validate
+     * @param {string} id The PID body of a project or a resource to validate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    validatePid: (prefix: string, id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * PidApi - functional programming interface
+ * @export
+ */
+export declare const PidApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2PidsOptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Sends an inquiry to the owner of the given PID.
+     * @param {string} prefix The PID prefix of a project or a resource to validate
+     * @param {string} id The PID body of a project or a resource to validate
+     * @param {PidRequestDto} [pidRequestDto] The data transfer object containing the inquiry details.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    sendRequestToOwner(prefix: string, id: string, pidRequestDto?: PidRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Validates the given PID.
+     * @param {string} prefix The PID prefix of a project or a resource to validate
+     * @param {string} id The PID body of a project or a resource to validate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    validatePid(prefix: string, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PidValidationDtoResponse>>;
+};
+/**
+ * PidApi - factory interface
+ * @export
+ */
+export declare const PidApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2PidsOptions(options?: AxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Sends an inquiry to the owner of the given PID.
+     * @param {PidApiSendRequestToOwnerRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    sendRequestToOwner(requestParameters: PidApiSendRequestToOwnerRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Validates the given PID.
+     * @param {PidApiValidatePidRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    validatePid(requestParameters: PidApiValidatePidRequest, options?: AxiosRequestConfig): AxiosPromise<PidValidationDtoResponse>;
+};
+/**
+ * Request parameters for sendRequestToOwner operation in PidApi.
+ * @export
+ * @interface PidApiSendRequestToOwnerRequest
+ */
+export interface PidApiSendRequestToOwnerRequest {
+    /**
+     * The PID prefix of a project or a resource to validate
+     * @type {string}
+     * @memberof PidApiSendRequestToOwner
+     */
+    readonly prefix: string;
+    /**
+     * The PID body of a project or a resource to validate
+     * @type {string}
+     * @memberof PidApiSendRequestToOwner
+     */
+    readonly id: string;
+    /**
+     * The data transfer object containing the inquiry details.
+     * @type {PidRequestDto}
+     * @memberof PidApiSendRequestToOwner
+     */
+    readonly pidRequestDto?: PidRequestDto;
+}
+/**
+ * Request parameters for validatePid operation in PidApi.
+ * @export
+ * @interface PidApiValidatePidRequest
+ */
+export interface PidApiValidatePidRequest {
+    /**
+     * The PID prefix of a project or a resource to validate
+     * @type {string}
+     * @memberof PidApiValidatePid
+     */
+    readonly prefix: string;
+    /**
+     * The PID body of a project or a resource to validate
+     * @type {string}
+     * @memberof PidApiValidatePid
+     */
+    readonly id: string;
+}
+/**
+ * PidApi - object-oriented interface
+ * @export
+ * @class PidApi
+ * @extends {BaseAPI}
+ */
+export declare class PidApi extends BaseAPI {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PidApi
+     */
+    apiV2PidsOptions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     *
+     * @summary Sends an inquiry to the owner of the given PID.
+     * @param {PidApiSendRequestToOwnerRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PidApi
+     */
+    sendRequestToOwner(requestParameters: PidApiSendRequestToOwnerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     *
+     * @summary Validates the given PID.
+     * @param {PidApiValidatePidRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PidApi
+     */
+    validatePid(requestParameters: PidApiValidatePidRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PidValidationDtoResponse, any>>;
+}