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,447 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: LineItem
|
||||
|
||||
[internal](../modules/internal.md).LineItem
|
||||
|
||||
Base abstract entity for all entities
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- [`BaseEntity`](internal.BaseEntity.md)
|
||||
|
||||
↳ **`LineItem`**
|
||||
|
||||
## Properties
|
||||
|
||||
### adjustments
|
||||
|
||||
• **adjustments**: [`LineItemAdjustment`](internal.LineItemAdjustment.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:20
|
||||
|
||||
___
|
||||
|
||||
### allow\_discounts
|
||||
|
||||
• **allow\_discounts**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:30
|
||||
|
||||
___
|
||||
|
||||
### beforeInsert
|
||||
|
||||
• `Private` **beforeInsert**: `any`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:49
|
||||
|
||||
___
|
||||
|
||||
### cart
|
||||
|
||||
• **cart**: [`Cart`](internal.Cart.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:12
|
||||
|
||||
___
|
||||
|
||||
### cart\_id
|
||||
|
||||
• **cart\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:11
|
||||
|
||||
___
|
||||
|
||||
### claim\_order
|
||||
|
||||
• **claim\_order**: [`ClaimOrder`](internal.ClaimOrder.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:18
|
||||
|
||||
___
|
||||
|
||||
### claim\_order\_id
|
||||
|
||||
• **claim\_order\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:17
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[BaseEntity](internal.BaseEntity.md).[created_at](internal.BaseEntity.md#created_at)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/interfaces/models/base-entity.d.ts:6
|
||||
|
||||
___
|
||||
|
||||
### description
|
||||
|
||||
• **description**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:25
|
||||
|
||||
___
|
||||
|
||||
### discount\_total
|
||||
|
||||
• `Optional` **discount\_total**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:47
|
||||
|
||||
___
|
||||
|
||||
### fulfilled\_quantity
|
||||
|
||||
• **fulfilled\_quantity**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:36
|
||||
|
||||
___
|
||||
|
||||
### gift\_card\_total
|
||||
|
||||
• `Optional` **gift\_card\_total**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:48
|
||||
|
||||
___
|
||||
|
||||
### has\_shipping
|
||||
|
||||
• **has\_shipping**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:31
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[BaseEntity](internal.BaseEntity.md).[id](internal.BaseEntity.md#id)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/interfaces/models/base-entity.d.ts:5
|
||||
|
||||
___
|
||||
|
||||
### includes\_tax
|
||||
|
||||
• **includes\_tax**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:40
|
||||
|
||||
___
|
||||
|
||||
### is\_giftcard
|
||||
|
||||
• **is\_giftcard**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:28
|
||||
|
||||
___
|
||||
|
||||
### is\_return
|
||||
|
||||
• **is\_return**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:27
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:39
|
||||
|
||||
___
|
||||
|
||||
### order
|
||||
|
||||
• **order**: [`Order`](internal.Order.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:14
|
||||
|
||||
___
|
||||
|
||||
### order\_edit
|
||||
|
||||
• `Optional` **order\_edit**: ``null`` \| [`OrderEdit`](internal.OrderEdit.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:23
|
||||
|
||||
___
|
||||
|
||||
### order\_edit\_id
|
||||
|
||||
• `Optional` **order\_edit\_id**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:22
|
||||
|
||||
___
|
||||
|
||||
### order\_id
|
||||
|
||||
• **order\_id**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:13
|
||||
|
||||
___
|
||||
|
||||
### original\_item\_id
|
||||
|
||||
• `Optional` **original\_item\_id**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:21
|
||||
|
||||
___
|
||||
|
||||
### original\_tax\_total
|
||||
|
||||
• `Optional` **original\_tax\_total**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:46
|
||||
|
||||
___
|
||||
|
||||
### original\_total
|
||||
|
||||
• `Optional` **original\_total**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:45
|
||||
|
||||
___
|
||||
|
||||
### quantity
|
||||
|
||||
• **quantity**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:35
|
||||
|
||||
___
|
||||
|
||||
### refundable
|
||||
|
||||
• `Optional` **refundable**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:41
|
||||
|
||||
___
|
||||
|
||||
### returned\_quantity
|
||||
|
||||
• **returned\_quantity**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:37
|
||||
|
||||
___
|
||||
|
||||
### shipped\_quantity
|
||||
|
||||
• **shipped\_quantity**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:38
|
||||
|
||||
___
|
||||
|
||||
### should\_merge
|
||||
|
||||
• **should\_merge**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:29
|
||||
|
||||
___
|
||||
|
||||
### subtotal
|
||||
|
||||
• `Optional` **subtotal**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:42
|
||||
|
||||
___
|
||||
|
||||
### swap
|
||||
|
||||
• **swap**: [`Swap`](internal.Swap.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:16
|
||||
|
||||
___
|
||||
|
||||
### swap\_id
|
||||
|
||||
• **swap\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:15
|
||||
|
||||
___
|
||||
|
||||
### tax\_lines
|
||||
|
||||
• **tax\_lines**: [`LineItemTaxLine`](internal.LineItemTaxLine.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:19
|
||||
|
||||
___
|
||||
|
||||
### tax\_total
|
||||
|
||||
• `Optional` **tax\_total**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:43
|
||||
|
||||
___
|
||||
|
||||
### thumbnail
|
||||
|
||||
• **thumbnail**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:26
|
||||
|
||||
___
|
||||
|
||||
### title
|
||||
|
||||
• **title**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:24
|
||||
|
||||
___
|
||||
|
||||
### total
|
||||
|
||||
• `Optional` **total**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:44
|
||||
|
||||
___
|
||||
|
||||
### unit\_price
|
||||
|
||||
• **unit\_price**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:32
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[BaseEntity](internal.BaseEntity.md).[updated_at](internal.BaseEntity.md#updated_at)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/interfaces/models/base-entity.d.ts:7
|
||||
|
||||
___
|
||||
|
||||
### variant
|
||||
|
||||
• **variant**: [`ProductVariant`](internal.ProductVariant.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:34
|
||||
|
||||
___
|
||||
|
||||
### variant\_id
|
||||
|
||||
• **variant\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/line-item.d.ts:33
|
||||
Reference in New Issue
Block a user