/** * 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 { CreateCommissionAgreementProductRequestDto } from '../models'; import { CreateCommissionAgreementProductResponseClass } from '../models'; import { GetCommissionAgreementProductResponseClass } from '../models'; import { ListCommissionAgreementProductsResponseClass } from '../models'; import { UpdateCommissionAgreementProductRequestDto } from '../models'; import { UpdateCommissionAgreementProductResponseClass } from '../models'; /** * CommissionAgreementProductsApi - axios parameter creator * @export */ export declare const CommissionAgreementProductsApiAxiosParamCreator: (configuration?: Configuration) => { /** * This will create commission agreement product. * @summary Create the commission agreement product * @param {CreateCommissionAgreementProductRequestDto} createCommissionAgreementProductRequestDto * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCommissionAgreementProduct: (createCommissionAgreementProductRequestDto: CreateCommissionAgreementProductRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise; /** * This will delete commission agreement product. * @summary Delete the commission agreement product * @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} */ deleteCommissionAgreementProduct: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise; /** * This will get commission agreement product. * @summary Retrieve the commission agreement product * @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} */ getCommissionAgreementProduct: (code: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise; /** * Retrieves a list of commission agreement products. * @summary List commission agreement products * @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, commissionAgreementVersionId, productSlug, status, createdAt</i> * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, productSlug</i> * @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, updatedAt, productSlug, status</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: version<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, commissionAgreementVersionId, productSlug, status, createdAt</i> * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCommissionAgreementProducts: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise; /** * This will update commission agreement product. * @summary Update the commission agreement product * @param {string} code Unique identifier for the object. * @param {UpdateCommissionAgreementProductRequestDto} updateCommissionAgreementProductRequestDto * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCommissionAgreementProduct: (code: string, updateCommissionAgreementProductRequestDto: UpdateCommissionAgreementProductRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise; }; /** * CommissionAgreementProductsApi - functional programming interface * @export */ export declare const CommissionAgreementProductsApiFp: (configuration?: Configuration) => { /** * This will create commission agreement product. * @summary Create the commission agreement product * @param {CreateCommissionAgreementProductRequestDto} createCommissionAgreementProductRequestDto * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCommissionAgreementProduct(createCommissionAgreementProductRequestDto: CreateCommissionAgreementProductRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This will delete commission agreement product. * @summary Delete the commission agreement product * @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} */ deleteCommissionAgreementProduct(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This will get commission agreement product. * @summary Retrieve the commission agreement product * @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} */ getCommissionAgreementProduct(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a list of commission agreement products. * @summary List commission agreement products * @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, commissionAgreementVersionId, productSlug, status, createdAt</i> * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, productSlug</i> * @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, updatedAt, productSlug, status</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: version<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, commissionAgreementVersionId, productSlug, status, createdAt</i> * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCommissionAgreementProducts(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 agreement product. * @summary Update the commission agreement product * @param {string} code Unique identifier for the object. * @param {UpdateCommissionAgreementProductRequestDto} updateCommissionAgreementProductRequestDto * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCommissionAgreementProduct(code: string, updateCommissionAgreementProductRequestDto: UpdateCommissionAgreementProductRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * CommissionAgreementProductsApi - factory interface * @export */ export declare const CommissionAgreementProductsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * This will create commission agreement product. * @summary Create the commission agreement product * @param {CreateCommissionAgreementProductRequestDto} createCommissionAgreementProductRequestDto * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCommissionAgreementProduct(createCommissionAgreementProductRequestDto: CreateCommissionAgreementProductRequestDto, authorization?: string, options?: any): AxiosPromise; /** * This will delete commission agreement product. * @summary Delete the commission agreement product * @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} */ deleteCommissionAgreementProduct(code: string, authorization?: string, options?: any): AxiosPromise; /** * This will get commission agreement product. * @summary Retrieve the commission agreement product * @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} */ getCommissionAgreementProduct(code: string, expand: string, authorization?: string, options?: any): AxiosPromise; /** * Retrieves a list of commission agreement products. * @summary List commission agreement products * @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, commissionAgreementVersionId, productSlug, status, createdAt</i> * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, productSlug</i> * @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, updatedAt, productSlug, status</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: version<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, commissionAgreementVersionId, productSlug, status, createdAt</i> * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCommissionAgreementProducts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise; /** * This will update commission agreement product. * @summary Update the commission agreement product * @param {string} code Unique identifier for the object. * @param {UpdateCommissionAgreementProductRequestDto} updateCommissionAgreementProductRequestDto * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCommissionAgreementProduct(code: string, updateCommissionAgreementProductRequestDto: UpdateCommissionAgreementProductRequestDto, authorization?: string, options?: any): AxiosPromise; }; /** * Request parameters for createCommissionAgreementProduct operation in CommissionAgreementProductsApi. * @export * @interface CommissionAgreementProductsApiCreateCommissionAgreementProductRequest */ export interface CommissionAgreementProductsApiCreateCommissionAgreementProductRequest { /** * * @type {CreateCommissionAgreementProductRequestDto} * @memberof CommissionAgreementProductsApiCreateCommissionAgreementProduct */ readonly createCommissionAgreementProductRequestDto: CreateCommissionAgreementProductRequestDto; /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof CommissionAgreementProductsApiCreateCommissionAgreementProduct */ readonly authorization?: string; } /** * Request parameters for deleteCommissionAgreementProduct operation in CommissionAgreementProductsApi. * @export * @interface CommissionAgreementProductsApiDeleteCommissionAgreementProductRequest */ export interface CommissionAgreementProductsApiDeleteCommissionAgreementProductRequest { /** * Unique identifier for the object. * @type {string} * @memberof CommissionAgreementProductsApiDeleteCommissionAgreementProduct */ readonly code: string; /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof CommissionAgreementProductsApiDeleteCommissionAgreementProduct */ readonly authorization?: string; } /** * Request parameters for getCommissionAgreementProduct operation in CommissionAgreementProductsApi. * @export * @interface CommissionAgreementProductsApiGetCommissionAgreementProductRequest */ export interface CommissionAgreementProductsApiGetCommissionAgreementProductRequest { /** * * @type {string} * @memberof CommissionAgreementProductsApiGetCommissionAgreementProduct */ readonly code: string; /** * * @type {string} * @memberof CommissionAgreementProductsApiGetCommissionAgreementProduct */ readonly expand: string; /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof CommissionAgreementProductsApiGetCommissionAgreementProduct */ readonly authorization?: string; } /** * Request parameters for listCommissionAgreementProducts operation in CommissionAgreementProductsApi. * @export * @interface CommissionAgreementProductsApiListCommissionAgreementProductsRequest */ export interface CommissionAgreementProductsApiListCommissionAgreementProductsRequest { /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof CommissionAgreementProductsApiListCommissionAgreementProducts */ readonly authorization?: string; /** * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10. * @type {number} * @memberof CommissionAgreementProductsApiListCommissionAgreementProducts */ 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 CommissionAgreementProductsApiListCommissionAgreementProducts */ 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, commissionAgreementVersionId, productSlug, status, createdAt</i> * @type {string} * @memberof CommissionAgreementProductsApiListCommissionAgreementProducts */ readonly filter?: string; /** * Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, productSlug</i> * @type {string} * @memberof CommissionAgreementProductsApiListCommissionAgreementProducts */ 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, updatedAt, productSlug, status</i> * @type {string} * @memberof CommissionAgreementProductsApiListCommissionAgreementProducts */ 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: version<i> * @type {string} * @memberof CommissionAgreementProductsApiListCommissionAgreementProducts */ 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, commissionAgreementVersionId, productSlug, status, createdAt</i> * @type {string} * @memberof CommissionAgreementProductsApiListCommissionAgreementProducts */ readonly filters?: string; } /** * Request parameters for updateCommissionAgreementProduct operation in CommissionAgreementProductsApi. * @export * @interface CommissionAgreementProductsApiUpdateCommissionAgreementProductRequest */ export interface CommissionAgreementProductsApiUpdateCommissionAgreementProductRequest { /** * Unique identifier for the object. * @type {string} * @memberof CommissionAgreementProductsApiUpdateCommissionAgreementProduct */ readonly code: string; /** * * @type {UpdateCommissionAgreementProductRequestDto} * @memberof CommissionAgreementProductsApiUpdateCommissionAgreementProduct */ readonly updateCommissionAgreementProductRequestDto: UpdateCommissionAgreementProductRequestDto; /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof CommissionAgreementProductsApiUpdateCommissionAgreementProduct */ readonly authorization?: string; } /** * CommissionAgreementProductsApi - object-oriented interface * @export * @class CommissionAgreementProductsApi * @extends {BaseAPI} */ export declare class CommissionAgreementProductsApi extends BaseAPI { /** * This will create commission agreement product. * @summary Create the commission agreement product * @param {CommissionAgreementProductsApiCreateCommissionAgreementProductRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CommissionAgreementProductsApi */ createCommissionAgreementProduct(requestParameters: CommissionAgreementProductsApiCreateCommissionAgreementProductRequest, options?: AxiosRequestConfig): Promise>; /** * This will delete commission agreement product. * @summary Delete the commission agreement product * @param {CommissionAgreementProductsApiDeleteCommissionAgreementProductRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CommissionAgreementProductsApi */ deleteCommissionAgreementProduct(requestParameters: CommissionAgreementProductsApiDeleteCommissionAgreementProductRequest, options?: AxiosRequestConfig): Promise>; /** * This will get commission agreement product. * @summary Retrieve the commission agreement product * @param {CommissionAgreementProductsApiGetCommissionAgreementProductRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CommissionAgreementProductsApi */ getCommissionAgreementProduct(requestParameters: CommissionAgreementProductsApiGetCommissionAgreementProductRequest, options?: AxiosRequestConfig): Promise>; /** * Retrieves a list of commission agreement products. * @summary List commission agreement products * @param {CommissionAgreementProductsApiListCommissionAgreementProductsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CommissionAgreementProductsApi */ listCommissionAgreementProducts(requestParameters?: CommissionAgreementProductsApiListCommissionAgreementProductsRequest, options?: AxiosRequestConfig): Promise>; /** * This will update commission agreement product. * @summary Update the commission agreement product * @param {CommissionAgreementProductsApiUpdateCommissionAgreementProductRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CommissionAgreementProductsApi */ updateCommissionAgreementProduct(requestParameters: CommissionAgreementProductsApiUpdateCommissionAgreementProductRequest, options?: AxiosRequestConfig): Promise>; }