892d737c1f
* adjusted configurations * enhancements to tool and configurations * change reference in docs * fixed issue in workflows reference * added project name * more optimizations * fix context error * added a types reference * resolved missing types * fix reference reflection types not having children * add an expand url parameter * added new option to the README * added details about new option
116 lines
3.2 KiB
Plaintext
116 lines
3.2 KiB
Plaintext
---
|
|
displayed_sidebar: pricingReference
|
|
badge:
|
|
variant: orange
|
|
text: Beta
|
|
slug: /references/pricing/deleteMoneyAmounts
|
|
sidebar_label: deleteMoneyAmounts
|
|
---
|
|
|
|
import ParameterTypes from "@site/src/components/ParameterTypes"
|
|
|
|
# deleteMoneyAmounts - Pricing Module Reference
|
|
|
|
This documentation provides a reference to the `deleteMoneyAmounts` method. This belongs to the Pricing Module.
|
|
|
|
This method deletes money amounts by their IDs.
|
|
|
|
## Example
|
|
|
|
```ts
|
|
import {
|
|
initialize as initializePricingModule,
|
|
} from "@medusajs/pricing"
|
|
|
|
async function deleteMoneyAmounts (moneyAmountIds: string[]) {
|
|
const pricingService = await initializePricingModule()
|
|
|
|
await pricingService.deleteMoneyAmounts(
|
|
moneyAmountIds
|
|
)
|
|
}
|
|
```
|
|
|
|
## Parameters
|
|
|
|
<ParameterTypes parameters={[
|
|
{
|
|
"name": "ids",
|
|
"type": "`string`[]",
|
|
"description": "The IDs of the money amounts to delete.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "sharedContext",
|
|
"type": "[Context](../../pricing/interfaces/pricing.Context.mdx)",
|
|
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
|
|
"optional": true,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": [
|
|
{
|
|
"name": "enableNestedTransactions",
|
|
"type": "`boolean`",
|
|
"description": "A boolean value indicating whether nested transactions are enabled.",
|
|
"optional": true,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "isolationLevel",
|
|
"type": "`string`",
|
|
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
|
|
"optional": true,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "manager",
|
|
"type": "`TManager`",
|
|
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
|
|
"optional": true,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "transactionId",
|
|
"type": "`string`",
|
|
"description": "A string indicating the ID of the current transaction.",
|
|
"optional": true,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "transactionManager",
|
|
"type": "`TManager`",
|
|
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
|
|
"optional": true,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
}
|
|
]
|
|
}
|
|
]} />
|
|
|
|
## Returns
|
|
|
|
<ParameterTypes parameters={[
|
|
{
|
|
"name": "Promise",
|
|
"type": "Promise<void>",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"description": "Resolves when the money amounts are successfully deleted.",
|
|
"expandable": false,
|
|
"children": []
|
|
}
|
|
]} />
|