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

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

Browse Source 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-04-04 21:01:53 +03:00
committed by GitHub
co-authored by olivermrbl
parent 3838067a54
commit 198f39f8d4
60 changed files with 3569 additions and 2425 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/content/references/services/classes/LineItemService.md
+60 -92
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/line-item.ts:59](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L59)
[medusa/src/services/line-item.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L56)
## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
@@ -66,17 +66,17 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11)
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___
### cartRepository\_
• `Protected` `Readonly` **cartRepository\_**: typeof `CartRepository`
• `Protected` `Readonly` **cartRepository\_**: `Repository`<`Cart`\>
#### Defined in
[packages/medusa/src/services/line-item.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L50)
[medusa/src/services/line-item.ts:47](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L47)
___
@@ -86,17 +86,17 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:55](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L55)
[medusa/src/services/line-item.ts:52](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L52)
___
### itemTaxLineRepo\_
• `Protected` `Readonly` **itemTaxLineRepo\_**: typeof `LineItemTaxLineRepository`
• `Protected` `Readonly` **itemTaxLineRepo\_**: `Repository`<`LineItemTaxLine`\> & { `deleteForCart`: (`cartId`: `string`) => `Promise`<`void`\> ; `upsertLines`: (`lines`: `LineItemTaxLine`[]) => `Promise`<`LineItemTaxLine`[]\> }
#### Defined in
[packages/medusa/src/services/line-item.ts:49](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L49)
[medusa/src/services/line-item.ts:46](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L46)
___
@@ -106,17 +106,17 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:56](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L56)
[medusa/src/services/line-item.ts:53](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L53)
___
### lineItemRepository\_
• `Protected` `Readonly` **lineItemRepository\_**: typeof `LineItemRepository`
• `Protected` `Readonly` **lineItemRepository\_**: `Repository`<`LineItem`\> & { `findByReturn`: (`returnId`: `string`) => `Promise`<`LineItem` & { `return_item`: `ReturnItem` }[]\> }
#### Defined in
[packages/medusa/src/services/line-item.ts:48](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L48)
[medusa/src/services/line-item.ts:45](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L45)
___
@@ -124,13 +124,13 @@ ___
• `Protected` **manager\_**: `EntityManager`
#### Overrides
#### Inherited from
TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/line-item.ts:45](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L45)
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___
@@ -140,7 +140,7 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:53](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L53)
[medusa/src/services/line-item.ts:50](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L50)
___
@@ -150,7 +150,7 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:52](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L52)
[medusa/src/services/line-item.ts:49](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L49)
___
@@ -160,7 +160,7 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:51](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L51)
[medusa/src/services/line-item.ts:48](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L48)
___
@@ -170,7 +170,7 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:54](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L54)
[medusa/src/services/line-item.ts:51](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L51)
___
@@ -180,7 +180,7 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:57](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L57)
[medusa/src/services/line-item.ts:54](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L54)
___
@@ -188,13 +188,31 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides
#### Inherited from
TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/line-item.ts:46](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L46)
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods
@@ -233,7 +251,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___
@@ -246,48 +264,7 @@ ___
| 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?` | ``null`` \| `string` |
| `data.discount_total?` | ``null`` \| `number` |
| `data.fulfilled_quantity?` | ``null`` \| `number` |
| `data.gift_card_total?` | ``null`` \| `number` |
| `data.has_shipping?` | ``null`` \| `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; ... 49 more ...; updated\_at?: { ...; } \| undefined; } |
| `data.order_edit?` | ``null`` \| { order\_id?: string \| undefined; order?: { readonly object?: "order" \| undefined; status?: OrderStatus \| undefined; fulfillment\_status?: FulfillmentStatus \| undefined; ... 50 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?` | ``null`` \| `number` |
| `data.shipped_quantity?` | ``null`` \| `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; ... 30 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 23 more ...; updated\_at?: { ...; } \| undefined; } |
| `data.variant_id?` | ``null`` \| `string` |
| `data` | `DeepPartial`<`LineItem`\> |
| `options` | `Object` |
| `options.setOriginalLineItemId?` | `boolean` |
@@ -297,7 +274,7 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:496](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L496)
[medusa/src/services/line-item.ts:494](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L494)
___
@@ -328,7 +305,7 @@ the created line item
#### Defined in
[packages/medusa/src/services/line-item.ts:377](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L377)
[medusa/src/services/line-item.ts:373](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L373)
___
@@ -354,7 +331,7 @@ the created line items
#### Defined in
[packages/medusa/src/services/line-item.ts:135](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L135)
[medusa/src/services/line-item.ts:130](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L130)
___
@@ -368,16 +345,7 @@ Create a line item tax line.
| Name | Type | Description |
| :------ | :------ | :------ |
| `args` | `Object` | tax line partial passed to the repo create method |
| `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; ... 36 more ...; updated\_at?: {... | - |
| `args.item_id?` | `string` | - |
| `args.metadata?` | { [x: string]: unknown; } | - |
| `args.name?` | `string` | - |
| `args.rate?` | `number` | - |
| `args.updated_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } | - |
| `args` | `DeepPartial`<`LineItemTaxLine`\> | tax line partial passed to the repo create method |
#### Returns
@@ -387,13 +355,13 @@ a new line item tax line
#### Defined in
[packages/medusa/src/services/line-item.ts:488](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L488)
[medusa/src/services/line-item.ts:486](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L486)
___
### delete
▸ **delete**(`id`): `Promise`<`undefined` \| `LineItem`\>
▸ **delete**(`id`): `Promise`<`undefined` \| ``null`` \| `LineItem`\>
Deletes a line item.
@@ -405,19 +373,19 @@ Deletes a line item.
#### Returns
`Promise`<`undefined` \| `LineItem`\>
`Promise`<`undefined` \| ``null`` \| `LineItem`\>
the result of the delete operation
#### Defined in
[packages/medusa/src/services/line-item.ts:448](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L448)
[medusa/src/services/line-item.ts:446](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L446)
___
### deleteWithTaxLines
▸ **deleteWithTaxLines**(`id`): `Promise`<`undefined` \| `LineItem`\>
▸ **deleteWithTaxLines**(`id`): `Promise`<`undefined` \| ``null`` \| `LineItem`\>
Deletes a line item with the tax lines.
@@ -429,13 +397,13 @@ Deletes a line item with the tax lines.
#### Returns
`Promise`<`undefined` \| `LineItem`\>
`Promise`<`undefined` \| ``null`` \| `LineItem`\>
the result of the delete operation
#### Defined in
[packages/medusa/src/services/line-item.ts:467](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L467)
[medusa/src/services/line-item.ts:465](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L465)
___
@@ -467,7 +435,7 @@ Generate a single or multiple line item without persisting the data into the db
#### Defined in
[packages/medusa/src/services/line-item.ts:196](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L196)
[medusa/src/services/line-item.ts:191](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L191)
___
@@ -497,7 +465,7 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:311](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L311)
[medusa/src/services/line-item.ts:306](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L306)
___
@@ -518,7 +486,7 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:88](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L88)
[medusa/src/services/line-item.ts:83](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L83)
___
@@ -543,7 +511,7 @@ the line item
#### Defined in
[packages/medusa/src/services/line-item.ts:108](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L108)
[medusa/src/services/line-item.ts:104](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L104)
___
@@ -567,7 +535,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___
@@ -592,7 +560,7 @@ the updated line item(s)
#### Defined in
[packages/medusa/src/services/line-item.ts:405](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L405)
[medusa/src/services/line-item.ts:403](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L403)
___
@@ -621,7 +589,7 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:567](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L567)
[medusa/src/services/line-item.ts:565](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L565)
___
@@ -645,4 +613,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)