@teemill/platform 0.29.0 → 0.30.0

package/dist/esm/api.d.ts

@@ -2,7 +2,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.29.0
+ * The version of the OpenAPI document: 0.30.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -68,6 +68,55 @@ export interface Address {
      */
     'state'?: string;
 }
+/**
+ *
+ * @export
+ * @interface AmendOrderRequest
+ */
+export interface AmendOrderRequest {
+    /**
+     *
+     * @type {Array<AmendOrderRequestAmendmentsInner>}
+     * @memberof AmendOrderRequest
+     */
+    'amendments': Array<AmendOrderRequestAmendmentsInner>;
+}
+/**
+ *
+ * @export
+ * @interface AmendOrderRequestAmendmentsInner
+ */
+export interface AmendOrderRequestAmendmentsInner {
+    /**
+     * Unique order item identifier
+     * @type {string}
+     * @memberof AmendOrderRequestAmendmentsInner
+     */
+    'id': string;
+    /**
+     *
+     * @type {string}
+     * @memberof AmendOrderRequestAmendmentsInner
+     */
+    'action': AmendOrderRequestAmendmentsInnerActionEnum;
+    /**
+     * The quantity of the item to refund or exchange. This must be less than or equal to the quantity of the item in the order.
+     * @type {number}
+     * @memberof AmendOrderRequestAmendmentsInner
+     */
+    'quantity': number;
+    /**
+     * A reference to the variant being ordered
+     * @type {string}
+     * @memberof AmendOrderRequestAmendmentsInner
+     */
+    'newVariantRef'?: string;
+}
+export declare const AmendOrderRequestAmendmentsInnerActionEnum: {
+    readonly Refund: "refund";
+    readonly Exchange: "exchange";
+};
+export type AmendOrderRequestAmendmentsInnerActionEnum = typeof AmendOrderRequestAmendmentsInnerActionEnum[keyof typeof AmendOrderRequestAmendmentsInnerActionEnum];
 /**
  *
  * @export
@@ -1448,6 +1497,19 @@ export interface Project {
      */
     'name': string;
 }
+/**
+ *
+ * @export
+ * @interface ReturnOrderRequest
+ */
+export interface ReturnOrderRequest {
+    /**
+     *
+     * @type {Array<AmendOrderRequestAmendmentsInner>}
+     * @memberof ReturnOrderRequest
+     */
+    'returns': Array<AmendOrderRequestAmendmentsInner>;
+}
 /**
  *
  * @export
@@ -1953,7 +2015,7 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
      * @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 {Array<string>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
+     * @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
@@ -1966,7 +2028,7 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    exportCustomers: (project: string, platformId: string, sortBy?: Array<ExportCustomersSortByEnum>, countries?: Array<string>, projects?: Array<string>, gender?: ExportCustomersGenderEnum, productTypes?: Array<string>, usedDiscount?: boolean, minimumTotalOrderCount?: number, maximumTotalOrderCount?: number, minimumRefundedOrderCount?: number, maximumRefundedOrderCount?: number, minimumLifetimeValue?: number, maximumLifetimeValue?: number, 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
@@ -1989,7 +2051,7 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
      * @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 {Array<string>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
+     * @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
@@ -2002,7 +2064,7 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
      * @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>, projects?: Array<string>, gender?: ListCustomersGenderEnum, productTypes?: Array<string>, usedDiscount?: boolean, minimumTotalOrderCount?: number, maximumTotalOrderCount?: number, minimumRefundedOrderCount?: number, maximumRefundedOrderCount?: number, minimumLifetimeValue?: number, maximumLifetimeValue?: 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
@@ -2018,7 +2080,7 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
      * @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 {Array<string>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
+     * @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
@@ -2031,7 +2093,7 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    exportCustomers(project: string, platformId: string, sortBy?: Array<ExportCustomersSortByEnum>, countries?: Array<string>, projects?: Array<string>, gender?: ExportCustomersGenderEnum, productTypes?: Array<string>, 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>>;
+    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
@@ -2054,7 +2116,7 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
      * @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 {Array<string>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
+     * @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
@@ -2067,7 +2129,7 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
      * @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>, projects?: Array<string>, gender?: ListCustomersGenderEnum, productTypes?: Array<string>, 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>>;
+    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
@@ -2143,10 +2205,10 @@ export interface CustomersApiExportCustomersRequest {
     readonly gender?: ExportCustomersGenderEnum;
     /**
      * Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
-     * @type {Array<string>}
+     * @type {Array<number>}
      * @memberof CustomersApiExportCustomers
      */
-    readonly productTypes?: Array<string>;
+    readonly productTypes?: Array<number>;
     /**
      * Filter customers by whether they have used a discount
      * @type {boolean}
@@ -2289,10 +2351,10 @@ export interface CustomersApiListCustomersRequest {
     readonly gender?: ListCustomersGenderEnum;
     /**
      * Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
-     * @type {Array<string>}
+     * @type {Array<number>}
      * @memberof CustomersApiListCustomers
      */
-    readonly productTypes?: Array<string>;
+    readonly productTypes?: Array<number>;
     /**
      * Filter customers by whether they have used a discount
      * @type {boolean}
@@ -2812,6 +2874,17 @@ export declare class EnquiriesApi extends BaseAPI {
  * @export
  */
 export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Amend the contents of an order
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {string} orderId The order identifier
+     * @param {AmendOrderRequest} amendOrderRequest AmendOrder schema
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    amendOrder: (project: string, platformId: string, orderId: string, amendOrderRequest: AmendOrderRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Confirm order
@@ -2912,6 +2985,17 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     retryPlatformPayment: (project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Return the contents of an order for a refund or exchange
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {string} orderId The order identifier
+     * @param {ReturnOrderRequest} returnOrderRequest ReturnOrder schema
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    returnOrder: (project: string, platformId: string, orderId: string, returnOrderRequest: ReturnOrderRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
      * @summary Send order receipt
@@ -2939,6 +3023,17 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
  * @export
  */
 export declare const OrdersApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Amend the contents of an order
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {string} orderId The order identifier
+     * @param {AmendOrderRequest} amendOrderRequest AmendOrder schema
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    amendOrder(project: string, platformId: string, orderId: string, amendOrderRequest: AmendOrderRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
     /**
      *
      * @summary Confirm order
@@ -3039,6 +3134,17 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     retryPlatformPayment(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
+    /**
+     *
+     * @summary Return the contents of an order for a refund or exchange
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {string} orderId The order identifier
+     * @param {ReturnOrderRequest} returnOrderRequest ReturnOrder schema
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    returnOrder(project: string, platformId: string, orderId: string, returnOrderRequest: ReturnOrderRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
     /**
      * Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
      * @summary Send order receipt
@@ -3066,6 +3172,14 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
  * @export
  */
 export declare const OrdersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Amend the contents of an order
+     * @param {OrdersApiAmendOrderRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    amendOrder(requestParameters: OrdersApiAmendOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order>;
     /**
      *
      * @summary Confirm order
@@ -3138,6 +3252,14 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order>;
+    /**
+     *
+     * @summary Return the contents of an order for a refund or exchange
+     * @param {OrdersApiReturnOrderRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    returnOrder(requestParameters: OrdersApiReturnOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order>;
     /**
      * Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
      * @summary Send order receipt
@@ -3155,6 +3277,37 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
      */
     updateFulfillment(requestParameters: OrdersApiUpdateFulfillmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Fulfillment>;
 };
+/**
+ * Request parameters for amendOrder operation in OrdersApi.
+ * @export
+ * @interface OrdersApiAmendOrderRequest
+ */
+export interface OrdersApiAmendOrderRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof OrdersApiAmendOrder
+     */
+    readonly project: string;
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof OrdersApiAmendOrder
+     */
+    readonly platformId: string;
+    /**
+     * The order identifier
+     * @type {string}
+     * @memberof OrdersApiAmendOrder
+     */
+    readonly orderId: string;
+    /**
+     * AmendOrder schema
+     * @type {AmendOrderRequest}
+     * @memberof OrdersApiAmendOrder
+     */
+    readonly amendOrderRequest: AmendOrderRequest;
+}
 /**
  * Request parameters for confirmOrder operation in OrdersApi.
  * @export
@@ -3440,6 +3593,37 @@ export interface OrdersApiRetryPlatformPaymentRequest {
      */
     readonly orderId: string;
 }
+/**
+ * Request parameters for returnOrder operation in OrdersApi.
+ * @export
+ * @interface OrdersApiReturnOrderRequest
+ */
+export interface OrdersApiReturnOrderRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof OrdersApiReturnOrder
+     */
+    readonly project: string;
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof OrdersApiReturnOrder
+     */
+    readonly platformId: string;
+    /**
+     * The order identifier
+     * @type {string}
+     * @memberof OrdersApiReturnOrder
+     */
+    readonly orderId: string;
+    /**
+     * ReturnOrder schema
+     * @type {ReturnOrderRequest}
+     * @memberof OrdersApiReturnOrder
+     */
+    readonly returnOrderRequest: ReturnOrderRequest;
+}
 /**
  * Request parameters for sendOrderReceipt operation in OrdersApi.
  * @export
@@ -3503,6 +3687,15 @@ export interface OrdersApiUpdateFulfillmentRequest {
  * @extends {BaseAPI}
  */
 export declare class OrdersApi extends BaseAPI {
+    /**
+     *
+     * @summary Amend the contents of an order
+     * @param {OrdersApiAmendOrderRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    amendOrder(requestParameters: OrdersApiAmendOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
     /**
      *
      * @summary Confirm order
@@ -3584,6 +3777,15 @@ export declare class OrdersApi extends BaseAPI {
      * @memberof OrdersApi
      */
     retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
+    /**
+     *
+     * @summary Return the contents of an order for a refund or exchange
+     * @param {OrdersApiReturnOrderRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    returnOrder(requestParameters: OrdersApiReturnOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
     /**
      * Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
      * @summary Send order receipt