Files

Shahed Nasser fa7c94b4cc 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

2023-09-21 20:57:15 +03:00

18 KiB

Raw Blame History

Class: AdminOrdersResource

Hierarchy

default

↳ AdminOrdersResource

Methods

addShippingMethod

▸ addShippingMethod(id, payload, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

Name	Type
`id`	`string`
`payload`	`AdminPostOrdersOrderShippingMethodsReq`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:152

cancel

▸ cancel(id, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

Name	Type
`id`	`string`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:144

cancelClaim

▸ cancelClaim(id, claimId, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

Name	Type
`id`	`string`
`claimId`	`string`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:225

cancelClaimFulfillment

▸ cancelClaimFulfillment(id, claimId, fulfillmentId, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

Name	Type
`id`	`string`
`claimId`	`string`
`fulfillmentId`	`string`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:116

cancelFulfillment

▸ cancelFulfillment(id, fulfillmentId, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

Name	Type
`id`	`string`
`fulfillmentId`	`string`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:97

cancelSwap

▸ cancelSwap(id, swapId, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

Name	Type
`id`	`string`
`swapId`	`string`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:178

cancelSwapFulfillment

▸ cancelSwapFulfillment(id, swapId, fulfillmentId, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

Name	Type
`id`	`string`
`swapId`	`string`
`fulfillmentId`	`string`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:106

capturePayment

▸ capturePayment(id, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

Name	Type
`id`	`string`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:71

complete

▸ complete(id, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

Name	Type
`id`	`string`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:63

createClaim

▸ createClaim(id, payload, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

Name	Type
`id`	`string`
`payload`	`AdminPostOrdersOrderClaimsReq`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:216

createClaimShipment

▸ createClaimShipment(id, claimId, payload, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

Name	Type
`id`	`string`
`claimId`	`string`
`payload`	`AdminPostOrdersOrderClaimsClaimShipmentsReq`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:254

createFulfillment

▸ createFulfillment(id, payload, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

Name	Type
`id`	`string`
`payload`	`AdminPostOrdersOrderFulfillmentsReq`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:88

createShipment

▸ createShipment(id, payload, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

Name	Type
`id`	`string`
`payload`	`AdminPostOrdersOrderShipmentReq`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:126

createSwap

▸ createSwap(id, payload, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

Name	Type
`id`	`string`
`payload`	`AdminPostOrdersOrderSwapsReq`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:169

createSwapShipment

▸ createSwapShipment(id, swapId, payload, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

Name	Type
`id`	`string`
`swapId`	`string`
`payload`	`AdminPostOrdersOrderSwapsSwapShipmentsReq`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:197

fulfillClaim

▸ fulfillClaim(id, claimId, payload, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

Name	Type
`id`	`string`
`claimId`	`string`
`payload`	`AdminPostOrdersOrderClaimsClaimFulfillmentsReq`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:244

fulfillSwap

▸ fulfillSwap(id, swapId, payload, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

Name	Type
`id`	`string`
`swapId`	`string`
`payload`	`AdminPostOrdersOrderSwapsSwapFulfillmentsReq`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:187

list

▸ list(query?, customHeaders?): ResponsePromise<AdminOrdersListRes>

Parameters

Name	Type
`query?`	`AdminGetOrdersParams`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminOrdersListRes>

Defined in

medusa-js/src/resources/admin/orders.ts:49

processSwapPayment

▸ processSwapPayment(id, swapId, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

Name	Type
`id`	`string`
`swapId`	`string`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:207

refundPayment

▸ refundPayment(id, payload, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

Name	Type
`id`	`string`
`payload`	`AdminPostOrdersOrderRefundsReq`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:79

requestReturn

▸ requestReturn(id, payload, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

Name	Type
`id`	`string`
`payload`	`AdminPostOrdersOrderReturnsReq`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:135

retrieve

▸ retrieve(id, query?, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

Name	Type
`id`	`string`
`query?`	`FindParams`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:34

update

▸ update(id, payload, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

Name	Type
`id`	`string`
`payload`	`AdminPostOrdersOrderReq`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:25

updateClaim

▸ updateClaim(id, claimId, payload, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

Name	Type
`id`	`string`
`claimId`	`string`
`payload`	`AdminPostOrdersOrderClaimsClaimReq`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:234

18 KiB Raw Blame History

Class: AdminOrdersResource

Hierarchy

Methods

addShippingMethod

Parameters

Returns

Defined in

archive

Parameters

Returns

Defined in

cancel

Parameters

Returns

Defined in

cancelClaim

Parameters

Returns

Defined in

cancelClaimFulfillment

Parameters

Returns

Defined in

cancelFulfillment

Parameters

Returns

Defined in

cancelSwap

Parameters

Returns

Defined in

cancelSwapFulfillment

Parameters

Returns

Defined in

capturePayment

Parameters

Returns

Defined in

complete

Parameters

Returns

Defined in

createClaim

Parameters

Returns

Defined in

createClaimShipment

Parameters

Returns

Defined in

createFulfillment

Parameters

Returns

Defined in

createShipment

Parameters

Returns

Defined in

createSwap

Parameters

Returns

Defined in

createSwapShipment

Parameters

Returns

Defined in

fulfillClaim

Parameters

Returns

Defined in

fulfillSwap

Parameters

Returns

Defined in

list

Parameters

Returns

Defined in

18 KiB

Raw Blame History