chore(docs): Generated References (#5516)
Generated the following references: - `js-client` - `pricing` - `services` Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
committed by
GitHub
GitHub
parent
80fe362f33
commit
aa2bb7a31b
@@ -1,4 +1,4 @@
|
||||
# Class: SwapService
|
||||
# SwapService
|
||||
|
||||
Handles swaps
|
||||
|
||||
@@ -12,12 +12,12 @@ Handles swaps
|
||||
|
||||
### constructor
|
||||
|
||||
• **new SwapService**(`«destructured»`)
|
||||
**new SwapService**(`«destructured»`)
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| Name |
|
||||
| :------ |
|
||||
| `«destructured»` | `InjectedProps` |
|
||||
|
||||
#### Overrides
|
||||
@@ -26,13 +26,13 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:91](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/swap.ts#L91)
|
||||
[medusa/src/services/swap.ts:91](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/swap.ts#L91)
|
||||
|
||||
## Properties
|
||||
|
||||
### \_\_configModule\_\_
|
||||
|
||||
• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\>
|
||||
`Protected` `Optional` `Readonly` **\_\_configModule\_\_**: Record<`string`, `unknown`\>
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -40,13 +40,13 @@ TransactionBaseService.\_\_configModule\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
|
||||
|
||||
___
|
||||
|
||||
### \_\_container\_\_
|
||||
|
||||
• `Protected` `Readonly` **\_\_container\_\_**: `any`
|
||||
`Protected` `Readonly` **\_\_container\_\_**: `any`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -54,13 +54,13 @@ TransactionBaseService.\_\_container\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### \_\_moduleDeclaration\_\_
|
||||
|
||||
• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: `Record`<`string`, `unknown`\>
|
||||
`Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: Record<`string`, `unknown`\>
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -68,73 +68,73 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
|
||||
|
||||
___
|
||||
|
||||
### cartService\_
|
||||
|
||||
• `Protected` `Readonly` **cartService\_**: [`CartService`](CartService.md)
|
||||
`Protected` `Readonly` **cartService\_**: [`CartService`](CartService.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:77](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/swap.ts#L77)
|
||||
[medusa/src/services/swap.ts:77](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/swap.ts#L77)
|
||||
|
||||
___
|
||||
|
||||
### customShippingOptionService\_
|
||||
|
||||
• `Protected` `Readonly` **customShippingOptionService\_**: [`CustomShippingOptionService`](CustomShippingOptionService.md)
|
||||
`Protected` `Readonly` **customShippingOptionService\_**: [`CustomShippingOptionService`](CustomShippingOptionService.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:87](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/swap.ts#L87)
|
||||
[medusa/src/services/swap.ts:87](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/swap.ts#L87)
|
||||
|
||||
___
|
||||
|
||||
### eventBus\_
|
||||
|
||||
• `Protected` `Readonly` **eventBus\_**: [`EventBusService`](EventBusService.md)
|
||||
`Protected` `Readonly` **eventBus\_**: [`EventBusService`](EventBusService.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:78](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/swap.ts#L78)
|
||||
[medusa/src/services/swap.ts:78](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/swap.ts#L78)
|
||||
|
||||
___
|
||||
|
||||
### fulfillmentService\_
|
||||
|
||||
• `Protected` `Readonly` **fulfillmentService\_**: [`FulfillmentService`](FulfillmentService.md)
|
||||
`Protected` `Readonly` **fulfillmentService\_**: [`FulfillmentService`](FulfillmentService.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:83](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/swap.ts#L83)
|
||||
[medusa/src/services/swap.ts:83](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/swap.ts#L83)
|
||||
|
||||
___
|
||||
|
||||
### lineItemAdjustmentService\_
|
||||
|
||||
• `Protected` `Readonly` **lineItemAdjustmentService\_**: [`LineItemAdjustmentService`](LineItemAdjustmentService.md)
|
||||
`Protected` `Readonly` **lineItemAdjustmentService\_**: [`LineItemAdjustmentService`](LineItemAdjustmentService.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:86](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/swap.ts#L86)
|
||||
[medusa/src/services/swap.ts:86](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/swap.ts#L86)
|
||||
|
||||
___
|
||||
|
||||
### lineItemService\_
|
||||
|
||||
• `Protected` `Readonly` **lineItemService\_**: [`LineItemService`](LineItemService.md)
|
||||
`Protected` `Readonly` **lineItemService\_**: [`LineItemService`](LineItemService.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:82](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/swap.ts#L82)
|
||||
[medusa/src/services/swap.ts:82](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/swap.ts#L82)
|
||||
|
||||
___
|
||||
|
||||
### manager\_
|
||||
|
||||
• `Protected` **manager\_**: `EntityManager`
|
||||
`Protected` **manager\_**: `EntityManager`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -142,83 +142,83 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
|
||||
|
||||
___
|
||||
|
||||
### orderService\_
|
||||
|
||||
• `Protected` `Readonly` **orderService\_**: [`OrderService`](OrderService.md)
|
||||
`Protected` `Readonly` **orderService\_**: [`OrderService`](OrderService.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:79](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/swap.ts#L79)
|
||||
[medusa/src/services/swap.ts:79](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/swap.ts#L79)
|
||||
|
||||
___
|
||||
|
||||
### paymentProviderService\_
|
||||
|
||||
• `Protected` `Readonly` **paymentProviderService\_**: [`PaymentProviderService`](PaymentProviderService.md)
|
||||
`Protected` `Readonly` **paymentProviderService\_**: [`PaymentProviderService`](PaymentProviderService.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:85](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/swap.ts#L85)
|
||||
[medusa/src/services/swap.ts:85](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/swap.ts#L85)
|
||||
|
||||
___
|
||||
|
||||
### productVariantInventoryService\_
|
||||
|
||||
• `Protected` `Readonly` **productVariantInventoryService\_**: [`ProductVariantInventoryService`](ProductVariantInventoryService.md)
|
||||
`Protected` `Readonly` **productVariantInventoryService\_**: [`ProductVariantInventoryService`](ProductVariantInventoryService.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:89](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/swap.ts#L89)
|
||||
[medusa/src/services/swap.ts:89](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/swap.ts#L89)
|
||||
|
||||
___
|
||||
|
||||
### returnService\_
|
||||
|
||||
• `Protected` `Readonly` **returnService\_**: [`ReturnService`](ReturnService.md)
|
||||
`Protected` `Readonly` **returnService\_**: [`ReturnService`](ReturnService.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:80](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/swap.ts#L80)
|
||||
[medusa/src/services/swap.ts:80](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/swap.ts#L80)
|
||||
|
||||
___
|
||||
|
||||
### shippingOptionService\_
|
||||
|
||||
• `Protected` `Readonly` **shippingOptionService\_**: [`ShippingOptionService`](ShippingOptionService.md)
|
||||
`Protected` `Readonly` **shippingOptionService\_**: [`ShippingOptionService`](ShippingOptionService.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:84](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/swap.ts#L84)
|
||||
[medusa/src/services/swap.ts:84](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/swap.ts#L84)
|
||||
|
||||
___
|
||||
|
||||
### swapRepository\_
|
||||
|
||||
• `Protected` `Readonly` **swapRepository\_**: `Repository`<`Swap`\>
|
||||
`Protected` `Readonly` **swapRepository\_**: `Repository`<`Swap`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:75](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/swap.ts#L75)
|
||||
[medusa/src/services/swap.ts:75](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/swap.ts#L75)
|
||||
|
||||
___
|
||||
|
||||
### totalsService\_
|
||||
|
||||
• `Protected` `Readonly` **totalsService\_**: [`TotalsService`](TotalsService.md)
|
||||
`Protected` `Readonly` **totalsService\_**: [`TotalsService`](TotalsService.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:81](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/swap.ts#L81)
|
||||
[medusa/src/services/swap.ts:81](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/swap.ts#L81)
|
||||
|
||||
___
|
||||
|
||||
### transactionManager\_
|
||||
|
||||
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
|
||||
`Protected` **transactionManager\_**: `undefined` \| `EntityManager`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -226,13 +226,13 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
|
||||
|
||||
___
|
||||
|
||||
### Events
|
||||
|
||||
▪ `Static` **Events**: `Object`
|
||||
`Static` **Events**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
@@ -250,67 +250,70 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:63](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/swap.ts#L63)
|
||||
[medusa/src/services/swap.ts:63](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/swap.ts#L63)
|
||||
|
||||
## Accessors
|
||||
|
||||
### activeManager\_
|
||||
|
||||
• `Protected` `get` **activeManager_**(): `EntityManager`
|
||||
`Protected` `get` **activeManager_**(): `EntityManager`
|
||||
|
||||
#### Returns
|
||||
|
||||
`EntityManager`
|
||||
|
||||
-`EntityManager`:
|
||||
|
||||
#### Inherited from
|
||||
|
||||
TransactionBaseService.activeManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
|
||||
|
||||
## Methods
|
||||
|
||||
### areReturnItemsValid
|
||||
|
||||
▸ `Protected` **areReturnItemsValid**(`returnItems`): `Promise`<`boolean`\>
|
||||
`Protected` **areReturnItemsValid**(`returnItems`): `Promise`<`boolean`\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| Name |
|
||||
| :------ |
|
||||
| `returnItems` | `WithRequiredProperty`<`Partial`<`ReturnItem`\>, ``"item_id"``\>[] |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`boolean`\>
|
||||
|
||||
-`Promise`:
|
||||
-`boolean`: (optional)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:1240](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/swap.ts#L1240)
|
||||
[medusa/src/services/swap.ts:1240](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/swap.ts#L1240)
|
||||
|
||||
___
|
||||
|
||||
### atomicPhase\_
|
||||
|
||||
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
|
||||
`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` |
|
||||
| `TResult` | `object` |
|
||||
| `TError` | `object` |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| Name | 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 |
|
||||
@@ -319,7 +322,7 @@ transaction manager is created.
|
||||
|
||||
`Promise`<`TResult`\>
|
||||
|
||||
the result of the transactional work
|
||||
-`Promise`: the result of the transactional work
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -327,13 +330,13 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
|
||||
|
||||
___
|
||||
|
||||
### cancel
|
||||
|
||||
▸ **cancel**(`swapId`): `Promise`<`Swap`\>
|
||||
**cancel**(`swapId`): `Promise`<`Swap`\>
|
||||
|
||||
Cancels a given swap if possible. A swap can only be canceled if all
|
||||
related returns, fulfillments, and payments have been canceled. If a swap
|
||||
@@ -341,84 +344,87 @@ is associated with a refund, it cannot be canceled.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| Name | Description |
|
||||
| :------ | :------ |
|
||||
| `swapId` | `string` | the id of the swap to cancel. |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`Swap`\>
|
||||
|
||||
the canceled swap.
|
||||
-`Promise`: the canceled swap.
|
||||
-`Swap`:
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:857](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/swap.ts#L857)
|
||||
[medusa/src/services/swap.ts:857](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/swap.ts#L857)
|
||||
|
||||
___
|
||||
|
||||
### cancelFulfillment
|
||||
|
||||
▸ **cancelFulfillment**(`fulfillmentId`): `Promise`<`Swap`\>
|
||||
**cancelFulfillment**(`fulfillmentId`): `Promise`<`Swap`\>
|
||||
|
||||
Cancels a fulfillment (if related to a swap)
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| Name | Description |
|
||||
| :------ | :------ |
|
||||
| `fulfillmentId` | `string` | the ID of the fulfillment to cancel |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`Swap`\>
|
||||
|
||||
updated swap
|
||||
-`Promise`: updated swap
|
||||
-`Swap`:
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:1059](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/swap.ts#L1059)
|
||||
[medusa/src/services/swap.ts:1059](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/swap.ts#L1059)
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
▸ **create**(`order`, `returnItems`, `additionalItems?`, `returnShipping?`, `custom?`): `Promise`<`Swap`\>
|
||||
**create**(`order`, `returnItems`, `additionalItems?`, `returnShipping?`, `custom?`): `Promise`<`Swap`\>
|
||||
|
||||
Creates a swap from an order, with given return items, additional items
|
||||
and an optional return shipping method.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| Name | Description |
|
||||
| :------ | :------ |
|
||||
| `order` | `Order` | the order to base the swap off |
|
||||
| `returnItems` | `WithRequiredProperty`<`Partial`<`ReturnItem`\>, ``"item_id"``\>[] | the items to return in the swap |
|
||||
| `additionalItems?` | `Pick`<`LineItem`, ``"variant_id"`` \| ``"quantity"``\>[] | the items to send to the customer |
|
||||
| `returnShipping?` | `Object` | an optional shipping method for returning the returnItems |
|
||||
| `returnShipping.option_id` | `string` | - |
|
||||
| `returnShipping.price?` | `number` | - |
|
||||
| `custom` | `Object` | contains relevant custom information. This object may include no_notification which will disable sending notification when creating swap. If set, it overrules the attribute inherited from the order |
|
||||
| `custom.allow_backorder?` | `boolean` | - |
|
||||
| `custom.idempotency_key?` | `string` | - |
|
||||
| `custom.location_id?` | `string` | - |
|
||||
| `custom.no_notification?` | `boolean` | - |
|
||||
| `returnShipping?` | `object` | an optional shipping method for returning the returnItems |
|
||||
| `returnShipping.option_id` | `string` |
|
||||
| `returnShipping.price?` | `number` |
|
||||
| `custom` | `object` | contains relevant custom information. This object may include no_notification which will disable sending notification when creating swap. If set, it overrules the attribute inherited from the order |
|
||||
| `custom.allow_backorder?` | `boolean` |
|
||||
| `custom.idempotency_key?` | `string` |
|
||||
| `custom.location_id?` | `string` |
|
||||
| `custom.no_notification?` | `boolean` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`Swap`\>
|
||||
|
||||
the newly created swap
|
||||
-`Promise`: the newly created swap
|
||||
-`Swap`:
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:321](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/swap.ts#L321)
|
||||
[medusa/src/services/swap.ts:321](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/swap.ts#L321)
|
||||
|
||||
___
|
||||
|
||||
### createCart
|
||||
|
||||
▸ **createCart**(`swapId`, `customShippingOptions?`, `context?`): `Promise`<`Swap`\>
|
||||
**createCart**(`swapId`, `customShippingOptions?`, `context?`): `Promise`<`Swap`\>
|
||||
|
||||
Creates a cart from the given swap. The cart can be used to pay
|
||||
for differences associated with the swap. The swap represented by the
|
||||
@@ -427,36 +433,37 @@ swap.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| :------ | :------ | :------ | :------ |
|
||||
| `swapId` | `string` | `undefined` | the id of the swap to create the cart from |
|
||||
| Name | Default value | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `swapId` | `string` | the id of the swap to create the cart from |
|
||||
| `customShippingOptions` | { `option_id`: `string` ; `price`: `number` }[] | `[]` | the shipping options |
|
||||
| `context` | `Object` | `{}` | - |
|
||||
| `context.sales_channel_id?` | `string` | `undefined` | - |
|
||||
| `context` | `object` |
|
||||
| `context.sales_channel_id?` | `string` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`Swap`\>
|
||||
|
||||
the swap with its cart_id prop set to the id of the new cart.
|
||||
-`Promise`: the swap with its cart_id prop set to the id of the new cart.
|
||||
-`Swap`:
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:577](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/swap.ts#L577)
|
||||
[medusa/src/services/swap.ts:577](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/swap.ts#L577)
|
||||
|
||||
___
|
||||
|
||||
### createFulfillment
|
||||
|
||||
▸ **createFulfillment**(`swapId`, `config?`): `Promise`<`Swap`\>
|
||||
**createFulfillment**(`swapId`, `config?`): `Promise`<`Swap`\>
|
||||
|
||||
Fulfills the additional items associated with the swap. Will call the
|
||||
fulfillment providers associated with the shipping methods.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| Name | Description |
|
||||
| :------ | :------ |
|
||||
| `swapId` | `string` | the id of the swap to fulfill, |
|
||||
| `config` | `CreateShipmentConfig` | optional configurations, includes optional metadata to attach to the shipment, and a no_notification flag. |
|
||||
|
||||
@@ -464,24 +471,25 @@ fulfillment providers associated with the shipping methods.
|
||||
|
||||
`Promise`<`Swap`\>
|
||||
|
||||
the updated swap with new status and fulfillments.
|
||||
-`Promise`: the updated swap with new status and fulfillments.
|
||||
-`Swap`:
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:919](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/swap.ts#L919)
|
||||
[medusa/src/services/swap.ts:919](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/swap.ts#L919)
|
||||
|
||||
___
|
||||
|
||||
### createShipment
|
||||
|
||||
▸ **createShipment**(`swapId`, `fulfillmentId`, `trackingLinks?`, `config?`): `Promise`<`Swap`\>
|
||||
**createShipment**(`swapId`, `fulfillmentId`, `trackingLinks?`, `config?`): `Promise`<`Swap`\>
|
||||
|
||||
Marks a fulfillment as shipped and attaches tracking numbers.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| Name | Description |
|
||||
| :------ | :------ |
|
||||
| `swapId` | `string` | the id of the swap that has been shipped. |
|
||||
| `fulfillmentId` | `string` | the id of the specific fulfillment that has been shipped |
|
||||
| `trackingLinks?` | { `tracking_number`: `string` }[] | the tracking numbers associated with the shipment |
|
||||
@@ -491,24 +499,25 @@ Marks a fulfillment as shipped and attaches tracking numbers.
|
||||
|
||||
`Promise`<`Swap`\>
|
||||
|
||||
the updated swap with new fulfillments and status.
|
||||
-`Promise`: the updated swap with new fulfillments and status.
|
||||
-`Swap`:
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:1090](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/swap.ts#L1090)
|
||||
[medusa/src/services/swap.ts:1090](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/swap.ts#L1090)
|
||||
|
||||
___
|
||||
|
||||
### deleteMetadata
|
||||
|
||||
▸ **deleteMetadata**(`swapId`, `key`): `Promise`<`Swap`\>
|
||||
**deleteMetadata**(`swapId`, `key`): `Promise`<`Swap`\>
|
||||
|
||||
Dedicated method to delete metadata for a swap.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| Name | Description |
|
||||
| :------ | :------ |
|
||||
| `swapId` | `string` | the order to delete metadata from. |
|
||||
| `key` | `string` | key for metadata field |
|
||||
|
||||
@@ -516,24 +525,25 @@ Dedicated method to delete metadata for a swap.
|
||||
|
||||
`Promise`<`Swap`\>
|
||||
|
||||
resolves to the updated result.
|
||||
-`Promise`: resolves to the updated result.
|
||||
-`Swap`:
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:1168](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/swap.ts#L1168)
|
||||
[medusa/src/services/swap.ts:1168](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/swap.ts#L1168)
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`selector`, `config?`): `Promise`<`Swap`[]\>
|
||||
**list**(`selector`, `config?`): `Promise`<`Swap`[]\>
|
||||
|
||||
List swaps.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| Name | Description |
|
||||
| :------ | :------ |
|
||||
| `selector` | `Selector`<`Swap`\> | the query object for find |
|
||||
| `config` | `FindConfig`<`Swap`\> | the configuration used to find the objects. contains relations, skip, and take. |
|
||||
|
||||
@@ -541,24 +551,26 @@ List swaps.
|
||||
|
||||
`Promise`<`Swap`[]\>
|
||||
|
||||
the result of the find operation
|
||||
-`Promise`: the result of the find operation
|
||||
-`Swap[]`:
|
||||
-`Swap`:
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:273](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/swap.ts#L273)
|
||||
[medusa/src/services/swap.ts:273](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/swap.ts#L273)
|
||||
|
||||
___
|
||||
|
||||
### listAndCount
|
||||
|
||||
▸ **listAndCount**(`selector`, `config?`): `Promise`<[`Swap`[], `number`]\>
|
||||
**listAndCount**(`selector`, `config?`): `Promise`<[`Swap`[], `number`]\>
|
||||
|
||||
List swaps.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| Name | Description |
|
||||
| :------ | :------ |
|
||||
| `selector` | `Selector`<`Swap`\> | the query object for find |
|
||||
| `config` | `FindConfig`<`Swap`\> | the configuration used to find the objects. contains relations, skip, and take. |
|
||||
|
||||
@@ -566,97 +578,102 @@ List swaps.
|
||||
|
||||
`Promise`<[`Swap`[], `number`]\>
|
||||
|
||||
the result of the find operation
|
||||
-`Promise`: the result of the find operation
|
||||
-`Swap[]`:
|
||||
-`number`: (optional)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:293](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/swap.ts#L293)
|
||||
[medusa/src/services/swap.ts:293](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/swap.ts#L293)
|
||||
|
||||
___
|
||||
|
||||
### processDifference
|
||||
|
||||
▸ **processDifference**(`swapId`): `Promise`<`Swap`\>
|
||||
**processDifference**(`swapId`): `Promise`<`Swap`\>
|
||||
|
||||
Process difference for the requested swap.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| Name | Description |
|
||||
| :------ | :------ |
|
||||
| `swapId` | `string` | id of a swap being processed |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`Swap`\>
|
||||
|
||||
processed swap
|
||||
-`Promise`: processed swap
|
||||
-`Swap`:
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:421](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/swap.ts#L421)
|
||||
[medusa/src/services/swap.ts:421](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/swap.ts#L421)
|
||||
|
||||
___
|
||||
|
||||
### registerCartCompletion
|
||||
|
||||
▸ **registerCartCompletion**(`swapId`): `Promise`<`Swap`\>
|
||||
**registerCartCompletion**(`swapId`): `Promise`<`Swap`\>
|
||||
|
||||
Register a cart completion
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| Name | Description |
|
||||
| :------ | :------ |
|
||||
| `swapId` | `string` | The id of the swap |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`Swap`\>
|
||||
|
||||
swap related to the cart
|
||||
-`Promise`: swap related to the cart
|
||||
-`Swap`:
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:724](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/swap.ts#L724)
|
||||
[medusa/src/services/swap.ts:724](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/swap.ts#L724)
|
||||
|
||||
___
|
||||
|
||||
### registerReceived
|
||||
|
||||
▸ **registerReceived**(`id`): `Promise`<`Swap`\>
|
||||
**registerReceived**(`id`): `Promise`<`Swap`\>
|
||||
|
||||
Registers the swap return items as received so that they cannot be used
|
||||
as a part of other swaps/returns.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| Name | Description |
|
||||
| :------ | :------ |
|
||||
| `id` | `any` | the id of the order with the swap. |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`Swap`\>
|
||||
|
||||
the resulting order
|
||||
-`Promise`: the resulting order
|
||||
-`Swap`:
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:1206](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/swap.ts#L1206)
|
||||
[medusa/src/services/swap.ts:1206](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/swap.ts#L1206)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`swapId`, `config?`): `Promise`<`Swap`\>
|
||||
**retrieve**(`swapId`, `config?`): `Promise`<`Swap`\>
|
||||
|
||||
Retrieves a swap with the given id.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| Name | Description |
|
||||
| :------ | :------ |
|
||||
| `swapId` | `string` | the id of the swap to retrieve |
|
||||
| `config` | `Omit`<`FindConfig`<`Swap`\>, ``"select"``\> & { `select?`: `string`[] } | the configuration to retrieve the swap |
|
||||
|
||||
@@ -664,97 +681,101 @@ Retrieves a swap with the given id.
|
||||
|
||||
`Promise`<`Swap`\>
|
||||
|
||||
the swap
|
||||
-`Promise`: the swap
|
||||
-`Swap`:
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:203](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/swap.ts#L203)
|
||||
[medusa/src/services/swap.ts:203](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/swap.ts#L203)
|
||||
|
||||
___
|
||||
|
||||
### retrieveByCartId
|
||||
|
||||
▸ **retrieveByCartId**(`cartId`, `relations?`): `Promise`<`Swap`\>
|
||||
**retrieveByCartId**(`cartId`, `relations?`): `Promise`<`Swap`\>
|
||||
|
||||
Retrieves a swap based on its associated cart id
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| :------ | :------ | :------ | :------ |
|
||||
| `cartId` | `string` | `undefined` | the cart id that the swap's cart has |
|
||||
| Name | Default value | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `cartId` | `string` | the cart id that the swap's cart has |
|
||||
| `relations` | `undefined` \| `string`[] | `[]` | the relations to retrieve swap |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`Swap`\>
|
||||
|
||||
the swap
|
||||
-`Promise`: the swap
|
||||
-`Swap`:
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:246](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/swap.ts#L246)
|
||||
[medusa/src/services/swap.ts:246](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/swap.ts#L246)
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
|
||||
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } |
|
||||
| Name |
|
||||
| :------ |
|
||||
| `err` | Record<`string`, `unknown`\> \| { `code`: `string` } |
|
||||
|
||||
#### Returns
|
||||
|
||||
`boolean`
|
||||
|
||||
-`boolean`: (optional)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
### transformQueryForCart
|
||||
|
||||
▸ `Protected` **transformQueryForCart**(`config`): `Omit`<`FindConfig`<`Swap`\>, ``"select"``\> & { `select?`: `string`[] } & { `cartRelations`: `undefined` \| `string`[] ; `cartSelects`: `undefined` \| keyof `Cart`[] }
|
||||
`Protected` **transformQueryForCart**(`config`): `Omit`<`FindConfig`<`Swap`\>, ``"select"``\> & { `select?`: `string`[] } & { `cartRelations`: `undefined` \| `string`[] ; `cartSelects`: `undefined` \| keyof `Cart`[] }
|
||||
|
||||
Transform find config object for retrieval.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| Name | Description |
|
||||
| :------ | :------ |
|
||||
| `config` | `Omit`<`FindConfig`<`Swap`\>, ``"select"``\> & { `select?`: `string`[] } | parsed swap find config |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Omit`<`FindConfig`<`Swap`\>, ``"select"``\> & { `select?`: `string`[] } & { `cartRelations`: `undefined` \| `string`[] ; `cartSelects`: `undefined` \| keyof `Cart`[] }
|
||||
|
||||
transformed find swap config
|
||||
-``Omit`<`FindConfig`<`Swap`\>, ``"select"``\> & { `select?`: `string`[] } & { `cartRelations`: `undefined` \| `string`[] ; `cartSelects`: `undefined` \| keyof `Cart`[] }`: (optional) transformed find swap config
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:130](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/swap.ts#L130)
|
||||
[medusa/src/services/swap.ts:130](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/swap.ts#L130)
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
▸ **update**(`swapId`, `update`): `Promise`<`Swap`\>
|
||||
**update**(`swapId`, `update`): `Promise`<`Swap`\>
|
||||
|
||||
Update the swap record.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| Name | Description |
|
||||
| :------ | :------ |
|
||||
| `swapId` | `string` | id of a swap to update |
|
||||
| `update` | `Partial`<`Swap`\> | new data |
|
||||
|
||||
@@ -762,32 +783,35 @@ Update the swap record.
|
||||
|
||||
`Promise`<`Swap`\>
|
||||
|
||||
updated swap record
|
||||
-`Promise`: updated swap record
|
||||
-`Swap`:
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:544](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/swap.ts#L544)
|
||||
[medusa/src/services/swap.ts:544](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/swap.ts#L544)
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
▸ **withTransaction**(`transactionManager?`): [`SwapService`](SwapService.md)
|
||||
**withTransaction**(`transactionManager?`): [`SwapService`](SwapService.md)
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| Name |
|
||||
| :------ |
|
||||
| `transactionManager?` | `EntityManager` |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`SwapService`](SwapService.md)
|
||||
|
||||
-`SwapService`:
|
||||
|
||||
#### Inherited from
|
||||
|
||||
TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
|
||||
|
||||
Reference in New Issue
Block a user