@emilgroup/commission-sdk 1.0.0-beta.4 → 1.0.0-beta.5

package/api.ts

@@ -20,6 +20,7 @@ import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig, AxiosResp
 import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
 // @ts-ignore
 import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
+import { CommissionAgreementProductsApi } from './api';
 import { CommissionAgreementVersionsApi } from './api';
 import { CommissionAgreementsApi } from './api';
 import { CommissionRecipientsApi } from './api';
@@ -27,6 +28,7 @@ import { CommissionsApi } from './api';
 import { DefaultApi } from './api';
 
 
+export * from './api/commission-agreement-products-api';
 export * from './api/commission-agreement-versions-api';
 export * from './api/commission-agreements-api';
 export * from './api/commission-recipients-api';

package/dist/api/commission-agreement-products-api.d.ts

@@ -0,0 +1,375 @@
+/**
+ * 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<RequestArgs>;
+    /**
+     * 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<RequestArgs>;
+    /**
+     * 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<RequestArgs>;
+    /**
+     * 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 {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt&lt;/i&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt&lt;/i&gt;
+     * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: code, productSlug&lt;/i&gt;
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: createdAt, productSlug, status&lt;/i&gt;
+     * @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.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: version&lt;i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCommissionAgreementProducts: (authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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<RequestArgs>;
+};
+/**
+ * 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<CreateCommissionAgreementProductResponseClass>>;
+    /**
+     * 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<void>>;
+    /**
+     * 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<GetCommissionAgreementProductResponseClass>>;
+    /**
+     * 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 {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt&lt;/i&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt&lt;/i&gt;
+     * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: code, productSlug&lt;/i&gt;
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: createdAt, productSlug, status&lt;/i&gt;
+     * @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.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: version&lt;i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCommissionAgreementProducts(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionAgreementProductsResponseClass>>;
+    /**
+     * 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<UpdateCommissionAgreementProductResponseClass>>;
+};
+/**
+ * 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<CreateCommissionAgreementProductResponseClass>;
+    /**
+     * 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<void>;
+    /**
+     * 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<GetCommissionAgreementProductResponseClass>;
+    /**
+     * 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 {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt&lt;/i&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt&lt;/i&gt;
+     * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: code, productSlug&lt;/i&gt;
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: createdAt, productSlug, status&lt;/i&gt;
+     * @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.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: version&lt;i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCommissionAgreementProducts(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListCommissionAgreementProductsResponseClass>;
+    /**
+     * 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<UpdateCommissionAgreementProductResponseClass>;
+};
+/**
+ * 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;
+    /**
+     * Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt&lt;/i&gt;
+     * @type {string}
+     * @memberof CommissionAgreementProductsApiListCommissionAgreementProducts
+     */
+    readonly filter?: string;
+    /**
+     * Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt&lt;/i&gt;
+     * @type {string}
+     * @memberof CommissionAgreementProductsApiListCommissionAgreementProducts
+     */
+    readonly filters?: string;
+    /**
+     * Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: code, productSlug&lt;/i&gt;
+     * @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.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: createdAt, productSlug, status&lt;/i&gt;
+     * @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.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: version&lt;i&gt;
+     * @type {string}
+     * @memberof CommissionAgreementProductsApiListCommissionAgreementProducts
+     */
+    readonly expand?: 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<import("axios").AxiosResponse<CreateCommissionAgreementProductResponseClass, any, {}>>;
+    /**
+     * 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<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * 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<import("axios").AxiosResponse<GetCommissionAgreementProductResponseClass, any, {}>>;
+    /**
+     * 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<import("axios").AxiosResponse<ListCommissionAgreementProductsResponseClass, any, {}>>;
+    /**
+     * 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<import("axios").AxiosResponse<UpdateCommissionAgreementProductResponseClass, any, {}>>;
+}