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

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

Browse Source 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-03-13 18:29:42 +00:00
committed by GitHub
parent a5582b93b8
commit 9ceddf45a9
58 changed files with 1496 additions and 1463 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
docs/content/references/services/classes/CustomShippingOptionService.md
View File

@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/custom-shipping-option.ts:20](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/custom-shipping-option.ts#L20)
[packages/medusa/src/services/custom-shipping-option.ts:20](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/custom-shipping-option.ts#L20)
## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/interfaces/transaction-base-service.ts#L11)
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/interfaces/transaction-base-service.ts#L11)
___
@@ -76,7 +76,7 @@ ___
#### Defined in
[packages/medusa/src/services/custom-shipping-option.ts:18](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/custom-shipping-option.ts#L18)
[packages/medusa/src/services/custom-shipping-option.ts:18](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/custom-shipping-option.ts#L18)
___
@@ -90,7 +90,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/custom-shipping-option.ts:15](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/custom-shipping-option.ts#L15)
[packages/medusa/src/services/custom-shipping-option.ts:15](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/custom-shipping-option.ts#L15)
___
@@ -104,7 +104,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/custom-shipping-option.ts:16](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/custom-shipping-option.ts#L16)
[packages/medusa/src/services/custom-shipping-option.ts:16](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/custom-shipping-option.ts#L16)
## Methods
@@ -143,31 +143,38 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
### create
▸ **create**(`data`): `Promise`<`CustomShippingOption`\>
▸ **create**<`T`, `TResult`\>(`data`): `Promise`<`TResult`\>
Creates a custom shipping option
#### Type parameters
| Name | Type |
| :------ | :------ |
| `T` | `CreateCustomShippingOptionInput` \| `CreateCustomShippingOptionInput`[] |
| `TResult` | `T` extends `CreateCustomShippingOptionInput`[] ? `CustomShippingOption`[] : `CustomShippingOption` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `data` | `CreateCustomShippingOptionInput` | the custom shipping option to create |
| `data` | `T` | the custom shipping option to create |
#### Returns
`Promise`<`CustomShippingOption`\>
`Promise`<`TResult`\>
resolves to the creation result
#### Defined in
[packages/medusa/src/services/custom-shipping-option.ts:89](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/custom-shipping-option.ts#L89)
[packages/medusa/src/services/custom-shipping-option.ts:89](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/custom-shipping-option.ts#L89)
___
@@ -192,7 +199,7 @@ custom shipping options matching the query
#### Defined in
[packages/medusa/src/services/custom-shipping-option.ts:65](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/custom-shipping-option.ts#L65)
[packages/medusa/src/services/custom-shipping-option.ts:65](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/custom-shipping-option.ts#L65)
___
@@ -217,7 +224,7 @@ the requested custom shipping option.
#### Defined in
[packages/medusa/src/services/custom-shipping-option.ts:37](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/custom-shipping-option.ts#L37)
[packages/medusa/src/services/custom-shipping-option.ts:37](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/custom-shipping-option.ts#L37)
___
@@ -241,7 +248,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -265,4 +272,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/interfaces/transaction-base-service.ts#L14)