@teemill/platform 0.24.0 → 0.27.0

package/dist/api.d.ts

@@ -2,7 +2,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.24.0
+ * The version of the OpenAPI document: 0.27.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -378,6 +378,12 @@ export interface Enquiry {
      * @memberof Enquiry
      */
     'chatChannelRef'?: string | null;
+    /**
+     * The unique id of the user who owns the enquiry
+     * @type {string}
+     * @memberof Enquiry
+     */
+    'owner': string | null;
 }
 export declare const EnquiryStatusEnum: {
     readonly New: "New";
@@ -1535,6 +1541,12 @@ export interface Statistics {
      * @memberof Statistics
      */
     'totalOrderCount': number;
+    /**
+     *
+     * @type {number}
+     * @memberof Statistics
+     */
+    'refundedOrderCount': number;
     /**
      *
      * @type {string}
@@ -1610,6 +1622,19 @@ export interface Terms {
      */
     'updatedAt': string;
 }
+/**
+ *
+ * @export
+ * @interface UpdateCustomerEnquiryRequest
+ */
+export interface UpdateCustomerEnquiryRequest {
+    /**
+     * The unique id of the user who owns the enquiry
+     * @type {string}
+     * @memberof UpdateCustomerEnquiryRequest
+     */
+    'owner'?: string | null;
+}
 /**
  *
  * @export
@@ -1720,7 +1745,10 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
      * @summary Export customers
      * @param {string} project Project unique identifier
      * @param {string} platformId The platform identifier
+     * @param {Array<string>} [countries] Filter customers by country code
+     * @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 {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
@@ -1728,7 +1756,7 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    exportCustomers: (project: string, platformId: string, totalOrderCount?: number, lifetimeValue?: number, sortBy?: Array<ExportCustomersSortByEnum>, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    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>;
     /**
      * Get a customer for a platform by a given customer ID.
      * @summary Get customer
@@ -1748,14 +1776,17 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
      * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
      * @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 {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 {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>, totalOrderCount?: 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>, gender?: ListCustomersGenderEnum, totalOrderCount?: number, refundedOrderCount?: number, lifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * CustomersApi - functional programming interface
@@ -1767,7 +1798,10 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
      * @summary Export customers
      * @param {string} project Project unique identifier
      * @param {string} platformId The platform identifier
+     * @param {Array<string>} [countries] Filter customers by country code
+     * @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 {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
@@ -1775,7 +1809,7 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    exportCustomers(project: string, platformId: string, totalOrderCount?: number, lifetimeValue?: number, sortBy?: Array<ExportCustomersSortByEnum>, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
+    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>>;
     /**
      * Get a customer for a platform by a given customer ID.
      * @summary Get customer
@@ -1795,14 +1829,17 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
      * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
      * @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 {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 {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>, totalOrderCount?: 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>, gender?: ListCustomersGenderEnum, totalOrderCount?: number, refundedOrderCount?: number, lifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>>;
 };
 /**
  * CustomersApi - factory interface
@@ -1852,12 +1889,30 @@ export interface CustomersApiExportCustomersRequest {
      * @memberof CustomersApiExportCustomers
      */
     readonly platformId: string;
+    /**
+     * Filter customers by country code
+     * @type {Array<string>}
+     * @memberof CustomersApiExportCustomers
+     */
+    readonly countries?: Array<string>;
+    /**
+     * Filter customers by gender equal to the value provided
+     * @type {'male' | 'female'}
+     * @memberof CustomersApiExportCustomers
+     */
+    readonly gender?: ExportCustomersGenderEnum;
     /**
      * Filter customers by total order count equal to the value provided
      * @type {number}
      * @memberof CustomersApiExportCustomers
      */
     readonly totalOrderCount?: number;
+    /**
+     * Filter customers by refunded order count equal to the value provided
+     * @type {number}
+     * @memberof CustomersApiExportCustomers
+     */
+    readonly refundedOrderCount?: number;
     /**
      * Filter customers by lifetime value less than or equal to the value provided
      * @type {number}
@@ -1866,7 +1921,7 @@ export interface CustomersApiExportCustomersRequest {
     readonly lifetimeValue?: 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' | '+lastPurchased' | '-lastPurchased'>}
+     * @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+refundedOrderCount' | '-refundedOrderCount' | '+lastPurchased' | '-lastPurchased'>}
      * @memberof CustomersApiExportCustomers
      */
     readonly sortBy?: Array<ExportCustomersSortByEnum>;
@@ -1946,16 +2001,34 @@ 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' | '+lastPurchased' | '-lastPurchased'>}
+     * @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+refundedOrderCount' | '-refundedOrderCount' | '+lastPurchased' | '-lastPurchased'>}
      * @memberof CustomersApiListCustomers
      */
     readonly sortBy?: Array<ListCustomersSortByEnum>;
+    /**
+     * Filter customers by country code
+     * @type {Array<string>}
+     * @memberof CustomersApiListCustomers
+     */
+    readonly countries?: Array<string>;
+    /**
+     * Filter customers by gender equal to the value provided
+     * @type {'male' | 'female'}
+     * @memberof CustomersApiListCustomers
+     */
+    readonly gender?: ListCustomersGenderEnum;
     /**
      * Filter customers by total order count equal to the value provided
      * @type {number}
      * @memberof CustomersApiListCustomers
      */
     readonly totalOrderCount?: number;
+    /**
+     * Filter customers by refunded order count equal to the value provided
+     * @type {number}
+     * @memberof CustomersApiListCustomers
+     */
+    readonly refundedOrderCount?: number;
     /**
      * Filter customers by lifetime value less than or equal to the value provided
      * @type {number}
@@ -2010,6 +2083,14 @@ 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
  */
@@ -2018,6 +2099,8 @@ export declare const ExportCustomersSortByEnum: {
     readonly LifetimeValue2: "-lifetimeValue";
     readonly TotalOrderCount: "+totalOrderCount";
     readonly TotalOrderCount2: "-totalOrderCount";
+    readonly RefundedOrderCount: "+refundedOrderCount";
+    readonly RefundedOrderCount2: "-refundedOrderCount";
     readonly LastPurchased: "+lastPurchased";
     readonly LastPurchased2: "-lastPurchased";
 };
@@ -2030,10 +2113,20 @@ export declare const ListCustomersSortByEnum: {
     readonly LifetimeValue2: "-lifetimeValue";
     readonly TotalOrderCount: "+totalOrderCount";
     readonly TotalOrderCount2: "-totalOrderCount";
+    readonly RefundedOrderCount: "+refundedOrderCount";
+    readonly RefundedOrderCount2: "-refundedOrderCount";
     readonly LastPurchased: "+lastPurchased";
     readonly LastPurchased2: "-lastPurchased";
 };
 export type ListCustomersSortByEnum = typeof ListCustomersSortByEnum[keyof typeof ListCustomersSortByEnum];
+/**
+ * @export
+ */
+export declare const ListCustomersGenderEnum: {
+    readonly Male: "male";
+    readonly Female: "female";
+};
+export type ListCustomersGenderEnum = typeof ListCustomersGenderEnum[keyof typeof ListCustomersGenderEnum];
 /**
  * EnquiriesApi - axios parameter creator
  * @export
@@ -2083,6 +2176,17 @@ export declare const EnquiriesApiAxiosParamCreator: (configuration?: Configurati
      * @throws {RequiredError}
      */
     listCustomerEnquiryLogs: (project: string, platformId: string, enquiryId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update a customer enquiry
+     * @summary Update customer enquiry
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {string} enquiryId The enquiry identifier
+     * @param {UpdateCustomerEnquiryRequest} updateCustomerEnquiryRequest Enquiry update
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateCustomerEnquiry: (project: string, platformId: string, enquiryId: string, updateCustomerEnquiryRequest: UpdateCustomerEnquiryRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * EnquiriesApi - functional programming interface
@@ -2133,6 +2237,17 @@ export declare const EnquiriesApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     listCustomerEnquiryLogs(project: string, platformId: string, enquiryId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCustomerEnquiryLogs200Response>>;
+    /**
+     * Update a customer enquiry
+     * @summary Update customer enquiry
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {string} enquiryId The enquiry identifier
+     * @param {UpdateCustomerEnquiryRequest} updateCustomerEnquiryRequest Enquiry update
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateCustomerEnquiry(project: string, platformId: string, enquiryId: string, updateCustomerEnquiryRequest: UpdateCustomerEnquiryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Enquiry>>;
 };
 /**
  * EnquiriesApi - factory interface
@@ -2171,6 +2286,14 @@ export declare const EnquiriesApiFactory: (configuration?: Configuration, basePa
      * @throws {RequiredError}
      */
     listCustomerEnquiryLogs(requestParameters: EnquiriesApiListCustomerEnquiryLogsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListCustomerEnquiryLogs200Response>;
+    /**
+     * Update a customer enquiry
+     * @summary Update customer enquiry
+     * @param {EnquiriesApiUpdateCustomerEnquiryRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateCustomerEnquiry(requestParameters: EnquiriesApiUpdateCustomerEnquiryRequest, options?: RawAxiosRequestConfig): AxiosPromise<Enquiry>;
 };
 /**
  * Request parameters for createChatChannel operation in EnquiriesApi.
@@ -2296,6 +2419,37 @@ export interface EnquiriesApiListCustomerEnquiryLogsRequest {
      */
     readonly enquiryId: string;
 }
+/**
+ * Request parameters for updateCustomerEnquiry operation in EnquiriesApi.
+ * @export
+ * @interface EnquiriesApiUpdateCustomerEnquiryRequest
+ */
+export interface EnquiriesApiUpdateCustomerEnquiryRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof EnquiriesApiUpdateCustomerEnquiry
+     */
+    readonly project: string;
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof EnquiriesApiUpdateCustomerEnquiry
+     */
+    readonly platformId: string;
+    /**
+     * The enquiry identifier
+     * @type {string}
+     * @memberof EnquiriesApiUpdateCustomerEnquiry
+     */
+    readonly enquiryId: string;
+    /**
+     * Enquiry update
+     * @type {UpdateCustomerEnquiryRequest}
+     * @memberof EnquiriesApiUpdateCustomerEnquiry
+     */
+    readonly updateCustomerEnquiryRequest: UpdateCustomerEnquiryRequest;
+}
 /**
  * EnquiriesApi - object-oriented interface
  * @export
@@ -2339,6 +2493,15 @@ export declare class EnquiriesApi extends BaseAPI {
      * @memberof EnquiriesApi
      */
     listCustomerEnquiryLogs(requestParameters: EnquiriesApiListCustomerEnquiryLogsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCustomerEnquiryLogs200Response, any>>;
+    /**
+     * Update a customer enquiry
+     * @summary Update customer enquiry
+     * @param {EnquiriesApiUpdateCustomerEnquiryRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof EnquiriesApi
+     */
+    updateCustomerEnquiry(requestParameters: EnquiriesApiUpdateCustomerEnquiryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Enquiry, any>>;
 }
 /**
  * OrdersApi - axios parameter creator
@@ -2408,10 +2571,12 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
      * @param {string} [start] Start of date range to filter when orders were placed
      * @param {string} [end] End of date range to filter when orders were placed
      * @param {ListOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the &#x60;start&#x60; and &#x60;end&#x60; fields should query.
+     * @param {number} [maxOrderTotal] The maximum value of the order
+     * @param {number} [minOrderTotal] The minimum value of the order
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listOrders: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, dateFilterType?: ListOrdersDateFilterTypeEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    listOrders: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, dateFilterType?: ListOrdersDateFilterTypeEnum, maxOrderTotal?: number, minOrderTotal?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Retries failed platform payment, so fulfillment can proceed.
      * @summary Retry
@@ -2512,10 +2677,12 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
      * @param {string} [start] Start of date range to filter when orders were placed
      * @param {string} [end] End of date range to filter when orders were placed
      * @param {ListOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the &#x60;start&#x60; and &#x60;end&#x60; fields should query.
+     * @param {number} [maxOrderTotal] The maximum value of the order
+     * @param {number} [minOrderTotal] The minimum value of the order
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listOrders(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, dateFilterType?: ListOrdersDateFilterTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrdersResponse>>;
+    listOrders(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, dateFilterType?: ListOrdersDateFilterTypeEnum, maxOrderTotal?: number, minOrderTotal?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrdersResponse>>;
     /**
      * Retries failed platform payment, so fulfillment can proceed.
      * @summary Retry
@@ -2817,6 +2984,18 @@ export interface OrdersApiListOrdersRequest {
      * @memberof OrdersApiListOrders
      */
     readonly dateFilterType?: ListOrdersDateFilterTypeEnum;
+    /**
+     * The maximum value of the order
+     * @type {number}
+     * @memberof OrdersApiListOrders
+     */
+    readonly maxOrderTotal?: number;
+    /**
+     * The minimum value of the order
+     * @type {number}
+     * @memberof OrdersApiListOrders
+     */
+    readonly minOrderTotal?: number;
 }
 /**
  * Request parameters for retryPlatformPayment operation in OrdersApi.