asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
522e306e2e9abf4afce63f30714389eba32bef7f
medusa-store/docs/content/references/services/classes/ShippingOptionService.md
github-actions[bot] 9ceddf45a9 chore(docs): Generated Services Reference (automated) (#3465) 
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>
2023-03-13 18:29:42 +00:00

673 lines
17 KiB
Markdown
Raw Blame History

# Class: ShippingOptionService
Provides layer to manipulate profiles.
## Hierarchy
- `TransactionBaseService`
↳ **`ShippingOptionService`**
## Constructors
### constructor
• **new ShippingOptionService**(`__namedParameters`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `__namedParameters` | `InjectedDependencies` |
#### Overrides
TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/shipping-option.ts:55](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/shipping-option.ts#L55)
## Properties
### \_\_configModule\_\_
• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\>
#### Inherited from
TransactionBaseService.\_\_configModule\_\_
#### Defined in
[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)
___
### \_\_container\_\_
• `Protected` `Readonly` **\_\_container\_\_**: `any`
#### Inherited from
TransactionBaseService.\_\_container\_\_
#### Defined in
[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)
___
### \_\_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/77fd361ce/packages/medusa/src/interfaces/transaction-base-service.ts#L11)
___
### featureFlagRouter\_
• `Protected` `Readonly` **featureFlagRouter\_**: `FlagRouter`
#### Defined in
[packages/medusa/src/services/shipping-option.ts:50](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/shipping-option.ts#L50)
___
### manager\_
• `Protected` **manager\_**: `EntityManager`
#### Overrides
TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/shipping-option.ts:52](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/shipping-option.ts#L52)
___
### methodRepository\_
• `Protected` `Readonly` **methodRepository\_**: typeof `ShippingMethodRepository`
#### Defined in
[packages/medusa/src/services/shipping-option.ts:49](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/shipping-option.ts#L49)
___
### optionRepository\_
• `Protected` `Readonly` **optionRepository\_**: typeof `ShippingOptionRepository`
#### Defined in
[packages/medusa/src/services/shipping-option.ts:48](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/shipping-option.ts#L48)
___
### providerService\_
• `Protected` `Readonly` **providerService\_**: [`FulfillmentProviderService`](FulfillmentProviderService.md)
#### Defined in
[packages/medusa/src/services/shipping-option.ts:44](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/shipping-option.ts#L44)
___
### regionService\_
• `Protected` `Readonly` **regionService\_**: [`RegionService`](RegionService.md)
#### Defined in
[packages/medusa/src/services/shipping-option.ts:45](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/shipping-option.ts#L45)
___
### requirementRepository\_
• `Protected` `Readonly` **requirementRepository\_**: typeof `ShippingOptionRequirementRepository`
#### Defined in
[packages/medusa/src/services/shipping-option.ts:47](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/shipping-option.ts#L47)
___
### transactionManager\_
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides
TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/shipping-option.ts:53](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/shipping-option.ts#L53)
## Methods
### addRequirement
▸ **addRequirement**(`optionId`, `requirement`): `Promise`<`ShippingOption`\>
Adds a requirement to a shipping option. Only 1 requirement of each type
is allowed.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `optionId` | `string` | the option to add the requirement to. |
| `requirement` | `ShippingOptionRequirement` | the requirement for the option. |
#### Returns
`Promise`<`ShippingOption`\>
the result of update
#### Defined in
[packages/medusa/src/services/shipping-option.ts:713](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/shipping-option.ts#L713)
___
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
| :------ |
| `TResult` |
| `TError` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[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`<`ShippingOption`\>
Creates a new shipping option. Used both for outbound and inbound shipping
options. The difference is registered by the `is_return` field which
defaults to false.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `data` | `CreateShippingOptionInput` | the data to create shipping options |
#### Returns
`Promise`<`ShippingOption`\>
the result of the create operation
#### Defined in
[packages/medusa/src/services/shipping-option.ts:451](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/shipping-option.ts#L451)
___
### createShippingMethod
▸ **createShippingMethod**(`optionId`, `data`, `config`): `Promise`<`ShippingMethod`\>
Creates a shipping method for a given cart.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `optionId` | `string` | the id of the option to use for the method. |
| `data` | `Record`<`string`, `unknown`\> | the optional provider data to use. |
| `config` | `CreateShippingMethodDto` | the cart to create the shipping method for. |
#### Returns
`Promise`<`ShippingMethod`\>
the resulting shipping method.
#### Defined in
[packages/medusa/src/services/shipping-option.ts:278](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/shipping-option.ts#L278)
___
### delete
▸ **delete**(`optionId`): `Promise`<`void` \| `ShippingOption`\>
Deletes a profile with a given profile id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `optionId` | `string` | the id of the profile to delete. Must be castable as an ObjectId |
#### Returns
`Promise`<`void` \| `ShippingOption`\>
the result of the delete operation.
#### Defined in
[packages/medusa/src/services/shipping-option.ts:691](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/shipping-option.ts#L691)
___
### deleteShippingMethods
▸ **deleteShippingMethods**(`shippingMethods`): `Promise`<`ShippingMethod`[]\>
Removes a given shipping method
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `shippingMethods` | `ShippingMethod` \| `ShippingMethod`[] | the shipping method to remove |
#### Returns
`Promise`<`ShippingMethod`[]\>
removed shipping methods
#### Defined in
[packages/medusa/src/services/shipping-option.ts:258](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/shipping-option.ts#L258)
___
### getPrice\_
▸ **getPrice_**(`option`, `data`, `cart`): `Promise`<`number`\>
Returns the amount to be paid for a shipping method. Will ask the
fulfillment provider to calculate the price if the shipping option has the
price type "calculated".
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `option` | `ShippingOption` | the shipping option to retrieve the price for. |
| `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
`Promise`<`number`\>
the price of the shipping option.
#### Defined in
[packages/medusa/src/services/shipping-option.ts:791](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/shipping-option.ts#L791)
___
### list
▸ **list**(`selector`, `config?`): `Promise`<`ShippingOption`[]\>
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `Selector`<`ShippingMethod`\> | the query object for find |
| `config` | `FindConfig`<`ShippingOption`\> | config object |
#### Returns
`Promise`<`ShippingOption`[]\>
the result of the find operation
#### Defined in
[packages/medusa/src/services/shipping-option.ts:148](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/shipping-option.ts#L148)
___
### listAndCount
▸ **listAndCount**(`selector`, `config?`): `Promise`<[`ShippingOption`[], `number`]\>
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `Selector`<`ShippingOption`\> | the query object for find |
| `config` | `FindConfig`<`ShippingOption`\> | config object |
#### Returns
`Promise`<[`ShippingOption`[], `number`]\>
the result of the find operation
#### Defined in
[packages/medusa/src/services/shipping-option.ts:164](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/shipping-option.ts#L164)
___
### removeRequirement
▸ **removeRequirement**(`requirementId`): `Promise`<`void` \| `ShippingOptionRequirement`\>
Removes a requirement from a shipping option
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requirementId` | `any` | the id of the requirement to remove |
#### Returns
`Promise`<`void` \| `ShippingOptionRequirement`\>
the result of update
#### Defined in
[packages/medusa/src/services/shipping-option.ts:742](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/shipping-option.ts#L742)
___
### retrieve
▸ **retrieve**(`optionId`, `options?`): `Promise`<`ShippingOption`\>
Gets a profile by id.
Throws in case of DB Error and if profile was not found.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `optionId` | `any` | the id of the profile to get. |
| `options` | `Object` | the options to get a profile |
| `options.relations?` | `string`[] | - |
| `options.select?` | keyof `ShippingOption`[] | - |
#### Returns
`Promise`<`ShippingOption`\>
the profile document.
#### Defined in
[packages/medusa/src/services/shipping-option.ts:182](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/shipping-option.ts#L182)
___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } |
#### Returns
`boolean`
#### Inherited from
TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[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)
___
### update
▸ **update**(`optionId`, `update`): `Promise`<`ShippingOption`\>
Updates a profile. Metadata updates and product updates should use
dedicated methods, e.g. `setMetadata`, etc. The function
will throw errors if metadata or product updates are attempted.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `optionId` | `string` | the id of the option. Must be a string that can be casted to an ObjectId |
| `update` | `UpdateShippingOptionInput` | an object with the update values. |
#### Returns
`Promise`<`ShippingOption`\>
resolves to the update result.
#### Defined in
[packages/medusa/src/services/shipping-option.ts:579](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/shipping-option.ts#L579)
___
### updateShippingMethod
▸ **updateShippingMethod**(`id`, `update`): `Promise`<`undefined` \| `ShippingMethod`\>
Updates a shipping method's associations. Useful when a cart is completed
and its methods should be copied to an order/swap entity.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | the id of the shipping method to update |
| `update` | `ShippingMethodUpdate` | the values to update the method with |
#### Returns
`Promise`<`undefined` \| `ShippingMethod`\>
the resulting shipping method
#### Defined in
[packages/medusa/src/services/shipping-option.ts:229](https://github.com/medusajs/medusa/blob/77fd361ce/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/77fd361ce/packages/medusa/src/services/shipping-option.ts#L767)
___
### validateAndMutatePrice
▸ `Private` **validateAndMutatePrice**(`option`, `priceInput`): `Promise`<`CreateShippingOptionInput` \| `Omit`<`ShippingOption`, ``"beforeInsert"``\>\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `option` | `ShippingOption` \| `CreateShippingOptionInput` |
| `priceInput` | `ValidatePriceTypeAndAmountInput` |
#### Returns
`Promise`<`CreateShippingOptionInput` \| `Omit`<`ShippingOption`, ``"beforeInsert"``\>\>
#### Defined in
[packages/medusa/src/services/shipping-option.ts:408](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/shipping-option.ts#L408)
___
### validateCartOption
▸ **validateCartOption**(`option`, `cart`): `Promise`<``null`` \| `ShippingOption`\>
Checks if a given option id is a valid option for a cart. If it is the
option is returned with the correct price. Throws when region_ids do not
match, or when the shipping option requirements are not satisfied.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `option` | `ShippingOption` | the option object to check |
| `cart` | `Cart` | the cart object to check against |
#### Returns
`Promise`<``null`` \| `ShippingOption`\>
the validated shipping option
#### Defined in
[packages/medusa/src/services/shipping-option.ts:366](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/shipping-option.ts#L366)
___
### validatePriceType\_
▸ **validatePriceType_**(`priceType`, `option`): `Promise`<`ShippingOptionPriceType`\>
Validates a shipping option price
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `priceType` | `ShippingOptionPriceType` | the price to validate |
| `option` | `ShippingOption` | the option to validate against |
#### Returns
`Promise`<`ShippingOptionPriceType`\>
the validated price
#### Defined in
[packages/medusa/src/services/shipping-option.ts:539](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/shipping-option.ts#L539)
___
### validateRequirement\_
▸ **validateRequirement_**(`requirement`, `optionId?`): `Promise`<`ShippingOptionRequirement`\>
Validates a requirement
#### Parameters
| Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ |
| `requirement` | `ShippingOptionRequirement` | `undefined` | the requirement to validate |
| `optionId` | `undefined` \| `string` | `undefined` | the id to validate the requirement |
#### Returns
`Promise`<`ShippingOptionRequirement`\>
a validated shipping requirement
#### Defined in
[packages/medusa/src/services/shipping-option.ts:82](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/shipping-option.ts#L82)
___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`ShippingOptionService`](ShippingOptionService.md)
#### Parameters
| Name | Type |
| :------ | :------ |
| `transactionManager?` | `EntityManager` |
#### Returns
[`ShippingOptionService`](ShippingOptionService.md)
#### Inherited from
TransactionBaseService.withTransaction
#### Defined in
[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)
Reference in New Issue View Git Blame Copy Permalink