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

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-02-09 19:55:08 +02:00
committed by GitHub
co-authored by olivermrbl
parent eee9283818
commit 91234c14b5
58 changed files with 2472 additions and 1445 deletions
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/order.ts:129](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L129)
[packages/medusa/src/services/order.ts:129](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L129)
## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
@@ -52,7 +52,21 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
### \_\_moduleDeclaration\_\_
`Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: `Record`<`string`, `unknown`\>
#### Inherited from
TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/interfaces/transaction-base-service.ts#L11)
___
@@ -62,7 +76,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:121](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L121)
[packages/medusa/src/services/order.ts:121](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L121)
___
@@ -72,7 +86,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:120](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L120)
[packages/medusa/src/services/order.ts:120](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L120)
___
@@ -82,7 +96,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:108](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L108)
[packages/medusa/src/services/order.ts:108](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L108)
___
@@ -92,7 +106,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:112](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L112)
[packages/medusa/src/services/order.ts:112](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L112)
___
@@ -102,7 +116,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:123](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L123)
[packages/medusa/src/services/order.ts:123](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L123)
___
@@ -112,7 +126,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:124](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L124)
[packages/medusa/src/services/order.ts:124](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L124)
___
@@ -122,7 +136,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:125](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L125)
[packages/medusa/src/services/order.ts:125](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L125)
___
@@ -132,7 +146,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:113](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L113)
[packages/medusa/src/services/order.ts:113](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L113)
___
@@ -142,7 +156,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:114](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L114)
[packages/medusa/src/services/order.ts:114](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L114)
___
@@ -152,7 +166,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:122](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L122)
[packages/medusa/src/services/order.ts:122](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L122)
___
@@ -162,7 +176,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:115](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L115)
[packages/medusa/src/services/order.ts:115](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L115)
___
@@ -176,7 +190,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/order.ts:104](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L104)
[packages/medusa/src/services/order.ts:104](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L104)
___
@@ -186,7 +200,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:117](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L117)
[packages/medusa/src/services/order.ts:117](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L117)
___
@@ -196,7 +210,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:107](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L107)
[packages/medusa/src/services/order.ts:107](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L107)
___
@@ -206,7 +220,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:109](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L109)
[packages/medusa/src/services/order.ts:109](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L109)
___
@@ -216,7 +230,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:127](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L127)
[packages/medusa/src/services/order.ts:127](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L127)
___
@@ -226,7 +240,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:119](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L119)
[packages/medusa/src/services/order.ts:119](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L119)
___
@@ -236,7 +250,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:110](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L110)
[packages/medusa/src/services/order.ts:110](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L110)
___
@@ -246,7 +260,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:111](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L111)
[packages/medusa/src/services/order.ts:111](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L111)
___
@@ -256,7 +270,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:118](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L118)
[packages/medusa/src/services/order.ts:118](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L118)
___
@@ -266,7 +280,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:116](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L116)
[packages/medusa/src/services/order.ts:116](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L116)
___
@@ -280,7 +294,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/order.ts:105](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L105)
[packages/medusa/src/services/order.ts:105](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L105)
___
@@ -311,7 +325,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:85](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L85)
[packages/medusa/src/services/order.ts:85](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L85)
## Methods
@@ -334,7 +348,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:949](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L949)
[packages/medusa/src/services/order.ts:947](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L947)
___
@@ -359,7 +373,7 @@ the result of the update operation
#### Defined in
[packages/medusa/src/services/order.ts:1496](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L1496)
[packages/medusa/src/services/order.ts:1484](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L1484)
___
@@ -398,7 +412,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -424,7 +438,7 @@ result of the update operation.
#### Defined in
[packages/medusa/src/services/order.ts:1101](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L1101)
[packages/medusa/src/services/order.ts:1099](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L1099)
___
@@ -448,7 +462,7 @@ updated order
#### Defined in
[packages/medusa/src/services/order.ts:1433](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L1433)
[packages/medusa/src/services/order.ts:1421](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L1421)
___
@@ -472,7 +486,7 @@ result of the update operation.
#### Defined in
[packages/medusa/src/services/order.ts:1200](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L1200)
[packages/medusa/src/services/order.ts:1188](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L1188)
___
@@ -494,7 +508,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/order.ts:517](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L517)
[packages/medusa/src/services/order.ts:517](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L517)
___
@@ -518,7 +532,7 @@ resolves to the creation result.
#### Defined in
[packages/medusa/src/services/order.ts:545](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L545)
[packages/medusa/src/services/order.ts:545](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L545)
___
@@ -550,7 +564,7 @@ result of the update operation.
#### Defined in
[packages/medusa/src/services/order.ts:1305](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L1305)
[packages/medusa/src/services/order.ts:1293](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L1293)
___
@@ -572,7 +586,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:735](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L735)
[packages/medusa/src/services/order.ts:735](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L735)
___
@@ -601,7 +615,7 @@ the result of the refund operation.
#### Defined in
[packages/medusa/src/services/order.ts:1522](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L1522)
[packages/medusa/src/services/order.ts:1510](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L1510)
___
@@ -632,7 +646,7 @@ the resulting order following the update.
#### Defined in
[packages/medusa/src/services/order.ts:789](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L789)
[packages/medusa/src/services/order.ts:789](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L789)
___
@@ -655,7 +669,7 @@ Calculate and attach the different total fields on the object
#### Defined in
[packages/medusa/src/services/order.ts:1722](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L1722)
[packages/medusa/src/services/order.ts:1710](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L1710)
___
@@ -676,7 +690,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:1588](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L1588)
[packages/medusa/src/services/order.ts:1576](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L1576)
___
@@ -702,7 +716,7 @@ the line items generated by the transformer.
#### Defined in
[packages/medusa/src/services/order.ts:1475](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L1475)
[packages/medusa/src/services/order.ts:1463](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L1463)
___
@@ -722,7 +736,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:1948](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L1948)
[packages/medusa/src/services/order.ts:1936](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L1936)
___
@@ -745,7 +759,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/order.ts:183](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L183)
[packages/medusa/src/services/order.ts:183](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L183)
___
@@ -768,7 +782,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/order.ts:200](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L200)
[packages/medusa/src/services/order.ts:200](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L200)
___
@@ -800,7 +814,7 @@ the result of the update operation
#### Defined in
[packages/medusa/src/services/order.ts:1873](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L1873)
[packages/medusa/src/services/order.ts:1861](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L1861)
___
@@ -825,7 +839,7 @@ the order document
#### Defined in
[packages/medusa/src/services/order.ts:343](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L343)
[packages/medusa/src/services/order.ts:343](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L343)
___
@@ -850,7 +864,7 @@ the order document
#### Defined in
[packages/medusa/src/services/order.ts:439](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L439)
[packages/medusa/src/services/order.ts:439](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L439)
___
@@ -875,7 +889,7 @@ the order document
#### Defined in
[packages/medusa/src/services/order.ts:480](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L480)
[packages/medusa/src/services/order.ts:480](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L480)
___
@@ -896,7 +910,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:384](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L384)
[packages/medusa/src/services/order.ts:384](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L384)
___
@@ -918,7 +932,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:422](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L422)
[packages/medusa/src/services/order.ts:422](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L422)
___
@@ -942,7 +956,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -968,7 +982,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:267](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L267)
[packages/medusa/src/services/order.ts:267](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L267)
___
@@ -995,7 +1009,7 @@ resolves to the update result.
#### Defined in
[packages/medusa/src/services/order.ts:1012](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L1012)
[packages/medusa/src/services/order.ts:1010](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L1010)
___
@@ -1020,7 +1034,7 @@ the result of the update operation
#### Defined in
[packages/medusa/src/services/order.ts:877](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L877)
[packages/medusa/src/services/order.ts:877](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L877)
___
@@ -1045,7 +1059,7 @@ the result of the update operation
#### Defined in
[packages/medusa/src/services/order.ts:917](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L917)
[packages/medusa/src/services/order.ts:916](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L916)
___
@@ -1074,7 +1088,7 @@ a line item that has the requested fulfillment quantity
#### Defined in
[packages/medusa/src/services/order.ts:1272](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L1272)
[packages/medusa/src/services/order.ts:1260](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/order.ts#L1260)
___
@@ -1098,4 +1112,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/interfaces/transaction-base-service.ts#L14)