@emilgroup/commission-sdk 1.0.0-beta.9 → 1.0.2

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

@@ -1,393 +0,0 @@
-/**
- * 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 {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
-     * @param {string} [pageToken] A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
-     * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
-     * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
-     * @param {'createdAt'} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
-     * @param {'items'} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
-     * @param {string} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    listCommissions: (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'createdAt', expand?: 'items', filters?: string, 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 {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
-     * @param {string} [pageToken] A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
-     * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
-     * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
-     * @param {'createdAt'} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
-     * @param {'items'} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
-     * @param {string} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'createdAt', expand?: 'items', filters?: string, 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 {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
-     * @param {string} [pageToken] A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
-     * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
-     * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
-     * @param {'createdAt'} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
-     * @param {'items'} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
-     * @param {string} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'createdAt', expand?: 'items', filters?: string, 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;
-    /**
-     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
-     * @type {number}
-     * @memberof CommissionsApiListCommissions
-     */
-    readonly pageSize?: number;
-    /**
-     * A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
-     * @type {string}
-     * @memberof CommissionsApiListCommissions
-     */
-    readonly pageToken?: string;
-    /**
-     * Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
-     * @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';
-    /**
-     * To search the list by any field, pass search&#x3D;xxx to fetch the result.
-     * @type {string}
-     * @memberof CommissionsApiListCommissions
-     */
-    readonly search?: string;
-    /**
-     * The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
-     * @type {'createdAt'}
-     * @memberof CommissionsApiListCommissions
-     */
-    readonly order?: 'createdAt';
-    /**
-     * Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
-     * @type {'items'}
-     * @memberof CommissionsApiListCommissions
-     */
-    readonly expand?: 'items';
-    /**
-     * Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
-     * @type {string}
-     * @memberof CommissionsApiListCommissions
-     */
-    readonly filters?: string;
-}
-/**
- * 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, {}>>;
-}