flexinet-api 0.0.1882-prerelease0-dev → 0.0.1882

package/dist/api.d.ts

@@ -268,6 +268,12 @@ export interface BalanceBulkUpdateRequest {
      * @memberof BalanceBulkUpdateRequest
      */
     'currency'?: TransactionCurrencyKind;
+    /**
+     *
+     * @type {string}
+     * @memberof BalanceBulkUpdateRequest
+     */
+    'description'?: string;
 }
 /**
  *
@@ -299,6 +305,12 @@ export interface BalanceUpdateRequest {
      * @memberof BalanceUpdateRequest
      */
     'currency'?: TransactionCurrencyKind;
+    /**
+     *
+     * @type {string}
+     * @memberof BalanceUpdateRequest
+     */
+    'description'?: string;
 }
 /**
  *
@@ -843,7 +855,9 @@ export interface CustomDealMinTargetValueResponse {
  */
 export type CustomDealRestriction = {
     kind: 'minTurnover';
-} & MinTurnoverRestriction;
+} & MinTurnoverRestriction | {
+    kind: 'required';
+} & RequiredRestriction;
 /**
  *
  * @export
@@ -1073,43 +1087,6 @@ export interface MetricsCollection {
      */
     'total': Metrics;
 }
-/**
- *
- * @export
- * @interface MinTargetValue
- */
-export interface MinTargetValue {
-    /**
-     *
-     * @type {string}
-     * @memberof MinTargetValue
-     */
-    'startingAt': string;
-    /**
-     *
-     * @type {string}
-     * @memberof MinTargetValue
-     */
-    'endingAt': string;
-    /**
-     *
-     * @type {BeneficiaryKind}
-     * @memberof MinTargetValue
-     */
-    'beneficiaryKind': BeneficiaryKind;
-    /**
-     *
-     * @type {Array<string>}
-     * @memberof MinTargetValue
-     */
-    'beneficiaryValues': Array<string>;
-    /**
-     *
-     * @type {Array<Rule>}
-     * @memberof MinTargetValue
-     */
-    'rules': Array<Rule>;
-}
 /**
  *
  * @export
@@ -1141,10 +1118,16 @@ export type MinTurnoverRestrictionKindEnum = typeof MinTurnoverRestrictionKindEn
 export interface MinTurnoverRestrictionValue {
     /**
      *
-     * @type {Array<Rule>}
+     * @type {string}
      * @memberof MinTurnoverRestrictionValue
      */
-    'rules': Array<Rule>;
+    'tagKey': string;
+    /**
+     *
+     * @type {string}
+     * @memberof MinTurnoverRestrictionValue
+     */
+    'tagValue': string;
     /**
      *
      * @type {string}
@@ -1159,10 +1142,10 @@ export interface MinTurnoverRestrictionValue {
     'priority': CustomDealRestrictionPriority;
     /**
      *
-     * @type {string}
+     * @type {number}
      * @memberof MinTurnoverRestrictionValue
      */
-    'pointsPercent': string;
+    'points': number;
 }
 /**
  *
@@ -1402,6 +1385,12 @@ export interface Order {
      * @memberof Order
      */
     'source'?: string;
+    /**
+     *
+     * @type {OrderSourceReference}
+     * @memberof Order
+     */
+    'sourceReference'?: OrderSourceReference;
     /**
      *
      * @type {string}
@@ -1489,6 +1478,11 @@ export interface OrderListResponse {
      */
     'nextToken'?: string;
 }
+/**
+ * @type OrderSourceReference
+ * @export
+ */
+export type OrderSourceReference = PeriodPromotion | User;
 /**
  *
  * @export
@@ -1498,7 +1492,6 @@ export declare const OrderStatus: {
     readonly Pending: "pending";
     readonly Completed: "completed";
     readonly Cancelled: "cancelled";
-    readonly Unknown: "unknown";
 };
 export type OrderStatus = typeof OrderStatus[keyof typeof OrderStatus];
 /**
@@ -2770,6 +2763,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
@@ -3573,6 +3589,12 @@ export interface Transaction {
      * @memberof Transaction
      */
     'currency': TransactionCurrencyKind;
+    /**
+     *
+     * @type {string}
+     * @memberof Transaction
+     */
+    'description'?: string;
 }
 /**
  *
@@ -4086,7 +4108,7 @@ export interface UserOrder {
      * @type {string}
      * @memberof UserOrder
      */
-    'clientID': string;
+    'clientID'?: string;
     /**
      *
      * @type {OrderStatus}
@@ -5346,11 +5368,16 @@ export declare const CustomDealsApiAxiosParamCreator: (configuration?: Configura
     /**
      * Get custom deal min target value
      * @summary Get custom deal min target value
-     * @param {MinTargetValue} minTargetValue
+     * @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: (minTargetValue: MinTargetValue, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getCustomDealMinTargetValue: (startingAt: string, endingAt: string, beneficiaryKind: BeneficiaryKind, beneficiaryValues: Array<string>, tagKey: string, tagValue: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * List custom deal restrictions
      * @summary List custom deal restrictions
@@ -5375,11 +5402,16 @@ export declare const CustomDealsApiFp: (configuration?: Configuration) => {
     /**
      * Get custom deal min target value
      * @summary Get custom deal min target value
-     * @param {MinTargetValue} minTargetValue
+     * @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(minTargetValue: MinTargetValue, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomDealMinTargetValueResponse>>;
+    getCustomDealMinTargetValue(startingAt: string, endingAt: string, beneficiaryKind: BeneficiaryKind, beneficiaryValues: Array<string>, tagKey: string, tagValue: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomDealMinTargetValueResponse>>;
     /**
      * List custom deal restrictions
      * @summary List custom deal restrictions
@@ -5404,11 +5436,16 @@ export declare const CustomDealsApiFactory: (configuration?: Configuration, base
     /**
      * Get custom deal min target value
      * @summary Get custom deal min target value
-     * @param {MinTargetValue} minTargetValue
+     * @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(minTargetValue: MinTargetValue, options?: any): AxiosPromise<CustomDealMinTargetValueResponse>;
+    getCustomDealMinTargetValue(startingAt: string, endingAt: string, beneficiaryKind: BeneficiaryKind, beneficiaryValues: Array<string>, tagKey: string, tagValue: string, options?: any): AxiosPromise<CustomDealMinTargetValueResponse>;
     /**
      * List custom deal restrictions
      * @summary List custom deal restrictions
@@ -5436,12 +5473,17 @@ export declare class CustomDealsApi extends BaseAPI {
     /**
      * Get custom deal min target value
      * @summary Get custom deal min target value
-     * @param {MinTargetValue} minTargetValue
+     * @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
      */
-    getCustomDealMinTargetValue(minTargetValue: MinTargetValue, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CustomDealMinTargetValueResponse, any>>;
+    getCustomDealMinTargetValue(startingAt: string, endingAt: string, beneficiaryKind: BeneficiaryKind, beneficiaryValues: Array<string>, tagKey: string, tagValue: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CustomDealMinTargetValueResponse, any>>;
     /**
      * List custom deal restrictions
      * @summary List custom deal restrictions
@@ -6921,10 +6963,11 @@ export declare const PromotionApiAxiosParamCreator: (configuration?: Configurati
      * @param {PromotionSortByField} [sortBy] sort by field
      * @param {SortDirection} [sortDirection] sort direction
      * @param {boolean} [onlyClaimable] only claimable promotions
+     * @param {Array<string>} [iDs] IDs to filter by
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listPromotions: (nextToken?: string, tags?: string, segmentId?: string, ownerID?: string, type?: PromotionType, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, clientIDs?: Array<string>, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, onlyClaimable?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    listPromotions: (nextToken?: string, tags?: string, segmentId?: string, ownerID?: string, type?: PromotionType, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, clientIDs?: Array<string>, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, onlyClaimable?: boolean, iDs?: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * List users promotions
      * @summary List promotions
@@ -6939,10 +6982,11 @@ export declare const PromotionApiAxiosParamCreator: (configuration?: Configurati
      * @param {SortDirection} [sortDirection] sort direction
      * @param {boolean} [onlyClaimable] only claimable promotions
      * @param {PromotionType} [type] promotion type
+     * @param {Array<string>} [iDs] IDs to filter by
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listUserPromotions: (nextToken?: string, tags?: string, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, onlyClaimable?: boolean, type?: PromotionType, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    listUserPromotions: (nextToken?: string, tags?: string, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, onlyClaimable?: boolean, type?: PromotionType, iDs?: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Update promotion by id
      * @summary Update promotion
@@ -7063,10 +7107,11 @@ export declare const PromotionApiFp: (configuration?: Configuration) => {
      * @param {PromotionSortByField} [sortBy] sort by field
      * @param {SortDirection} [sortDirection] sort direction
      * @param {boolean} [onlyClaimable] only claimable promotions
+     * @param {Array<string>} [iDs] IDs to filter by
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listPromotions(nextToken?: string, tags?: string, segmentId?: string, ownerID?: string, type?: PromotionType, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, clientIDs?: Array<string>, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, onlyClaimable?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PromotionsResponse>>;
+    listPromotions(nextToken?: string, tags?: string, segmentId?: string, ownerID?: string, type?: PromotionType, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, clientIDs?: Array<string>, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, onlyClaimable?: boolean, iDs?: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PromotionsResponse>>;
     /**
      * List users promotions
      * @summary List promotions
@@ -7081,10 +7126,11 @@ export declare const PromotionApiFp: (configuration?: Configuration) => {
      * @param {SortDirection} [sortDirection] sort direction
      * @param {boolean} [onlyClaimable] only claimable promotions
      * @param {PromotionType} [type] promotion type
+     * @param {Array<string>} [iDs] IDs to filter by
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listUserPromotions(nextToken?: string, tags?: string, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, onlyClaimable?: boolean, type?: PromotionType, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserPromotionsResponse>>;
+    listUserPromotions(nextToken?: string, tags?: string, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, onlyClaimable?: boolean, type?: PromotionType, iDs?: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserPromotionsResponse>>;
     /**
      * Update promotion by id
      * @summary Update promotion
@@ -7205,10 +7251,11 @@ export declare const PromotionApiFactory: (configuration?: Configuration, basePa
      * @param {PromotionSortByField} [sortBy] sort by field
      * @param {SortDirection} [sortDirection] sort direction
      * @param {boolean} [onlyClaimable] only claimable promotions
+     * @param {Array<string>} [iDs] IDs to filter by
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listPromotions(nextToken?: string, tags?: string, segmentId?: string, ownerID?: string, type?: PromotionType, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, clientIDs?: Array<string>, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, onlyClaimable?: boolean, options?: any): AxiosPromise<PromotionsResponse>;
+    listPromotions(nextToken?: string, tags?: string, segmentId?: string, ownerID?: string, type?: PromotionType, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, clientIDs?: Array<string>, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, onlyClaimable?: boolean, iDs?: Array<string>, options?: any): AxiosPromise<PromotionsResponse>;
     /**
      * List users promotions
      * @summary List promotions
@@ -7223,10 +7270,11 @@ export declare const PromotionApiFactory: (configuration?: Configuration, basePa
      * @param {SortDirection} [sortDirection] sort direction
      * @param {boolean} [onlyClaimable] only claimable promotions
      * @param {PromotionType} [type] promotion type
+     * @param {Array<string>} [iDs] IDs to filter by
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listUserPromotions(nextToken?: string, tags?: string, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, onlyClaimable?: boolean, type?: PromotionType, options?: any): AxiosPromise<UserPromotionsResponse>;
+    listUserPromotions(nextToken?: string, tags?: string, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, onlyClaimable?: boolean, type?: PromotionType, iDs?: Array<string>, options?: any): AxiosPromise<UserPromotionsResponse>;
     /**
      * Update promotion by id
      * @summary Update promotion
@@ -7359,11 +7407,12 @@ export declare class PromotionApi extends BaseAPI {
      * @param {PromotionSortByField} [sortBy] sort by field
      * @param {SortDirection} [sortDirection] sort direction
      * @param {boolean} [onlyClaimable] only claimable promotions
+     * @param {Array<string>} [iDs] IDs to filter by
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof PromotionApi
      */
-    listPromotions(nextToken?: string, tags?: string, segmentId?: string, ownerID?: string, type?: PromotionType, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, clientIDs?: Array<string>, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, onlyClaimable?: boolean, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PromotionsResponse, any>>;
+    listPromotions(nextToken?: string, tags?: string, segmentId?: string, ownerID?: string, type?: PromotionType, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, clientIDs?: Array<string>, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, onlyClaimable?: boolean, iDs?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PromotionsResponse, any>>;
     /**
      * List users promotions
      * @summary List promotions
@@ -7378,11 +7427,12 @@ export declare class PromotionApi extends BaseAPI {
      * @param {SortDirection} [sortDirection] sort direction
      * @param {boolean} [onlyClaimable] only claimable promotions
      * @param {PromotionType} [type] promotion type
+     * @param {Array<string>} [iDs] IDs to filter by
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof PromotionApi
      */
-    listUserPromotions(nextToken?: string, tags?: string, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, onlyClaimable?: boolean, type?: PromotionType, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UserPromotionsResponse, any>>;
+    listUserPromotions(nextToken?: string, tags?: string, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, onlyClaimable?: boolean, type?: PromotionType, iDs?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UserPromotionsResponse, any>>;
     /**
      * Update promotion by id
      * @summary Update promotion