Files
medusa-store/www/apps/docs/content/references/services/classes/DiscountConditionService.mdx
github-actions[bot] 39649b3552 chore(docs): Generated References (#5602)
Generated the following references:
- `pricing`
- `product`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2023-11-10 17:31:02 +00:00

471 lines
11 KiB
Plaintext

---
displayed_sidebar: servicesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# DiscountConditionService
Provides layer to manipulate discount conditions.
#### Implements
## Constructors
### constructor
**new DiscountConditionService**(`«destructured»`)
#### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "[`InjectedDependencies`](../types/InjectedDependencies-8.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "Record<`string`, `unknown`\\>",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "Record<`string`, `unknown`\\>",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "discountConditionRepository_",
"type": "`Repository`<[`DiscountCondition`](DiscountCondition.mdx)\\> & { `addConditionResources`: Method addConditionResources ; `canApplyForCustomer`: Method canApplyForCustomer ; `findOneWithDiscount`: Method findOneWithDiscount ; `getJoinTableResourceIdentifiers`: Method getJoinTableResourceIdentifiers ; `isValidForProduct`: Method isValidForProduct ; `queryConditionTable`: Method queryConditionTable ; `removeConditionResources`: Method removeConditionResources }",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "eventBus_",
"type": "[`EventBusService`](EventBusService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
## Accessors
### activeManager\_
`Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
## Methods
### atomicPhase\_
`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => `Promise`<`TResult`\\>",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
`Promise`<`TResult`\>
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`TResult`\\>",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
___
### delete
**delete**(`discountConditionId`): `Promise`<`void` \| [`DiscountCondition`](DiscountCondition.mdx)\>
#### Parameters
<ParameterTypes parameters={[
{
"name": "discountConditionId",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
`Promise`<`void` \| [`DiscountCondition`](DiscountCondition.mdx)\>
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void` \\| [`DiscountCondition`](DiscountCondition.mdx)\\>",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### removeResources
**removeResources**(`data`): `Promise`<`void`\>
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`Omit`](../types/Omit.mdx)<[`DiscountConditionInput`](../types/DiscountConditionInput.mdx), ``\"id\"``\\> & { `id`: `string` }",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
`Promise`<`void`\>
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### retrieve
**retrieve**(`conditionId`, `config?`): `Promise`<[`DiscountCondition`](DiscountCondition.mdx)\>
#### Parameters
<ParameterTypes parameters={[
{
"name": "conditionId",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`DiscountCondition`](DiscountCondition.mdx)\\>",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
`Promise`<[`DiscountCondition`](DiscountCondition.mdx)\>
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`DiscountCondition`](DiscountCondition.mdx)\\>",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### shouldRetryTransaction\_
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "Record<`string`, `unknown`\\> \\| { `code`: `string` }",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
`boolean`
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### upsertCondition
**upsertCondition**(`data`, `overrideExisting?`): `Promise`<([`DiscountConditionProduct`](DiscountConditionProduct.mdx) \| [`DiscountConditionProductType`](DiscountConditionProductType.mdx) \| [`DiscountConditionProductCollection`](DiscountConditionProductCollection.mdx) \| [`DiscountConditionProductTag`](DiscountConditionProductTag.mdx) \| [`DiscountConditionCustomerGroup`](DiscountConditionCustomerGroup.mdx))[]\>
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`DiscountConditionInput`](../types/DiscountConditionInput.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "overrideExisting",
"type": "`boolean`",
"description": "",
"optional": false,
"defaultValue": "true",
"expandable": false,
"children": []
}
]} />
#### Returns
`Promise`<([`DiscountConditionProduct`](DiscountConditionProduct.mdx) \| [`DiscountConditionProductType`](DiscountConditionProductType.mdx) \| [`DiscountConditionProductCollection`](DiscountConditionProductCollection.mdx) \| [`DiscountConditionProductTag`](DiscountConditionProductTag.mdx) \| [`DiscountConditionCustomerGroup`](DiscountConditionCustomerGroup.mdx))[]\>
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<([`DiscountConditionProduct`](DiscountConditionProduct.mdx) \\| [`DiscountConditionProductType`](DiscountConditionProductType.mdx) \\| [`DiscountConditionProductCollection`](DiscountConditionProductCollection.mdx) \\| [`DiscountConditionProductTag`](DiscountConditionProductTag.mdx) \\| [`DiscountConditionCustomerGroup`](DiscountConditionCustomerGroup.mdx))[]\\>",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### withTransaction
**withTransaction**(`transactionManager?`): [`DiscountConditionService`](DiscountConditionService.mdx)
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
[`DiscountConditionService`](DiscountConditionService.mdx)
<ParameterTypes parameters={[
{
"name": "DiscountConditionService",
"type": "[`DiscountConditionService`](DiscountConditionService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### resolveConditionType\_
`Static` `Protected` **resolveConditionType_**(`data`): `undefined` \| { `resource_ids`: (`string` \| { `id`: `string` })[] ; `type`: [`DiscountConditionType`](../enums/DiscountConditionType.mdx) }
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`DiscountConditionInput`](../types/DiscountConditionInput.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
`undefined` \| { `resource_ids`: (`string` \| { `id`: `string` })[] ; `type`: [`DiscountConditionType`](../enums/DiscountConditionType.mdx) }
<ParameterTypes parameters={[
{
"name": "undefined \\| { `resource_ids`: (`string` \\| { `id`: `string` })[] ; `type`: [`DiscountConditionType`](../enums/DiscountConditionType.mdx) }",
"type": "`undefined` \\| { `resource_ids`: (`string` \\| { `id`: `string` })[] ; `type`: [`DiscountConditionType`](../enums/DiscountConditionType.mdx) }",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />