@emilgroup/accounting-sdk-node 1.1.0 → 1.2.0

package/dist/api/users-api.d.ts

@@ -0,0 +1,275 @@
+/**
+ * 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 { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+import { RequestArgs, BaseAPI } from '../base';
+import { CreateUserRequestDto } from '../models';
+import { CreateUserResponseClass } from '../models';
+import { GetUserResponseClass } from '../models';
+import { ListUsersResponseClass } from '../models';
+import { UpdateUserRequestDto } from '../models';
+import { UpdateUserResponseClass } from '../models';
+/**
+ * UsersApi - axios parameter creator
+ * @export
+ */
+export declare const UsersApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * 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?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * UsersApi - functional programming interface
+ * @export
+ */
+export declare const UsersApiFp: (configuration?: Configuration) => {
+    /**
+     * 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?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateUserResponseClass>>;
+    /**
+     * 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?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetUserResponseClass>>;
+    /**
+     * 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?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListUsersResponseClass>>;
+    /**
+     * 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?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateUserResponseClass>>;
+};
+/**
+ * UsersApi - factory interface
+ * @export
+ */
+export declare const UsersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+};
+/**
+ * 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 declare 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
+     */
+    createUser(requestParameters: UsersApiCreateUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateUserResponseClass, any>>;
+    /**
+     * 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
+     */
+    getUser(requestParameters: UsersApiGetUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserResponseClass, any>>;
+    /**
+     * 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
+     */
+    listUsers(requestParameters?: UsersApiListUsersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListUsersResponseClass, any>>;
+    /**
+     * 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
+     */
+    updateUser(requestParameters: UsersApiUpdateUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateUserResponseClass, any>>;
+}