@coscine/api-client 3.3.0 → 3.3.2-package.0

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

@@ -0,0 +1,165 @@
+/**
+ * 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 { SearchCategoryType } from '../../@coscine/model';
+import { SearchResultDtoPagedSearchResponse } from '../../@coscine/model';
+/**
+ * SearchApi - axios parameter creator
+ * @export
+ */
+export declare const SearchApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2SearchOptions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Retrieves a search result by given search parameters.
+     * @param {string} [query] The search query
+     * @param {boolean} [useAdvancedSyntax] Set true for advanced Elasticsearch search syntax
+     * @param {Array<string>} [languages] Set the used languages
+     * @param {SearchCategoryType} [category] Set the category filter
+     * @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}
+     */
+    getSearchResults: (query?: string, useAdvancedSyntax?: boolean, languages?: Array<string>, category?: SearchCategoryType, pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * SearchApi - functional programming interface
+ * @export
+ */
+export declare const SearchApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2SearchOptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Retrieves a search result by given search parameters.
+     * @param {string} [query] The search query
+     * @param {boolean} [useAdvancedSyntax] Set true for advanced Elasticsearch search syntax
+     * @param {Array<string>} [languages] Set the used languages
+     * @param {SearchCategoryType} [category] Set the category filter
+     * @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}
+     */
+    getSearchResults(query?: string, useAdvancedSyntax?: boolean, languages?: Array<string>, category?: SearchCategoryType, pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchResultDtoPagedSearchResponse>>;
+};
+/**
+ * SearchApi - factory interface
+ * @export
+ */
+export declare const SearchApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2SearchOptions(options?: AxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Retrieves a search result by given search parameters.
+     * @param {SearchApiGetSearchResultsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSearchResults(requestParameters?: SearchApiGetSearchResultsRequest, options?: AxiosRequestConfig): AxiosPromise<SearchResultDtoPagedSearchResponse>;
+};
+/**
+ * Request parameters for getSearchResults operation in SearchApi.
+ * @export
+ * @interface SearchApiGetSearchResultsRequest
+ */
+export interface SearchApiGetSearchResultsRequest {
+    /**
+     * The search query
+     * @type {string}
+     * @memberof SearchApiGetSearchResults
+     */
+    readonly query?: string;
+    /**
+     * Set true for advanced Elasticsearch search syntax
+     * @type {boolean}
+     * @memberof SearchApiGetSearchResults
+     */
+    readonly useAdvancedSyntax?: boolean;
+    /**
+     * Set the used languages
+     * @type {Array<string>}
+     * @memberof SearchApiGetSearchResults
+     */
+    readonly languages?: Array<string>;
+    /**
+     * Set the category filter
+     * @type {SearchCategoryType}
+     * @memberof SearchApiGetSearchResults
+     */
+    readonly category?: SearchCategoryType;
+    /**
+     * The desired page number. Should be greater than or equal to 1. Default is 1.
+     * @type {number}
+     * @memberof SearchApiGetSearchResults
+     */
+    readonly pageNumber?: number;
+    /**
+     * The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
+     * @type {number}
+     * @memberof SearchApiGetSearchResults
+     */
+    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 SearchApiGetSearchResults
+     */
+    readonly orderBy?: string;
+}
+/**
+ * SearchApi - object-oriented interface
+ * @export
+ * @class SearchApi
+ * @extends {BaseAPI}
+ */
+export declare class SearchApi extends BaseAPI {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SearchApi
+     */
+    apiV2SearchOptions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     *
+     * @summary Retrieves a search result by given search parameters.
+     * @param {SearchApiGetSearchResultsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SearchApi
+     */
+    getSearchResults(requestParameters?: SearchApiGetSearchResultsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchResultDtoPagedSearchResponse, any>>;
+}

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

@@ -0,0 +1,272 @@
+/**
+ * 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 { ApiTokenDtoPagedResponse } from '../../@coscine/model';
+import { ApiTokenDtoResponse } from '../../@coscine/model';
+import { ApiTokenForCreationDto } from '../../@coscine/model';
+/**
+ * SelfApiTokenApi - axios parameter creator
+ * @export
+ */
+export declare const SelfApiTokenApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2SelfApiTokensOptions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Creates an API token for the current authenticated user.
+     * @param {ApiTokenForCreationDto} [apiTokenForCreationDto] The API token data for creation.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createApiToken: (apiTokenForCreationDto?: ApiTokenForCreationDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Retrieves all API tokens for the current authenticated user.
+     * @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}
+     */
+    getAllApiTokens: (pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Retrieves an API token for the current authenticated user.
+     * @param {string} apiTokenId The ID of the token.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getApiToken: (apiTokenId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Revokes an API token for the current authenticated user.
+     * @param {string} apiTokenId The ID of the token.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    revokeToken: (apiTokenId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * SelfApiTokenApi - functional programming interface
+ * @export
+ */
+export declare const SelfApiTokenApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2SelfApiTokensOptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Creates an API token for the current authenticated user.
+     * @param {ApiTokenForCreationDto} [apiTokenForCreationDto] The API token data for creation.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createApiToken(apiTokenForCreationDto?: ApiTokenForCreationDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiTokenDtoResponse>>;
+    /**
+     *
+     * @summary Retrieves all API tokens for the current authenticated user.
+     * @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}
+     */
+    getAllApiTokens(pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiTokenDtoPagedResponse>>;
+    /**
+     *
+     * @summary Retrieves an API token for the current authenticated user.
+     * @param {string} apiTokenId The ID of the token.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getApiToken(apiTokenId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiTokenDtoResponse>>;
+    /**
+     *
+     * @summary Revokes an API token for the current authenticated user.
+     * @param {string} apiTokenId The ID of the token.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    revokeToken(apiTokenId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+};
+/**
+ * SelfApiTokenApi - factory interface
+ * @export
+ */
+export declare const SelfApiTokenApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2SelfApiTokensOptions(options?: AxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Creates an API token for the current authenticated user.
+     * @param {SelfApiTokenApiCreateApiTokenRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createApiToken(requestParameters?: SelfApiTokenApiCreateApiTokenRequest, options?: AxiosRequestConfig): AxiosPromise<ApiTokenDtoResponse>;
+    /**
+     *
+     * @summary Retrieves all API tokens for the current authenticated user.
+     * @param {SelfApiTokenApiGetAllApiTokensRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAllApiTokens(requestParameters?: SelfApiTokenApiGetAllApiTokensRequest, options?: AxiosRequestConfig): AxiosPromise<ApiTokenDtoPagedResponse>;
+    /**
+     *
+     * @summary Retrieves an API token for the current authenticated user.
+     * @param {SelfApiTokenApiGetApiTokenRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getApiToken(requestParameters: SelfApiTokenApiGetApiTokenRequest, options?: AxiosRequestConfig): AxiosPromise<ApiTokenDtoResponse>;
+    /**
+     *
+     * @summary Revokes an API token for the current authenticated user.
+     * @param {SelfApiTokenApiRevokeTokenRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    revokeToken(requestParameters: SelfApiTokenApiRevokeTokenRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
+};
+/**
+ * Request parameters for createApiToken operation in SelfApiTokenApi.
+ * @export
+ * @interface SelfApiTokenApiCreateApiTokenRequest
+ */
+export interface SelfApiTokenApiCreateApiTokenRequest {
+    /**
+     * The API token data for creation.
+     * @type {ApiTokenForCreationDto}
+     * @memberof SelfApiTokenApiCreateApiToken
+     */
+    readonly apiTokenForCreationDto?: ApiTokenForCreationDto;
+}
+/**
+ * Request parameters for getAllApiTokens operation in SelfApiTokenApi.
+ * @export
+ * @interface SelfApiTokenApiGetAllApiTokensRequest
+ */
+export interface SelfApiTokenApiGetAllApiTokensRequest {
+    /**
+     * The desired page number. Should be greater than or equal to 1. Default is 1.
+     * @type {number}
+     * @memberof SelfApiTokenApiGetAllApiTokens
+     */
+    readonly pageNumber?: number;
+    /**
+     * The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
+     * @type {number}
+     * @memberof SelfApiTokenApiGetAllApiTokens
+     */
+    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 SelfApiTokenApiGetAllApiTokens
+     */
+    readonly orderBy?: string;
+}
+/**
+ * Request parameters for getApiToken operation in SelfApiTokenApi.
+ * @export
+ * @interface SelfApiTokenApiGetApiTokenRequest
+ */
+export interface SelfApiTokenApiGetApiTokenRequest {
+    /**
+     * The ID of the token.
+     * @type {string}
+     * @memberof SelfApiTokenApiGetApiToken
+     */
+    readonly apiTokenId: string;
+}
+/**
+ * Request parameters for revokeToken operation in SelfApiTokenApi.
+ * @export
+ * @interface SelfApiTokenApiRevokeTokenRequest
+ */
+export interface SelfApiTokenApiRevokeTokenRequest {
+    /**
+     * The ID of the token.
+     * @type {string}
+     * @memberof SelfApiTokenApiRevokeToken
+     */
+    readonly apiTokenId: string;
+}
+/**
+ * SelfApiTokenApi - object-oriented interface
+ * @export
+ * @class SelfApiTokenApi
+ * @extends {BaseAPI}
+ */
+export declare class SelfApiTokenApi extends BaseAPI {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SelfApiTokenApi
+     */
+    apiV2SelfApiTokensOptions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     *
+     * @summary Creates an API token for the current authenticated user.
+     * @param {SelfApiTokenApiCreateApiTokenRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SelfApiTokenApi
+     */
+    createApiToken(requestParameters?: SelfApiTokenApiCreateApiTokenRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiTokenDtoResponse, any>>;
+    /**
+     *
+     * @summary Retrieves all API tokens for the current authenticated user.
+     * @param {SelfApiTokenApiGetAllApiTokensRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SelfApiTokenApi
+     */
+    getAllApiTokens(requestParameters?: SelfApiTokenApiGetAllApiTokensRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiTokenDtoPagedResponse, any>>;
+    /**
+     *
+     * @summary Retrieves an API token for the current authenticated user.
+     * @param {SelfApiTokenApiGetApiTokenRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SelfApiTokenApi
+     */
+    getApiToken(requestParameters: SelfApiTokenApiGetApiTokenRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiTokenDtoResponse, any>>;
+    /**
+     *
+     * @summary Revokes an API token for the current authenticated user.
+     * @param {SelfApiTokenApiRevokeTokenRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SelfApiTokenApi
+     */
+    revokeToken(requestParameters: SelfApiTokenApiRevokeTokenRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+}