flexinet-api 0.0.1237-prerelease0 → 0.0.1265-prerelease0

package/README.md

@@ -1,4 +1,4 @@
-## flexinet-api@0.0.1237-prerelease0
+## flexinet-api@0.0.1265-prerelease0
 
 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install flexinet-api@0.0.1237-prerelease0 --save
+npm install flexinet-api@0.0.1265-prerelease0 --save
 ```
 
 _unPublished (not recommended):_

package/api.ts

@@ -23,6 +23,25 @@ import type { RequestArgs } from './base';
 // @ts-ignore
 import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError } from './base';
 
+/**
+ * 
+ * @export
+ * @interface AdminOrderCreationRequest
+ */
+export interface AdminOrderCreationRequest {
+    /**
+     * 
+     * @type {Array<OrderItemCreationRequest>}
+     * @memberof AdminOrderCreationRequest
+     */
+    'items': Array<OrderItemCreationRequest>;
+    /**
+     * 
+     * @type {Beneficiary}
+     * @memberof AdminOrderCreationRequest
+     */
+    'beneficiary'?: Beneficiary;
+}
 /**
  * 
  * @export
@@ -238,7 +257,7 @@ export interface BalanceUpdateRequest {
      * @type {TransactionKind}
      * @memberof BalanceUpdateRequest
      */
-    'transactionKind'?: TransactionKind;
+    'transactionKind': TransactionKind;
     /**
      * 
      * @type {TransactionCurrencyKind}
@@ -716,6 +735,19 @@ export const Condition = {
 export type Condition = typeof Condition[keyof typeof Condition];
 
 
+/**
+ * 
+ * @export
+ * @interface CustomDealMinTargetValueResponse
+ */
+export interface CustomDealMinTargetValueResponse {
+    /**
+     * 
+     * @type {number}
+     * @memberof CustomDealMinTargetValueResponse
+     */
+    'minTargetValue': number;
+}
 /**
  * @type CustomDealRestriction
  * @export
@@ -1283,6 +1315,12 @@ export interface Order {
      * @memberof Order
      */
     'status'?: OrderStatus;
+    /**
+     * 
+     * @type {string}
+     * @memberof Order
+     */
+    'clientID'?: string;
 }
 
 
@@ -1332,7 +1370,8 @@ export interface OrderItemCreationRequest {
 
 export const OrderKind = {
     Webshop: 'webshop',
-    Promotions: 'promotions'
+    Promotions: 'promotions',
+    SalesBudget: 'sales_budget'
 } as const;
 
 export type OrderKind = typeof OrderKind[keyof typeof OrderKind];
@@ -3690,7 +3729,8 @@ export const TransactionSource = {
     Promotion: 'promotion',
     Manual: 'manual',
     Expiry: 'expiry',
-    Transfer: 'transfer'
+    Transfer: 'transfer',
+    SalesBudget: 'sales_budget'
 } as const;
 
 export type TransactionSource = typeof TransactionSource[keyof typeof TransactionSource];
@@ -3700,7 +3740,7 @@ export type TransactionSource = typeof TransactionSource[keyof typeof Transactio
  * @type TransactionSourceReference
  * @export
  */
-export type TransactionSourceReference = BalanceWithBeneficiaryRef | Order | PeriodPromotion | User;
+export type TransactionSourceReference = BalanceWithBeneficiaryRef | PeriodPromotion | User | UserOrder;
 
 /**
  * 
@@ -4055,7 +4095,7 @@ export interface UserOrder {
      * @type {string}
      * @memberof UserOrder
      */
-    'source'?: string;
+    'source': string;
     /**
      * 
      * @type {string}
@@ -4064,10 +4104,10 @@ export interface UserOrder {
     'userID'?: string;
     /**
      * 
-     * @type {OrderStatus}
+     * @type {string}
      * @memberof UserOrder
      */
-    'status'?: OrderStatus;
+    'clientID': string;
 }
 
 
@@ -5954,6 +5994,86 @@ export const CustomDealsApiAxiosParamCreator = function (configuration?: Configu
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Get custom deal min target value
+         * @summary Get custom deal min target value
+         * @param {string} startingAt start at
+         * @param {string} endingAt end at
+         * @param {BeneficiaryKind} beneficiaryKind beneficiary kind
+         * @param {Array<string>} beneficiaryValues beneficiary values
+         * @param {string} tagKey tag key
+         * @param {string} tagValue tag value
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getCustomDealMinTargetValue: async (startingAt: string, endingAt: string, beneficiaryKind: BeneficiaryKind, beneficiaryValues: Array<string>, tagKey: string, tagValue: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'startingAt' is not null or undefined
+            assertParamExists('getCustomDealMinTargetValue', 'startingAt', startingAt)
+            // verify required parameter 'endingAt' is not null or undefined
+            assertParamExists('getCustomDealMinTargetValue', 'endingAt', endingAt)
+            // verify required parameter 'beneficiaryKind' is not null or undefined
+            assertParamExists('getCustomDealMinTargetValue', 'beneficiaryKind', beneficiaryKind)
+            // verify required parameter 'beneficiaryValues' is not null or undefined
+            assertParamExists('getCustomDealMinTargetValue', 'beneficiaryValues', beneficiaryValues)
+            // verify required parameter 'tagKey' is not null or undefined
+            assertParamExists('getCustomDealMinTargetValue', 'tagKey', tagKey)
+            // verify required parameter 'tagValue' is not null or undefined
+            assertParamExists('getCustomDealMinTargetValue', 'tagValue', tagValue)
+            const localVarPath = `/admins/custom-deals/min-target-value`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication systemJWT required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (startingAt !== undefined) {
+                localVarQueryParameter['startingAt'] = (startingAt as any instanceof Date) ?
+                    (startingAt as any).toISOString() :
+                    startingAt;
+            }
+
+            if (endingAt !== undefined) {
+                localVarQueryParameter['endingAt'] = (endingAt as any instanceof Date) ?
+                    (endingAt as any).toISOString() :
+                    endingAt;
+            }
+
+            if (beneficiaryKind !== undefined) {
+                localVarQueryParameter['beneficiaryKind'] = beneficiaryKind;
+            }
+
+            if (beneficiaryValues) {
+                localVarQueryParameter['beneficiaryValues'] = beneficiaryValues;
+            }
+
+            if (tagKey !== undefined) {
+                localVarQueryParameter['tagKey'] = tagKey;
+            }
+
+            if (tagValue !== undefined) {
+                localVarQueryParameter['tagValue'] = tagValue;
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * List custom deal restrictions
          * @summary List custom deal restrictions
@@ -6009,6 +6129,22 @@ export const CustomDealsApiFp = function(configuration?: Configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.createCustomDealRestrictions(customDealRestriction, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Get custom deal min target value
+         * @summary Get custom deal min target value
+         * @param {string} startingAt start at
+         * @param {string} endingAt end at
+         * @param {BeneficiaryKind} beneficiaryKind beneficiary kind
+         * @param {Array<string>} beneficiaryValues beneficiary values
+         * @param {string} tagKey tag key
+         * @param {string} tagValue tag value
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getCustomDealMinTargetValue(startingAt: string, endingAt: string, beneficiaryKind: BeneficiaryKind, beneficiaryValues: Array<string>, tagKey: string, tagValue: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomDealMinTargetValueResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getCustomDealMinTargetValue(startingAt, endingAt, beneficiaryKind, beneficiaryValues, tagKey, tagValue, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * List custom deal restrictions
          * @summary List custom deal restrictions
@@ -6039,6 +6175,21 @@ export const CustomDealsApiFactory = function (configuration?: Configuration, ba
         createCustomDealRestrictions(customDealRestriction: CustomDealRestriction, options?: any): AxiosPromise<void> {
             return localVarFp.createCustomDealRestrictions(customDealRestriction, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Get custom deal min target value
+         * @summary Get custom deal min target value
+         * @param {string} startingAt start at
+         * @param {string} endingAt end at
+         * @param {BeneficiaryKind} beneficiaryKind beneficiary kind
+         * @param {Array<string>} beneficiaryValues beneficiary values
+         * @param {string} tagKey tag key
+         * @param {string} tagValue tag value
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getCustomDealMinTargetValue(startingAt: string, endingAt: string, beneficiaryKind: BeneficiaryKind, beneficiaryValues: Array<string>, tagKey: string, tagValue: string, options?: any): AxiosPromise<CustomDealMinTargetValueResponse> {
+            return localVarFp.getCustomDealMinTargetValue(startingAt, endingAt, beneficiaryKind, beneficiaryValues, tagKey, tagValue, options).then((request) => request(axios, basePath));
+        },
         /**
          * List custom deal restrictions
          * @summary List custom deal restrictions
@@ -6070,6 +6221,23 @@ export class CustomDealsApi extends BaseAPI {
         return CustomDealsApiFp(this.configuration).createCustomDealRestrictions(customDealRestriction, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Get custom deal min target value
+     * @summary Get custom deal min target value
+     * @param {string} startingAt start at
+     * @param {string} endingAt end at
+     * @param {BeneficiaryKind} beneficiaryKind beneficiary kind
+     * @param {Array<string>} beneficiaryValues beneficiary values
+     * @param {string} tagKey tag key
+     * @param {string} tagValue tag value
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomDealsApi
+     */
+    public getCustomDealMinTargetValue(startingAt: string, endingAt: string, beneficiaryKind: BeneficiaryKind, beneficiaryValues: Array<string>, tagKey: string, tagValue: string, options?: AxiosRequestConfig) {
+        return CustomDealsApiFp(this.configuration).getCustomDealMinTargetValue(startingAt, endingAt, beneficiaryKind, beneficiaryValues, tagKey, tagValue, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * List custom deal restrictions
      * @summary List custom deal restrictions
@@ -6919,6 +7087,44 @@ export class NotificationApi extends BaseAPI {
  */
 export const OrderApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
+        /**
+         * Create a product order. If successful the value of the product will be deducted from the used balance.
+         * @summary Create an order for a product
+         * @param {AdminOrderCreationRequest} [adminOrderCreationRequest] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createAdminOrder: async (adminOrderCreationRequest?: AdminOrderCreationRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/admins/orders`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication systemJWT required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(adminOrderCreationRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Create a product order. If successful the value of the product will be deducted from the used balance.
          * @summary Create an order for a product
@@ -7044,10 +7250,12 @@ export const OrderApiAxiosParamCreator = function (configuration?: Configuration
          * @param {string} [createdBefore] Filter orders created before the specified date
          * @param {Array<string>} [userIDs] Filter by user ids
          * @param {Array<string>} [clientIDs] Filter by client ids
+         * @param {OrderKind} [kind] Filter by kind
+         * @param {string} [source] Filter by order source. Either promotion or user reference, depending on the kind.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listOrders: async (paginationToken?: string, search?: string, productId?: string, balanceIDs?: Array<string>, createdAfter?: string, createdBefore?: string, userIDs?: Array<string>, clientIDs?: Array<string>, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+        listOrders: async (paginationToken?: string, search?: string, productId?: string, balanceIDs?: Array<string>, createdAfter?: string, createdBefore?: string, userIDs?: Array<string>, clientIDs?: Array<string>, kind?: OrderKind, source?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
             const localVarPath = `/admins/orders`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -7100,6 +7308,14 @@ export const OrderApiAxiosParamCreator = function (configuration?: Configuration
                 localVarQueryParameter['clientIDs'] = clientIDs;
             }
 
+            if (kind !== undefined) {
+                localVarQueryParameter['kind'] = kind;
+            }
+
+            if (source !== undefined) {
+                localVarQueryParameter['source'] = source;
+            }
+
 
     
             setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -7194,6 +7410,17 @@ export const OrderApiAxiosParamCreator = function (configuration?: Configuration
 export const OrderApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = OrderApiAxiosParamCreator(configuration)
     return {
+        /**
+         * Create a product order. If successful the value of the product will be deducted from the used balance.
+         * @summary Create an order for a product
+         * @param {AdminOrderCreationRequest} [adminOrderCreationRequest] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async createAdminOrder(adminOrderCreationRequest?: AdminOrderCreationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.createAdminOrder(adminOrderCreationRequest, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * Create a product order. If successful the value of the product will be deducted from the used balance.
          * @summary Create an order for a product
@@ -7238,11 +7465,13 @@ export const OrderApiFp = function(configuration?: Configuration) {
          * @param {string} [createdBefore] Filter orders created before the specified date
          * @param {Array<string>} [userIDs] Filter by user ids
          * @param {Array<string>} [clientIDs] Filter by client ids
+         * @param {OrderKind} [kind] Filter by kind
+         * @param {string} [source] Filter by order source. Either promotion or user reference, depending on the kind.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async listOrders(paginationToken?: string, search?: string, productId?: string, balanceIDs?: Array<string>, createdAfter?: string, createdBefore?: string, userIDs?: Array<string>, clientIDs?: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderListResponse>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.listOrders(paginationToken, search, productId, balanceIDs, createdAfter, createdBefore, userIDs, clientIDs, options);
+        async listOrders(paginationToken?: string, search?: string, productId?: string, balanceIDs?: Array<string>, createdAfter?: string, createdBefore?: string, userIDs?: Array<string>, clientIDs?: Array<string>, kind?: OrderKind, source?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderListResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listOrders(paginationToken, search, productId, balanceIDs, createdAfter, createdBefore, userIDs, clientIDs, kind, source, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
@@ -7272,6 +7501,16 @@ export const OrderApiFp = function(configuration?: Configuration) {
 export const OrderApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
     const localVarFp = OrderApiFp(configuration)
     return {
+        /**
+         * Create a product order. If successful the value of the product will be deducted from the used balance.
+         * @summary Create an order for a product
+         * @param {AdminOrderCreationRequest} [adminOrderCreationRequest] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createAdminOrder(adminOrderCreationRequest?: AdminOrderCreationRequest, options?: any): AxiosPromise<Order> {
+            return localVarFp.createAdminOrder(adminOrderCreationRequest, options).then((request) => request(axios, basePath));
+        },
         /**
          * Create a product order. If successful the value of the product will be deducted from the used balance.
          * @summary Create an order for a product
@@ -7313,11 +7552,13 @@ export const OrderApiFactory = function (configuration?: Configuration, basePath
          * @param {string} [createdBefore] Filter orders created before the specified date
          * @param {Array<string>} [userIDs] Filter by user ids
          * @param {Array<string>} [clientIDs] Filter by client ids
+         * @param {OrderKind} [kind] Filter by kind
+         * @param {string} [source] Filter by order source. Either promotion or user reference, depending on the kind.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listOrders(paginationToken?: string, search?: string, productId?: string, balanceIDs?: Array<string>, createdAfter?: string, createdBefore?: string, userIDs?: Array<string>, clientIDs?: Array<string>, options?: any): AxiosPromise<OrderListResponse> {
-            return localVarFp.listOrders(paginationToken, search, productId, balanceIDs, createdAfter, createdBefore, userIDs, clientIDs, options).then((request) => request(axios, basePath));
+        listOrders(paginationToken?: string, search?: string, productId?: string, balanceIDs?: Array<string>, createdAfter?: string, createdBefore?: string, userIDs?: Array<string>, clientIDs?: Array<string>, kind?: OrderKind, source?: string, options?: any): AxiosPromise<OrderListResponse> {
+            return localVarFp.listOrders(paginationToken, search, productId, balanceIDs, createdAfter, createdBefore, userIDs, clientIDs, kind, source, options).then((request) => request(axios, basePath));
         },
         /**
          * List existing orders
@@ -7345,6 +7586,18 @@ export const OrderApiFactory = function (configuration?: Configuration, basePath
  * @extends {BaseAPI}
  */
 export class OrderApi extends BaseAPI {
+    /**
+     * Create a product order. If successful the value of the product will be deducted from the used balance.
+     * @summary Create an order for a product
+     * @param {AdminOrderCreationRequest} [adminOrderCreationRequest] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderApi
+     */
+    public createAdminOrder(adminOrderCreationRequest?: AdminOrderCreationRequest, options?: AxiosRequestConfig) {
+        return OrderApiFp(this.configuration).createAdminOrder(adminOrderCreationRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Create a product order. If successful the value of the product will be deducted from the used balance.
      * @summary Create an order for a product
@@ -7392,12 +7645,14 @@ export class OrderApi extends BaseAPI {
      * @param {string} [createdBefore] Filter orders created before the specified date
      * @param {Array<string>} [userIDs] Filter by user ids
      * @param {Array<string>} [clientIDs] Filter by client ids
+     * @param {OrderKind} [kind] Filter by kind
+     * @param {string} [source] Filter by order source. Either promotion or user reference, depending on the kind.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof OrderApi
      */
-    public listOrders(paginationToken?: string, search?: string, productId?: string, balanceIDs?: Array<string>, createdAfter?: string, createdBefore?: string, userIDs?: Array<string>, clientIDs?: Array<string>, options?: AxiosRequestConfig) {
-        return OrderApiFp(this.configuration).listOrders(paginationToken, search, productId, balanceIDs, createdAfter, createdBefore, userIDs, clientIDs, options).then((request) => request(this.axios, this.basePath));
+    public listOrders(paginationToken?: string, search?: string, productId?: string, balanceIDs?: Array<string>, createdAfter?: string, createdBefore?: string, userIDs?: Array<string>, clientIDs?: Array<string>, kind?: OrderKind, source?: string, options?: AxiosRequestConfig) {
+        return OrderApiFp(this.configuration).listOrders(paginationToken, search, productId, balanceIDs, createdAfter, createdBefore, userIDs, clientIDs, kind, source, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**