@teemill/platform 0.28.0 → 0.29.2

package/dist/api.d.ts

@@ -2,7 +2,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.28.0
+ * The version of the OpenAPI document: 0.29.2
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1751,6 +1751,12 @@ export interface Statistics {
      * @memberof Statistics
      */
     'lastPurchased': string | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Statistics
+     */
+    'usedDiscount': boolean;
 }
 /**
  *
@@ -1943,18 +1949,24 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
      * @summary Export customers
      * @param {string} project Project unique identifier
      * @param {string} platformId The platform identifier
+     * @param {Array<ExportCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
      * @param {Array<string>} [countries] Filter customers by country code
+     * @param {Array<string>} [projects] Filter customers by project. In the absence of this field, all projects will be included in the export.
      * @param {ExportCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
-     * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
-     * @param {number} [refundedOrderCount] Filter customers by refunded order count equal to the value provided
-     * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
-     * @param {Array<ExportCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
+     * @param {Array<number>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
+     * @param {boolean} [usedDiscount] Filter customers by whether they have used a discount
+     * @param {number} [minimumTotalOrderCount] Filter customers by total order count greater than or equal to the value provided
+     * @param {number} [maximumTotalOrderCount] Filter customers by total order count less than or equal to the value provided
+     * @param {number} [minimumRefundedOrderCount] Filter customers by refunded order count greater than or equal to the value provided
+     * @param {number} [maximumRefundedOrderCount] Filter customers by refunded order count less than or equal to the value provided
+     * @param {number} [minimumLifetimeValue] Filter customers by lifetime value greater than or equal to the value provided
+     * @param {number} [maximumLifetimeValue] Filter customers by lifetime value less than or equal to the value provided
      * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
      * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    exportCustomers: (project: string, platformId: string, countries?: Array<string>, gender?: ExportCustomersGenderEnum, totalOrderCount?: number, refundedOrderCount?: number, lifetimeValue?: number, sortBy?: Array<ExportCustomersSortByEnum>, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    exportCustomers: (project: string, platformId: string, sortBy?: Array<ExportCustomersSortByEnum>, countries?: Array<string>, projects?: Array<string>, gender?: ExportCustomersGenderEnum, productTypes?: Array<number>, usedDiscount?: boolean, minimumTotalOrderCount?: number, maximumTotalOrderCount?: number, minimumRefundedOrderCount?: number, maximumRefundedOrderCount?: number, minimumLifetimeValue?: number, maximumLifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get a customer for a platform by a given customer ID.
      * @summary Get customer
@@ -1975,16 +1987,22 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
      * @param {string} [search] Search term to filter results
      * @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
      * @param {Array<string>} [countries] Filter customers by country code
+     * @param {Array<string>} [projects] Filter customers by project. In the absence of this field, all projects will be included in the export.
      * @param {ListCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
-     * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
-     * @param {number} [refundedOrderCount] Filter customers by refunded order count equal to the value provided
-     * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
+     * @param {Array<number>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
+     * @param {boolean} [usedDiscount] Filter customers by whether they have used a discount
+     * @param {number} [minimumTotalOrderCount] Filter customers by total order count greater than or equal to the value provided
+     * @param {number} [maximumTotalOrderCount] Filter customers by total order count less than or equal to the value provided
+     * @param {number} [minimumRefundedOrderCount] Filter customers by refunded order count greater than or equal to the value provided
+     * @param {number} [maximumRefundedOrderCount] Filter customers by refunded order count less than or equal to the value provided
+     * @param {number} [minimumLifetimeValue] Filter customers by lifetime value greater than or equal to the value provided
+     * @param {number} [maximumLifetimeValue] Filter customers by lifetime value less than or equal to the value provided
      * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
      * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listCustomers: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, countries?: Array<string>, gender?: ListCustomersGenderEnum, totalOrderCount?: number, refundedOrderCount?: number, lifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    listCustomers: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, countries?: Array<string>, projects?: Array<string>, gender?: ListCustomersGenderEnum, productTypes?: Array<number>, usedDiscount?: boolean, minimumTotalOrderCount?: number, maximumTotalOrderCount?: number, minimumRefundedOrderCount?: number, maximumRefundedOrderCount?: number, minimumLifetimeValue?: number, maximumLifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * CustomersApi - functional programming interface
@@ -1996,18 +2014,24 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
      * @summary Export customers
      * @param {string} project Project unique identifier
      * @param {string} platformId The platform identifier
+     * @param {Array<ExportCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
      * @param {Array<string>} [countries] Filter customers by country code
+     * @param {Array<string>} [projects] Filter customers by project. In the absence of this field, all projects will be included in the export.
      * @param {ExportCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
-     * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
-     * @param {number} [refundedOrderCount] Filter customers by refunded order count equal to the value provided
-     * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
-     * @param {Array<ExportCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
+     * @param {Array<number>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
+     * @param {boolean} [usedDiscount] Filter customers by whether they have used a discount
+     * @param {number} [minimumTotalOrderCount] Filter customers by total order count greater than or equal to the value provided
+     * @param {number} [maximumTotalOrderCount] Filter customers by total order count less than or equal to the value provided
+     * @param {number} [minimumRefundedOrderCount] Filter customers by refunded order count greater than or equal to the value provided
+     * @param {number} [maximumRefundedOrderCount] Filter customers by refunded order count less than or equal to the value provided
+     * @param {number} [minimumLifetimeValue] Filter customers by lifetime value greater than or equal to the value provided
+     * @param {number} [maximumLifetimeValue] Filter customers by lifetime value less than or equal to the value provided
      * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
      * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    exportCustomers(project: string, platformId: string, countries?: Array<string>, gender?: ExportCustomersGenderEnum, totalOrderCount?: number, refundedOrderCount?: number, lifetimeValue?: number, sortBy?: Array<ExportCustomersSortByEnum>, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
+    exportCustomers(project: string, platformId: string, sortBy?: Array<ExportCustomersSortByEnum>, countries?: Array<string>, projects?: Array<string>, gender?: ExportCustomersGenderEnum, productTypes?: Array<number>, usedDiscount?: boolean, minimumTotalOrderCount?: number, maximumTotalOrderCount?: number, minimumRefundedOrderCount?: number, maximumRefundedOrderCount?: number, minimumLifetimeValue?: number, maximumLifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
     /**
      * Get a customer for a platform by a given customer ID.
      * @summary Get customer
@@ -2028,16 +2052,22 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
      * @param {string} [search] Search term to filter results
      * @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
      * @param {Array<string>} [countries] Filter customers by country code
+     * @param {Array<string>} [projects] Filter customers by project. In the absence of this field, all projects will be included in the export.
      * @param {ListCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
-     * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
-     * @param {number} [refundedOrderCount] Filter customers by refunded order count equal to the value provided
-     * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
+     * @param {Array<number>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
+     * @param {boolean} [usedDiscount] Filter customers by whether they have used a discount
+     * @param {number} [minimumTotalOrderCount] Filter customers by total order count greater than or equal to the value provided
+     * @param {number} [maximumTotalOrderCount] Filter customers by total order count less than or equal to the value provided
+     * @param {number} [minimumRefundedOrderCount] Filter customers by refunded order count greater than or equal to the value provided
+     * @param {number} [maximumRefundedOrderCount] Filter customers by refunded order count less than or equal to the value provided
+     * @param {number} [minimumLifetimeValue] Filter customers by lifetime value greater than or equal to the value provided
+     * @param {number} [maximumLifetimeValue] Filter customers by lifetime value less than or equal to the value provided
      * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
      * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listCustomers(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, countries?: Array<string>, gender?: ListCustomersGenderEnum, totalOrderCount?: number, refundedOrderCount?: number, lifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>>;
+    listCustomers(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, countries?: Array<string>, projects?: Array<string>, gender?: ListCustomersGenderEnum, productTypes?: Array<number>, usedDiscount?: boolean, minimumTotalOrderCount?: number, maximumTotalOrderCount?: number, minimumRefundedOrderCount?: number, maximumRefundedOrderCount?: number, minimumLifetimeValue?: number, maximumLifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>>;
 };
 /**
  * CustomersApi - factory interface
@@ -2087,12 +2117,24 @@ export interface CustomersApiExportCustomersRequest {
      * @memberof CustomersApiExportCustomers
      */
     readonly platformId: string;
+    /**
+     * An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
+     * @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+refundedOrderCount' | '-refundedOrderCount' | '+lastPurchased' | '-lastPurchased' | '+usedDiscount' | '-usedDiscount'>}
+     * @memberof CustomersApiExportCustomers
+     */
+    readonly sortBy?: Array<ExportCustomersSortByEnum>;
     /**
      * Filter customers by country code
      * @type {Array<string>}
      * @memberof CustomersApiExportCustomers
      */
     readonly countries?: Array<string>;
+    /**
+     * Filter customers by project. In the absence of this field, all projects will be included in the export.
+     * @type {Array<string>}
+     * @memberof CustomersApiExportCustomers
+     */
+    readonly projects?: Array<string>;
     /**
      * Filter customers by gender equal to the value provided
      * @type {'male' | 'female'}
@@ -2100,29 +2142,53 @@ export interface CustomersApiExportCustomersRequest {
      */
     readonly gender?: ExportCustomersGenderEnum;
     /**
-     * Filter customers by total order count equal to the value provided
+     * Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
+     * @type {Array<number>}
+     * @memberof CustomersApiExportCustomers
+     */
+    readonly productTypes?: Array<number>;
+    /**
+     * Filter customers by whether they have used a discount
+     * @type {boolean}
+     * @memberof CustomersApiExportCustomers
+     */
+    readonly usedDiscount?: boolean;
+    /**
+     * Filter customers by total order count greater than or equal to the value provided
      * @type {number}
      * @memberof CustomersApiExportCustomers
      */
-    readonly totalOrderCount?: number;
+    readonly minimumTotalOrderCount?: number;
     /**
-     * Filter customers by refunded order count equal to the value provided
+     * Filter customers by total order count less than or equal to the value provided
      * @type {number}
      * @memberof CustomersApiExportCustomers
      */
-    readonly refundedOrderCount?: number;
+    readonly maximumTotalOrderCount?: number;
     /**
-     * Filter customers by lifetime value less than or equal to the value provided
+     * Filter customers by refunded order count greater than or equal to the value provided
      * @type {number}
      * @memberof CustomersApiExportCustomers
      */
-    readonly lifetimeValue?: number;
+    readonly minimumRefundedOrderCount?: number;
     /**
-     * An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
-     * @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+refundedOrderCount' | '-refundedOrderCount' | '+lastPurchased' | '-lastPurchased'>}
+     * Filter customers by refunded order count less than or equal to the value provided
+     * @type {number}
      * @memberof CustomersApiExportCustomers
      */
-    readonly sortBy?: Array<ExportCustomersSortByEnum>;
+    readonly maximumRefundedOrderCount?: number;
+    /**
+     * Filter customers by lifetime value greater than or equal to the value provided
+     * @type {number}
+     * @memberof CustomersApiExportCustomers
+     */
+    readonly minimumLifetimeValue?: number;
+    /**
+     * Filter customers by lifetime value less than or equal to the value provided
+     * @type {number}
+     * @memberof CustomersApiExportCustomers
+     */
+    readonly maximumLifetimeValue?: number;
     /**
      * Start of date range to filter customers by last purchase date
      * @type {string}
@@ -2199,7 +2265,7 @@ export interface CustomersApiListCustomersRequest {
     readonly search?: string;
     /**
      * An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
-     * @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+refundedOrderCount' | '-refundedOrderCount' | '+lastPurchased' | '-lastPurchased'>}
+     * @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+refundedOrderCount' | '-refundedOrderCount' | '+lastPurchased' | '-lastPurchased' | '+usedDiscount' | '-usedDiscount'>}
      * @memberof CustomersApiListCustomers
      */
     readonly sortBy?: Array<ListCustomersSortByEnum>;
@@ -2209,6 +2275,12 @@ export interface CustomersApiListCustomersRequest {
      * @memberof CustomersApiListCustomers
      */
     readonly countries?: Array<string>;
+    /**
+     * Filter customers by project. In the absence of this field, all projects will be included in the export.
+     * @type {Array<string>}
+     * @memberof CustomersApiListCustomers
+     */
+    readonly projects?: Array<string>;
     /**
      * Filter customers by gender equal to the value provided
      * @type {'male' | 'female'}
@@ -2216,23 +2288,53 @@ export interface CustomersApiListCustomersRequest {
      */
     readonly gender?: ListCustomersGenderEnum;
     /**
-     * Filter customers by total order count equal to the value provided
+     * Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
+     * @type {Array<number>}
+     * @memberof CustomersApiListCustomers
+     */
+    readonly productTypes?: Array<number>;
+    /**
+     * Filter customers by whether they have used a discount
+     * @type {boolean}
+     * @memberof CustomersApiListCustomers
+     */
+    readonly usedDiscount?: boolean;
+    /**
+     * Filter customers by total order count greater than or equal to the value provided
+     * @type {number}
+     * @memberof CustomersApiListCustomers
+     */
+    readonly minimumTotalOrderCount?: number;
+    /**
+     * Filter customers by total order count less than or equal to the value provided
+     * @type {number}
+     * @memberof CustomersApiListCustomers
+     */
+    readonly maximumTotalOrderCount?: number;
+    /**
+     * Filter customers by refunded order count greater than or equal to the value provided
+     * @type {number}
+     * @memberof CustomersApiListCustomers
+     */
+    readonly minimumRefundedOrderCount?: number;
+    /**
+     * Filter customers by refunded order count less than or equal to the value provided
      * @type {number}
      * @memberof CustomersApiListCustomers
      */
-    readonly totalOrderCount?: number;
+    readonly maximumRefundedOrderCount?: number;
     /**
-     * Filter customers by refunded order count equal to the value provided
+     * Filter customers by lifetime value greater than or equal to the value provided
      * @type {number}
      * @memberof CustomersApiListCustomers
      */
-    readonly refundedOrderCount?: number;
+    readonly minimumLifetimeValue?: number;
     /**
      * Filter customers by lifetime value less than or equal to the value provided
      * @type {number}
      * @memberof CustomersApiListCustomers
      */
-    readonly lifetimeValue?: number;
+    readonly maximumLifetimeValue?: number;
     /**
      * Start of date range to filter customers by last purchase date
      * @type {string}
@@ -2281,14 +2383,6 @@ export declare class CustomersApi extends BaseAPI {
      */
     listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CustomersResponse, any>>;
 }
-/**
- * @export
- */
-export declare const ExportCustomersGenderEnum: {
-    readonly Male: "male";
-    readonly Female: "female";
-};
-export type ExportCustomersGenderEnum = typeof ExportCustomersGenderEnum[keyof typeof ExportCustomersGenderEnum];
 /**
  * @export
  */
@@ -2301,8 +2395,18 @@ export declare const ExportCustomersSortByEnum: {
     readonly RefundedOrderCount2: "-refundedOrderCount";
     readonly LastPurchased: "+lastPurchased";
     readonly LastPurchased2: "-lastPurchased";
+    readonly UsedDiscount: "+usedDiscount";
+    readonly UsedDiscount2: "-usedDiscount";
 };
 export type ExportCustomersSortByEnum = typeof ExportCustomersSortByEnum[keyof typeof ExportCustomersSortByEnum];
+/**
+ * @export
+ */
+export declare const ExportCustomersGenderEnum: {
+    readonly Male: "male";
+    readonly Female: "female";
+};
+export type ExportCustomersGenderEnum = typeof ExportCustomersGenderEnum[keyof typeof ExportCustomersGenderEnum];
 /**
  * @export
  */
@@ -2315,6 +2419,8 @@ export declare const ListCustomersSortByEnum: {
     readonly RefundedOrderCount2: "-refundedOrderCount";
     readonly LastPurchased: "+lastPurchased";
     readonly LastPurchased2: "-lastPurchased";
+    readonly UsedDiscount: "+usedDiscount";
+    readonly UsedDiscount2: "-usedDiscount";
 };
 export type ListCustomersSortByEnum = typeof ListCustomersSortByEnum[keyof typeof ListCustomersSortByEnum];
 /**