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

www/docs/content/references/entities/classes/Order.md

@@ -0,0 +1,577 @@
+---
+displayed_sidebar: entitiesSidebar
+---
+
+# Class: Order
+
+## Hierarchy
+
+- `BaseEntity`
+
+  ↳ **`Order`**
+
+## Constructors
+
+### constructor
+
+• **new Order**()
+
+#### Inherited from
+
+BaseEntity.constructor
+
+## Properties
+
+### billing\_address
+
+• **billing\_address**: [`Address`](Address.md)
+
+#### Defined in
+
+[models/order.ts:125](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L125)
+
+___
+
+### billing\_address\_id
+
+• **billing\_address\_id**: `string`
+
+#### Defined in
+
+[models/order.ts:121](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L121)
+
+___
+
+### canceled\_at
+
+• **canceled\_at**: `Date`
+
+#### Defined in
+
+[models/order.ts:231](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L231)
+
+___
+
+### cart
+
+• **cart**: [`Cart`](Cart.md)
+
+#### Defined in
+
+[models/order.ts:106](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L106)
+
+___
+
+### cart\_id
+
+• **cart\_id**: `string`
+
+#### Defined in
+
+[models/order.ts:102](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L102)
+
+___
+
+### claims
+
+• **claims**: [`ClaimOrder`](ClaimOrder.md)[]
+
+#### Defined in
+
+[models/order.ts:199](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L199)
+
+___
+
+### 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)
+
+___
+
+### currency
+
+• **currency**: [`Currency`](Currency.md)
+
+#### Defined in
+
+[models/order.ts:149](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L149)
+
+___
+
+### currency\_code
+
+• **currency\_code**: `string`
+
+#### Defined in
+
+[models/order.ts:145](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L145)
+
+___
+
+### customer
+
+• **customer**: [`Customer`](Customer.md)
+
+#### Defined in
+
+[models/order.ts:114](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L114)
+
+___
+
+### customer\_id
+
+• **customer\_id**: `string`
+
+#### Defined in
+
+[models/order.ts:110](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L110)
+
+___
+
+### discount\_total
+
+• **discount\_total**: `number`
+
+#### Defined in
+
+[models/order.ts:256](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L256)
+
+___
+
+### discounts
+
+• **discounts**: [`Discount`](Discount.md)[]
+
+#### Defined in
+
+[models/order.ts:166](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L166)
+
+___
+
+### display\_id
+
+• **display\_id**: `number`
+
+#### Defined in
+
+[models/order.ts:98](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L98)
+
+___
+
+### draft\_order
+
+• **draft\_order**: [`DraftOrder`](DraftOrder.md)
+
+#### Defined in
+
+[models/order.ts:212](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L212)
+
+___
+
+### draft\_order\_id
+
+• **draft\_order\_id**: `string`
+
+#### Defined in
+
+[models/order.ts:208](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L208)
+
+___
+
+### edits
+
+• **edits**: [`OrderEdit`](OrderEdit.md)[]
+
+#### Defined in
+
+[models/order.ts:220](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L220)
+
+___
+
+### email
+
+• **email**: `string`
+
+#### Defined in
+
+[models/order.ts:117](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L117)
+
+___
+
+### external\_id
+
+• **external\_id**: ``null`` \| `string`
+
+#### Defined in
+
+[models/order.ts:243](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L243)
+
+___
+
+### fulfillment\_status
+
+• **fulfillment\_status**: [`FulfillmentStatus`](../enums/FulfillmentStatus.md)
+
+#### Defined in
+
+[models/order.ts:90](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L90)
+
+___
+
+### fulfillments
+
+• **fulfillments**: [`Fulfillment`](Fulfillment.md)[]
+
+#### Defined in
+
+[models/order.ts:193](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L193)
+
+___
+
+### gift\_card\_tax\_total
+
+• **gift\_card\_tax\_total**: `number`
+
+#### Defined in
+
+[models/order.ts:264](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L264)
+
+___
+
+### gift\_card\_total
+
+• **gift\_card\_total**: `number`
+
+#### Defined in
+
+[models/order.ts:263](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L263)
+
+___
+
+### gift\_card\_transactions
+
+• **gift\_card\_transactions**: [`GiftCardTransaction`](GiftCardTransaction.md)[]
+
+#### Defined in
+
+[models/order.ts:228](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L228)
+
+___
+
+### gift\_cards
+
+• **gift\_cards**: [`GiftCard`](GiftCard.md)[]
+
+#### Defined in
+
+[models/order.ts:180](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L180)
+
+___
+
+### 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)
+
+___
+
+### idempotency\_key
+
+• **idempotency\_key**: `string`
+
+#### Defined in
+
+[models/order.ts:240](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L240)
+
+___
+
+### items
+
+• **items**: [`LineItem`](LineItem.md)[]
+
+#### Defined in
+
+[models/order.ts:225](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L225)
+
+___
+
+### metadata
+
+• **metadata**: `Record`<`string`, `unknown`\>
+
+#### Defined in
+
+[models/order.ts:234](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L234)
+
+___
+
+### no\_notification
+
+• **no\_notification**: `boolean`
+
+#### Defined in
+
+[models/order.ts:237](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L237)
+
+___
+
+### object
+
+• `Readonly` **object**: ``"order"``
+
+#### Defined in
+
+[models/order.ts:80](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L80)
+
+___
+
+### paid\_total
+
+• **paid\_total**: `number`
+
+#### Defined in
+
+[models/order.ts:261](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L261)
+
+___
+
+### payment\_status
+
+• **payment\_status**: [`PaymentStatus`](../enums/PaymentStatus.md)
+
+#### Defined in
+
+[models/order.ts:93](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L93)
+
+___
+
+### payments
+
+• **payments**: [`Payment`](Payment.md)[]
+
+#### Defined in
+
+[models/order.ts:188](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L188)
+
+___
+
+### refundable\_amount
+
+• **refundable\_amount**: `number`
+
+#### Defined in
+
+[models/order.ts:262](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L262)
+
+___
+
+### refunded\_total
+
+• **refunded\_total**: `number`
+
+#### Defined in
+
+[models/order.ts:258](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L258)
+
+___
+
+### refunds
+
+• **refunds**: [`Refund`](Refund.md)[]
+
+#### Defined in
+
+[models/order.ts:202](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L202)
+
+___
+
+### region
+
+• **region**: [`Region`](Region.md)
+
+#### Defined in
+
+[models/order.ts:141](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L141)
+
+___
+
+### region\_id
+
+• **region\_id**: `string`
+
+#### Defined in
+
+[models/order.ts:137](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L137)
+
+___
+
+### returns
+
+• **returns**: [`Return`](Return.md)[]
+
+#### Defined in
+
+[models/order.ts:196](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L196)
+
+___
+
+### sales\_channel
+
+• **sales\_channel**: [`SalesChannel`](SalesChannel.md)
+
+#### Defined in
+
+[models/order.ts:252](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L252)
+
+___
+
+### sales\_channel\_id
+
+• **sales\_channel\_id**: ``null`` \| `string`
+
+#### Defined in
+
+[models/order.ts:246](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L246)
+
+___
+
+### shipping\_address
+
+• **shipping\_address**: [`Address`](Address.md)
+
+#### Defined in
+
+[models/order.ts:133](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L133)
+
+___
+
+### shipping\_address\_id
+
+• **shipping\_address\_id**: `string`
+
+#### Defined in
+
+[models/order.ts:129](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L129)
+
+___
+
+### shipping\_methods
+
+• **shipping\_methods**: [`ShippingMethod`](ShippingMethod.md)[]
+
+#### Defined in
+
+[models/order.ts:185](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L185)
+
+___
+
+### shipping\_total
+
+• **shipping\_total**: `number`
+
+#### Defined in
+
+[models/order.ts:255](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L255)
+
+___
+
+### status
+
+• **status**: [`OrderStatus`](../enums/OrderStatus.md)
+
+#### Defined in
+
+[models/order.ts:83](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L83)
+
+___
+
+### subtotal
+
+• **subtotal**: `number`
+
+#### Defined in
+
+[models/order.ts:260](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L260)
+
+___
+
+### swaps
+
+• **swaps**: [`Swap`](Swap.md)[]
+
+#### Defined in
+
+[models/order.ts:205](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L205)
+
+___
+
+### tax\_rate
+
+• **tax\_rate**: ``null`` \| `number`
+
+#### Defined in
+
+[models/order.ts:152](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L152)
+
+___
+
+### tax\_total
+
+• **tax\_total**: ``null`` \| `number`
+
+#### Defined in
+
+[models/order.ts:257](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L257)
+
+___
+
+### total
+
+• **total**: `number`
+
+#### Defined in
+
+[models/order.ts:259](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L259)
+
+___
+
+### 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)
+
+## Methods
+
+### beforeInsert
+
+▸ `Private` **beforeInsert**(): `Promise`<`void`\>
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[models/order.ts:266](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/order.ts#L266)