Skip to content
Snippets Groups Projects
Commit cc302d88 authored by Benedikt Heinrichs's avatar Benedikt Heinrichs
Browse files

Update: Types for new Organization API

parent f85b6984
Branches Issue/2228-userOrganization
Tags
2 merge requests!46Release: Sprint/2022 21 :robot:,!45Update: Types for new Organization API
......@@ -21,6 +21,57 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
// @ts-ignore
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
/**
* Object for representing the isMember relationship
* @export
* @interface IsMemberObject
*/
export interface IsMemberObject {
/**
* Is Member of requested organization
* @type {boolean}
* @memberof IsMemberObject
*/
isMember?: boolean;
}
/**
* Information about an Organization
* @export
* @interface OrganizationObject
*/
export interface OrganizationObject {
/**
* Name of the Organization
* @type {string}
* @memberof OrganizationObject
*/
displayName?: string | null;
/**
* ROR Id of the Organization
* @type {string}
* @memberof OrganizationObject
*/
url?: string | null;
/**
* Optional: Contact E-Mail
* @type {string}
* @memberof OrganizationObject
*/
email?: string | null;
}
/**
* Wrapping the request (to stay compatible to the old implementation)
* @export
* @interface WrapperObject
*/
export interface WrapperObject {
/**
* Wrapper list to stay compatible to the old implementation
* @type {Array<OrganizationObject>}
* @memberof WrapperObject
*/
data?: Array<OrganizationObject> | null;
}
/**
* OrganizationApi - axios parameter creator
......@@ -233,7 +284,7 @@ export const OrganizationApiFp = function(configuration?: Configuration) {
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async organizationGetOrganization(url: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
async organizationGetOrganization(url: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WrapperObject>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.organizationGetOrganization(url, options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
......@@ -244,7 +295,7 @@ export const OrganizationApiFp = function(configuration?: Configuration) {
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async organizationGetROR(filter?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
async organizationGetROR(filter?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WrapperObject>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.organizationGetROR(filter, options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
......@@ -256,7 +307,7 @@ export const OrganizationApiFp = function(configuration?: Configuration) {
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async organizationIndex(member?: number, filter?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
async organizationIndex(member?: number, filter?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WrapperObject>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.organizationIndex(member, filter, options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
......@@ -267,7 +318,7 @@ export const OrganizationApiFp = function(configuration?: Configuration) {
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async organizationIsMember(url: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
async organizationIsMember(url: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IsMemberObject>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.organizationIsMember(url, options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
......@@ -277,7 +328,7 @@ export const OrganizationApiFp = function(configuration?: Configuration) {
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async organizationIsMember2(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
async organizationIsMember2(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WrapperObject>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.organizationIsMember2(options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
......@@ -298,7 +349,7 @@ export const OrganizationApiFactory = function (configuration?: Configuration, b
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
organizationGetOrganization(url: string, options?: any): AxiosPromise<any> {
organizationGetOrganization(url: string, options?: any): AxiosPromise<WrapperObject> {
return localVarFp.organizationGetOrganization(url, options).then((request) => request(axios, basePath));
},
/**
......@@ -308,7 +359,7 @@ export const OrganizationApiFactory = function (configuration?: Configuration, b
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
organizationGetROR(filter?: string, options?: any): AxiosPromise<any> {
organizationGetROR(filter?: string, options?: any): AxiosPromise<WrapperObject> {
return localVarFp.organizationGetROR(filter, options).then((request) => request(axios, basePath));
},
/**
......@@ -319,7 +370,7 @@ export const OrganizationApiFactory = function (configuration?: Configuration, b
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
organizationIndex(member?: number, filter?: string, options?: any): AxiosPromise<any> {
organizationIndex(member?: number, filter?: string, options?: any): AxiosPromise<WrapperObject> {
return localVarFp.organizationIndex(member, filter, options).then((request) => request(axios, basePath));
},
/**
......@@ -329,7 +380,7 @@ export const OrganizationApiFactory = function (configuration?: Configuration, b
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
organizationIsMember(url: string, options?: any): AxiosPromise<any> {
organizationIsMember(url: string, options?: any): AxiosPromise<IsMemberObject> {
return localVarFp.organizationIsMember(url, options).then((request) => request(axios, basePath));
},
/**
......@@ -338,7 +389,7 @@ export const OrganizationApiFactory = function (configuration?: Configuration, b
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
organizationIsMember2(options?: any): AxiosPromise<any> {
organizationIsMember2(options?: any): AxiosPromise<WrapperObject> {
return localVarFp.organizationIsMember2(options).then((request) => request(axios, basePath));
},
};
......
......@@ -18,7 +18,7 @@ import { Configuration } from "./configuration";
// @ts-ignore
import globalAxios, { AxiosPromise, AxiosInstance } from 'axios';
export const BASE_PATH = "https://d-sp16.devlef.campus.rwth-aachen.de/coscine/api/Coscine.Api.Organization".replace(/\/+$/, "");
export const BASE_PATH = "https://d-sp23.devlef.campus.rwth-aachen.de/coscine/api/Coscine.Api.Organization".replace(/\/+$/, "");
/**
*
......
This diff is collapsed.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment