@emilgroup/accounting-sdk-node 1.1.0 → 1.3.0

package/api/users-api.ts

@@ -0,0 +1,496 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL GdvService
+ * The EMIL GdvService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.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 globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
+// @ts-ignore
+import { CreateUserRequestDto } from '../models';
+// @ts-ignore
+import { CreateUserResponseClass } from '../models';
+// @ts-ignore
+import { GetUserResponseClass } from '../models';
+// @ts-ignore
+import { ListUsersResponseClass } from '../models';
+// @ts-ignore
+import { UpdateUserRequestDto } from '../models';
+// @ts-ignore
+import { UpdateUserResponseClass } from '../models';
+// URLSearchParams not necessarily used
+// @ts-ignore
+import { URL, URLSearchParams } from 'url';
+const FormData = require('form-data');
+/**
+ * UsersApi - axios parameter creator
+ * @export
+ */
+export const UsersApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Create a gdv tenant user.
+         * @summary Create the gdv tenant user
+         * @param {CreateUserRequestDto} createUserRequestDto 
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createUser: async (createUserRequestDto: CreateUserRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'createUserRequestDto' is not null or undefined
+            assertParamExists('createUser', 'createUserRequestDto', createUserRequestDto)
+            const localVarPath = `/gdvservice/v1/users`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            let baseAccessToken;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+                baseAccessToken = configuration.accessToken;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(createUserRequestDto, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Retrieves the details of the gdv tenant user that was previously created. Supply the unique gdv tenant user code      that was returned when you created it and Emil Api will return the corresponding gdv tenant user information.
+         * @summary Retrieve the gdv tenant user
+         * @param {string} code Unique identifier for the object.
+         * @param {string} [authorization] Bearer Token
+         * @param {string} [expand] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getUser: async (code: string, authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'code' is not null or undefined
+            assertParamExists('getUser', 'code', code)
+            const localVarPath = `/gdvservice/v1/users/{code}`
+                .replace(`{${"code"}}`, encodeURIComponent(String(code)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            let baseAccessToken;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+                baseAccessToken = configuration.accessToken;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (expand !== undefined) {
+                localVarQueryParameter['expand'] = expand;
+            }
+
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Returns a list of gdv tenant users you have previously created.        The gdv tenant users are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
+         * @summary List gdv tenant users
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listUsers: async (authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/gdvservice/v1/users`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            let baseAccessToken;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+                baseAccessToken = configuration.accessToken;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Updates the specified gdv tenant user by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+         * @summary Update the gdv tenant user
+         * @param {string} code Unique identifier for the object.
+         * @param {UpdateUserRequestDto} updateUserRequestDto 
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateUser: async (code: string, updateUserRequestDto: UpdateUserRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'code' is not null or undefined
+            assertParamExists('updateUser', 'code', code)
+            // verify required parameter 'updateUserRequestDto' is not null or undefined
+            assertParamExists('updateUser', 'updateUserRequestDto', updateUserRequestDto)
+            const localVarPath = `/gdvservice/v1/users/{code}`
+                .replace(`{${"code"}}`, encodeURIComponent(String(code)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            let baseAccessToken;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+                baseAccessToken = configuration.accessToken;
+            }
+
+            const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(updateUserRequestDto, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * UsersApi - functional programming interface
+ * @export
+ */
+export const UsersApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = UsersApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Create a gdv tenant user.
+         * @summary Create the gdv tenant user
+         * @param {CreateUserRequestDto} createUserRequestDto 
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async createUser(createUserRequestDto: CreateUserRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateUserResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.createUser(createUserRequestDto, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * Retrieves the details of the gdv tenant user that was previously created. Supply the unique gdv tenant user code      that was returned when you created it and Emil Api will return the corresponding gdv tenant user information.
+         * @summary Retrieve the gdv tenant user
+         * @param {string} code Unique identifier for the object.
+         * @param {string} [authorization] Bearer Token
+         * @param {string} [expand] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getUser(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetUserResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getUser(code, authorization, expand, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * Returns a list of gdv tenant users you have previously created.        The gdv tenant users are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
+         * @summary List gdv tenant users
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listUsers(authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListUsersResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listUsers(authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * Updates the specified gdv tenant user by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+         * @summary Update the gdv tenant user
+         * @param {string} code Unique identifier for the object.
+         * @param {UpdateUserRequestDto} updateUserRequestDto 
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async updateUser(code: string, updateUserRequestDto: UpdateUserRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateUserResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.updateUser(code, updateUserRequestDto, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+    }
+};
+
+/**
+ * UsersApi - factory interface
+ * @export
+ */
+export const UsersApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = UsersApiFp(configuration)
+    return {
+        /**
+         * Create a gdv tenant user.
+         * @summary Create the gdv tenant user
+         * @param {CreateUserRequestDto} createUserRequestDto 
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createUser(createUserRequestDto: CreateUserRequestDto, authorization?: string, options?: any): AxiosPromise<CreateUserResponseClass> {
+            return localVarFp.createUser(createUserRequestDto, authorization, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Retrieves the details of the gdv tenant user that was previously created. Supply the unique gdv tenant user code      that was returned when you created it and Emil Api will return the corresponding gdv tenant user information.
+         * @summary Retrieve the gdv tenant user
+         * @param {string} code Unique identifier for the object.
+         * @param {string} [authorization] Bearer Token
+         * @param {string} [expand] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getUser(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetUserResponseClass> {
+            return localVarFp.getUser(code, authorization, expand, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Returns a list of gdv tenant users you have previously created.        The gdv tenant users are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
+         * @summary List gdv tenant users
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listUsers(authorization?: string, options?: any): AxiosPromise<ListUsersResponseClass> {
+            return localVarFp.listUsers(authorization, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Updates the specified gdv tenant user by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+         * @summary Update the gdv tenant user
+         * @param {string} code Unique identifier for the object.
+         * @param {UpdateUserRequestDto} updateUserRequestDto 
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateUser(code: string, updateUserRequestDto: UpdateUserRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateUserResponseClass> {
+            return localVarFp.updateUser(code, updateUserRequestDto, authorization, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * Request parameters for createUser operation in UsersApi.
+ * @export
+ * @interface UsersApiCreateUserRequest
+ */
+export interface UsersApiCreateUserRequest {
+    /**
+     * 
+     * @type {CreateUserRequestDto}
+     * @memberof UsersApiCreateUser
+     */
+    readonly createUserRequestDto: CreateUserRequestDto
+
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof UsersApiCreateUser
+     */
+    readonly authorization?: string
+}
+
+/**
+ * Request parameters for getUser operation in UsersApi.
+ * @export
+ * @interface UsersApiGetUserRequest
+ */
+export interface UsersApiGetUserRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof UsersApiGetUser
+     */
+    readonly code: string
+
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof UsersApiGetUser
+     */
+    readonly authorization?: string
+
+    /**
+     * 
+     * @type {string}
+     * @memberof UsersApiGetUser
+     */
+    readonly expand?: string
+}
+
+/**
+ * Request parameters for listUsers operation in UsersApi.
+ * @export
+ * @interface UsersApiListUsersRequest
+ */
+export interface UsersApiListUsersRequest {
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof UsersApiListUsers
+     */
+    readonly authorization?: string
+}
+
+/**
+ * Request parameters for updateUser operation in UsersApi.
+ * @export
+ * @interface UsersApiUpdateUserRequest
+ */
+export interface UsersApiUpdateUserRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof UsersApiUpdateUser
+     */
+    readonly code: string
+
+    /**
+     * 
+     * @type {UpdateUserRequestDto}
+     * @memberof UsersApiUpdateUser
+     */
+    readonly updateUserRequestDto: UpdateUserRequestDto
+
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof UsersApiUpdateUser
+     */
+    readonly authorization?: string
+}
+
+/**
+ * UsersApi - object-oriented interface
+ * @export
+ * @class UsersApi
+ * @extends {BaseAPI}
+ */
+export class UsersApi extends BaseAPI {
+    /**
+     * Create a gdv tenant user.
+     * @summary Create the gdv tenant user
+     * @param {UsersApiCreateUserRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UsersApi
+     */
+    public createUser(requestParameters: UsersApiCreateUserRequest, options?: AxiosRequestConfig) {
+        return UsersApiFp(this.configuration).createUser(requestParameters.createUserRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Retrieves the details of the gdv tenant user that was previously created. Supply the unique gdv tenant user code      that was returned when you created it and Emil Api will return the corresponding gdv tenant user information.
+     * @summary Retrieve the gdv tenant user
+     * @param {UsersApiGetUserRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UsersApi
+     */
+    public getUser(requestParameters: UsersApiGetUserRequest, options?: AxiosRequestConfig) {
+        return UsersApiFp(this.configuration).getUser(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Returns a list of gdv tenant users you have previously created.        The gdv tenant users are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
+     * @summary List gdv tenant users
+     * @param {UsersApiListUsersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UsersApi
+     */
+    public listUsers(requestParameters: UsersApiListUsersRequest = {}, options?: AxiosRequestConfig) {
+        return UsersApiFp(this.configuration).listUsers(requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Updates the specified gdv tenant user by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the gdv tenant user
+     * @param {UsersApiUpdateUserRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UsersApi
+     */
+    public updateUser(requestParameters: UsersApiUpdateUserRequest, options?: AxiosRequestConfig) {
+        return UsersApiFp(this.configuration).updateUser(requestParameters.code, requestParameters.updateUserRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+}