@medusajs/core-flows/dist/customer/workflows/delete-addresses.d.ts

Set of workflow definitions for Medusa

import { WorkflowData } from "@medusajs/framework/workflows-sdk";
/**
 * The details of the addresses to delete.
 */
export type DeleteCustomerAddressesWorkflowInput = {
    /**
     * The IDs of the addresses to delete.
     */
    ids: string[];
};
export declare const deleteCustomerAddressesWorkflowId = "delete-customer-addresses";
/**
 * This workflow deletes one or more customer addresses. It's used by the
 * [Remove Customer Addresses Admin API Route](https://docs.medusajs.com/api/admin#customers_deletecustomersidaddressesaddress_id)
 * and the [Remove Customer Addresses Store API Route](https://docs.medusajs.com/api/store#customers_deletecustomersmeaddressesaddress_id).
 *
 * :::note
 *
 * This workflow deletes addresses created by the [Customer Module](https://docs.medusajs.com/resources/commerce-modules/customer)
 * only. So, you can't delete addresses attached to a cart, for example. To do that, use the workflow
 * relevant to that module.
 *
 * :::
 *
 * You can use this workflow within your customizations or your own custom workflows, allowing you to
 * delete customer addresses in your custom flows.
 *
 * @example
 * const { result } = await deleteCustomerAddressesWorkflow(container)
 * .run({
 *   input: {
 *     ids: [
 *       "cuaddress_123"
 *     ]
 *   }
 * })
 *
 * @summary
 *
 * Delete one or more customer addresses.
 *
 * @property hooks.addressesDeleted - This hook is executed after the addresses are deleted. You can consume this hook to perform custom actions.
 */
export declare const deleteCustomerAddressesWorkflow: import("@medusajs/framework/workflows-sdk").ReturnWorkflow<DeleteCustomerAddressesWorkflowInput, never, [import("@medusajs/framework/workflows-sdk").Hook<"addressesDeleted", {
    ids: (string[] | WorkflowData<string[]>) & string[];
}, unknown>]>;
//# sourceMappingURL=delete-addresses.d.ts.map