@teemill/platform 0.33.0 → 0.34.1

package/dist/esm/api.d.ts

@@ -2,7 +2,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.33.0
+ * The version of the OpenAPI document: 0.34.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -111,12 +111,37 @@ export interface AmendOrderRequestAmendmentsInner {
      * @memberof AmendOrderRequestAmendmentsInner
      */
     'newVariantRef'?: string;
+    /**
+     *
+     * @type {AmendOrderRequestAmendmentsInnerReason}
+     * @memberof AmendOrderRequestAmendmentsInner
+     */
+    'reason': AmendOrderRequestAmendmentsInnerReason;
 }
 export declare const AmendOrderRequestAmendmentsInnerActionEnum: {
     readonly Refund: "refund";
     readonly Exchange: "exchange";
 };
 export type AmendOrderRequestAmendmentsInnerActionEnum = typeof AmendOrderRequestAmendmentsInnerActionEnum[keyof typeof AmendOrderRequestAmendmentsInnerActionEnum];
+/**
+ *
+ * @export
+ * @interface AmendOrderRequestAmendmentsInnerReason
+ */
+export interface AmendOrderRequestAmendmentsInnerReason {
+    /**
+     * A reference to the resource location
+     * @type {string}
+     * @memberof AmendOrderRequestAmendmentsInnerReason
+     */
+    'reasonRef': string;
+    /**
+     * Additional comments as to why the item is being returned or exchanged.
+     * @type {string}
+     * @memberof AmendOrderRequestAmendmentsInnerReason
+     */
+    'additionalComments'?: string | null;
+}
 /**
  *
  * @export
@@ -1096,10 +1121,29 @@ export interface InlineObject {
  * @interface InlineObject1
  */
 export interface InlineObject1 {
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof InlineObject1
+     */
+    'tags': Array<string>;
+    /**
+     *
+     * @type {number}
+     * @memberof InlineObject1
+     */
+    'nextPageToken'?: number | null;
+}
+/**
+ *
+ * @export
+ * @interface InlineObject2
+ */
+export interface InlineObject2 {
     /**
      * The URL to redirect to
      * @type {string}
-     * @memberof InlineObject1
+     * @memberof InlineObject2
      */
     'redirect_url': string;
 }
@@ -1827,10 +1871,71 @@ export interface Project {
 export interface ReturnOrderRequest {
     /**
      *
-     * @type {Array<AmendOrderRequestAmendmentsInner>}
+     * @type {Array<ReturnOrderRequestReturnsInner>}
      * @memberof ReturnOrderRequest
      */
-    'returns': Array<AmendOrderRequestAmendmentsInner>;
+    'returns': Array<ReturnOrderRequestReturnsInner>;
+}
+/**
+ *
+ * @export
+ * @interface ReturnOrderRequestReturnsInner
+ */
+export interface ReturnOrderRequestReturnsInner {
+    /**
+     * Unique order item identifier
+     * @type {string}
+     * @memberof ReturnOrderRequestReturnsInner
+     */
+    'id': string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReturnOrderRequestReturnsInner
+     */
+    'action': ReturnOrderRequestReturnsInnerActionEnum;
+    /**
+     * 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 ReturnOrderRequestReturnsInner
+     */
+    'quantity': number;
+    /**
+     * A reference to the variant being ordered
+     * @type {string}
+     * @memberof ReturnOrderRequestReturnsInner
+     */
+    'newVariantRef'?: string;
+    /**
+     *
+     * @type {ReturnOrderRequestReturnsInnerReason}
+     * @memberof ReturnOrderRequestReturnsInner
+     */
+    'reason': ReturnOrderRequestReturnsInnerReason;
+}
+export declare const ReturnOrderRequestReturnsInnerActionEnum: {
+    readonly Refund: "refund";
+    readonly Exchange: "exchange";
+};
+export type ReturnOrderRequestReturnsInnerActionEnum = typeof ReturnOrderRequestReturnsInnerActionEnum[keyof typeof ReturnOrderRequestReturnsInnerActionEnum];
+/**
+ *
+ * @export
+ * @interface ReturnOrderRequestReturnsInnerReason
+ */
+export interface ReturnOrderRequestReturnsInnerReason {
+    /**
+     * A reference to the reason for the return or exchange.
+     * @type {string}
+     * @memberof ReturnOrderRequestReturnsInnerReason
+     */
+    'reasonRef': string;
+    /**
+     * Additional comments as to why the item is being returned or exchanged.
+     * @type {string}
+     * @memberof ReturnOrderRequestReturnsInnerReason
+     */
+    'additionalComments'?: string | null;
 }
 /**
  *
@@ -2363,6 +2468,8 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
      * @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<number>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
+     * @param {Array<string>} [demographics] Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export.
+     * @param {Array<string>} [tags] Filter customers by purchase tags. 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
@@ -2375,7 +2482,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<number>, 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>, demographics?: Array<string>, tags?: Array<string>, 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
@@ -2386,6 +2493,18 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
      * @throws {RequiredError}
      */
     getCustomer: (project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List customer tags
+     * @summary List customer tags
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {number} [pageToken] Page reference token
+     * @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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCustomerTags: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * List customers for a platform
      * @summary List customers
@@ -2399,6 +2518,8 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
      * @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<number>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
+     * @param {Array<string>} [demographics] Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export.
+     * @param {Array<string>} [tags] Filter customers by purchase tags. 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
@@ -2411,7 +2532,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<number>, 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>, demographics?: Array<string>, tags?: Array<string>, 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
@@ -2428,6 +2549,8 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
      * @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<number>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
+     * @param {Array<string>} [demographics] Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export.
+     * @param {Array<string>} [tags] Filter customers by purchase tags. 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
@@ -2440,7 +2563,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<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>>;
+    exportCustomers(project: string, platformId: string, sortBy?: Array<ExportCustomersSortByEnum>, countries?: Array<string>, projects?: Array<string>, gender?: ExportCustomersGenderEnum, productTypes?: Array<number>, demographics?: Array<string>, tags?: 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>>;
     /**
      * Get a customer for a platform by a given customer ID.
      * @summary Get customer
@@ -2451,6 +2574,18 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getCustomer(project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Customer>>;
+    /**
+     * List customer tags
+     * @summary List customer tags
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {number} [pageToken] Page reference token
+     * @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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCustomerTags(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineObject1>>;
     /**
      * List customers for a platform
      * @summary List customers
@@ -2464,6 +2599,8 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
      * @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<number>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
+     * @param {Array<string>} [demographics] Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export.
+     * @param {Array<string>} [tags] Filter customers by purchase tags. 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
@@ -2476,7 +2613,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<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>>;
+    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>, demographics?: Array<string>, tags?: 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>>;
 };
 /**
  * CustomersApi - factory interface
@@ -2499,6 +2636,14 @@ export declare const CustomersApiFactory: (configuration?: Configuration, basePa
      * @throws {RequiredError}
      */
     getCustomer(requestParameters: CustomersApiGetCustomerRequest, options?: RawAxiosRequestConfig): AxiosPromise<Customer>;
+    /**
+     * List customer tags
+     * @summary List customer tags
+     * @param {CustomersApiListCustomerTagsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCustomerTags(requestParameters: CustomersApiListCustomerTagsRequest, options?: RawAxiosRequestConfig): AxiosPromise<InlineObject1>;
     /**
      * List customers for a platform
      * @summary List customers
@@ -2556,6 +2701,18 @@ export interface CustomersApiExportCustomersRequest {
      * @memberof CustomersApiExportCustomers
      */
     readonly productTypes?: Array<number>;
+    /**
+     * Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export.
+     * @type {Array<string>}
+     * @memberof CustomersApiExportCustomers
+     */
+    readonly demographics?: Array<string>;
+    /**
+     * Filter customers by purchase tags. In the absence of this field, all customers will be included in the export.
+     * @type {Array<string>}
+     * @memberof CustomersApiExportCustomers
+     */
+    readonly tags?: Array<string>;
     /**
      * Filter customers by whether they have used a discount
      * @type {boolean}
@@ -2636,6 +2793,43 @@ export interface CustomersApiGetCustomerRequest {
      */
     readonly customerId: string;
 }
+/**
+ * Request parameters for listCustomerTags operation in CustomersApi.
+ * @export
+ * @interface CustomersApiListCustomerTagsRequest
+ */
+export interface CustomersApiListCustomerTagsRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof CustomersApiListCustomerTags
+     */
+    readonly project: string;
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof CustomersApiListCustomerTags
+     */
+    readonly platformId: string;
+    /**
+     * Page reference token
+     * @type {number}
+     * @memberof CustomersApiListCustomerTags
+     */
+    readonly pageToken?: number;
+    /**
+     * Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @type {number}
+     * @memberof CustomersApiListCustomerTags
+     */
+    readonly pageSize?: number;
+    /**
+     * Search term to filter results
+     * @type {string}
+     * @memberof CustomersApiListCustomerTags
+     */
+    readonly search?: string;
+}
 /**
  * Request parameters for listCustomers operation in CustomersApi.
  * @export
@@ -2702,6 +2896,18 @@ export interface CustomersApiListCustomersRequest {
      * @memberof CustomersApiListCustomers
      */
     readonly productTypes?: Array<number>;
+    /**
+     * Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export.
+     * @type {Array<string>}
+     * @memberof CustomersApiListCustomers
+     */
+    readonly demographics?: Array<string>;
+    /**
+     * Filter customers by purchase tags. In the absence of this field, all customers will be included in the export.
+     * @type {Array<string>}
+     * @memberof CustomersApiListCustomers
+     */
+    readonly tags?: Array<string>;
     /**
      * Filter customers by whether they have used a discount
      * @type {boolean}
@@ -2782,6 +2988,15 @@ export declare class CustomersApi extends BaseAPI {
      * @memberof CustomersApi
      */
     getCustomer(requestParameters: CustomersApiGetCustomerRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Customer, any>>;
+    /**
+     * List customer tags
+     * @summary List customer tags
+     * @param {CustomersApiListCustomerTagsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomersApi
+     */
+    listCustomerTags(requestParameters: CustomersApiListCustomerTagsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InlineObject1, any>>;
     /**
      * List customers for a platform
      * @summary List customers
@@ -4345,7 +4560,7 @@ export declare const PaymentApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    authorizeStripe(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineObject1>>;
+    authorizeStripe(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineObject2>>;
     /**
      * Deauthorize a Stripe payment account
      * @summary Deauthorize Stripe
@@ -4375,7 +4590,7 @@ export declare const PaymentApiFactory: (configuration?: Configuration, basePath
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    authorizeStripe(requestParameters: PaymentApiAuthorizeStripeRequest, options?: RawAxiosRequestConfig): AxiosPromise<InlineObject1>;
+    authorizeStripe(requestParameters: PaymentApiAuthorizeStripeRequest, options?: RawAxiosRequestConfig): AxiosPromise<InlineObject2>;
     /**
      * Deauthorize a Stripe payment account
      * @summary Deauthorize Stripe
@@ -4447,7 +4662,7 @@ export declare class PaymentApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof PaymentApi
      */
-    authorizeStripe(requestParameters: PaymentApiAuthorizeStripeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InlineObject1, any>>;
+    authorizeStripe(requestParameters: PaymentApiAuthorizeStripeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InlineObject2, any>>;
     /**
      * Deauthorize a Stripe payment account
      * @summary Deauthorize Stripe