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

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2022-09-14 13:26:03 +03:00
committed by GitHub
parent 3efeb6b84f
commit fbdcb78066
45 changed files with 1441 additions and 1080 deletions

View File

@@ -18,7 +18,7 @@ Provides layer to manipulate profiles.
| Name | Type |
| :------ | :------ |
| `__namedParameters` | `Object` |
| `__namedParameters` | `InjectedDependencies` |
#### Overrides
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/shipping-option.ts:39](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/shipping-option.ts#L39)
[packages/medusa/src/services/shipping-option.ts:52](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/shipping-option.ts#L52)
## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
@@ -54,7 +54,17 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
### featureFlagRouter\_
`Protected` `Readonly` **featureFlagRouter\_**: `FlagRouter`
#### Defined in
[packages/medusa/src/services/shipping-option.ts:47](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/shipping-option.ts#L47)
___
@@ -68,7 +78,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/shipping-option.ts:36](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/shipping-option.ts#L36)
[packages/medusa/src/services/shipping-option.ts:49](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/shipping-option.ts#L49)
___
@@ -78,7 +88,7 @@ ___
#### Defined in
[packages/medusa/src/services/shipping-option.ts:34](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/shipping-option.ts#L34)
[packages/medusa/src/services/shipping-option.ts:46](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/shipping-option.ts#L46)
___
@@ -88,7 +98,7 @@ ___
#### Defined in
[packages/medusa/src/services/shipping-option.ts:33](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/shipping-option.ts#L33)
[packages/medusa/src/services/shipping-option.ts:45](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/shipping-option.ts#L45)
___
@@ -98,7 +108,7 @@ ___
#### Defined in
[packages/medusa/src/services/shipping-option.ts:30](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/shipping-option.ts#L30)
[packages/medusa/src/services/shipping-option.ts:42](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/shipping-option.ts#L42)
___
@@ -108,7 +118,7 @@ ___
#### Defined in
[packages/medusa/src/services/shipping-option.ts:31](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/shipping-option.ts#L31)
[packages/medusa/src/services/shipping-option.ts:43](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/shipping-option.ts#L43)
___
@@ -118,7 +128,7 @@ ___
#### Defined in
[packages/medusa/src/services/shipping-option.ts:32](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/shipping-option.ts#L32)
[packages/medusa/src/services/shipping-option.ts:44](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/shipping-option.ts#L44)
___
@@ -132,7 +142,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/shipping-option.ts:37](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/shipping-option.ts#L37)
[packages/medusa/src/services/shipping-option.ts:50](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/shipping-option.ts#L50)
## Methods
@@ -158,7 +168,7 @@ the result of update
#### Defined in
[packages/medusa/src/services/shipping-option.ts:620](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/shipping-option.ts#L620)
[packages/medusa/src/services/shipping-option.ts:665](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/shipping-option.ts#L665)
___
@@ -197,7 +207,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -223,7 +233,7 @@ the result of the create operation
#### Defined in
[packages/medusa/src/services/shipping-option.ts:380](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/shipping-option.ts#L380)
[packages/medusa/src/services/shipping-option.ts:405](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/shipping-option.ts#L405)
___
@@ -249,7 +259,7 @@ the resulting shipping method.
#### Defined in
[packages/medusa/src/services/shipping-option.ts:253](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/shipping-option.ts#L253)
[packages/medusa/src/services/shipping-option.ts:268](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/shipping-option.ts#L268)
___
@@ -273,7 +283,7 @@ the result of the delete operation.
#### Defined in
[packages/medusa/src/services/shipping-option.ts:598](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/shipping-option.ts#L598)
[packages/medusa/src/services/shipping-option.ts:643](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/shipping-option.ts#L643)
___
@@ -297,7 +307,7 @@ removed shipping methods
#### Defined in
[packages/medusa/src/services/shipping-option.ts:233](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/shipping-option.ts#L233)
[packages/medusa/src/services/shipping-option.ts:248](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/shipping-option.ts#L248)
___
@@ -325,7 +335,7 @@ the price of the shipping option.
#### Defined in
[packages/medusa/src/services/shipping-option.ts:679](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/shipping-option.ts#L679)
[packages/medusa/src/services/shipping-option.ts:724](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/shipping-option.ts#L724)
___
@@ -348,7 +358,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/shipping-option.ts:130](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/shipping-option.ts#L130)
[packages/medusa/src/services/shipping-option.ts:145](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/shipping-option.ts#L145)
___
@@ -371,7 +381,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/shipping-option.ts:146](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/shipping-option.ts#L146)
[packages/medusa/src/services/shipping-option.ts:161](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/shipping-option.ts#L161)
___
@@ -395,7 +405,7 @@ the result of update
#### Defined in
[packages/medusa/src/services/shipping-option.ts:649](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/shipping-option.ts#L649)
[packages/medusa/src/services/shipping-option.ts:694](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/shipping-option.ts#L694)
___
@@ -423,7 +433,7 @@ the profile document.
#### Defined in
[packages/medusa/src/services/shipping-option.ts:164](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/shipping-option.ts#L164)
[packages/medusa/src/services/shipping-option.ts:179](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/shipping-option.ts#L179)
___
@@ -447,7 +457,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -474,7 +484,7 @@ resolves to the update result.
#### Defined in
[packages/medusa/src/services/shipping-option.ts:494](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/shipping-option.ts#L494)
[packages/medusa/src/services/shipping-option.ts:529](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/shipping-option.ts#L529)
___
@@ -500,7 +510,7 @@ the resulting shipping method
#### Defined in
[packages/medusa/src/services/shipping-option.ts:204](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/shipping-option.ts#L204)
[packages/medusa/src/services/shipping-option.ts:219](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/shipping-option.ts#L219)
___
@@ -527,7 +537,7 @@ the validated shipping option
#### Defined in
[packages/medusa/src/services/shipping-option.ts:331](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/shipping-option.ts#L331)
[packages/medusa/src/services/shipping-option.ts:356](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/shipping-option.ts#L356)
___
@@ -552,7 +562,7 @@ the validated price
#### Defined in
[packages/medusa/src/services/shipping-option.ts:458](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/shipping-option.ts#L458)
[packages/medusa/src/services/shipping-option.ts:493](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/shipping-option.ts#L493)
___
@@ -577,7 +587,7 @@ a validated shipping requirement
#### Defined in
[packages/medusa/src/services/shipping-option.ts:64](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/shipping-option.ts#L64)
[packages/medusa/src/services/shipping-option.ts:79](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/shipping-option.ts#L79)
___
@@ -601,4 +611,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/interfaces/transaction-base-service.ts#L13)