/** * 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 { CreateCommissionRecipientForProductsRequestDto } from '../models'; import { CreateCommissionRecipientForProductsResponseClass } from '../models'; import { CreateCommissionRecipientRequestDto } from '../models'; import { CreateCommissionRecipientResponseClass } from '../models'; import { GetCommissionRecipientResponseClass } from '../models'; import { ListCommissionRecipientsResponseClass } from '../models'; import { UpdateCommissionRecipientRequestDto } from '../models'; import { UpdateCommissionRecipientResponseClass } from '../models'; /** * CommissionRecipientsApi - axios parameter creator * @export */ export declare const CommissionRecipientsApiAxiosParamCreator: (configuration?: Configuration) => { /** * This will create commission recipient. * @summary Create the commission recipient * @param {CreateCommissionRecipientRequestDto} createCommissionRecipientRequestDto * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCommissionRecipient: (createCommissionRecipientRequestDto: CreateCommissionRecipientRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise; /** * This will create a list of commission recipients, one per commission agreement product code provided * @summary Create the commission recipient bulk * @param {CreateCommissionRecipientForProductsRequestDto} createCommissionRecipientForProductsRequestDto * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCommissionRecipientWithProducts: (createCommissionRecipientForProductsRequestDto: CreateCommissionRecipientForProductsRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise; /** * This will delete commission recipient. * @summary Delete the commission recipient * @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} */ deleteCommissionRecipient: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise; /** * This will get commission recipient. * @summary Retrieve the commission recipient * @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} */ getCommissionRecipient: (code: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise; /** * Retrieves a list of commission recipients. * @summary List commission recipients * @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, displayName, partnerCode, status, createdAt, commissionAgreementProductCode, commissionAgreementVersionCode</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: createdAt</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: commissionAgreementProduct<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, displayName, partnerCode, status, createdAt, commissionAgreementProductCode, commissionAgreementVersionCode</i> * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCommissionRecipients: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise; /** * This will update commission recipient. * @summary Update the commission recipient * @param {string} code * @param {UpdateCommissionRecipientRequestDto} updateCommissionRecipientRequestDto * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCommissionRecipient: (code: string, updateCommissionRecipientRequestDto: UpdateCommissionRecipientRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise; }; /** * CommissionRecipientsApi - functional programming interface * @export */ export declare const CommissionRecipientsApiFp: (configuration?: Configuration) => { /** * This will create commission recipient. * @summary Create the commission recipient * @param {CreateCommissionRecipientRequestDto} createCommissionRecipientRequestDto * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCommissionRecipient(createCommissionRecipientRequestDto: CreateCommissionRecipientRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This will create a list of commission recipients, one per commission agreement product code provided * @summary Create the commission recipient bulk * @param {CreateCommissionRecipientForProductsRequestDto} createCommissionRecipientForProductsRequestDto * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCommissionRecipientWithProducts(createCommissionRecipientForProductsRequestDto: CreateCommissionRecipientForProductsRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This will delete commission recipient. * @summary Delete the commission recipient * @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} */ deleteCommissionRecipient(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This will get commission recipient. * @summary Retrieve the commission recipient * @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} */ getCommissionRecipient(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a list of commission recipients. * @summary List commission recipients * @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, displayName, partnerCode, status, createdAt, commissionAgreementProductCode, commissionAgreementVersionCode</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: createdAt</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: commissionAgreementProduct<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, displayName, partnerCode, status, createdAt, commissionAgreementProductCode, commissionAgreementVersionCode</i> * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCommissionRecipients(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This will update commission recipient. * @summary Update the commission recipient * @param {string} code * @param {UpdateCommissionRecipientRequestDto} updateCommissionRecipientRequestDto * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCommissionRecipient(code: string, updateCommissionRecipientRequestDto: UpdateCommissionRecipientRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * CommissionRecipientsApi - factory interface * @export */ export declare const CommissionRecipientsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * This will create commission recipient. * @summary Create the commission recipient * @param {CreateCommissionRecipientRequestDto} createCommissionRecipientRequestDto * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCommissionRecipient(createCommissionRecipientRequestDto: CreateCommissionRecipientRequestDto, authorization?: string, options?: any): AxiosPromise; /** * This will create a list of commission recipients, one per commission agreement product code provided * @summary Create the commission recipient bulk * @param {CreateCommissionRecipientForProductsRequestDto} createCommissionRecipientForProductsRequestDto * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCommissionRecipientWithProducts(createCommissionRecipientForProductsRequestDto: CreateCommissionRecipientForProductsRequestDto, authorization?: string, options?: any): AxiosPromise; /** * This will delete commission recipient. * @summary Delete the commission recipient * @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} */ deleteCommissionRecipient(code: string, authorization?: string, options?: any): AxiosPromise; /** * This will get commission recipient. * @summary Retrieve the commission recipient * @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} */ getCommissionRecipient(code: string, expand: string, authorization?: string, options?: any): AxiosPromise; /** * Retrieves a list of commission recipients. * @summary List commission recipients * @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, displayName, partnerCode, status, createdAt, commissionAgreementProductCode, commissionAgreementVersionCode</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: createdAt</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: commissionAgreementProduct<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, displayName, partnerCode, status, createdAt, commissionAgreementProductCode, commissionAgreementVersionCode</i> * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCommissionRecipients(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise; /** * This will update commission recipient. * @summary Update the commission recipient * @param {string} code * @param {UpdateCommissionRecipientRequestDto} updateCommissionRecipientRequestDto * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCommissionRecipient(code: string, updateCommissionRecipientRequestDto: UpdateCommissionRecipientRequestDto, authorization?: string, options?: any): AxiosPromise; }; /** * Request parameters for createCommissionRecipient operation in CommissionRecipientsApi. * @export * @interface CommissionRecipientsApiCreateCommissionRecipientRequest */ export interface CommissionRecipientsApiCreateCommissionRecipientRequest { /** * * @type {CreateCommissionRecipientRequestDto} * @memberof CommissionRecipientsApiCreateCommissionRecipient */ readonly createCommissionRecipientRequestDto: CreateCommissionRecipientRequestDto; /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof CommissionRecipientsApiCreateCommissionRecipient */ readonly authorization?: string; } /** * Request parameters for createCommissionRecipientWithProducts operation in CommissionRecipientsApi. * @export * @interface CommissionRecipientsApiCreateCommissionRecipientWithProductsRequest */ export interface CommissionRecipientsApiCreateCommissionRecipientWithProductsRequest { /** * * @type {CreateCommissionRecipientForProductsRequestDto} * @memberof CommissionRecipientsApiCreateCommissionRecipientWithProducts */ readonly createCommissionRecipientForProductsRequestDto: CreateCommissionRecipientForProductsRequestDto; /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof CommissionRecipientsApiCreateCommissionRecipientWithProducts */ readonly authorization?: string; } /** * Request parameters for deleteCommissionRecipient operation in CommissionRecipientsApi. * @export * @interface CommissionRecipientsApiDeleteCommissionRecipientRequest */ export interface CommissionRecipientsApiDeleteCommissionRecipientRequest { /** * Unique identifier for the object. * @type {string} * @memberof CommissionRecipientsApiDeleteCommissionRecipient */ readonly code: string; /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof CommissionRecipientsApiDeleteCommissionRecipient */ readonly authorization?: string; } /** * Request parameters for getCommissionRecipient operation in CommissionRecipientsApi. * @export * @interface CommissionRecipientsApiGetCommissionRecipientRequest */ export interface CommissionRecipientsApiGetCommissionRecipientRequest { /** * * @type {string} * @memberof CommissionRecipientsApiGetCommissionRecipient */ readonly code: string; /** * * @type {string} * @memberof CommissionRecipientsApiGetCommissionRecipient */ readonly expand: string; /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof CommissionRecipientsApiGetCommissionRecipient */ readonly authorization?: string; } /** * Request parameters for listCommissionRecipients operation in CommissionRecipientsApi. * @export * @interface CommissionRecipientsApiListCommissionRecipientsRequest */ export interface CommissionRecipientsApiListCommissionRecipientsRequest { /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof CommissionRecipientsApiListCommissionRecipients */ readonly authorization?: string; /** * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10. * @type {number} * @memberof CommissionRecipientsApiListCommissionRecipients */ 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 CommissionRecipientsApiListCommissionRecipients */ 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, displayName, partnerCode, status, createdAt, commissionAgreementProductCode, commissionAgreementVersionCode</i> * @type {string} * @memberof CommissionRecipientsApiListCommissionRecipients */ readonly filter?: string; /** * To search the list by any field, pass search=xxx to fetch the result. * @type {string} * @memberof CommissionRecipientsApiListCommissionRecipients */ 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: createdAt</i> * @type {string} * @memberof CommissionRecipientsApiListCommissionRecipients */ 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: commissionAgreementProduct<i> * @type {string} * @memberof CommissionRecipientsApiListCommissionRecipients */ 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, displayName, partnerCode, status, createdAt, commissionAgreementProductCode, commissionAgreementVersionCode</i> * @type {string} * @memberof CommissionRecipientsApiListCommissionRecipients */ readonly filters?: string; } /** * Request parameters for updateCommissionRecipient operation in CommissionRecipientsApi. * @export * @interface CommissionRecipientsApiUpdateCommissionRecipientRequest */ export interface CommissionRecipientsApiUpdateCommissionRecipientRequest { /** * * @type {string} * @memberof CommissionRecipientsApiUpdateCommissionRecipient */ readonly code: string; /** * * @type {UpdateCommissionRecipientRequestDto} * @memberof CommissionRecipientsApiUpdateCommissionRecipient */ readonly updateCommissionRecipientRequestDto: UpdateCommissionRecipientRequestDto; /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof CommissionRecipientsApiUpdateCommissionRecipient */ readonly authorization?: string; } /** * CommissionRecipientsApi - object-oriented interface * @export * @class CommissionRecipientsApi * @extends {BaseAPI} */ export declare class CommissionRecipientsApi extends BaseAPI { /** * This will create commission recipient. * @summary Create the commission recipient * @param {CommissionRecipientsApiCreateCommissionRecipientRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CommissionRecipientsApi */ createCommissionRecipient(requestParameters: CommissionRecipientsApiCreateCommissionRecipientRequest, options?: AxiosRequestConfig): Promise>; /** * This will create a list of commission recipients, one per commission agreement product code provided * @summary Create the commission recipient bulk * @param {CommissionRecipientsApiCreateCommissionRecipientWithProductsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CommissionRecipientsApi */ createCommissionRecipientWithProducts(requestParameters: CommissionRecipientsApiCreateCommissionRecipientWithProductsRequest, options?: AxiosRequestConfig): Promise>; /** * This will delete commission recipient. * @summary Delete the commission recipient * @param {CommissionRecipientsApiDeleteCommissionRecipientRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CommissionRecipientsApi */ deleteCommissionRecipient(requestParameters: CommissionRecipientsApiDeleteCommissionRecipientRequest, options?: AxiosRequestConfig): Promise>; /** * This will get commission recipient. * @summary Retrieve the commission recipient * @param {CommissionRecipientsApiGetCommissionRecipientRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CommissionRecipientsApi */ getCommissionRecipient(requestParameters: CommissionRecipientsApiGetCommissionRecipientRequest, options?: AxiosRequestConfig): Promise>; /** * Retrieves a list of commission recipients. * @summary List commission recipients * @param {CommissionRecipientsApiListCommissionRecipientsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CommissionRecipientsApi */ listCommissionRecipients(requestParameters?: CommissionRecipientsApiListCommissionRecipientsRequest, options?: AxiosRequestConfig): Promise>; /** * This will update commission recipient. * @summary Update the commission recipient * @param {CommissionRecipientsApiUpdateCommissionRecipientRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CommissionRecipientsApi */ updateCommissionRecipient(requestParameters: CommissionRecipientsApiUpdateCommissionRecipientRequest, options?: AxiosRequestConfig): Promise>; }