chore(docs): Generated Services Reference (automated) (#5333)

Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
github-actions[bot]
2023-10-09 19:57:05 +03:00
committed by GitHub
co-authored by shahednasser Shahed Nasser
parent 431782d023
commit 074055acbb
58 changed files with 1975 additions and 1840 deletions
@@ -10,13 +10,13 @@
### constructor
**new LineItemService**(`__namedParameters`)
**new LineItemService**(`«destructured»`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `__namedParameters` | `InjectedDependencies` |
| `«destructured»` | `InjectedDependencies` |
#### Overrides
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in
[medusa/src/services/line-item.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L56)
[medusa/src/services/line-item.ts:57](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L57)
## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___
@@ -76,7 +76,7 @@ ___
#### Defined in
[medusa/src/services/line-item.ts:47](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L47)
[medusa/src/services/line-item.ts:48](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L48)
___
@@ -86,7 +86,7 @@ ___
#### Defined in
[medusa/src/services/line-item.ts:52](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L52)
[medusa/src/services/line-item.ts:53](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L53)
___
@@ -96,7 +96,7 @@ ___
#### Defined in
[medusa/src/services/line-item.ts:46](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L46)
[medusa/src/services/line-item.ts:47](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L47)
___
@@ -106,7 +106,7 @@ ___
#### Defined in
[medusa/src/services/line-item.ts:53](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L53)
[medusa/src/services/line-item.ts:54](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L54)
___
@@ -116,7 +116,7 @@ ___
#### Defined in
[medusa/src/services/line-item.ts:45](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L45)
[medusa/src/services/line-item.ts:46](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L46)
___
@@ -130,7 +130,7 @@ TransactionBaseService.manager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___
@@ -140,7 +140,7 @@ ___
#### Defined in
[medusa/src/services/line-item.ts:50](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L50)
[medusa/src/services/line-item.ts:51](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L51)
___
@@ -150,7 +150,7 @@ ___
#### Defined in
[medusa/src/services/line-item.ts:49](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L49)
[medusa/src/services/line-item.ts:50](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L50)
___
@@ -160,7 +160,7 @@ ___
#### Defined in
[medusa/src/services/line-item.ts:48](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L48)
[medusa/src/services/line-item.ts:49](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L49)
___
@@ -170,7 +170,7 @@ ___
#### Defined in
[medusa/src/services/line-item.ts:51](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L51)
[medusa/src/services/line-item.ts:52](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L52)
___
@@ -180,7 +180,7 @@ ___
#### Defined in
[medusa/src/services/line-item.ts:54](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L54)
[medusa/src/services/line-item.ts:55](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L55)
___
@@ -194,7 +194,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors
@@ -212,7 +212,7 @@ TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods
@@ -251,7 +251,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___
@@ -274,7 +274,7 @@ ___
#### Defined in
[medusa/src/services/line-item.ts:514](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L514)
[medusa/src/services/line-item.ts:541](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L541)
___
@@ -305,7 +305,7 @@ the created line item
#### Defined in
[medusa/src/services/line-item.ts:392](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L392)
[medusa/src/services/line-item.ts:421](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L421)
___
@@ -331,7 +331,7 @@ the created line items
#### Defined in
[medusa/src/services/line-item.ts:130](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L130)
[medusa/src/services/line-item.ts:131](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L131)
___
@@ -355,7 +355,7 @@ a new line item tax line
#### Defined in
[medusa/src/services/line-item.ts:506](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L506)
[medusa/src/services/line-item.ts:533](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L533)
___
@@ -379,7 +379,7 @@ the result of the delete operation
#### Defined in
[medusa/src/services/line-item.ts:465](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L465)
[medusa/src/services/line-item.ts:494](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L494)
___
@@ -387,11 +387,6 @@ ___
▸ **deleteWithTaxLines**(`id`): `Promise`<`undefined` \| ``null`` \| `LineItem`\>
**`Deprecated`**
no the cascade on the entity takes care of it
Deletes a line item with the tax lines.
#### Parameters
| Name | Type | Description |
@@ -404,9 +399,14 @@ Deletes a line item with the tax lines.
the result of the delete operation
**`Deprecated`**
no the cascade on the entity takes care of it
Deletes a line item with the tax lines.
#### Defined in
[medusa/src/services/line-item.ts:485](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L485)
[medusa/src/services/line-item.ts:516](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L516)
___
@@ -438,7 +438,7 @@ Generate a single or multiple line item without persisting the data into the db
#### Defined in
[medusa/src/services/line-item.ts:191](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L191)
[medusa/src/services/line-item.ts:192](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L192)
___
@@ -468,7 +468,7 @@ ___
#### Defined in
[medusa/src/services/line-item.ts:316](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L316)
[medusa/src/services/line-item.ts:337](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L337)
___
@@ -489,7 +489,7 @@ ___
#### Defined in
[medusa/src/services/line-item.ts:83](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L83)
[medusa/src/services/line-item.ts:84](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L84)
___
@@ -514,7 +514,7 @@ the line item
#### Defined in
[medusa/src/services/line-item.ts:104](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L104)
[medusa/src/services/line-item.ts:105](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L105)
___
@@ -538,7 +538,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___
@@ -563,7 +563,7 @@ the updated line item(s)
#### Defined in
[medusa/src/services/line-item.ts:422](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L422)
[medusa/src/services/line-item.ts:451](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L451)
___
@@ -592,7 +592,7 @@ ___
#### Defined in
[medusa/src/services/line-item.ts:585](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L585)
[medusa/src/services/line-item.ts:612](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L612)
___
@@ -616,4 +616,4 @@ TransactionBaseService.withTransaction
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)