/** * 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 { CreateCommissionAgreementRequestDto } from '../models'; import { CreateCommissionAgreementResponseClass } from '../models'; import { GetCommissionAgreementResponseClass } from '../models'; import { ListCommissionAgreementsResponseClass } from '../models'; import { PatchCommissionAgreementStatusRequestDto } from '../models'; import { PatchCommissionAgreementStatusResponseClass } from '../models'; import { UpdateCommissionAgreementRequestDto } from '../models'; import { UpdateCommissionAgreementResponseClass } from '../models'; /** * CommissionAgreementsApi - axios parameter creator * @export */ export declare const CommissionAgreementsApiAxiosParamCreator: (configuration?: Configuration) => { /** * This will create commission agreement. * @summary Create the commission agreement * @param {CreateCommissionAgreementRequestDto} createCommissionAgreementRequestDto * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCommissionAgreement: (createCommissionAgreementRequestDto: CreateCommissionAgreementRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise; /** * This will delete commission agreement. * @summary Delete the commission agreement * @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} */ deleteCommissionAgreement: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise; /** * This will get commission agreement. * @summary Retrieve the commission agreement * @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} */ getCommissionAgreement: (code: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise; /** * Retrieves a list of commission agreements. * @summary List commission agreements * @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, createdAt, partnerCode, productSlug, endDate</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, commissionAgreementNumber, name, description</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: commissionAgreementNumber, status, createdAt, updatedAt, billingFrequency</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: versions, products<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, createdAt, partnerCode, productSlug, endDate</i> * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCommissionAgreements: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise; /** * This will patch commission agreement status. * @summary Update the commission agreement status * @param {string} code Unique identifier for the object. * @param {PatchCommissionAgreementStatusRequestDto} patchCommissionAgreementStatusRequestDto * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchCommissionAgreementStatus: (code: string, patchCommissionAgreementStatusRequestDto: PatchCommissionAgreementStatusRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise; /** * This will update commission agreement. * @summary Update the commission agreement * @param {string} code * @param {UpdateCommissionAgreementRequestDto} updateCommissionAgreementRequestDto * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCommissionAgreement: (code: string, updateCommissionAgreementRequestDto: UpdateCommissionAgreementRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise; }; /** * CommissionAgreementsApi - functional programming interface * @export */ export declare const CommissionAgreementsApiFp: (configuration?: Configuration) => { /** * This will create commission agreement. * @summary Create the commission agreement * @param {CreateCommissionAgreementRequestDto} createCommissionAgreementRequestDto * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCommissionAgreement(createCommissionAgreementRequestDto: CreateCommissionAgreementRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This will delete commission agreement. * @summary Delete the commission agreement * @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} */ deleteCommissionAgreement(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This will get commission agreement. * @summary Retrieve the commission agreement * @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} */ getCommissionAgreement(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a list of commission agreements. * @summary List commission agreements * @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, createdAt, partnerCode, productSlug, endDate</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, commissionAgreementNumber, name, description</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: commissionAgreementNumber, status, createdAt, updatedAt, billingFrequency</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: versions, products<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, createdAt, partnerCode, productSlug, endDate</i> * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCommissionAgreements(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 patch commission agreement status. * @summary Update the commission agreement status * @param {string} code Unique identifier for the object. * @param {PatchCommissionAgreementStatusRequestDto} patchCommissionAgreementStatusRequestDto * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchCommissionAgreementStatus(code: string, patchCommissionAgreementStatusRequestDto: PatchCommissionAgreementStatusRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This will update commission agreement. * @summary Update the commission agreement * @param {string} code * @param {UpdateCommissionAgreementRequestDto} updateCommissionAgreementRequestDto * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCommissionAgreement(code: string, updateCommissionAgreementRequestDto: UpdateCommissionAgreementRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * CommissionAgreementsApi - factory interface * @export */ export declare const CommissionAgreementsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * This will create commission agreement. * @summary Create the commission agreement * @param {CreateCommissionAgreementRequestDto} createCommissionAgreementRequestDto * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCommissionAgreement(createCommissionAgreementRequestDto: CreateCommissionAgreementRequestDto, authorization?: string, options?: any): AxiosPromise; /** * This will delete commission agreement. * @summary Delete the commission agreement * @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} */ deleteCommissionAgreement(code: string, authorization?: string, options?: any): AxiosPromise; /** * This will get commission agreement. * @summary Retrieve the commission agreement * @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} */ getCommissionAgreement(code: string, expand: string, authorization?: string, options?: any): AxiosPromise; /** * Retrieves a list of commission agreements. * @summary List commission agreements * @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, createdAt, partnerCode, productSlug, endDate</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, commissionAgreementNumber, name, description</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: commissionAgreementNumber, status, createdAt, updatedAt, billingFrequency</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: versions, products<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, createdAt, partnerCode, productSlug, endDate</i> * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCommissionAgreements(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise; /** * This will patch commission agreement status. * @summary Update the commission agreement status * @param {string} code Unique identifier for the object. * @param {PatchCommissionAgreementStatusRequestDto} patchCommissionAgreementStatusRequestDto * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchCommissionAgreementStatus(code: string, patchCommissionAgreementStatusRequestDto: PatchCommissionAgreementStatusRequestDto, authorization?: string, options?: any): AxiosPromise; /** * This will update commission agreement. * @summary Update the commission agreement * @param {string} code * @param {UpdateCommissionAgreementRequestDto} updateCommissionAgreementRequestDto * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCommissionAgreement(code: string, updateCommissionAgreementRequestDto: UpdateCommissionAgreementRequestDto, authorization?: string, options?: any): AxiosPromise; }; /** * Request parameters for createCommissionAgreement operation in CommissionAgreementsApi. * @export * @interface CommissionAgreementsApiCreateCommissionAgreementRequest */ export interface CommissionAgreementsApiCreateCommissionAgreementRequest { /** * * @type {CreateCommissionAgreementRequestDto} * @memberof CommissionAgreementsApiCreateCommissionAgreement */ readonly createCommissionAgreementRequestDto: CreateCommissionAgreementRequestDto; /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof CommissionAgreementsApiCreateCommissionAgreement */ readonly authorization?: string; } /** * Request parameters for deleteCommissionAgreement operation in CommissionAgreementsApi. * @export * @interface CommissionAgreementsApiDeleteCommissionAgreementRequest */ export interface CommissionAgreementsApiDeleteCommissionAgreementRequest { /** * Unique identifier for the object. * @type {string} * @memberof CommissionAgreementsApiDeleteCommissionAgreement */ readonly code: string; /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof CommissionAgreementsApiDeleteCommissionAgreement */ readonly authorization?: string; } /** * Request parameters for getCommissionAgreement operation in CommissionAgreementsApi. * @export * @interface CommissionAgreementsApiGetCommissionAgreementRequest */ export interface CommissionAgreementsApiGetCommissionAgreementRequest { /** * * @type {string} * @memberof CommissionAgreementsApiGetCommissionAgreement */ readonly code: string; /** * * @type {string} * @memberof CommissionAgreementsApiGetCommissionAgreement */ readonly expand: string; /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof CommissionAgreementsApiGetCommissionAgreement */ readonly authorization?: string; } /** * Request parameters for listCommissionAgreements operation in CommissionAgreementsApi. * @export * @interface CommissionAgreementsApiListCommissionAgreementsRequest */ export interface CommissionAgreementsApiListCommissionAgreementsRequest { /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof CommissionAgreementsApiListCommissionAgreements */ readonly authorization?: string; /** * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10. * @type {number} * @memberof CommissionAgreementsApiListCommissionAgreements */ 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 CommissionAgreementsApiListCommissionAgreements */ 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, createdAt, partnerCode, productSlug, endDate</i> * @type {string} * @memberof CommissionAgreementsApiListCommissionAgreements */ 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, commissionAgreementNumber, name, description</i> * @type {string} * @memberof CommissionAgreementsApiListCommissionAgreements */ 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: commissionAgreementNumber, status, createdAt, updatedAt, billingFrequency</i> * @type {string} * @memberof CommissionAgreementsApiListCommissionAgreements */ 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: versions, products<i> * @type {string} * @memberof CommissionAgreementsApiListCommissionAgreements */ 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, createdAt, partnerCode, productSlug, endDate</i> * @type {string} * @memberof CommissionAgreementsApiListCommissionAgreements */ readonly filters?: string; } /** * Request parameters for patchCommissionAgreementStatus operation in CommissionAgreementsApi. * @export * @interface CommissionAgreementsApiPatchCommissionAgreementStatusRequest */ export interface CommissionAgreementsApiPatchCommissionAgreementStatusRequest { /** * Unique identifier for the object. * @type {string} * @memberof CommissionAgreementsApiPatchCommissionAgreementStatus */ readonly code: string; /** * * @type {PatchCommissionAgreementStatusRequestDto} * @memberof CommissionAgreementsApiPatchCommissionAgreementStatus */ readonly patchCommissionAgreementStatusRequestDto: PatchCommissionAgreementStatusRequestDto; /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof CommissionAgreementsApiPatchCommissionAgreementStatus */ readonly authorization?: string; } /** * Request parameters for updateCommissionAgreement operation in CommissionAgreementsApi. * @export * @interface CommissionAgreementsApiUpdateCommissionAgreementRequest */ export interface CommissionAgreementsApiUpdateCommissionAgreementRequest { /** * * @type {string} * @memberof CommissionAgreementsApiUpdateCommissionAgreement */ readonly code: string; /** * * @type {UpdateCommissionAgreementRequestDto} * @memberof CommissionAgreementsApiUpdateCommissionAgreement */ readonly updateCommissionAgreementRequestDto: UpdateCommissionAgreementRequestDto; /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof CommissionAgreementsApiUpdateCommissionAgreement */ readonly authorization?: string; } /** * CommissionAgreementsApi - object-oriented interface * @export * @class CommissionAgreementsApi * @extends {BaseAPI} */ export declare class CommissionAgreementsApi extends BaseAPI { /** * This will create commission agreement. * @summary Create the commission agreement * @param {CommissionAgreementsApiCreateCommissionAgreementRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CommissionAgreementsApi */ createCommissionAgreement(requestParameters: CommissionAgreementsApiCreateCommissionAgreementRequest, options?: AxiosRequestConfig): Promise>; /** * This will delete commission agreement. * @summary Delete the commission agreement * @param {CommissionAgreementsApiDeleteCommissionAgreementRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CommissionAgreementsApi */ deleteCommissionAgreement(requestParameters: CommissionAgreementsApiDeleteCommissionAgreementRequest, options?: AxiosRequestConfig): Promise>; /** * This will get commission agreement. * @summary Retrieve the commission agreement * @param {CommissionAgreementsApiGetCommissionAgreementRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CommissionAgreementsApi */ getCommissionAgreement(requestParameters: CommissionAgreementsApiGetCommissionAgreementRequest, options?: AxiosRequestConfig): Promise>; /** * Retrieves a list of commission agreements. * @summary List commission agreements * @param {CommissionAgreementsApiListCommissionAgreementsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CommissionAgreementsApi */ listCommissionAgreements(requestParameters?: CommissionAgreementsApiListCommissionAgreementsRequest, options?: AxiosRequestConfig): Promise>; /** * This will patch commission agreement status. * @summary Update the commission agreement status * @param {CommissionAgreementsApiPatchCommissionAgreementStatusRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CommissionAgreementsApi */ patchCommissionAgreementStatus(requestParameters: CommissionAgreementsApiPatchCommissionAgreementStatusRequest, options?: AxiosRequestConfig): Promise>; /** * This will update commission agreement. * @summary Update the commission agreement * @param {CommissionAgreementsApiUpdateCommissionAgreementRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CommissionAgreementsApi */ updateCommissionAgreement(requestParameters: CommissionAgreementsApiUpdateCommissionAgreementRequest, options?: AxiosRequestConfig): Promise>; }