@emilgroup/commission-sdk-node 1.0.0-beta.1

package/dist/api/commission-agreements-api.d.ts

@@ -0,0 +1,357 @@
+/**
+ * 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 { CreateCommissionAgreementRequestDto } from '../models';
+import { CreateCommissionAgreementResponseClass } from '../models';
+import { GetCommissionAgreementResponseClass } from '../models';
+import { ListCommissionAgreementsResponseClass } from '../models';
+import { UpdateCommissionAgreementRequestDto } from '../models';
+import { UpdateCommissionAgreementResponseClass } from '../models';
+/**
+ * CommissionAgreementsApi - axios parameter creator
+ * @export
+ */
+export declare const CommissionAgreementsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * This will create commission agreement.
+     * @summary Create the commission agreement
+     * @param {CreateCommissionAgreementRequestDto} createCommissionAgreementRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCommissionAgreement: (createCommissionAgreementRequestDto: CreateCommissionAgreementRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will delete commission agreement.
+     * @summary Delete the commission agreement
+     * @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}
+     */
+    deleteCommissionAgreement: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will get commission agreement.
+     * @summary Retrieve the commission agreement
+     * @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}
+     */
+    getCommissionAgreement: (code: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves a list of commission agreements.
+     * @summary List commission agreements
+     * @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, 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, 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&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}
+     */
+    listCommissionAgreements: (authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will update commission agreement.
+     * @summary Update the commission agreement
+     * @param {UpdateCommissionAgreementRequestDto} updateCommissionAgreementRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateCommissionAgreement: (updateCommissionAgreementRequestDto: UpdateCommissionAgreementRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * CommissionAgreementsApi - functional programming interface
+ * @export
+ */
+export declare const CommissionAgreementsApiFp: (configuration?: Configuration) => {
+    /**
+     * This will create commission agreement.
+     * @summary Create the commission agreement
+     * @param {CreateCommissionAgreementRequestDto} createCommissionAgreementRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCommissionAgreement(createCommissionAgreementRequestDto: CreateCommissionAgreementRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCommissionAgreementResponseClass>>;
+    /**
+     * This will delete commission agreement.
+     * @summary Delete the commission agreement
+     * @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}
+     */
+    deleteCommissionAgreement(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * This will get commission agreement.
+     * @summary Retrieve the commission agreement
+     * @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}
+     */
+    getCommissionAgreement(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCommissionAgreementResponseClass>>;
+    /**
+     * Retrieves a list of commission agreements.
+     * @summary List commission agreements
+     * @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, 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, 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&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}
+     */
+    listCommissionAgreements(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionAgreementsResponseClass>>;
+    /**
+     * This will update commission agreement.
+     * @summary Update the commission agreement
+     * @param {UpdateCommissionAgreementRequestDto} updateCommissionAgreementRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateCommissionAgreement(updateCommissionAgreementRequestDto: UpdateCommissionAgreementRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCommissionAgreementResponseClass>>;
+};
+/**
+ * CommissionAgreementsApi - factory interface
+ * @export
+ */
+export declare const CommissionAgreementsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * This will create commission agreement.
+     * @summary Create the commission agreement
+     * @param {CreateCommissionAgreementRequestDto} createCommissionAgreementRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCommissionAgreement(createCommissionAgreementRequestDto: CreateCommissionAgreementRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCommissionAgreementResponseClass>;
+    /**
+     * This will delete commission agreement.
+     * @summary Delete the commission agreement
+     * @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}
+     */
+    deleteCommissionAgreement(code: string, authorization?: string, options?: any): AxiosPromise<void>;
+    /**
+     * This will get commission agreement.
+     * @summary Retrieve the commission agreement
+     * @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}
+     */
+    getCommissionAgreement(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetCommissionAgreementResponseClass>;
+    /**
+     * Retrieves a list of commission agreements.
+     * @summary List commission agreements
+     * @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, 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, 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&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}
+     */
+    listCommissionAgreements(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListCommissionAgreementsResponseClass>;
+    /**
+     * This will update commission agreement.
+     * @summary Update the commission agreement
+     * @param {UpdateCommissionAgreementRequestDto} updateCommissionAgreementRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateCommissionAgreement(updateCommissionAgreementRequestDto: UpdateCommissionAgreementRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateCommissionAgreementResponseClass>;
+};
+/**
+ * Request parameters for createCommissionAgreement operation in CommissionAgreementsApi.
+ * @export
+ * @interface CommissionAgreementsApiCreateCommissionAgreementRequest
+ */
+export interface CommissionAgreementsApiCreateCommissionAgreementRequest {
+    /**
+     *
+     * @type {CreateCommissionAgreementRequestDto}
+     * @memberof CommissionAgreementsApiCreateCommissionAgreement
+     */
+    readonly createCommissionAgreementRequestDto: CreateCommissionAgreementRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionAgreementsApiCreateCommissionAgreement
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deleteCommissionAgreement operation in CommissionAgreementsApi.
+ * @export
+ * @interface CommissionAgreementsApiDeleteCommissionAgreementRequest
+ */
+export interface CommissionAgreementsApiDeleteCommissionAgreementRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof CommissionAgreementsApiDeleteCommissionAgreement
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionAgreementsApiDeleteCommissionAgreement
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getCommissionAgreement operation in CommissionAgreementsApi.
+ * @export
+ * @interface CommissionAgreementsApiGetCommissionAgreementRequest
+ */
+export interface CommissionAgreementsApiGetCommissionAgreementRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof CommissionAgreementsApiGetCommissionAgreement
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CommissionAgreementsApiGetCommissionAgreement
+     */
+    readonly expand: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionAgreementsApiGetCommissionAgreement
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listCommissionAgreements operation in CommissionAgreementsApi.
+ * @export
+ * @interface CommissionAgreementsApiListCommissionAgreementsRequest
+ */
+export interface CommissionAgreementsApiListCommissionAgreementsRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionAgreementsApiListCommissionAgreements
+     */
+    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, createdAt&lt;/i&gt;
+     * @type {string}
+     * @memberof CommissionAgreementsApiListCommissionAgreements
+     */
+    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, createdAt&lt;/i&gt;
+     * @type {string}
+     * @memberof CommissionAgreementsApiListCommissionAgreements
+     */
+    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&lt;/i&gt;
+     * @type {string}
+     * @memberof CommissionAgreementsApiListCommissionAgreements
+     */
+    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 CommissionAgreementsApiListCommissionAgreements
+     */
+    readonly expand?: string;
+}
+/**
+ * Request parameters for updateCommissionAgreement operation in CommissionAgreementsApi.
+ * @export
+ * @interface CommissionAgreementsApiUpdateCommissionAgreementRequest
+ */
+export interface CommissionAgreementsApiUpdateCommissionAgreementRequest {
+    /**
+     *
+     * @type {UpdateCommissionAgreementRequestDto}
+     * @memberof CommissionAgreementsApiUpdateCommissionAgreement
+     */
+    readonly updateCommissionAgreementRequestDto: UpdateCommissionAgreementRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionAgreementsApiUpdateCommissionAgreement
+     */
+    readonly authorization?: string;
+}
+/**
+ * CommissionAgreementsApi - object-oriented interface
+ * @export
+ * @class CommissionAgreementsApi
+ * @extends {BaseAPI}
+ */
+export declare class CommissionAgreementsApi extends BaseAPI {
+    /**
+     * This will create commission agreement.
+     * @summary Create the commission agreement
+     * @param {CommissionAgreementsApiCreateCommissionAgreementRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionAgreementsApi
+     */
+    createCommissionAgreement(requestParameters: CommissionAgreementsApiCreateCommissionAgreementRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCommissionAgreementResponseClass, any, {}>>;
+    /**
+     * This will delete commission agreement.
+     * @summary Delete the commission agreement
+     * @param {CommissionAgreementsApiDeleteCommissionAgreementRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionAgreementsApi
+     */
+    deleteCommissionAgreement(requestParameters: CommissionAgreementsApiDeleteCommissionAgreementRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * This will get commission agreement.
+     * @summary Retrieve the commission agreement
+     * @param {CommissionAgreementsApiGetCommissionAgreementRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionAgreementsApi
+     */
+    getCommissionAgreement(requestParameters: CommissionAgreementsApiGetCommissionAgreementRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCommissionAgreementResponseClass, any, {}>>;
+    /**
+     * Retrieves a list of commission agreements.
+     * @summary List commission agreements
+     * @param {CommissionAgreementsApiListCommissionAgreementsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionAgreementsApi
+     */
+    listCommissionAgreements(requestParameters?: CommissionAgreementsApiListCommissionAgreementsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCommissionAgreementsResponseClass, any, {}>>;
+    /**
+     * This will update commission agreement.
+     * @summary Update the commission agreement
+     * @param {CommissionAgreementsApiUpdateCommissionAgreementRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionAgreementsApi
+     */
+    updateCommissionAgreement(requestParameters: CommissionAgreementsApiUpdateCommissionAgreementRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateCommissionAgreementResponseClass, any, {}>>;
+}