api-ref: custom API reference (#4770)
* initialized next.js project * finished markdown sections * added operation schema component * change page metadata * eslint fixes * fixes related to deployment * added response schema * resolve max stack issue * support for different property types * added support for property types * added loading for components * added more loading * type fixes * added oneOf type * removed console * fix replace with push * refactored everything * use static content for description * fixes and improvements * added code examples section * fix path name * optimizations * fixed tag navigation * add support for admin and store references * general enhancements * optimizations and fixes * fixes and enhancements * added search bar * loading enhancements * added loading * added code blocks * added margin top * add empty response text * fixed oneOf parameters * added path and query parameters * general fixes * added base path env variable * small fix for arrays * enhancements * design enhancements * general enhancements * fix isRequired * added enum values * enhancements * general fixes * general fixes * changed oas generation script * additions to the introduction section * added copy button for code + other enhancements * fix response code block * fix metadata * formatted store introduction * move sidebar logic to Tags component * added test env variables * fix code block bug * added loading animation * added expand param + loading * enhance operation loading * made responsive + improvements * added loading provider * fixed loading * adjustments for small devices * added sidebar label for endpoints * added feedback component * fixed analytics * general fixes * listen to scroll for other headings * added sample env file * update api ref files + support new fields * fix for external docs link * added new sections * fix last item in sidebar not showing * move docs content to www/docs * change redirect url * revert change * resolve build errors * configure rewrites * changed to environment variable url * revert changing environment variable name * add environment variable for API path * fix links * fix tailwind settings * remove vercel file * reconfigured api route * move api page under api * fix page metadata * fix external link in navigation bar * update api spec * updated api specs * fixed google lint error * add max-height on request samples * add padding before loading * fix for one of name * fix undefined types * general fixes * remove response schema example * redesigned navigation bar * redesigned sidebar * fixed up paddings * added feedback component + report issue * fixed up typography, padding, and general styling * redesigned code blocks * optimization * added error timeout * fixes * added indexing with algolia + fixes * fix errors with algolia script * redesign operation sections * fix heading scroll * design fixes * fix padding * fix padding + scroll issues * fix scroll issues * improve scroll performance * fixes for safari * optimization and fixes * fixes to docs + details animation * padding fixes for code block * added tab animation * fixed incorrect link * added selection styling * fix lint errors * redesigned details component * added detailed feedback form * api reference fixes * fix tabs * upgrade + fixes * updated documentation links * optimizations to sidebar items * fix spacing in sidebar item * optimizations and fixes * fix endpoint path styling * remove margin * final fixes * change margin on small devices * generated OAS * fixes for mobile * added feedback modal * optimize dark mode button * fixed color mode useeffect * minimize dom size * use new style system * radius and spacing design system * design fixes * fix eslint errors * added meta files * change cron schedule * fix docusaurus configurations * added operating system to feedback data * change content directory name * fixes to contribution guidelines * revert renaming content * added api-reference to documentation workflow * fixes for search * added dark mode + fixes * oas fixes * handle bugs * added code examples for clients * changed tooltip text * change authentication to card * change page title based on selected section * redesigned mobile navbar * fix icon colors * fix key colors * fix medusa-js installation command * change external regex in algolia * change changeset * fix padding on mobile * fix hydration error * update depedencies
This commit is contained in:
Shahed Nasser
@@ -0,0 +1,457 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: LineItem
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `BaseEntity`
|
||||
|
||||
↳ **`LineItem`**
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new LineItem**()
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.constructor
|
||||
|
||||
## Properties
|
||||
|
||||
### adjustments
|
||||
|
||||
• **adjustments**: [`LineItemAdjustment`](LineItemAdjustment.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:85](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L85)
|
||||
|
||||
___
|
||||
|
||||
### allow\_discounts
|
||||
|
||||
• **allow\_discounts**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:127](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L127)
|
||||
|
||||
___
|
||||
|
||||
### cart
|
||||
|
||||
• **cart**: [`Cart`](Cart.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:53](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L53)
|
||||
|
||||
___
|
||||
|
||||
### cart\_id
|
||||
|
||||
• **cart\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:49](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L49)
|
||||
|
||||
___
|
||||
|
||||
### claim\_order
|
||||
|
||||
• **claim\_order**: [`ClaimOrder`](ClaimOrder.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:77](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L77)
|
||||
|
||||
___
|
||||
|
||||
### claim\_order\_id
|
||||
|
||||
• **claim\_order\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:73](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L73)
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.created\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||
|
||||
___
|
||||
|
||||
### description
|
||||
|
||||
• **description**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:112](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L112)
|
||||
|
||||
___
|
||||
|
||||
### discount\_total
|
||||
|
||||
• `Optional` **discount\_total**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:167](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L167)
|
||||
|
||||
___
|
||||
|
||||
### fulfilled\_quantity
|
||||
|
||||
• **fulfilled\_quantity**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:147](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L147)
|
||||
|
||||
___
|
||||
|
||||
### gift\_card\_total
|
||||
|
||||
• `Optional` **gift\_card\_total**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:168](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L168)
|
||||
|
||||
___
|
||||
|
||||
### has\_shipping
|
||||
|
||||
• **has\_shipping**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:130](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L130)
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.id
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### includes\_tax
|
||||
|
||||
• **includes\_tax**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:159](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L159)
|
||||
|
||||
___
|
||||
|
||||
### is\_giftcard
|
||||
|
||||
• **is\_giftcard**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:121](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L121)
|
||||
|
||||
___
|
||||
|
||||
### is\_return
|
||||
|
||||
• **is\_return**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:118](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L118)
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:156](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L156)
|
||||
|
||||
___
|
||||
|
||||
### order
|
||||
|
||||
• **order**: [`Order`](Order.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:61](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L61)
|
||||
|
||||
___
|
||||
|
||||
### order\_edit
|
||||
|
||||
• `Optional` **order\_edit**: ``null`` \| [`OrderEdit`](OrderEdit.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:106](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L106)
|
||||
|
||||
___
|
||||
|
||||
### order\_edit\_id
|
||||
|
||||
• `Optional` **order\_edit\_id**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:97](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L97)
|
||||
|
||||
___
|
||||
|
||||
### order\_id
|
||||
|
||||
• **order\_id**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:57](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L57)
|
||||
|
||||
___
|
||||
|
||||
### original\_item\_id
|
||||
|
||||
• `Optional` **original\_item\_id**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:91](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L91)
|
||||
|
||||
___
|
||||
|
||||
### original\_tax\_total
|
||||
|
||||
• `Optional` **original\_tax\_total**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:166](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L166)
|
||||
|
||||
___
|
||||
|
||||
### original\_total
|
||||
|
||||
• `Optional` **original\_total**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:165](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L165)
|
||||
|
||||
___
|
||||
|
||||
### quantity
|
||||
|
||||
• **quantity**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:144](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L144)
|
||||
|
||||
___
|
||||
|
||||
### refundable
|
||||
|
||||
• `Optional` **refundable**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:161](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L161)
|
||||
|
||||
___
|
||||
|
||||
### returned\_quantity
|
||||
|
||||
• **returned\_quantity**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:150](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L150)
|
||||
|
||||
___
|
||||
|
||||
### shipped\_quantity
|
||||
|
||||
• **shipped\_quantity**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:153](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L153)
|
||||
|
||||
___
|
||||
|
||||
### should\_merge
|
||||
|
||||
• **should\_merge**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:124](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L124)
|
||||
|
||||
___
|
||||
|
||||
### subtotal
|
||||
|
||||
• `Optional` **subtotal**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:162](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L162)
|
||||
|
||||
___
|
||||
|
||||
### swap
|
||||
|
||||
• **swap**: [`Swap`](Swap.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:69](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L69)
|
||||
|
||||
___
|
||||
|
||||
### swap\_id
|
||||
|
||||
• **swap\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:65](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L65)
|
||||
|
||||
___
|
||||
|
||||
### tax\_lines
|
||||
|
||||
• **tax\_lines**: [`LineItemTaxLine`](LineItemTaxLine.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:80](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L80)
|
||||
|
||||
___
|
||||
|
||||
### tax\_total
|
||||
|
||||
• `Optional` **tax\_total**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:163](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L163)
|
||||
|
||||
___
|
||||
|
||||
### thumbnail
|
||||
|
||||
• **thumbnail**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:115](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L115)
|
||||
|
||||
___
|
||||
|
||||
### title
|
||||
|
||||
• **title**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:109](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L109)
|
||||
|
||||
___
|
||||
|
||||
### total
|
||||
|
||||
• `Optional` **total**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:164](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L164)
|
||||
|
||||
___
|
||||
|
||||
### unit\_price
|
||||
|
||||
• **unit\_price**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:133](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L133)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.updated\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||
|
||||
___
|
||||
|
||||
### variant
|
||||
|
||||
• **variant**: [`ProductVariant`](ProductVariant.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:141](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L141)
|
||||
|
||||
___
|
||||
|
||||
### variant\_id
|
||||
|
||||
• **variant\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:137](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L137)
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:170](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/line-item.ts#L170)
|
||||
Reference in New Issue
Block a user