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

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

Browse Source 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2022-10-10 19:31:16 +03:00
committed by GitHub
parent 35df4962f8
commit 23bf4eb192
50 changed files with 4049 additions and 1221 deletions
Download Patch File Download Diff File Expand all files Collapse all files

280
docs/content/references/services/classes/LineItemService.md
View File

@@ -1,10 +1,8 @@
# Class: LineItemService
Provides layer to manipulate line items.
## Hierarchy
- `"medusa-interfaces"`
- `TransactionBaseService`
↳ **`LineItemService`**
@@ -22,21 +20,49 @@ Provides layer to manipulate line items.
#### Overrides
BaseService.constructor
TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/line-item.ts:52](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L52)
[packages/medusa/src/services/line-item.ts:53](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L53)
## 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/35df4962f/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/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
### cartRepository\_
• `Protected` `Readonly` **cartRepository\_**: typeof `CartRepository`
#### Defined in
[packages/medusa/src/services/line-item.ts:44](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L44)
[packages/medusa/src/services/line-item.ts:44](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L44)
___
@@ -46,7 +72,7 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:49](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L49)
[packages/medusa/src/services/line-item.ts:49](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L49)
___
@@ -56,17 +82,17 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L43)
[packages/medusa/src/services/line-item.ts:43](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L43)
___
### lineItemAdjustmentService\_
• `Protected` `Readonly` **lineItemAdjustmentService\_**: `LineItemAdjustmentService`
• `Protected` `Readonly` **lineItemAdjustmentService\_**: [`LineItemAdjustmentService`](LineItemAdjustmentService.md)
#### Defined in
[packages/medusa/src/services/line-item.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L50)
[packages/medusa/src/services/line-item.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L50)
___
@@ -76,17 +102,21 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L42)
[packages/medusa/src/services/line-item.ts:42](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L42)
___
### manager\_
• `Protected` `Readonly` **manager\_**: `EntityManager`
• `Protected` **manager\_**: `EntityManager`
#### Overrides
TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/line-item.ts:41](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L41)
[packages/medusa/src/services/line-item.ts:39](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L39)
___
@@ -96,7 +126,7 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:47](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L47)
[packages/medusa/src/services/line-item.ts:47](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L47)
___
@@ -106,7 +136,7 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:46](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L46)
[packages/medusa/src/services/line-item.ts:46](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L46)
___
@@ -116,7 +146,7 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:45](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L45)
[packages/medusa/src/services/line-item.ts:45](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L45)
___
@@ -126,10 +156,137 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:48](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L48)
[packages/medusa/src/services/line-item.ts:48](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L48)
___
### taxProviderService\_
• `Protected` `Readonly` **taxProviderService\_**: [`TaxProviderService`](TaxProviderService.md)
#### Defined in
[packages/medusa/src/services/line-item.ts:51](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L51)
___
### transactionManager\_
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides
TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/line-item.ts:40](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L40)
## Methods
### 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/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
### cloneTo
▸ **cloneTo**(`ids`, `data?`, `options?`): `Promise`<`LineItem`[]\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `ids` | `string` \| `string`[] |
| `data` | `Object` |
| `data.adjustments?` | (`undefined` \| { id?: string \| undefined; item\_id?: string \| undefined; item?: { cart\_id?: string \| undefined; cart?: { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; ... 37 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 38 more ...; updated\_at?: { ...; }...)[] |
| `data.allow_discounts?` | `boolean` |
| `data.cart?` | { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; billing\_address?: { customer\_id?: string \| null \| undefined; customer?: { ...; } \| ... 1 more ... \| undefined; ... 15 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 36 more ...; updated\_at?: ... |
| `data.cart_id?` | `string` |
| `data.claim_order?` | { payment\_status?: ClaimPaymentStatus \| undefined; fulfillment\_status?: ClaimFulfillmentStatus \| undefined; claim\_items?: ({ images?: ({ ...; } \| undefined)[] \| undefined; ... 14 more ...; updated\_at?: { ...; } \| undefined; } \| undefined)[] \| undefined; ... 17 more ...; id?: string \| undefined; } |
| `data.claim_order_id?` | `string` |
| `data.created_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } |
| `data.description?` | `string` |
| `data.discount_total?` | ``null`` \| `number` |
| `data.fulfilled_quantity?` | `number` |
| `data.gift_card_total?` | ``null`` \| `number` |
| `data.has_shipping?` | `boolean` |
| `data.id?` | `string` |
| `data.includes_tax?` | `boolean` |
| `data.is_giftcard?` | `boolean` |
| `data.is_return?` | `boolean` |
| `data.metadata?` | { [x: string]: unknown; } |
| `data.order?` | { readonly object?: "order" \| undefined; status?: OrderStatus \| undefined; fulfillment\_status?: FulfillmentStatus \| undefined; payment\_status?: PaymentStatus \| undefined; ... 48 more ...; updated\_at?: { ...; } \| undefined; } |
| `data.order_edit?` | ``null`` \| { order\_id?: string \| undefined; order?: { readonly object?: "order" \| undefined; status?: OrderStatus \| undefined; fulfillment\_status?: FulfillmentStatus \| undefined; ... 49 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 27 more ...; updated\_at?: { ...; } \| undefined; } |
| `data.order_edit_id?` | ``null`` \| `string` |
| `data.order_id?` | ``null`` \| `string` |
| `data.original_item_id?` | ``null`` \| `string` |
| `data.original_tax_total?` | ``null`` \| `number` |
| `data.original_total?` | ``null`` \| `number` |
| `data.quantity?` | `number` |
| `data.refundable?` | ``null`` \| `number` |
| `data.returned_quantity?` | `number` |
| `data.shipped_quantity?` | `number` |
| `data.should_merge?` | `boolean` |
| `data.subtotal?` | ``null`` \| `number` |
| `data.swap?` | { fulfillment\_status?: SwapFulfillmentStatus \| undefined; payment\_status?: SwapPaymentStatus \| undefined; order\_id?: string \| undefined; ... 20 more ...; updated\_at?: { ...; } \| undefined; } |
| `data.swap_id?` | `string` |
| `data.tax_lines?` | (`undefined` \| { item\_id?: string \| undefined; item?: { cart\_id?: string \| undefined; cart?: { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; ... 37 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 38 more ...; updated\_at?: { ...; } \| undefined; } \| undefin...)[] |
| `data.tax_total?` | ``null`` \| `number` |
| `data.thumbnail?` | ``null`` \| `string` |
| `data.title?` | `string` |
| `data.total?` | ``null`` \| `number` |
| `data.unit_price?` | `number` |
| `data.updated_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } |
| `data.variant?` | { title?: string \| undefined; product\_id?: string \| undefined; product?: { title?: string \| undefined; subtitle?: string \| null \| undefined; description?: string \| null \| undefined; ... 29 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 22 more ...; updated\_at?: { ...; } \| undefined; } |
| `data.variant_id?` | `string` |
| `options` | `Object` |
| `options.setOriginalLineItemId?` | `boolean` |
#### Returns
`Promise`<`LineItem`[]\>
#### Defined in
[packages/medusa/src/services/line-item.ts:394](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L394)
___
### create
▸ **create**(`data`): `Promise`<`LineItem`\>
@@ -150,7 +307,7 @@ the created line item
#### Defined in
[packages/medusa/src/services/line-item.ts:292](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L292)
[packages/medusa/src/services/line-item.ts:278](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L278)
___
@@ -176,7 +333,7 @@ the created line items
#### Defined in
[packages/medusa/src/services/line-item.ts:149](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L149)
[packages/medusa/src/services/line-item.ts:128](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L128)
___
@@ -194,7 +351,7 @@ Create a line item tax line.
| `args.code?` | ``null`` \| `string` | - |
| `args.created_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } | - |
| `args.id?` | `string` | - |
| `args.item?` | { cart\_id?: string \| undefined; cart?: { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; billing\_address?: { customer\_id?: string \| ... 1 more ... \| undefined; ... 16 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 34 more ...; updated\_at?: {... | - |
| `args.item?` | { cart\_id?: string \| undefined; cart?: { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; billing\_address?: { customer\_id?: string \| ... 1 more ... \| undefined; ... 16 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 36 more ...; updated\_at?: {... | - |
| `args.item_id?` | `string` | - |
| `args.metadata?` | { [x: string]: unknown; } | - |
| `args.name?` | `string` | - |
@@ -209,7 +366,7 @@ a new line item tax line
#### Defined in
[packages/medusa/src/services/line-item.ts:359](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L359)
[packages/medusa/src/services/line-item.ts:386](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L386)
___
@@ -233,7 +390,31 @@ the result of the delete operation
#### Defined in
[packages/medusa/src/services/line-item.ts:340](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L340)
[packages/medusa/src/services/line-item.ts:346](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L346)
___
### deleteWithTaxLines
▸ **deleteWithTaxLines**(`id`): `Promise`<`undefined` \| `LineItem`\>
Deletes a line item with the tax lines.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | the id of the line item to delete |
#### Returns
`Promise`<`undefined` \| `LineItem`\>
the result of the delete operation
#### Defined in
[packages/medusa/src/services/line-item.ts:365](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L365)
___
@@ -253,6 +434,7 @@ ___
| `context.customer_id?` | `string` |
| `context.includes_tax?` | `boolean` |
| `context.metadata?` | `Record`<`string`, `unknown`\> |
| `context.order_edit_id?` | `string` |
| `context.unit_price?` | `number` |
#### Returns
@@ -261,7 +443,7 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:202](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L202)
[packages/medusa/src/services/line-item.ts:181](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L181)
___
@@ -273,7 +455,7 @@ ___
| Name | Type |
| :------ | :------ |
| `selector` | `any` |
| `selector` | `Selector`<`LineItem`\> |
| `config` | `FindConfig`<`LineItem`\> |
#### Returns
@@ -282,7 +464,7 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:101](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L101)
[packages/medusa/src/services/line-item.ts:81](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L81)
___
@@ -307,13 +489,37 @@ the line item
#### Defined in
[packages/medusa/src/services/line-item.ts:121](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L121)
[packages/medusa/src/services/line-item.ts:101](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L101)
___
### 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/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
### update
▸ **update**(`id`, `data`): `Promise`<`LineItem`\>
▸ **update**(`idOrSelector`, `data`): `Promise`<`LineItem`[]\>
Updates a line item
@@ -321,35 +527,39 @@ Updates a line item
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | the id of the line item to update |
| `data` | `Partial`<`LineItem`\> | the properties to update on line item |
| `idOrSelector` | `string` \| `Selector`<`LineItem`\> | the id or selector of the line item(s) to update |
| `data` | `Partial`<`LineItem`\> | the properties to update the line item(s) |
#### Returns
`Promise`<`LineItem`\>
`Promise`<`LineItem`[]\>
the update line item
the updated line item(s)
#### Defined in
[packages/medusa/src/services/line-item.ts:311](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L311)
[packages/medusa/src/services/line-item.ts:297](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L297)
___
### withTransaction
▸ **withTransaction**(`transactionManager`): [`LineItemService`](LineItemService.md)
▸ **withTransaction**(`transactionManager?`): [`LineItemService`](LineItemService.md)
#### Parameters
| Name | Type |
| :------ | :------ |
| `transactionManager` | `EntityManager` |
| `transactionManager?` | `EntityManager` |
#### Returns
[`LineItemService`](LineItemService.md)
#### Inherited from
TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/services/line-item.ts:78](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L78)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)