@emilgroup/commission-sdk 1.0.0-beta.1

package/configuration.ts

@@ -0,0 +1,110 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService 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.
+ */
+
+
+export interface ConfigurationParameters {
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    username?: string;
+    password?: string;
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    basePath?: string;
+    baseOptions?: any;
+    formDataCtor?: new () => any;
+}
+
+export class Configuration {
+    /**
+     * parameter for apiKey security
+     * @param name security name
+     * @memberof Configuration
+     */
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    username?: string;
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    password?: string;
+    /**
+     * parameter for oauth2 security
+     * @param name security name
+     * @param scopes oauth2 scope
+     * @memberof Configuration
+     */
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    /**
+     * override base path
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    basePath?: string;
+    /**
+     * base options for axios calls
+     *
+     * @type {any}
+     * @memberof Configuration
+     */
+    baseOptions?: any;
+    /**
+     * The FormData constructor that will be used to create multipart form data
+     * requests. You can inject this here so that execution environments that
+     * do not support the FormData class can still run the generated client.
+     *
+     * @type {new () => FormData}
+     */
+    formDataCtor?: new () => any;
+
+    constructor(param: ConfigurationParameters = {}) {
+        this.apiKey = param.apiKey;
+        this.username = param.username;
+        this.password = param.password;
+        this.accessToken = param.accessToken;
+        this.basePath = param.basePath;
+        this.baseOptions = param.baseOptions;
+        this.formDataCtor = param.formDataCtor;
+    }
+
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    public isJsonMime(mime: string): boolean {
+        const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
+        return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
+    }
+
+    /**
+     * Returns "Bearer" token.
+     * @param token - access token.
+     * @return Bearer token.
+     */
+    public getBearerToken(token?: string): string {
+        return ('' + token).startsWith("Bearer") ? token : "Bearer " + token;
+    }
+}

package/dist/api/commission-agreement-versions-api.d.ts

@@ -0,0 +1,300 @@
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService 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 { CreateCommissionAgreementVersionRequestDto } from '../models';
+import { CreateCommissionAgreementVersionResponseClass } from '../models';
+import { GetCommissionAgreementVersionResponseClass } from '../models';
+import { ListCommissionAgreementVersionsResponseClass } from '../models';
+/**
+ * CommissionAgreementVersionsApi - axios parameter creator
+ * @export
+ */
+export declare const CommissionAgreementVersionsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * This will create commission agreement version.
+     * @summary Create the commission agreement version
+     * @param {CreateCommissionAgreementVersionRequestDto} createCommissionAgreementVersionRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCommissionAgreementVersion: (createCommissionAgreementVersionRequestDto: CreateCommissionAgreementVersionRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will delete commission agreement version.
+     * @summary Delete the commission agreement version
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteCommissionAgreementVersion: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will get commission agreement version.
+     * @summary Retrieve the commission agreement version
+     * @param {string} code
+     * @param {string} expand
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCommissionAgreementVersion: (code: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves a list of commission agreement versions.
+     * @summary List commission agreement versions
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, commissionAgreementId, startDate, endDate, createdAt&lt;/i&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, commissionAgreementId, startDate, endDate, createdAt&lt;/i&gt;
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: createdAt, startDate, endDate&lt;/i&gt;
+     * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCommissionAgreementVersions: (authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * CommissionAgreementVersionsApi - functional programming interface
+ * @export
+ */
+export declare const CommissionAgreementVersionsApiFp: (configuration?: Configuration) => {
+    /**
+     * This will create commission agreement version.
+     * @summary Create the commission agreement version
+     * @param {CreateCommissionAgreementVersionRequestDto} createCommissionAgreementVersionRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCommissionAgreementVersion(createCommissionAgreementVersionRequestDto: CreateCommissionAgreementVersionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCommissionAgreementVersionResponseClass>>;
+    /**
+     * This will delete commission agreement version.
+     * @summary Delete the commission agreement version
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteCommissionAgreementVersion(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * This will get commission agreement version.
+     * @summary Retrieve the commission agreement version
+     * @param {string} code
+     * @param {string} expand
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCommissionAgreementVersion(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCommissionAgreementVersionResponseClass>>;
+    /**
+     * Retrieves a list of commission agreement versions.
+     * @summary List commission agreement versions
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, commissionAgreementId, startDate, endDate, createdAt&lt;/i&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, commissionAgreementId, startDate, endDate, createdAt&lt;/i&gt;
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: createdAt, startDate, endDate&lt;/i&gt;
+     * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCommissionAgreementVersions(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionAgreementVersionsResponseClass>>;
+};
+/**
+ * CommissionAgreementVersionsApi - factory interface
+ * @export
+ */
+export declare const CommissionAgreementVersionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * This will create commission agreement version.
+     * @summary Create the commission agreement version
+     * @param {CreateCommissionAgreementVersionRequestDto} createCommissionAgreementVersionRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCommissionAgreementVersion(createCommissionAgreementVersionRequestDto: CreateCommissionAgreementVersionRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCommissionAgreementVersionResponseClass>;
+    /**
+     * This will delete commission agreement version.
+     * @summary Delete the commission agreement version
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteCommissionAgreementVersion(code: string, authorization?: string, options?: any): AxiosPromise<void>;
+    /**
+     * This will get commission agreement version.
+     * @summary Retrieve the commission agreement version
+     * @param {string} code
+     * @param {string} expand
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCommissionAgreementVersion(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetCommissionAgreementVersionResponseClass>;
+    /**
+     * Retrieves a list of commission agreement versions.
+     * @summary List commission agreement versions
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, commissionAgreementId, startDate, endDate, createdAt&lt;/i&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, commissionAgreementId, startDate, endDate, createdAt&lt;/i&gt;
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: createdAt, startDate, endDate&lt;/i&gt;
+     * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCommissionAgreementVersions(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListCommissionAgreementVersionsResponseClass>;
+};
+/**
+ * Request parameters for createCommissionAgreementVersion operation in CommissionAgreementVersionsApi.
+ * @export
+ * @interface CommissionAgreementVersionsApiCreateCommissionAgreementVersionRequest
+ */
+export interface CommissionAgreementVersionsApiCreateCommissionAgreementVersionRequest {
+    /**
+     *
+     * @type {CreateCommissionAgreementVersionRequestDto}
+     * @memberof CommissionAgreementVersionsApiCreateCommissionAgreementVersion
+     */
+    readonly createCommissionAgreementVersionRequestDto: CreateCommissionAgreementVersionRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionAgreementVersionsApiCreateCommissionAgreementVersion
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deleteCommissionAgreementVersion operation in CommissionAgreementVersionsApi.
+ * @export
+ * @interface CommissionAgreementVersionsApiDeleteCommissionAgreementVersionRequest
+ */
+export interface CommissionAgreementVersionsApiDeleteCommissionAgreementVersionRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof CommissionAgreementVersionsApiDeleteCommissionAgreementVersion
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionAgreementVersionsApiDeleteCommissionAgreementVersion
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getCommissionAgreementVersion operation in CommissionAgreementVersionsApi.
+ * @export
+ * @interface CommissionAgreementVersionsApiGetCommissionAgreementVersionRequest
+ */
+export interface CommissionAgreementVersionsApiGetCommissionAgreementVersionRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof CommissionAgreementVersionsApiGetCommissionAgreementVersion
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CommissionAgreementVersionsApiGetCommissionAgreementVersion
+     */
+    readonly expand: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionAgreementVersionsApiGetCommissionAgreementVersion
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listCommissionAgreementVersions operation in CommissionAgreementVersionsApi.
+ * @export
+ * @interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRequest
+ */
+export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
+     */
+    readonly authorization?: string;
+    /**
+     * Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, commissionAgreementId, startDate, endDate, createdAt&lt;/i&gt;
+     * @type {string}
+     * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
+     */
+    readonly filter?: string;
+    /**
+     * Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, commissionAgreementId, startDate, endDate, createdAt&lt;/i&gt;
+     * @type {string}
+     * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
+     */
+    readonly filters?: string;
+    /**
+     * Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: createdAt, startDate, endDate&lt;/i&gt;
+     * @type {string}
+     * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
+     */
+    readonly order?: string;
+    /**
+     * Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;
+     * @type {string}
+     * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
+     */
+    readonly expand?: string;
+}
+/**
+ * CommissionAgreementVersionsApi - object-oriented interface
+ * @export
+ * @class CommissionAgreementVersionsApi
+ * @extends {BaseAPI}
+ */
+export declare class CommissionAgreementVersionsApi extends BaseAPI {
+    /**
+     * This will create commission agreement version.
+     * @summary Create the commission agreement version
+     * @param {CommissionAgreementVersionsApiCreateCommissionAgreementVersionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionAgreementVersionsApi
+     */
+    createCommissionAgreementVersion(requestParameters: CommissionAgreementVersionsApiCreateCommissionAgreementVersionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCommissionAgreementVersionResponseClass, any, {}>>;
+    /**
+     * This will delete commission agreement version.
+     * @summary Delete the commission agreement version
+     * @param {CommissionAgreementVersionsApiDeleteCommissionAgreementVersionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionAgreementVersionsApi
+     */
+    deleteCommissionAgreementVersion(requestParameters: CommissionAgreementVersionsApiDeleteCommissionAgreementVersionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * This will get commission agreement version.
+     * @summary Retrieve the commission agreement version
+     * @param {CommissionAgreementVersionsApiGetCommissionAgreementVersionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionAgreementVersionsApi
+     */
+    getCommissionAgreementVersion(requestParameters: CommissionAgreementVersionsApiGetCommissionAgreementVersionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCommissionAgreementVersionResponseClass, any, {}>>;
+    /**
+     * Retrieves a list of commission agreement versions.
+     * @summary List commission agreement versions
+     * @param {CommissionAgreementVersionsApiListCommissionAgreementVersionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionAgreementVersionsApi
+     */
+    listCommissionAgreementVersions(requestParameters?: CommissionAgreementVersionsApiListCommissionAgreementVersionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCommissionAgreementVersionsResponseClass, any, {}>>;
+}