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

package/dist/api/commissions-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 { CreateCommissionRequestDto } from '../models';
+import { CreateCommissionResponseClass } from '../models';
+import { GetCommissionResponseClass } from '../models';
+import { ListCommissionsResponseClass } from '../models';
+import { UpdateCommissionRequestDto } from '../models';
+import { UpdateCommissionResponseClass } from '../models';
+/**
+ * CommissionsApi - axios parameter creator
+ * @export
+ */
+export declare const CommissionsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * This will create commission.
+     * @summary Create the commission
+     * @param {CreateCommissionRequestDto} createCommissionRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCommission: (createCommissionRequestDto: CreateCommissionRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will delete commission.
+     * @summary Delete the commission
+     * @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}
+     */
+    deleteCommission: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will get commission.
+     * @summary Retrieve the commission
+     * @param {string} code Unique identifier for the object.
+     * @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}
+     */
+    getCommission: (code: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves a list of commissions.
+     * @summary List commissions
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {'createdAt'} [order]
+     * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter]
+     * @param {'items'} [expand]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCommissions: (authorization?: string, order?: 'createdAt', filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', expand?: 'items', options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will update commission.
+     * @summary Update the commission
+     * @param {string} code
+     * @param {UpdateCommissionRequestDto} updateCommissionRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateCommission: (code: string, updateCommissionRequestDto: UpdateCommissionRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * CommissionsApi - functional programming interface
+ * @export
+ */
+export declare const CommissionsApiFp: (configuration?: Configuration) => {
+    /**
+     * This will create commission.
+     * @summary Create the commission
+     * @param {CreateCommissionRequestDto} createCommissionRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCommission(createCommissionRequestDto: CreateCommissionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCommissionResponseClass>>;
+    /**
+     * This will delete commission.
+     * @summary Delete the commission
+     * @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}
+     */
+    deleteCommission(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * This will get commission.
+     * @summary Retrieve the commission
+     * @param {string} code Unique identifier for the object.
+     * @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}
+     */
+    getCommission(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCommissionResponseClass>>;
+    /**
+     * Retrieves a list of commissions.
+     * @summary List commissions
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {'createdAt'} [order]
+     * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter]
+     * @param {'items'} [expand]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCommissions(authorization?: string, order?: 'createdAt', filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', expand?: 'items', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionsResponseClass>>;
+    /**
+     * This will update commission.
+     * @summary Update the commission
+     * @param {string} code
+     * @param {UpdateCommissionRequestDto} updateCommissionRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateCommission(code: string, updateCommissionRequestDto: UpdateCommissionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCommissionResponseClass>>;
+};
+/**
+ * CommissionsApi - factory interface
+ * @export
+ */
+export declare const CommissionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * This will create commission.
+     * @summary Create the commission
+     * @param {CreateCommissionRequestDto} createCommissionRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCommission(createCommissionRequestDto: CreateCommissionRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCommissionResponseClass>;
+    /**
+     * This will delete commission.
+     * @summary Delete the commission
+     * @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}
+     */
+    deleteCommission(code: string, authorization?: string, options?: any): AxiosPromise<void>;
+    /**
+     * This will get commission.
+     * @summary Retrieve the commission
+     * @param {string} code Unique identifier for the object.
+     * @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}
+     */
+    getCommission(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetCommissionResponseClass>;
+    /**
+     * Retrieves a list of commissions.
+     * @summary List commissions
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {'createdAt'} [order]
+     * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter]
+     * @param {'items'} [expand]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCommissions(authorization?: string, order?: 'createdAt', filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', expand?: 'items', options?: any): AxiosPromise<ListCommissionsResponseClass>;
+    /**
+     * This will update commission.
+     * @summary Update the commission
+     * @param {string} code
+     * @param {UpdateCommissionRequestDto} updateCommissionRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateCommission(code: string, updateCommissionRequestDto: UpdateCommissionRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateCommissionResponseClass>;
+};
+/**
+ * Request parameters for createCommission operation in CommissionsApi.
+ * @export
+ * @interface CommissionsApiCreateCommissionRequest
+ */
+export interface CommissionsApiCreateCommissionRequest {
+    /**
+     *
+     * @type {CreateCommissionRequestDto}
+     * @memberof CommissionsApiCreateCommission
+     */
+    readonly createCommissionRequestDto: CreateCommissionRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionsApiCreateCommission
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deleteCommission operation in CommissionsApi.
+ * @export
+ * @interface CommissionsApiDeleteCommissionRequest
+ */
+export interface CommissionsApiDeleteCommissionRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof CommissionsApiDeleteCommission
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionsApiDeleteCommission
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getCommission operation in CommissionsApi.
+ * @export
+ * @interface CommissionsApiGetCommissionRequest
+ */
+export interface CommissionsApiGetCommissionRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof CommissionsApiGetCommission
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CommissionsApiGetCommission
+     */
+    readonly expand: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionsApiGetCommission
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listCommissions operation in CommissionsApi.
+ * @export
+ * @interface CommissionsApiListCommissionsRequest
+ */
+export interface CommissionsApiListCommissionsRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionsApiListCommissions
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {'createdAt'}
+     * @memberof CommissionsApiListCommissions
+     */
+    readonly order?: 'createdAt';
+    /**
+     *
+     * @type {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'}
+     * @memberof CommissionsApiListCommissions
+     */
+    readonly filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt';
+    /**
+     *
+     * @type {'items'}
+     * @memberof CommissionsApiListCommissions
+     */
+    readonly expand?: 'items';
+}
+/**
+ * Request parameters for updateCommission operation in CommissionsApi.
+ * @export
+ * @interface CommissionsApiUpdateCommissionRequest
+ */
+export interface CommissionsApiUpdateCommissionRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof CommissionsApiUpdateCommission
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {UpdateCommissionRequestDto}
+     * @memberof CommissionsApiUpdateCommission
+     */
+    readonly updateCommissionRequestDto: UpdateCommissionRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionsApiUpdateCommission
+     */
+    readonly authorization?: string;
+}
+/**
+ * CommissionsApi - object-oriented interface
+ * @export
+ * @class CommissionsApi
+ * @extends {BaseAPI}
+ */
+export declare class CommissionsApi extends BaseAPI {
+    /**
+     * This will create commission.
+     * @summary Create the commission
+     * @param {CommissionsApiCreateCommissionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionsApi
+     */
+    createCommission(requestParameters: CommissionsApiCreateCommissionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCommissionResponseClass, any, {}>>;
+    /**
+     * This will delete commission.
+     * @summary Delete the commission
+     * @param {CommissionsApiDeleteCommissionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionsApi
+     */
+    deleteCommission(requestParameters: CommissionsApiDeleteCommissionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * This will get commission.
+     * @summary Retrieve the commission
+     * @param {CommissionsApiGetCommissionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionsApi
+     */
+    getCommission(requestParameters: CommissionsApiGetCommissionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCommissionResponseClass, any, {}>>;
+    /**
+     * Retrieves a list of commissions.
+     * @summary List commissions
+     * @param {CommissionsApiListCommissionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionsApi
+     */
+    listCommissions(requestParameters?: CommissionsApiListCommissionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCommissionsResponseClass, any, {}>>;
+    /**
+     * This will update commission.
+     * @summary Update the commission
+     * @param {CommissionsApiUpdateCommissionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionsApi
+     */
+    updateCommission(requestParameters: CommissionsApiUpdateCommissionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateCommissionResponseClass, any, {}>>;
+}