asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

fix: overlapping branch names for generated PRs of references (#2097)

Browse Source 
* fix overlapping branch names of generated references

* regenerate references
This commit is contained in:
Shahed Nasser
2022-08-25 17:47:58 +03:00
committed by GitHub
parent f7a63f1782
commit a8293af8e1
353 changed files with 5590 additions and 3821 deletions
Download Patch File Download Diff File Expand all files Collapse all files

78
docs/content/references/services/classes/ShippingOptionService.md
View File

@@ -4,7 +4,7 @@ Provides layer to manipulate profiles.
## Hierarchy
- `TransactionBaseService`<[`ShippingOptionService`](ShippingOptionService.md)\>
- `TransactionBaseService`
↳ **`ShippingOptionService`**
@@ -22,39 +22,39 @@ Provides layer to manipulate profiles.
#### Overrides
TransactionBaseService&lt;ShippingOptionService\&gt;.constructor
TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/shipping-option.ts:39](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L39)
[packages/medusa/src/services/shipping-option.ts:39](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/shipping-option.ts#L39)
## Properties
### configModule
### \_\_configModule\_\_
• `Protected` `Optional` `Readonly` **configModule**: `Record`<`string`, `unknown`\>
• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\>
#### Inherited from
TransactionBaseService.configModule
TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
### container
### \_\_container\_\_
• `Protected` `Readonly` **container**: `unknown`
• `Protected` `Readonly` **\_\_container\_\_**: `any`
#### Inherited from
TransactionBaseService.container
TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -68,7 +68,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/shipping-option.ts:36](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L36)
[packages/medusa/src/services/shipping-option.ts:36](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/shipping-option.ts#L36)
___
@@ -78,7 +78,7 @@ ___
#### Defined in
[packages/medusa/src/services/shipping-option.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L34)
[packages/medusa/src/services/shipping-option.ts:34](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/shipping-option.ts#L34)
___
@@ -88,7 +88,7 @@ ___
#### Defined in
[packages/medusa/src/services/shipping-option.ts:33](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L33)
[packages/medusa/src/services/shipping-option.ts:33](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/shipping-option.ts#L33)
___
@@ -98,7 +98,7 @@ ___
#### Defined in
[packages/medusa/src/services/shipping-option.ts:30](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L30)
[packages/medusa/src/services/shipping-option.ts:30](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/shipping-option.ts#L30)
___
@@ -108,7 +108,7 @@ ___
#### Defined in
[packages/medusa/src/services/shipping-option.ts:31](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L31)
[packages/medusa/src/services/shipping-option.ts:31](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/shipping-option.ts#L31)
___
@@ -118,7 +118,7 @@ ___
#### Defined in
[packages/medusa/src/services/shipping-option.ts:32](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L32)
[packages/medusa/src/services/shipping-option.ts:32](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/shipping-option.ts#L32)
___
@@ -132,7 +132,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/shipping-option.ts:37](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L37)
[packages/medusa/src/services/shipping-option.ts:37](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/shipping-option.ts#L37)
## Methods
@@ -158,7 +158,7 @@ the result of update
#### Defined in
[packages/medusa/src/services/shipping-option.ts:623](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L623)
[packages/medusa/src/services/shipping-option.ts:620](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/shipping-option.ts#L620)
___
@@ -197,7 +197,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -223,7 +223,7 @@ the result of the create operation
#### Defined in
[packages/medusa/src/services/shipping-option.ts:380](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L380)
[packages/medusa/src/services/shipping-option.ts:380](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/shipping-option.ts#L380)
___
@@ -238,7 +238,7 @@ Creates a shipping method for a given cart.
| Name | Type | Description |
| :------ | :------ | :------ |
| `optionId` | `string` | the id of the option to use for the method. |
| `data` | `object` | the optional provider data to use. |
| `data` | `Record`<`string`, `unknown`\> | the optional provider data to use. |
| `config` | `CreateShippingMethodDto` | the cart to create the shipping method for. |
#### Returns
@@ -249,7 +249,7 @@ the resulting shipping method.
#### Defined in
[packages/medusa/src/services/shipping-option.ts:253](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L253)
[packages/medusa/src/services/shipping-option.ts:253](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/shipping-option.ts#L253)
___
@@ -273,7 +273,7 @@ the result of the delete operation.
#### Defined in
[packages/medusa/src/services/shipping-option.ts:601](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L601)
[packages/medusa/src/services/shipping-option.ts:598](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/shipping-option.ts#L598)
___
@@ -297,7 +297,7 @@ removed shipping methods
#### Defined in
[packages/medusa/src/services/shipping-option.ts:233](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L233)
[packages/medusa/src/services/shipping-option.ts:233](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/shipping-option.ts#L233)
___
@@ -314,8 +314,8 @@ price type "calculated".
| Name | Type | Description |
| :------ | :------ | :------ |
| `option` | `ShippingOption` | the shipping option to retrieve the price for. |
| `data` | `object` | the shipping data to retrieve the price. |
| `cart` | `undefined` \| `Order` \| `Cart` | the context in which the price should be retrieved. |
| `data` | `Record`<`string`, `unknown`\> | the shipping data to retrieve the price. |
| `cart` | `undefined` \| `Cart` \| `Order` | the context in which the price should be retrieved. |
#### Returns
@@ -325,7 +325,7 @@ the price of the shipping option.
#### Defined in
[packages/medusa/src/services/shipping-option.ts:682](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L682)
[packages/medusa/src/services/shipping-option.ts:679](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/shipping-option.ts#L679)
___
@@ -348,7 +348,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/shipping-option.ts:130](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L130)
[packages/medusa/src/services/shipping-option.ts:130](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/shipping-option.ts#L130)
___
@@ -371,7 +371,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/shipping-option.ts:146](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L146)
[packages/medusa/src/services/shipping-option.ts:146](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/shipping-option.ts#L146)
___
@@ -395,7 +395,7 @@ the result of update
#### Defined in
[packages/medusa/src/services/shipping-option.ts:652](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L652)
[packages/medusa/src/services/shipping-option.ts:649](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/shipping-option.ts#L649)
___
@@ -423,7 +423,7 @@ the profile document.
#### Defined in
[packages/medusa/src/services/shipping-option.ts:164](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L164)
[packages/medusa/src/services/shipping-option.ts:164](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/shipping-option.ts#L164)
___
@@ -447,7 +447,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -474,7 +474,7 @@ resolves to the update result.
#### Defined in
[packages/medusa/src/services/shipping-option.ts:494](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L494)
[packages/medusa/src/services/shipping-option.ts:494](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/shipping-option.ts#L494)
___
@@ -500,7 +500,7 @@ the resulting shipping method
#### Defined in
[packages/medusa/src/services/shipping-option.ts:204](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L204)
[packages/medusa/src/services/shipping-option.ts:204](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/shipping-option.ts#L204)
___
@@ -527,7 +527,7 @@ the validated shipping option
#### Defined in
[packages/medusa/src/services/shipping-option.ts:331](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L331)
[packages/medusa/src/services/shipping-option.ts:331](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/shipping-option.ts#L331)
___
@@ -552,7 +552,7 @@ the validated price
#### Defined in
[packages/medusa/src/services/shipping-option.ts:458](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L458)
[packages/medusa/src/services/shipping-option.ts:458](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/shipping-option.ts#L458)
___
@@ -577,7 +577,7 @@ a validated shipping requirement
#### Defined in
[packages/medusa/src/services/shipping-option.ts:64](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L64)
[packages/medusa/src/services/shipping-option.ts:64](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/shipping-option.ts#L64)
___
@@ -601,4 +601,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/interfaces/transaction-base-service.ts#L13)