docs: create docs workspace (#5174)

* docs: migrate ui docs to docs universe

* created yarn workspace

* added eslint and tsconfig configurations

* fix eslint configurations

* fixed eslint configurations

* shared tailwind configurations

* added shared ui package

* added more shared components

* migrating more components

* made details components shared

* move InlineCode component

* moved InputText

* moved Loading component

* Moved Modal component

* moved Select components

* Moved Tooltip component

* moved Search components

* moved ColorMode provider

* Moved Notification components and providers

* used icons package

* use UI colors in api-reference

* moved Navbar component

* used Navbar and Search in UI docs

* added Feedback to UI docs

* general enhancements

* fix color mode

* added copy colors file from ui-preset

* added features and enhancements to UI docs

* move Sidebar component and provider

* general fixes and preparations for deployment

* update docusaurus version

* adjusted versions

* fix output directory

* remove rootDirectory property

* fix yarn.lock

* moved code component

* added vale for all docs MD and MDX

* fix tests

* fix vale error

* fix deployment errors

* change ignore commands

* add output directory

* fix docs test

* general fixes

* content fixes

* fix announcement script

* added changeset

* fix vale checks

* added nofilter option

* fix vale error
This commit is contained in:
Shahed Nasser
2023-09-21 20:57:15 +03:00
committed by GitHub
parent 19c5d5ba36
commit fa7c94b4cc
3209 changed files with 32188 additions and 31018 deletions

View File

@@ -0,0 +1,251 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: ClaimOrder
[internal](../modules/internal.md).ClaimOrder
Base abstract entity for all entities
## Hierarchy
- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md)
**`ClaimOrder`**
## Properties
### additional\_items
**additional\_items**: [`LineItem`](internal.LineItem.md)[]
#### Defined in
medusa/dist/models/claim-order.d.ts:33
___
### beforeInsert
`Private` **beforeInsert**: `any`
#### Defined in
medusa/dist/models/claim-order.d.ts:50
___
### canceled\_at
**canceled\_at**: `Date`
#### Defined in
medusa/dist/models/claim-order.d.ts:43
___
### claim\_items
**claim\_items**: [`ClaimItem`](internal.ClaimItem.md)[]
#### Defined in
medusa/dist/models/claim-order.d.ts:32
___
### created\_at
**created\_at**: `Date`
#### Overrides
[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at)
#### Defined in
medusa/dist/models/claim-order.d.ts:44
___
### deleted\_at
**deleted\_at**: `Date`
#### Overrides
[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at)
#### Defined in
medusa/dist/models/claim-order.d.ts:46
___
### fulfillment\_status
**fulfillment\_status**: [`ClaimFulfillmentStatus`](../enums/internal.ClaimFulfillmentStatus.md)
#### Defined in
medusa/dist/models/claim-order.d.ts:31
___
### fulfillments
**fulfillments**: [`Fulfillment`](internal.Fulfillment.md)[]
#### Defined in
medusa/dist/models/claim-order.d.ts:41
___
### id
**id**: `string`
#### Inherited from
[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id)
#### Defined in
medusa/dist/interfaces/models/base-entity.d.ts:5
___
### idempotency\_key
**idempotency\_key**: `string`
#### Defined in
medusa/dist/models/claim-order.d.ts:49
___
### metadata
**metadata**: `Record`<`string`, `unknown`\>
#### Defined in
medusa/dist/models/claim-order.d.ts:48
___
### no\_notification
**no\_notification**: `boolean`
#### Defined in
medusa/dist/models/claim-order.d.ts:47
___
### order
**order**: [`Order`](internal.Order.md)
#### Defined in
medusa/dist/models/claim-order.d.ts:36
___
### order\_id
**order\_id**: `string`
#### Defined in
medusa/dist/models/claim-order.d.ts:35
___
### payment\_status
**payment\_status**: [`ClaimPaymentStatus`](../enums/internal.ClaimPaymentStatus.md)
#### Defined in
medusa/dist/models/claim-order.d.ts:30
___
### refund\_amount
**refund\_amount**: `number`
#### Defined in
medusa/dist/models/claim-order.d.ts:42
___
### return\_order
**return\_order**: [`Return`](internal.Return.md)
#### Defined in
medusa/dist/models/claim-order.d.ts:37
___
### shipping\_address
**shipping\_address**: [`Address`](internal.Address.md)
#### Defined in
medusa/dist/models/claim-order.d.ts:39
___
### shipping\_address\_id
**shipping\_address\_id**: `string`
#### Defined in
medusa/dist/models/claim-order.d.ts:38
___
### shipping\_methods
**shipping\_methods**: [`ShippingMethod`](internal.ShippingMethod.md)[]
#### Defined in
medusa/dist/models/claim-order.d.ts:40
___
### type
**type**: [`ClaimType`](../enums/internal.ClaimType.md)
#### Defined in
medusa/dist/models/claim-order.d.ts:34
___
### updated\_at
**updated\_at**: `Date`
#### Overrides
[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at)
#### Defined in
medusa/dist/models/claim-order.d.ts:45