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

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

@@ -0,0 +1,116 @@
+/**
+ * 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 { ResourceDtoResponse } from '../../@coscine/model';
+/**
+ * ResourceApi - axios parameter creator
+ * @export
+ */
+export declare const ResourceApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2ResourcesOptions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Retrieves a resource by its ID.
+     * @param {string} resourceId The ID of the resource to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getResource: (resourceId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ResourceApi - functional programming interface
+ * @export
+ */
+export declare const ResourceApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2ResourcesOptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Retrieves a resource by its ID.
+     * @param {string} resourceId The ID of the resource to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getResource(resourceId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResourceDtoResponse>>;
+};
+/**
+ * ResourceApi - factory interface
+ * @export
+ */
+export declare const ResourceApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2ResourcesOptions(options?: AxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Retrieves a resource by its ID.
+     * @param {ResourceApiGetResourceRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getResource(requestParameters: ResourceApiGetResourceRequest, options?: AxiosRequestConfig): AxiosPromise<ResourceDtoResponse>;
+};
+/**
+ * Request parameters for getResource operation in ResourceApi.
+ * @export
+ * @interface ResourceApiGetResourceRequest
+ */
+export interface ResourceApiGetResourceRequest {
+    /**
+     * The ID of the resource to retrieve.
+     * @type {string}
+     * @memberof ResourceApiGetResource
+     */
+    readonly resourceId: string;
+}
+/**
+ * ResourceApi - object-oriented interface
+ * @export
+ * @class ResourceApi
+ * @extends {BaseAPI}
+ */
+export declare class ResourceApi extends BaseAPI {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ResourceApi
+     */
+    apiV2ResourcesOptions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     *
+     * @summary Retrieves a resource by its ID.
+     * @param {ResourceApiGetResourceRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ResourceApi
+     */
+    getResource(requestParameters: ResourceApiGetResourceRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ResourceDtoResponse, any>>;
+}

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

@@ -0,0 +1,327 @@
+/**
+ * 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 { GitlabBranchDtoIEnumerableResponse } from '../../@coscine/model';
+import { GitlabProjectDtoIEnumerableResponse } from '../../@coscine/model';
+import { GitlabProjectDtoResponse } from '../../@coscine/model';
+import { ResourceTypeInformationDtoIEnumerableResponse } from '../../@coscine/model';
+import { ResourceTypeInformationDtoResponse } from '../../@coscine/model';
+/**
+ * ResourceTypeApi - axios parameter creator
+ * @export
+ */
+export declare const ResourceTypeApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2ResourceTypesOptions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Retrieves all branches of a GitLab project, that the user is a member of, based on the provided credentials.
+     * @param {number} gitlabProjectId The ID of the GitLab project.
+     * @param {string} domain Domain/Host of the GitLab Provider.
+     * @param {string} accessToken GitLab Project or Group Access Token.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAllGitlabBranchesForProject: (gitlabProjectId: number, domain: string, accessToken: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Retrieves all GitLab projects, that the user is a member of, based on the provided credentials.
+     * @param {string} domain Domain/Host of the GitLab Provider.
+     * @param {string} accessToken GitLab Project or Group Access Token.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAllGitlabProjects: (domain: string, accessToken: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Retrieves the entire global resource types information.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAllResourceTypesInformation: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Retrieves a single GitLab project, that the user is a member of, based on the provided credentials.
+     * @param {number} gitlabProjectId The ID of the GitLab project.
+     * @param {string} domain Domain/Host of the GitLab Provider.
+     * @param {string} accessToken GitLab Project or Group Access Token.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGitlabProject: (gitlabProjectId: number, domain: string, accessToken: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Retrieves the resource type information for a specific resource type.
+     * @param {string} resourceTypeId The ID of the resource type to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getResourceTypeInformation: (resourceTypeId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ResourceTypeApi - functional programming interface
+ * @export
+ */
+export declare const ResourceTypeApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2ResourceTypesOptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Retrieves all branches of a GitLab project, that the user is a member of, based on the provided credentials.
+     * @param {number} gitlabProjectId The ID of the GitLab project.
+     * @param {string} domain Domain/Host of the GitLab Provider.
+     * @param {string} accessToken GitLab Project or Group Access Token.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAllGitlabBranchesForProject(gitlabProjectId: number, domain: string, accessToken: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GitlabBranchDtoIEnumerableResponse>>;
+    /**
+     *
+     * @summary Retrieves all GitLab projects, that the user is a member of, based on the provided credentials.
+     * @param {string} domain Domain/Host of the GitLab Provider.
+     * @param {string} accessToken GitLab Project or Group Access Token.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAllGitlabProjects(domain: string, accessToken: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GitlabProjectDtoIEnumerableResponse>>;
+    /**
+     *
+     * @summary Retrieves the entire global resource types information.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAllResourceTypesInformation(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResourceTypeInformationDtoIEnumerableResponse>>;
+    /**
+     *
+     * @summary Retrieves a single GitLab project, that the user is a member of, based on the provided credentials.
+     * @param {number} gitlabProjectId The ID of the GitLab project.
+     * @param {string} domain Domain/Host of the GitLab Provider.
+     * @param {string} accessToken GitLab Project or Group Access Token.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGitlabProject(gitlabProjectId: number, domain: string, accessToken: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GitlabProjectDtoResponse>>;
+    /**
+     *
+     * @summary Retrieves the resource type information for a specific resource type.
+     * @param {string} resourceTypeId The ID of the resource type to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getResourceTypeInformation(resourceTypeId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResourceTypeInformationDtoResponse>>;
+};
+/**
+ * ResourceTypeApi - factory interface
+ * @export
+ */
+export declare const ResourceTypeApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2ResourceTypesOptions(options?: AxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Retrieves all branches of a GitLab project, that the user is a member of, based on the provided credentials.
+     * @param {ResourceTypeApiGetAllGitlabBranchesForProjectRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAllGitlabBranchesForProject(requestParameters: ResourceTypeApiGetAllGitlabBranchesForProjectRequest, options?: AxiosRequestConfig): AxiosPromise<GitlabBranchDtoIEnumerableResponse>;
+    /**
+     *
+     * @summary Retrieves all GitLab projects, that the user is a member of, based on the provided credentials.
+     * @param {ResourceTypeApiGetAllGitlabProjectsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAllGitlabProjects(requestParameters: ResourceTypeApiGetAllGitlabProjectsRequest, options?: AxiosRequestConfig): AxiosPromise<GitlabProjectDtoIEnumerableResponse>;
+    /**
+     *
+     * @summary Retrieves the entire global resource types information.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAllResourceTypesInformation(options?: AxiosRequestConfig): AxiosPromise<ResourceTypeInformationDtoIEnumerableResponse>;
+    /**
+     *
+     * @summary Retrieves a single GitLab project, that the user is a member of, based on the provided credentials.
+     * @param {ResourceTypeApiGetGitlabProjectRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGitlabProject(requestParameters: ResourceTypeApiGetGitlabProjectRequest, options?: AxiosRequestConfig): AxiosPromise<GitlabProjectDtoResponse>;
+    /**
+     *
+     * @summary Retrieves the resource type information for a specific resource type.
+     * @param {ResourceTypeApiGetResourceTypeInformationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getResourceTypeInformation(requestParameters: ResourceTypeApiGetResourceTypeInformationRequest, options?: AxiosRequestConfig): AxiosPromise<ResourceTypeInformationDtoResponse>;
+};
+/**
+ * Request parameters for getAllGitlabBranchesForProject operation in ResourceTypeApi.
+ * @export
+ * @interface ResourceTypeApiGetAllGitlabBranchesForProjectRequest
+ */
+export interface ResourceTypeApiGetAllGitlabBranchesForProjectRequest {
+    /**
+     * The ID of the GitLab project.
+     * @type {number}
+     * @memberof ResourceTypeApiGetAllGitlabBranchesForProject
+     */
+    readonly gitlabProjectId: number;
+    /**
+     * Domain/Host of the GitLab Provider.
+     * @type {string}
+     * @memberof ResourceTypeApiGetAllGitlabBranchesForProject
+     */
+    readonly domain: string;
+    /**
+     * GitLab Project or Group Access Token.
+     * @type {string}
+     * @memberof ResourceTypeApiGetAllGitlabBranchesForProject
+     */
+    readonly accessToken: string;
+}
+/**
+ * Request parameters for getAllGitlabProjects operation in ResourceTypeApi.
+ * @export
+ * @interface ResourceTypeApiGetAllGitlabProjectsRequest
+ */
+export interface ResourceTypeApiGetAllGitlabProjectsRequest {
+    /**
+     * Domain/Host of the GitLab Provider.
+     * @type {string}
+     * @memberof ResourceTypeApiGetAllGitlabProjects
+     */
+    readonly domain: string;
+    /**
+     * GitLab Project or Group Access Token.
+     * @type {string}
+     * @memberof ResourceTypeApiGetAllGitlabProjects
+     */
+    readonly accessToken: string;
+}
+/**
+ * Request parameters for getGitlabProject operation in ResourceTypeApi.
+ * @export
+ * @interface ResourceTypeApiGetGitlabProjectRequest
+ */
+export interface ResourceTypeApiGetGitlabProjectRequest {
+    /**
+     * The ID of the GitLab project.
+     * @type {number}
+     * @memberof ResourceTypeApiGetGitlabProject
+     */
+    readonly gitlabProjectId: number;
+    /**
+     * Domain/Host of the GitLab Provider.
+     * @type {string}
+     * @memberof ResourceTypeApiGetGitlabProject
+     */
+    readonly domain: string;
+    /**
+     * GitLab Project or Group Access Token.
+     * @type {string}
+     * @memberof ResourceTypeApiGetGitlabProject
+     */
+    readonly accessToken: string;
+}
+/**
+ * Request parameters for getResourceTypeInformation operation in ResourceTypeApi.
+ * @export
+ * @interface ResourceTypeApiGetResourceTypeInformationRequest
+ */
+export interface ResourceTypeApiGetResourceTypeInformationRequest {
+    /**
+     * The ID of the resource type to retrieve.
+     * @type {string}
+     * @memberof ResourceTypeApiGetResourceTypeInformation
+     */
+    readonly resourceTypeId: string;
+}
+/**
+ * ResourceTypeApi - object-oriented interface
+ * @export
+ * @class ResourceTypeApi
+ * @extends {BaseAPI}
+ */
+export declare class ResourceTypeApi extends BaseAPI {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ResourceTypeApi
+     */
+    apiV2ResourceTypesOptions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     *
+     * @summary Retrieves all branches of a GitLab project, that the user is a member of, based on the provided credentials.
+     * @param {ResourceTypeApiGetAllGitlabBranchesForProjectRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ResourceTypeApi
+     */
+    getAllGitlabBranchesForProject(requestParameters: ResourceTypeApiGetAllGitlabBranchesForProjectRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GitlabBranchDtoIEnumerableResponse, any>>;
+    /**
+     *
+     * @summary Retrieves all GitLab projects, that the user is a member of, based on the provided credentials.
+     * @param {ResourceTypeApiGetAllGitlabProjectsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ResourceTypeApi
+     */
+    getAllGitlabProjects(requestParameters: ResourceTypeApiGetAllGitlabProjectsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GitlabProjectDtoIEnumerableResponse, any>>;
+    /**
+     *
+     * @summary Retrieves the entire global resource types information.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ResourceTypeApi
+     */
+    getAllResourceTypesInformation(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ResourceTypeInformationDtoIEnumerableResponse, any>>;
+    /**
+     *
+     * @summary Retrieves a single GitLab project, that the user is a member of, based on the provided credentials.
+     * @param {ResourceTypeApiGetGitlabProjectRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ResourceTypeApi
+     */
+    getGitlabProject(requestParameters: ResourceTypeApiGetGitlabProjectRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GitlabProjectDtoResponse, any>>;
+    /**
+     *
+     * @summary Retrieves the resource type information for a specific resource type.
+     * @param {ResourceTypeApiGetResourceTypeInformationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ResourceTypeApi
+     */
+    getResourceTypeInformation(requestParameters: ResourceTypeApiGetResourceTypeInformationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ResourceTypeInformationDtoResponse, any>>;
+}

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

@@ -0,0 +1,179 @@
+/**
+ * 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 { RoleDtoPagedResponse } from '../../@coscine/model';
+import { RoleDtoResponse } from '../../@coscine/model';
+/**
+ * RoleApi - axios parameter creator
+ * @export
+ */
+export declare const RoleApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2RolesOptions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Retrieves a role by ID.
+     * @param {string} roleId The ID of the role.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRole: (roleId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Retrieves all roles.
+     * @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}
+     */
+    getRoles: (pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * RoleApi - functional programming interface
+ * @export
+ */
+export declare const RoleApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2RolesOptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Retrieves a role by ID.
+     * @param {string} roleId The ID of the role.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRole(roleId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RoleDtoResponse>>;
+    /**
+     *
+     * @summary Retrieves all roles.
+     * @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}
+     */
+    getRoles(pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RoleDtoPagedResponse>>;
+};
+/**
+ * RoleApi - factory interface
+ * @export
+ */
+export declare const RoleApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2RolesOptions(options?: AxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Retrieves a role by ID.
+     * @param {RoleApiGetRoleRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRole(requestParameters: RoleApiGetRoleRequest, options?: AxiosRequestConfig): AxiosPromise<RoleDtoResponse>;
+    /**
+     *
+     * @summary Retrieves all roles.
+     * @param {RoleApiGetRolesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRoles(requestParameters?: RoleApiGetRolesRequest, options?: AxiosRequestConfig): AxiosPromise<RoleDtoPagedResponse>;
+};
+/**
+ * Request parameters for getRole operation in RoleApi.
+ * @export
+ * @interface RoleApiGetRoleRequest
+ */
+export interface RoleApiGetRoleRequest {
+    /**
+     * The ID of the role.
+     * @type {string}
+     * @memberof RoleApiGetRole
+     */
+    readonly roleId: string;
+}
+/**
+ * Request parameters for getRoles operation in RoleApi.
+ * @export
+ * @interface RoleApiGetRolesRequest
+ */
+export interface RoleApiGetRolesRequest {
+    /**
+     * The desired page number. Should be greater than or equal to 1. Default is 1.
+     * @type {number}
+     * @memberof RoleApiGetRoles
+     */
+    readonly pageNumber?: number;
+    /**
+     * The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
+     * @type {number}
+     * @memberof RoleApiGetRoles
+     */
+    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 RoleApiGetRoles
+     */
+    readonly orderBy?: string;
+}
+/**
+ * RoleApi - object-oriented interface
+ * @export
+ * @class RoleApi
+ * @extends {BaseAPI}
+ */
+export declare class RoleApi extends BaseAPI {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RoleApi
+     */
+    apiV2RolesOptions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     *
+     * @summary Retrieves a role by ID.
+     * @param {RoleApiGetRoleRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RoleApi
+     */
+    getRole(requestParameters: RoleApiGetRoleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RoleDtoResponse, any>>;
+    /**
+     *
+     * @summary Retrieves all roles.
+     * @param {RoleApiGetRolesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RoleApi
+     */
+    getRoles(requestParameters?: RoleApiGetRolesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RoleDtoPagedResponse, any>>;
+}