flexinet-api 0.0.1236-prerelease0 → 0.0.1264-prerelease0

package/dist/esm/api.d.ts

@@ -13,6 +13,25 @@ import type { Configuration } from './configuration';
 import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
 import type { RequestArgs } from './base';
 import { BaseAPI } from './base';
+/**
+ *
+ * @export
+ * @interface AdminOrderCreationRequest
+ */
+export interface AdminOrderCreationRequest {
+    /**
+     *
+     * @type {Array<OrderItemCreationRequest>}
+     * @memberof AdminOrderCreationRequest
+     */
+    'items': Array<OrderItemCreationRequest>;
+    /**
+     *
+     * @type {Beneficiary}
+     * @memberof AdminOrderCreationRequest
+     */
+    'beneficiary'?: Beneficiary;
+}
 /**
  *
  * @export
@@ -211,7 +230,7 @@ export interface BalanceUpdateRequest {
      * @type {TransactionKind}
      * @memberof BalanceUpdateRequest
      */
-    'transactionKind'?: TransactionKind;
+    'transactionKind': TransactionKind;
     /**
      *
      * @type {TransactionCurrencyKind}
@@ -668,54 +687,14 @@ export declare const Condition: {
 };
 export type Condition = typeof Condition[keyof typeof Condition];
 /**
- *
+ * @type CustomDealRestriction
  * @export
- * @interface CustomDealRestriction
  */
-export interface CustomDealRestriction {
-    /**
-     *
-     * @type {string}
-     * @memberof CustomDealRestriction
-     */
-    'tagKey': string;
-    /**
-     *
-     * @type {string}
-     * @memberof CustomDealRestriction
-     */
-    'tagValue': string;
-    /**
-     *
-     * @type {number}
-     * @memberof CustomDealRestriction
-     */
-    'minTurnoverPercent': number;
-    /**
-     *
-     * @type {CustomDealRestrictionPriority}
-     * @memberof CustomDealRestriction
-     */
-    'priority': CustomDealRestrictionPriority;
-    /**
-     *
-     * @type {number}
-     * @memberof CustomDealRestriction
-     */
-    'points': number;
-    /**
-     *
-     * @type {string}
-     * @memberof CustomDealRestriction
-     */
-    'createdAt': string;
-    /**
-     *
-     * @type {string}
-     * @memberof CustomDealRestriction
-     */
-    'updatedAt': string;
-}
+export type CustomDealRestriction = {
+    kind: 'minTurnover';
+} & MinTurnoverRestriction | {
+    kind: 'required';
+} & RequiredRestriction;
 /**
  *
  * @export
@@ -727,43 +706,6 @@ export declare const CustomDealRestrictionPriority: {
     readonly High: "high";
 };
 export type CustomDealRestrictionPriority = typeof CustomDealRestrictionPriority[keyof typeof CustomDealRestrictionPriority];
-/**
- *
- * @export
- * @interface CustomDealRestrictionRequest
- */
-export interface CustomDealRestrictionRequest {
-    /**
-     *
-     * @type {string}
-     * @memberof CustomDealRestrictionRequest
-     */
-    'tagKey': string;
-    /**
-     *
-     * @type {string}
-     * @memberof CustomDealRestrictionRequest
-     */
-    'tagValue': string;
-    /**
-     *
-     * @type {number}
-     * @memberof CustomDealRestrictionRequest
-     */
-    'minTurnoverPercent': number;
-    /**
-     *
-     * @type {CustomDealRestrictionPriority}
-     * @memberof CustomDealRestrictionRequest
-     */
-    'priority': CustomDealRestrictionPriority;
-    /**
-     *
-     * @type {number}
-     * @memberof CustomDealRestrictionRequest
-     */
-    'points': number;
-}
 /**
  *
  * @export
@@ -972,6 +914,66 @@ export interface MetricsCollection {
      */
     'total': Metrics;
 }
+/**
+ *
+ * @export
+ * @interface MinTurnoverRestriction
+ */
+export interface MinTurnoverRestriction {
+    /**
+     *
+     * @type {string}
+     * @memberof MinTurnoverRestriction
+     */
+    'kind': MinTurnoverRestrictionKindEnum;
+    /**
+     *
+     * @type {Array<MinTurnoverRestrictionValue>}
+     * @memberof MinTurnoverRestriction
+     */
+    'values': Array<MinTurnoverRestrictionValue>;
+}
+export declare const MinTurnoverRestrictionKindEnum: {
+    readonly MinTurnover: "minTurnover";
+};
+export type MinTurnoverRestrictionKindEnum = typeof MinTurnoverRestrictionKindEnum[keyof typeof MinTurnoverRestrictionKindEnum];
+/**
+ *
+ * @export
+ * @interface MinTurnoverRestrictionValue
+ */
+export interface MinTurnoverRestrictionValue {
+    /**
+     *
+     * @type {string}
+     * @memberof MinTurnoverRestrictionValue
+     */
+    'tagKey': string;
+    /**
+     *
+     * @type {string}
+     * @memberof MinTurnoverRestrictionValue
+     */
+    'tagValue': string;
+    /**
+     *
+     * @type {number}
+     * @memberof MinTurnoverRestrictionValue
+     */
+    'minTurnoverPercent': number;
+    /**
+     *
+     * @type {CustomDealRestrictionPriority}
+     * @memberof MinTurnoverRestrictionValue
+     */
+    'priority': CustomDealRestrictionPriority;
+    /**
+     *
+     * @type {number}
+     * @memberof MinTurnoverRestrictionValue
+     */
+    'points': number;
+}
 /**
  *
  * @export
@@ -1222,6 +1224,12 @@ export interface Order {
      * @memberof Order
      */
     'status'?: OrderStatus;
+    /**
+     *
+     * @type {string}
+     * @memberof Order
+     */
+    'clientID'?: string;
 }
 /**
  *
@@ -1269,6 +1277,7 @@ export interface OrderItemCreationRequest {
 export declare const OrderKind: {
     readonly Webshop: "webshop";
     readonly Promotions: "promotions";
+    readonly SalesBudget: "sales_budget";
 };
 export type OrderKind = typeof OrderKind[keyof typeof OrderKind];
 /**
@@ -2158,6 +2167,12 @@ export interface Promotion {
      * @memberof Promotion
      */
     'status'?: PromotionStatus;
+    /**
+     *
+     * @type {string}
+     * @memberof Promotion
+     */
+    'reference'?: string;
 }
 /**
  * @type PromotionBeneficiariesResponse
@@ -2372,6 +2387,18 @@ export interface PromotionRequest {
      * @memberof PromotionRequest
      */
     'notificationConfig'?: PromotionNotificationConfig;
+    /**
+     *
+     * @type {PromotionType}
+     * @memberof PromotionRequest
+     */
+    'type'?: PromotionType;
+    /**
+     *
+     * @type {string}
+     * @memberof PromotionRequest
+     */
+    'reference'?: string;
 }
 /**
  *
@@ -2546,6 +2573,29 @@ export declare const ReportTypesResponseTypesEnum: {
     readonly PromotionExpanded: "promotion_expanded";
 };
 export type ReportTypesResponseTypesEnum = typeof ReportTypesResponseTypesEnum[keyof typeof ReportTypesResponseTypesEnum];
+/**
+ *
+ * @export
+ * @interface RequiredRestriction
+ */
+export interface RequiredRestriction {
+    /**
+     *
+     * @type {string}
+     * @memberof RequiredRestriction
+     */
+    'kind': RequiredRestrictionKindEnum;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof RequiredRestriction
+     */
+    'tagKeys': Array<string>;
+}
+export declare const RequiredRestrictionKindEnum: {
+    readonly Required: "required";
+};
+export type RequiredRestrictionKindEnum = typeof RequiredRestrictionKindEnum[keyof typeof RequiredRestrictionKindEnum];
 /**
  * @type Rule
  * @export
@@ -3470,13 +3520,14 @@ export declare const TransactionSource: {
     readonly Manual: "manual";
     readonly Expiry: "expiry";
     readonly Transfer: "transfer";
+    readonly SalesBudget: "sales_budget";
 };
 export type TransactionSource = typeof TransactionSource[keyof typeof TransactionSource];
 /**
  * @type TransactionSourceReference
  * @export
  */
-export type TransactionSourceReference = BalanceWithBeneficiaryRef | Order | PeriodPromotion | User;
+export type TransactionSourceReference = BalanceWithBeneficiaryRef | PeriodPromotion | User | UserOrder;
 /**
  *
  * @export
@@ -3612,6 +3663,12 @@ export interface UpdatePromotionRequest {
      * @memberof UpdatePromotionRequest
      */
     'notificationConfig'?: PromotionNotificationConfig;
+    /**
+     *
+     * @type {string}
+     * @memberof UpdatePromotionRequest
+     */
+    'reference'?: string;
 }
 /**
  *
@@ -3827,7 +3884,7 @@ export interface UserOrder {
      * @type {string}
      * @memberof UserOrder
      */
-    'source'?: string;
+    'source': string;
     /**
      *
      * @type {string}
@@ -3836,10 +3893,10 @@ export interface UserOrder {
     'userID'?: string;
     /**
      *
-     * @type {OrderStatus}
+     * @type {string}
      * @memberof UserOrder
      */
-    'status'?: OrderStatus;
+    'clientID': string;
 }
 /**
  *
@@ -4893,11 +4950,11 @@ export declare const CustomDealsApiAxiosParamCreator: (configuration?: Configura
     /**
      * Create custom deal restrictions
      * @summary Create custom deal restrictions
-     * @param {CustomDealRestrictionRequest} customDealRestrictionRequest Custom deal restrictions
+     * @param {CustomDealRestriction} customDealRestriction Custom deal restrictions
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createCustomDealRestrictions: (customDealRestrictionRequest: CustomDealRestrictionRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    createCustomDealRestrictions: (customDealRestriction: CustomDealRestriction, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * List custom deal restrictions
      * @summary List custom deal restrictions
@@ -4914,11 +4971,11 @@ export declare const CustomDealsApiFp: (configuration?: Configuration) => {
     /**
      * Create custom deal restrictions
      * @summary Create custom deal restrictions
-     * @param {CustomDealRestrictionRequest} customDealRestrictionRequest Custom deal restrictions
+     * @param {CustomDealRestriction} customDealRestriction Custom deal restrictions
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createCustomDealRestrictions(customDealRestrictionRequest: CustomDealRestrictionRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    createCustomDealRestrictions(customDealRestriction: CustomDealRestriction, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * List custom deal restrictions
      * @summary List custom deal restrictions
@@ -4935,11 +4992,11 @@ export declare const CustomDealsApiFactory: (configuration?: Configuration, base
     /**
      * Create custom deal restrictions
      * @summary Create custom deal restrictions
-     * @param {CustomDealRestrictionRequest} customDealRestrictionRequest Custom deal restrictions
+     * @param {CustomDealRestriction} customDealRestriction Custom deal restrictions
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createCustomDealRestrictions(customDealRestrictionRequest: CustomDealRestrictionRequest, options?: any): AxiosPromise<void>;
+    createCustomDealRestrictions(customDealRestriction: CustomDealRestriction, options?: any): AxiosPromise<void>;
     /**
      * List custom deal restrictions
      * @summary List custom deal restrictions
@@ -4958,12 +5015,12 @@ export declare class CustomDealsApi extends BaseAPI {
     /**
      * Create custom deal restrictions
      * @summary Create custom deal restrictions
-     * @param {CustomDealRestrictionRequest} customDealRestrictionRequest Custom deal restrictions
+     * @param {CustomDealRestriction} customDealRestriction Custom deal restrictions
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof CustomDealsApi
      */
-    createCustomDealRestrictions(customDealRestrictionRequest: CustomDealRestrictionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    createCustomDealRestrictions(customDealRestriction: CustomDealRestriction, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      * List custom deal restrictions
      * @summary List custom deal restrictions
@@ -5382,6 +5439,14 @@ export declare class NotificationApi extends BaseAPI {
  * @export
  */
 export declare const OrderApiAxiosParamCreator: (configuration?: 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
+     * @param {AdminOrderCreationRequest} [adminOrderCreationRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createAdminOrder: (adminOrderCreationRequest?: AdminOrderCreationRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * 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
@@ -5417,10 +5482,12 @@ export declare const OrderApiAxiosParamCreator: (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: (paginationToken?: string, search?: string, productId?: string, balanceIDs?: Array<string>, createdAfter?: string, createdBefore?: string, userIDs?: Array<string>, clientIDs?: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    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<RequestArgs>;
     /**
      * List existing orders
      * @summary List existing orders
@@ -5441,6 +5508,14 @@ export declare const OrderApiAxiosParamCreator: (configuration?: Configuration)
  * @export
  */
 export declare const OrderApiFp: (configuration?: 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
+     * @param {AdminOrderCreationRequest} [adminOrderCreationRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createAdminOrder(adminOrderCreationRequest?: AdminOrderCreationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
     /**
      * 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
@@ -5476,10 +5551,12 @@ export declare const OrderApiFp: (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(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>>;
+    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>>;
     /**
      * List existing orders
      * @summary List existing orders
@@ -5500,6 +5577,14 @@ export declare const OrderApiFp: (configuration?: Configuration) => {
  * @export
  */
 export declare const OrderApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * 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>;
     /**
      * 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
@@ -5535,10 +5620,12 @@ export declare const OrderApiFactory: (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>;
+    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>;
     /**
      * List existing orders
      * @summary List existing orders
@@ -5561,6 +5648,15 @@ export declare const OrderApiFactory: (configuration?: Configuration, basePath?:
  * @extends {BaseAPI}
  */
 export declare 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
+     */
+    createAdminOrder(adminOrderCreationRequest?: AdminOrderCreationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
     /**
      * 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
@@ -5599,11 +5695,13 @@ export declare 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
      */
-    listOrders(paginationToken?: string, search?: string, productId?: string, balanceIDs?: Array<string>, createdAfter?: string, createdBefore?: string, userIDs?: Array<string>, clientIDs?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderListResponse, any>>;
+    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<import("axios").AxiosResponse<OrderListResponse, any>>;
     /**
      * List existing orders
      * @summary List existing orders