chore(docs): Generated Services Reference (automated) (#3227)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
co-authored by
olivermrbl
olivermrbl
parent
eee9283818
commit
91234c14b5
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:55](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L55)
|
||||
[packages/medusa/src/services/shipping-option.ts:55](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/shipping-option.ts#L55)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -40,7 +40,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)
|
||||
|
||||
___
|
||||
|
||||
@@ -54,7 +54,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)
|
||||
|
||||
___
|
||||
|
||||
@@ -64,7 +78,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:50](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L50)
|
||||
[packages/medusa/src/services/shipping-option.ts:50](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/shipping-option.ts#L50)
|
||||
|
||||
___
|
||||
|
||||
@@ -78,7 +92,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:52](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L52)
|
||||
[packages/medusa/src/services/shipping-option.ts:52](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/shipping-option.ts#L52)
|
||||
|
||||
___
|
||||
|
||||
@@ -88,7 +102,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:49](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L49)
|
||||
[packages/medusa/src/services/shipping-option.ts:49](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/shipping-option.ts#L49)
|
||||
|
||||
___
|
||||
|
||||
@@ -98,7 +112,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L48)
|
||||
[packages/medusa/src/services/shipping-option.ts:48](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/shipping-option.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -108,7 +122,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:44](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L44)
|
||||
[packages/medusa/src/services/shipping-option.ts:44](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/shipping-option.ts#L44)
|
||||
|
||||
___
|
||||
|
||||
@@ -118,7 +132,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:45](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L45)
|
||||
[packages/medusa/src/services/shipping-option.ts:45](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/shipping-option.ts#L45)
|
||||
|
||||
___
|
||||
|
||||
@@ -128,7 +142,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:47](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L47)
|
||||
[packages/medusa/src/services/shipping-option.ts:47](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/shipping-option.ts#L47)
|
||||
|
||||
___
|
||||
|
||||
@@ -142,7 +156,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:53](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L53)
|
||||
[packages/medusa/src/services/shipping-option.ts:53](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/shipping-option.ts#L53)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -168,7 +182,7 @@ the result of update
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:709](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L709)
|
||||
[packages/medusa/src/services/shipping-option.ts:713](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/shipping-option.ts#L713)
|
||||
|
||||
___
|
||||
|
||||
@@ -207,7 +221,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)
|
||||
|
||||
___
|
||||
|
||||
@@ -233,7 +247,7 @@ the result of the create operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:451](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L451)
|
||||
[packages/medusa/src/services/shipping-option.ts:451](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/shipping-option.ts#L451)
|
||||
|
||||
___
|
||||
|
||||
@@ -259,7 +273,7 @@ the resulting shipping method.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:278](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L278)
|
||||
[packages/medusa/src/services/shipping-option.ts:278](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/shipping-option.ts#L278)
|
||||
|
||||
___
|
||||
|
||||
@@ -283,7 +297,7 @@ the result of the delete operation.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:687](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L687)
|
||||
[packages/medusa/src/services/shipping-option.ts:691](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/shipping-option.ts#L691)
|
||||
|
||||
___
|
||||
|
||||
@@ -307,7 +321,7 @@ removed shipping methods
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:258](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L258)
|
||||
[packages/medusa/src/services/shipping-option.ts:258](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/shipping-option.ts#L258)
|
||||
|
||||
___
|
||||
|
||||
@@ -335,7 +349,7 @@ the price of the shipping option.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:768](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L768)
|
||||
[packages/medusa/src/services/shipping-option.ts:791](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/shipping-option.ts#L791)
|
||||
|
||||
___
|
||||
|
||||
@@ -358,7 +372,7 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:148](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L148)
|
||||
[packages/medusa/src/services/shipping-option.ts:148](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/shipping-option.ts#L148)
|
||||
|
||||
___
|
||||
|
||||
@@ -370,7 +384,7 @@ ___
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `selector` | `Selector`<`ShippingMethod`\> | the query object for find |
|
||||
| `selector` | `Selector`<`ShippingOption`\> | the query object for find |
|
||||
| `config` | `FindConfig`<`ShippingOption`\> | config object |
|
||||
|
||||
#### Returns
|
||||
@@ -381,7 +395,7 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:164](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L164)
|
||||
[packages/medusa/src/services/shipping-option.ts:164](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/shipping-option.ts#L164)
|
||||
|
||||
___
|
||||
|
||||
@@ -405,7 +419,7 @@ the result of update
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:738](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L738)
|
||||
[packages/medusa/src/services/shipping-option.ts:742](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/shipping-option.ts#L742)
|
||||
|
||||
___
|
||||
|
||||
@@ -433,7 +447,7 @@ the profile document.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:182](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L182)
|
||||
[packages/medusa/src/services/shipping-option.ts:182](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/shipping-option.ts#L182)
|
||||
|
||||
___
|
||||
|
||||
@@ -457,7 +471,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)
|
||||
|
||||
___
|
||||
|
||||
@@ -484,7 +498,7 @@ resolves to the update result.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:579](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L579)
|
||||
[packages/medusa/src/services/shipping-option.ts:579](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/shipping-option.ts#L579)
|
||||
|
||||
___
|
||||
|
||||
@@ -510,7 +524,30 @@ the resulting shipping method
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:229](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L229)
|
||||
[packages/medusa/src/services/shipping-option.ts:229](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/shipping-option.ts#L229)
|
||||
|
||||
___
|
||||
|
||||
### updateShippingProfile
|
||||
|
||||
▸ **updateShippingProfile**(`optionIds`, `profileId`): `Promise`<`ShippingOption`[]\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `optionIds` | `string` \| `string`[] | ID or IDs of the shipping options to update |
|
||||
| `profileId` | `string` | Shipping profile ID to update the shipping options with |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`ShippingOption`[]\>
|
||||
|
||||
updated shipping options
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:767](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/shipping-option.ts#L767)
|
||||
|
||||
___
|
||||
|
||||
@@ -531,7 +568,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:408](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L408)
|
||||
[packages/medusa/src/services/shipping-option.ts:408](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/shipping-option.ts#L408)
|
||||
|
||||
___
|
||||
|
||||
@@ -558,7 +595,7 @@ the validated shipping option
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:366](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L366)
|
||||
[packages/medusa/src/services/shipping-option.ts:366](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/shipping-option.ts#L366)
|
||||
|
||||
___
|
||||
|
||||
@@ -583,7 +620,7 @@ the validated price
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:539](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L539)
|
||||
[packages/medusa/src/services/shipping-option.ts:539](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/shipping-option.ts#L539)
|
||||
|
||||
___
|
||||
|
||||
@@ -608,7 +645,7 @@ a validated shipping requirement
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:82](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L82)
|
||||
[packages/medusa/src/services/shipping-option.ts:82](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/shipping-option.ts#L82)
|
||||
|
||||
___
|
||||
|
||||
@@ -632,4 +669,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)
|
||||
|
||||
Reference in New Issue
Block a user