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

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

Browse Source 
Co-authored-by: kodiakhq[bot] <kodiakhq[bot]@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2022-12-23 10:20:47 +02:00
committed by GitHub
co-authored by kodiakhq[bot]
parent 8cbd627fb7
commit a32a2c4cf1
56 changed files with 2165 additions and 1675 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/content/references/services/classes/LineItemService.md
+110 -41
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/line-item.ts:53](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L53)
[packages/medusa/src/services/line-item.ts:60](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L60)
## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -62,7 +62,7 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:44](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L44)
[packages/medusa/src/services/line-item.ts:51](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L51)
___
@@ -72,7 +72,7 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:49](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L49)
[packages/medusa/src/services/line-item.ts:56](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L56)
___
@@ -82,7 +82,7 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:43](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L43)
[packages/medusa/src/services/line-item.ts:50](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L50)
___
@@ -92,7 +92,7 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:50](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L50)
[packages/medusa/src/services/line-item.ts:57](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L57)
___
@@ -102,7 +102,7 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:42](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L42)
[packages/medusa/src/services/line-item.ts:49](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L49)
___
@@ -116,7 +116,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/line-item.ts:39](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L39)
[packages/medusa/src/services/line-item.ts:46](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L46)
___
@@ -126,7 +126,7 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:47](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L47)
[packages/medusa/src/services/line-item.ts:54](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L54)
___
@@ -136,7 +136,7 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:46](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L46)
[packages/medusa/src/services/line-item.ts:53](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L53)
___
@@ -146,7 +146,7 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:45](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L45)
[packages/medusa/src/services/line-item.ts:52](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L52)
___
@@ -156,7 +156,7 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L48)
[packages/medusa/src/services/line-item.ts:55](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L55)
___
@@ -166,7 +166,7 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:51](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L51)
[packages/medusa/src/services/line-item.ts:58](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L58)
___
@@ -180,7 +180,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/line-item.ts:40](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L40)
[packages/medusa/src/services/line-item.ts:47](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L47)
## Methods
@@ -219,7 +219,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
___
@@ -283,31 +283,38 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:397](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L397)
[packages/medusa/src/services/line-item.ts:488](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L488)
___
### create
▸ **create**(`data`): `Promise`<`LineItem`\>
▸ **create**<`T`, `TResult`\>(`data`): `Promise`<`TResult`\>
Create a line item
#### Type parameters
| Name | Type |
| :------ | :------ |
| `T` | `LineItem` \| `LineItem`[] |
| `TResult` | `T` extends `LineItem` ? `LineItem` : `LineItem`[] |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `data` | `Partial`<`LineItem`\> | the line item object to create |
| `data` | `T` | the line item object to create |
#### Returns
`Promise`<`LineItem`\>
`Promise`<`TResult`\>
the created line item
#### Defined in
[packages/medusa/src/services/line-item.ts:281](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L281)
[packages/medusa/src/services/line-item.ts:369](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L369)
___
@@ -333,7 +340,7 @@ the created line items
#### Defined in
[packages/medusa/src/services/line-item.ts:128](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L128)
[packages/medusa/src/services/line-item.ts:135](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L135)
___
@@ -366,7 +373,7 @@ a new line item tax line
#### Defined in
[packages/medusa/src/services/line-item.ts:389](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L389)
[packages/medusa/src/services/line-item.ts:480](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L480)
___
@@ -390,7 +397,7 @@ the result of the delete operation
#### Defined in
[packages/medusa/src/services/line-item.ts:349](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L349)
[packages/medusa/src/services/line-item.ts:440](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L440)
___
@@ -414,28 +421,61 @@ the result of the delete operation
#### Defined in
[packages/medusa/src/services/line-item.ts:368](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L368)
[packages/medusa/src/services/line-item.ts:459](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L459)
___
### generate
▸ **generate**(`variantId`, `regionId`, `quantity`, `context?`): `Promise`<`LineItem`\>
▸ **generate**<`T`, `TResult`\>(`variantIdOrData`, `regionIdOrContext`, `quantity?`, `context?`): `Promise`<`TResult`\>
Generate a single or multiple line item without persisting the data into the db
#### Type parameters
| Name | Type |
| :------ | :------ |
| `T` | `string` \| `GenerateInputData` \| `GenerateInputData`[] |
| `TResult` | `T` extends `string` ? `LineItem` : `T` extends `LineItem` ? `LineItem` : `LineItem`[] |
#### Parameters
| Name | Type |
| :------ | :------ |
| `variantId` | `string` |
| `regionId` | `string` |
| `variantIdOrData` | `string` \| `T` |
| `regionIdOrContext` | `T` extends `string` ? `string` : `GenerateLineItemContext` |
| `quantity?` | `number` |
| `context` | `GenerateLineItemContext` |
#### Returns
`Promise`<`TResult`\>
#### Defined in
[packages/medusa/src/services/line-item.ts:195](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L195)
___
### generateLineItem
▸ `Protected` **generateLineItem**(`variant`, `quantity`, `context`): `Promise`<`LineItem`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `variant` | `Object` |
| `variant.id` | `string` |
| `variant.product` | `Object` |
| `variant.product.discountable` | `boolean` |
| `variant.product.is_giftcard` | `boolean` |
| `variant.product.thumbnail` | ``null`` \| `string` |
| `variant.product.title` | `string` |
| `variant.product_id` | `string` |
| `variant.title` | `string` |
| `quantity` | `number` |
| `context` | `Object` |
| `context.cart?` | `Cart` |
| `context.customer_id?` | `string` |
| `context.includes_tax?` | `boolean` |
| `context.metadata?` | `Record`<`string`, `unknown`\> |
| `context.order_edit_id?` | `string` |
| `context.unit_price?` | `number` |
| `context` | `GenerateLineItemContext` & { `variantPricing`: `ProductVariantPricing` } |
#### Returns
@@ -443,7 +483,7 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:181](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L181)
[packages/medusa/src/services/line-item.ts:298](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L298)
___
@@ -464,7 +504,7 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:81](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L81)
[packages/medusa/src/services/line-item.ts:88](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L88)
___
@@ -489,7 +529,7 @@ the line item
#### Defined in
[packages/medusa/src/services/line-item.ts:101](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L101)
[packages/medusa/src/services/line-item.ts:108](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L108)
___
@@ -513,7 +553,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
___
@@ -538,7 +578,36 @@ the updated line item(s)
#### Defined in
[packages/medusa/src/services/line-item.ts:300](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L300)
[packages/medusa/src/services/line-item.ts:397](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L397)
___
### validateGenerateArguments
▸ `Protected` **validateGenerateArguments**<`T`, `TResult`\>(`variantIdOrData`, `regionIdOrContext`, `quantity?`): `void`
#### Type parameters
| Name | Type |
| :------ | :------ |
| `T` | `string` \| `GenerateInputData` \| `GenerateInputData`[] |
| `TResult` | `T` extends `string` ? `LineItem` : `T` extends `LineItem` ? `LineItem` : `LineItem`[] |
#### Parameters
| Name | Type |
| :------ | :------ |
| `variantIdOrData` | `string` \| `T` |
| `regionIdOrContext` | `T` extends `string` ? `string` : `GenerateLineItemContext` |
| `quantity?` | `number` |
#### Returns
`void`
#### Defined in
[packages/medusa/src/services/line-item.ts:559](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L559)
___
@@ -562,4 +631,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)