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

chore(docs): Generated References (#5516)

Browse Source 
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]
2023-11-02 09:16:47 +00:00
committed by GitHub
co-authored by Oli Juhl Shahed Nasser
parent 80fe362f33
commit aa2bb7a31b
271 changed files with 38146 additions and 9809 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/services/classes/LineItemAdjustmentService.md
+92 -79
View File
@@ -1,4 +1,4 @@
# Class: LineItemAdjustmentService
# LineItemAdjustmentService
Provides layer to manipulate line item adjustments.
@@ -12,12 +12,12 @@ Provides layer to manipulate line item adjustments.
### constructor
• **new LineItemAdjustmentService**(`«destructured»`)
**new LineItemAdjustmentService**(`«destructured»`)
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `«destructured»` | `LineItemAdjustmentServiceProps` |
#### Overrides
@@ -26,13 +26,13 @@ TransactionBaseService.constructor
#### Defined in
[medusa/src/services/line-item-adjustment.ts:36](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/line-item-adjustment.ts#L36)
[medusa/src/services/line-item-adjustment.ts:36](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/line-item-adjustment.ts#L36)
## 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,33 +68,33 @@ 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)
___
### discountService
• `Private` `Readonly` **discountService**: [`DiscountService`](DiscountService.md)
`Private` `Readonly` **discountService**: [`DiscountService`](DiscountService.md)
#### Defined in
[medusa/src/services/line-item-adjustment.ts:34](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/line-item-adjustment.ts#L34)
[medusa/src/services/line-item-adjustment.ts:34](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/line-item-adjustment.ts#L34)
___
### lineItemAdjustmentRepo\_
• `Private` `Readonly` **lineItemAdjustmentRepo\_**: `Repository`<`LineItemAdjustment`\>
`Private` `Readonly` **lineItemAdjustmentRepo\_**: `Repository`<`LineItemAdjustment`\>
#### Defined in
[medusa/src/services/line-item-adjustment.ts:33](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/line-item-adjustment.ts#L33)
[medusa/src/services/line-item-adjustment.ts:33](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/line-item-adjustment.ts#L33)
___
### manager\_
• `Protected` **manager\_**: `EntityManager`
`Protected` **manager\_**: `EntityManager`
#### Inherited from
@@ -102,13 +102,13 @@ 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)
___
### transactionManager\_
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
`Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Inherited from
@@ -116,47 +116,47 @@ 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)
## 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
### 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 |
@@ -165,7 +165,7 @@ transaction manager is created.
`Promise`<`TResult`\>
the result of the transactional work
-`Promise`: the result of the transactional work
#### Inherited from
@@ -173,44 +173,45 @@ 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)
___
### create
▸ **create**(`data`): `Promise`<`LineItemAdjustment`\>
**create**(`data`): `Promise`<`LineItemAdjustment`\>
Creates a line item adjustment
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `data` | `Partial`<`LineItemAdjustment`\> | the line item adjustment to create |
#### Returns
`Promise`<`LineItemAdjustment`\>
line item adjustment
-`Promise`: line item adjustment
-`LineItemAdjustment`:
#### Defined in
[medusa/src/services/line-item-adjustment.ts:86](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/line-item-adjustment.ts#L86)
[medusa/src/services/line-item-adjustment.ts:86](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/line-item-adjustment.ts#L86)
___
### createAdjustmentForLineItem
▸ **createAdjustmentForLineItem**(`cart`, `lineItem`): `Promise`<`LineItemAdjustment`[]\>
**createAdjustmentForLineItem**(`cart`, `lineItem`): `Promise`<`LineItemAdjustment`[]\>
Creates adjustment for a line item
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `cart` | `Cart` | the cart object holding discounts |
| `lineItem` | `LineItem` | the line item for which a line item adjustment might be created |
@@ -218,24 +219,26 @@ Creates adjustment for a line item
`Promise`<`LineItemAdjustment`[]\>
a line item adjustment or undefined if no adjustment was created
-`Promise`: a line item adjustment or undefined if no adjustment was created
-`LineItemAdjustment[]`:
-`LineItemAdjustment`:
#### Defined in
[medusa/src/services/line-item-adjustment.ts:262](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/line-item-adjustment.ts#L262)
[medusa/src/services/line-item-adjustment.ts:262](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/line-item-adjustment.ts#L262)
___
### createAdjustments
▸ **createAdjustments**(`cart`, `lineItem?`): `Promise`<`LineItemAdjustment`[] \| `LineItemAdjustment`[][]\>
**createAdjustments**(`cart`, `lineItem?`): `Promise`<`LineItemAdjustment`[] \| `LineItemAdjustment`[][]\>
Creates adjustment for a line item
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `cart` | `Cart` | the cart object holding discounts |
| `lineItem?` | `LineItem` | the line item for which a line item adjustment might be created |
@@ -243,49 +246,50 @@ Creates adjustment for a line item
`Promise`<`LineItemAdjustment`[] \| `LineItemAdjustment`[][]\>
if a lineItem was given, returns a line item adjustment or undefined if no adjustment was created
-`Promise`: if a lineItem was given, returns a line item adjustment or undefined if no adjustment was created
otherwise returns an array of line item adjustments for each line item in the cart
-`LineItemAdjustment[] \| LineItemAdjustment[][]`: (optional)
#### Defined in
[medusa/src/services/line-item-adjustment.ts:290](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/line-item-adjustment.ts#L290)
[medusa/src/services/line-item-adjustment.ts:290](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/line-item-adjustment.ts#L290)
___
### delete
▸ **delete**(`selectorOrIds`): `Promise`<`void`\>
**delete**(`selectorOrIds`): `Promise`<`void`\>
Deletes line item adjustments matching a selector
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `selectorOrIds` | `string` \| `string`[] \| `FilterableLineItemAdjustmentProps` & { `discount_id?`: `FindOperator`<``null`` \| `string`\> } | the query object for find or the line item adjustment id |
#### Returns
`Promise`<`void`\>
the result of the delete operation
-`Promise`: the result of the delete operation
#### Defined in
[medusa/src/services/line-item-adjustment.ts:153](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/line-item-adjustment.ts#L153)
[medusa/src/services/line-item-adjustment.ts:153](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/line-item-adjustment.ts#L153)
___
### generateAdjustments
▸ **generateAdjustments**(`calculationContextData`, `generatedLineItem`, `context`): `Promise`<`GeneratedAdjustment`[]\>
**generateAdjustments**(`calculationContextData`, `generatedLineItem`, `context`): `Promise`<`GeneratedAdjustment`[]\>
Creates adjustment for a line item
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `calculationContextData` | `CalculationContextData` | the calculationContextData object holding discounts |
| `generatedLineItem` | `LineItem` | the line item for which a line item adjustment might be created |
| `context` | `AdjustmentContext` | the line item for which a line item adjustment might be created |
@@ -294,24 +298,25 @@ Creates adjustment for a line item
`Promise`<`GeneratedAdjustment`[]\>
a line item adjustment or undefined if no adjustment was created
-`Promise`: a line item adjustment or undefined if no adjustment was created
-`GeneratedAdjustment[]`:
#### Defined in
[medusa/src/services/line-item-adjustment.ts:188](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/line-item-adjustment.ts#L188)
[medusa/src/services/line-item-adjustment.ts:188](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/line-item-adjustment.ts#L188)
___
### list
▸ **list**(`selector?`, `config?`): `Promise`<`LineItemAdjustment`[]\>
**list**(`selector?`, `config?`): `Promise`<`LineItemAdjustment`[]\>
Lists line item adjustments
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `selector` | `FilterableLineItemAdjustmentProps` | the query object for find |
| `config` | `FindConfig`<`LineItemAdjustment`\> | the config to be used for find |
@@ -319,24 +324,26 @@ Lists line item adjustments
`Promise`<`LineItemAdjustment`[]\>
the result of the find operation
-`Promise`: the result of the find operation
-`LineItemAdjustment[]`:
-`LineItemAdjustment`:
#### Defined in
[medusa/src/services/line-item-adjustment.ts:136](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/line-item-adjustment.ts#L136)
[medusa/src/services/line-item-adjustment.ts:136](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/line-item-adjustment.ts#L136)
___
### retrieve
▸ **retrieve**(`lineItemAdjustmentId`, `config?`): `Promise`<`LineItemAdjustment`\>
**retrieve**(`lineItemAdjustmentId`, `config?`): `Promise`<`LineItemAdjustment`\>
Retrieves a line item adjustment by id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `lineItemAdjustmentId` | `string` | the id of the line item adjustment to retrieve |
| `config` | `FindConfig`<`LineItemAdjustment`\> | the config to retrieve the line item adjustment by |
@@ -344,48 +351,51 @@ Retrieves a line item adjustment by id.
`Promise`<`LineItemAdjustment`\>
the line item adjustment.
-`Promise`: the line item adjustment.
-`LineItemAdjustment`:
#### Defined in
[medusa/src/services/line-item-adjustment.ts:53](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/line-item-adjustment.ts#L53)
[medusa/src/services/line-item-adjustment.ts:53](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/line-item-adjustment.ts#L53)
___
### 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)
___
### update
▸ **update**(`id`, `data`): `Promise`<`LineItemAdjustment`\>
**update**(`id`, `data`): `Promise`<`LineItemAdjustment`\>
Creates a line item adjustment
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `id` | `string` | the line item adjustment id to update |
| `data` | `Partial`<`LineItemAdjustment`\> | the line item adjustment to create |
@@ -393,32 +403,35 @@ Creates a line item adjustment
`Promise`<`LineItemAdjustment`\>
line item adjustment
-`Promise`: line item adjustment
-`LineItemAdjustment`:
#### Defined in
[medusa/src/services/line-item-adjustment.ts:104](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/line-item-adjustment.ts#L104)
[medusa/src/services/line-item-adjustment.ts:104](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/line-item-adjustment.ts#L104)
___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`LineItemAdjustmentService`](LineItemAdjustmentService.md)
**withTransaction**(`transactionManager?`): [`LineItemAdjustmentService`](LineItemAdjustmentService.md)
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `transactionManager?` | `EntityManager` |
#### Returns
[`LineItemAdjustmentService`](LineItemAdjustmentService.md)
-`LineItemAdjustmentService`:
#### 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)