/** * 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; /** * 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; /** * 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; /** * 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 {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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list. * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i> * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result. * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: code, createdAt, startDate, endDate</i> * @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.<br/> <br/> <i>Allowed values: agreements<i> * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i> * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCommissionAgreementVersions: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise; }; /** * 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>; /** * 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>; /** * 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>; /** * 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 {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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list. * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i> * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result. * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: code, createdAt, startDate, endDate</i> * @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.<br/> <br/> <i>Allowed values: agreements<i> * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i> * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCommissionAgreementVersions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * 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; /** * 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; /** * 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; /** * 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 {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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list. * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i> * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result. * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: code, createdAt, startDate, endDate</i> * @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.<br/> <br/> <i>Allowed values: agreements<i> * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i> * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCommissionAgreementVersions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise; }; /** * 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; /** * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10. * @type {number} * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions */ 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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list. * @type {string} * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions */ readonly pageToken?: string; /** * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i> * @type {string} * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions */ readonly filter?: string; /** * To search the list by any field, pass search=xxx to fetch the result. * @type {string} * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions */ readonly search?: string; /** * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: code, createdAt, startDate, endDate</i> * @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.<br/> <br/> <i>Allowed values: agreements<i> * @type {string} * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions */ readonly expand?: string; /** * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i> * @type {string} * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions */ readonly filters?: 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>; /** * 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>; /** * 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>; /** * 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>; }