@teemill/platform 0.53.0 → 0.55.0

package/dist/esm/api.d.ts

@@ -2,7 +2,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.53.0
+ * The version of the OpenAPI document: 0.55.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -320,6 +320,7 @@ export interface Customer {
     'country': string | null;
     'statistics': Statistics;
     'shippingAddress'?: Address;
+    'billingAddress'?: Address;
     /**
      * Reference to the chat channel resource
      */
@@ -364,6 +365,27 @@ export interface DashboardItem {
     'sortOrder': number;
     'items'?: Array<DashboardItem> | null;
 }
+/**
+ * Data deletion request
+ */
+export interface DataDeletionRequest {
+    /**
+     * Unique object identifier
+     */
+    'id': string;
+    /**
+     * Reference to the customer resource
+     */
+    'customerRef': string;
+    /**
+     * Reference to the user resource
+     */
+    'requestedBy': string;
+    /**
+     * ISO 8601 Timestamp
+     */
+    'requestedAt': string;
+}
 /**
  * Estimated delivery date range. Null if accurate calculation not possible e.g. order contains pre-order items without back in stock dates.
  */
@@ -575,7 +597,7 @@ export interface Order {
     'contactInformation': ContactInformation;
     'paymentMethod'?: OrderPaymentMethod;
     'shippingAddress': Address;
-    'billingAddress'?: Address;
+    'billingAddress': Address;
     /**
      * ISO 8601 Timestamp
      */
@@ -994,6 +1016,12 @@ export interface UpdateCustomerEnquiryRequest {
      */
     'owner'?: string | null;
 }
+export interface UpdateCustomerRequest {
+    'email'?: string;
+    'name'?: string;
+    'billingAddress'?: Address;
+    'shippingAddress'?: Address;
+}
 export interface UpdateFulfillmentRequest {
     /**
      * Unique object identifier
@@ -1011,6 +1039,7 @@ export declare const UpdateModerationItemRequestJudgementEnum: {
 export type UpdateModerationItemRequestJudgementEnum = typeof UpdateModerationItemRequestJudgementEnum[keyof typeof UpdateModerationItemRequestJudgementEnum];
 export interface UpdateOrderRequest {
     'email'?: string;
+    'billingAddress'?: Address;
     'shippingAddress'?: Address;
     'priorityLevel'?: PriorityLevel;
 }
@@ -1067,6 +1096,16 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
      * @throws {RequiredError}
      */
     createCustomerChatChannel: (project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Create a data deletion request for a customer
+     * @summary Create data deletion request
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {string} customerId The customer identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCustomerDataDeletionRequest: (project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Export customers as a CSV file
      * @summary Export customers
@@ -1102,6 +1141,16 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
      * @throws {RequiredError}
      */
     getCustomer: (project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a data deletion request for a customer
+     * @summary Get data deletion request
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {string} customerId The customer identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCustomerDataDeletionRequest: (project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * List customer tags
      * @summary List customer tags
@@ -1142,6 +1191,17 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
      * @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>, 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>;
+    /**
+     *
+     * @summary Update the customer with the given customer ID
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {string} customerId The customer identifier
+     * @param {UpdateCustomerRequest} [updateCustomerRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateCustomer: (project: string, platformId: string, customerId: string, updateCustomerRequest?: UpdateCustomerRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * CustomersApi - functional programming interface
@@ -1157,6 +1217,16 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     createCustomerChatChannel(project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrderChatChannel200Response>>;
+    /**
+     * Create a data deletion request for a customer
+     * @summary Create data deletion request
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {string} customerId The customer identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCustomerDataDeletionRequest(project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataDeletionRequest>>;
     /**
      * Export customers as a CSV file
      * @summary Export customers
@@ -1192,6 +1262,16 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getCustomer(project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Customer>>;
+    /**
+     * Get a data deletion request for a customer
+     * @summary Get data deletion request
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {string} customerId The customer identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCustomerDataDeletionRequest(project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataDeletionRequest>>;
     /**
      * List customer tags
      * @summary List customer tags
@@ -1232,6 +1312,17 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
      * @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>, 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>>;
+    /**
+     *
+     * @summary Update the customer with the given customer ID
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {string} customerId The customer identifier
+     * @param {UpdateCustomerRequest} [updateCustomerRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateCustomer(project: string, platformId: string, customerId: string, updateCustomerRequest?: UpdateCustomerRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Customer>>;
 };
 /**
  * CustomersApi - factory interface
@@ -1245,6 +1336,14 @@ export declare const CustomersApiFactory: (configuration?: Configuration, basePa
      * @throws {RequiredError}
      */
     createCustomerChatChannel(requestParameters: CustomersApiCreateCustomerChatChannelRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateOrderChatChannel200Response>;
+    /**
+     * Create a data deletion request for a customer
+     * @summary Create data deletion request
+     * @param {CustomersApiCreateCustomerDataDeletionRequestRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCustomerDataDeletionRequest(requestParameters: CustomersApiCreateCustomerDataDeletionRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataDeletionRequest>;
     /**
      * Export customers as a CSV file
      * @summary Export customers
@@ -1261,6 +1360,14 @@ export declare const CustomersApiFactory: (configuration?: Configuration, basePa
      * @throws {RequiredError}
      */
     getCustomer(requestParameters: CustomersApiGetCustomerRequest, options?: RawAxiosRequestConfig): AxiosPromise<Customer>;
+    /**
+     * Get a data deletion request for a customer
+     * @summary Get data deletion request
+     * @param {CustomersApiGetCustomerDataDeletionRequestRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCustomerDataDeletionRequest(requestParameters: CustomersApiGetCustomerDataDeletionRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataDeletionRequest>;
     /**
      * List customer tags
      * @summary List customer tags
@@ -1277,6 +1384,14 @@ export declare const CustomersApiFactory: (configuration?: Configuration, basePa
      * @throws {RequiredError}
      */
     listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomersResponse>;
+    /**
+     *
+     * @summary Update the customer with the given customer ID
+     * @param {CustomersApiUpdateCustomerRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateCustomer(requestParameters: CustomersApiUpdateCustomerRequest, options?: RawAxiosRequestConfig): AxiosPromise<Customer>;
 };
 /**
  * Request parameters for createCustomerChatChannel operation in CustomersApi.
@@ -1295,6 +1410,23 @@ export interface CustomersApiCreateCustomerChatChannelRequest {
      */
     readonly customerId: string;
 }
+/**
+ * Request parameters for createCustomerDataDeletionRequest operation in CustomersApi.
+ */
+export interface CustomersApiCreateCustomerDataDeletionRequestRequest {
+    /**
+     * Project unique identifier
+     */
+    readonly project: string;
+    /**
+     * The platform identifier
+     */
+    readonly platformId: string;
+    /**
+     * The customer identifier
+     */
+    readonly customerId: string;
+}
 /**
  * Request parameters for exportCustomers operation in CustomersApi.
  */
@@ -1389,6 +1521,23 @@ export interface CustomersApiGetCustomerRequest {
      */
     readonly customerId: string;
 }
+/**
+ * Request parameters for getCustomerDataDeletionRequest operation in CustomersApi.
+ */
+export interface CustomersApiGetCustomerDataDeletionRequestRequest {
+    /**
+     * Project unique identifier
+     */
+    readonly project: string;
+    /**
+     * The platform identifier
+     */
+    readonly platformId: string;
+    /**
+     * The customer identifier
+     */
+    readonly customerId: string;
+}
 /**
  * Request parameters for listCustomerTags operation in CustomersApi.
  */
@@ -1503,6 +1652,24 @@ export interface CustomersApiListCustomersRequest {
      */
     readonly lastPurchasedEnd?: string;
 }
+/**
+ * Request parameters for updateCustomer operation in CustomersApi.
+ */
+export interface CustomersApiUpdateCustomerRequest {
+    /**
+     * Project unique identifier
+     */
+    readonly project: string;
+    /**
+     * The platform identifier
+     */
+    readonly platformId: string;
+    /**
+     * The customer identifier
+     */
+    readonly customerId: string;
+    readonly updateCustomerRequest?: UpdateCustomerRequest;
+}
 /**
  * CustomersApi - object-oriented interface
  */
@@ -1515,6 +1682,14 @@ export declare class CustomersApi extends BaseAPI {
      * @throws {RequiredError}
      */
     createCustomerChatChannel(requestParameters: CustomersApiCreateCustomerChatChannelRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrderChatChannel200Response, any, {}>>;
+    /**
+     * Create a data deletion request for a customer
+     * @summary Create data deletion request
+     * @param {CustomersApiCreateCustomerDataDeletionRequestRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCustomerDataDeletionRequest(requestParameters: CustomersApiCreateCustomerDataDeletionRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataDeletionRequest, any, {}>>;
     /**
      * Export customers as a CSV file
      * @summary Export customers
@@ -1531,6 +1706,14 @@ export declare class CustomersApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getCustomer(requestParameters: CustomersApiGetCustomerRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Customer, any, {}>>;
+    /**
+     * Get a data deletion request for a customer
+     * @summary Get data deletion request
+     * @param {CustomersApiGetCustomerDataDeletionRequestRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCustomerDataDeletionRequest(requestParameters: CustomersApiGetCustomerDataDeletionRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataDeletionRequest, any, {}>>;
     /**
      * List customer tags
      * @summary List customer tags
@@ -1547,6 +1730,14 @@ export declare class CustomersApi extends BaseAPI {
      * @throws {RequiredError}
      */
     listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CustomersResponse, any, {}>>;
+    /**
+     *
+     * @summary Update the customer with the given customer ID
+     * @param {CustomersApiUpdateCustomerRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateCustomer(requestParameters: CustomersApiUpdateCustomerRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Customer, any, {}>>;
 }
 export declare const ExportCustomersSortByEnum: {
     readonly LifetimeValue: "+lifetimeValue";