Files

Shahed Nasser 914d773d3a 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

2023-08-15 18:07:54 +03:00

12 KiB

Raw Blame History

Class: DraftOrderService

Handles draft orders

Implements

Hierarchy

TransactionBaseService

↳ DraftOrderService

Constructors

constructor

• new DraftOrderService(__namedParameters)

Parameters

Name	Type
`__namedParameters`	`InjectedDependencies`

Overrides

TransactionBaseService.constructor

Defined in

medusa/src/services/draft-order.ts:67

Properties

configModule

• Protected Optional Readonly __configModule__: Record<string, unknown>

Inherited from

TransactionBaseService.__configModule__

Defined in

medusa/src/interfaces/transaction-base-service.ts:14

container

• Protected Readonly __container__: any

Inherited from

TransactionBaseService.__container__

Defined in

medusa/src/interfaces/transaction-base-service.ts:13

moduleDeclaration

• Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

medusa/src/interfaces/transaction-base-service.ts:15

cartService_

• Protected Readonly cartService_: CartService

Defined in

medusa/src/services/draft-order.ts:61

customShippingOptionService_

• Protected Readonly customShippingOptionService_: CustomShippingOptionService

Defined in

medusa/src/services/draft-order.ts:65

draftOrderRepository_

• Protected Readonly draftOrderRepository_: Repository<DraftOrder>

Defined in

medusa/src/services/draft-order.ts:57

eventBus_

• Protected Readonly eventBus_: EventBusService

Defined in

medusa/src/services/draft-order.ts:60

lineItemService_

• Protected Readonly lineItemService_: LineItemService

Defined in

medusa/src/services/draft-order.ts:62

manager_

• Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:5

orderRepository_

• Protected Readonly orderRepository_: Repository<Order> & { findOneWithRelations: (relations: FindOptionsRelations<Order>, optionsWithoutRelations: Omit<FindManyOptions<Order>, "relations">) => Promise<Order> ; findWithRelations: (relations: FindOptionsRelations<Order>, optionsWithoutRelations: Omit<FindManyOptions<Order>, "relations">) => Promise<Order[]> }

Defined in

medusa/src/services/draft-order.ts:59

paymentRepository_

• Protected Readonly paymentRepository_: Repository<Payment>

Defined in

medusa/src/services/draft-order.ts:58

productVariantService_

• Protected Readonly productVariantService_: ProductVariantService

Defined in

medusa/src/services/draft-order.ts:63

shippingOptionService_

• Protected Readonly shippingOptionService_: ShippingOptionService

Defined in

medusa/src/services/draft-order.ts:64

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Inherited from

TransactionBaseService.transactionManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:6

Events

▪ Static Readonly Events: Object

Type declaration

Name	Type
`CREATED`	`string`
`UPDATED`	`string`

Defined in

medusa/src/services/draft-order.ts:52

Accessors

activeManager_

• Protected get activeManager_(): EntityManager

Returns

EntityManager

Inherited from

TransactionBaseService.activeManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:8

Methods

atomicPhase_

▸ Protected atomicPhase_<TResult, TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>

Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created.

Type parameters

Name
`TResult`
`TError`

Parameters

Name	Type	Description
`work`	(`transactionManager`: `EntityManager`) => `Promise`<`TResult`>	the transactional work to be done
`isolationOrErrorHandler?`	`IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`>	the isolation level to be used for the work.
`maybeErrorHandlerOrDontFail?`	(`error`: `TError`) => `Promise`<`void` \| `TResult`>	Potential error handler

Returns

Promise<TResult>

the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

medusa/src/interfaces/transaction-base-service.ts:56

create

▸ create(data): Promise<DraftOrder>

Creates a draft order.

Parameters

Name	Type	Description
`data`	`DraftOrderCreateProps`	data to create draft order from

Returns

Promise<DraftOrder>

the created draft order

Defined in

medusa/src/services/draft-order.ts:260

delete

▸ delete(draftOrderId): Promise<undefined | DraftOrder>

Deletes draft order idempotently.

Parameters

Name	Type	Description
`draftOrderId`	`string`	id of draft order to delete

Returns

Promise<undefined | DraftOrder>

empty promise

Defined in

medusa/src/services/draft-order.ts:156

list

▸ list(selector, config?): Promise<DraftOrder[]>

Lists draft orders

Parameters

Name	Type	Description
`selector`	`any`	query object for find
`config`	`FindConfig`<`DraftOrder`>	configurable attributes for find

Returns

Promise<DraftOrder[]>

list of draft orders

Defined in

medusa/src/services/draft-order.ts:238

listAndCount

▸ listAndCount(selector, config?): Promise<[DraftOrder[], number]>

Lists draft orders alongside the count

Parameters

Name	Type	Description
`selector`	`any`	query selector to filter draft orders
`config`	`FindConfig`<`DraftOrder`>	query config

Returns

Promise<[DraftOrder[], number]>

draft orders

Defined in

medusa/src/services/draft-order.ts:180

registerCartCompletion

▸ registerCartCompletion(draftOrderId, orderId): Promise<UpdateResult>

Registers a draft order as completed, when an order has been completed.

Parameters

Name	Type	Description
`draftOrderId`	`string`	id of draft order to complete
`orderId`	`string`	id of order completed from draft order cart

Returns

Promise<UpdateResult>

the created order

Defined in

medusa/src/services/draft-order.ts:420

retrieve

▸ retrieve(draftOrderId, config?): Promise<DraftOrder>

Retrieves a draft order with the given id.

Parameters

Name	Type	Description
`draftOrderId`	`string`	id of the draft order to retrieve
`config`	`FindConfig`<`DraftOrder`>	query object for findOne

Returns

Promise<DraftOrder>

the draft order

Defined in

medusa/src/services/draft-order.ts:98

retrieveByCartId

▸ retrieveByCartId(cartId, config?): Promise<DraftOrder>

Retrieves a draft order based on its associated cart id

Parameters

Name	Type	Description
`cartId`	`string`	cart id that the draft orders's cart has
`config`	`FindConfig`<`DraftOrder`>	query object for findOne

Returns

Promise<DraftOrder>

the draft order

Defined in

medusa/src/services/draft-order.ts:131

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

Name	Type
`err`	`Record`<`string`, `unknown`> \| { `code`: `string` }

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

medusa/src/interfaces/transaction-base-service.ts:37

update

▸ update(id, data): Promise<DraftOrder>

Updates a draft order with the given data

Parameters

Name	Type	Description
`id`	`string`	id of the draft order
`data`	`Object`	values to update the order with
`data.no_notification_order`	`boolean`	-

Returns

Promise<DraftOrder>

the updated draft order

Defined in

medusa/src/services/draft-order.ts:449

withTransaction

▸ withTransaction(transactionManager?): DraftOrderService

Parameters

Name	Type
`transactionManager?`	`EntityManager`

Returns

DraftOrderService

Inherited from

TransactionBaseService.withTransaction

Defined in

medusa/src/interfaces/transaction-base-service.ts:20

12 KiB Raw Blame History

Class: DraftOrderService

Hierarchy

Constructors

constructor

Parameters

Overrides

Defined in

Properties

__configModule__

Inherited from

Defined in

__container__

Inherited from

Defined in

__moduleDeclaration__

Inherited from

Defined in

cartService_

Defined in

customShippingOptionService_

Defined in

draftOrderRepository_

Defined in

eventBus_

Defined in

lineItemService_

Defined in

manager_

Inherited from

Defined in

orderRepository_

Defined in

paymentRepository_

Defined in

productVariantService_

Defined in

shippingOptionService_

Defined in

transactionManager_

Inherited from

Defined in

Events

Type declaration

Defined in

Accessors

activeManager_

Returns

Inherited from

Defined in

Methods

atomicPhase_

Type parameters

Parameters

Returns

Inherited from

Defined in

create

Parameters

Returns

Defined in

delete

Parameters

Returns

Defined in

list

Parameters

Returns

Defined in

listAndCount

Parameters

Returns

Defined in

registerCartCompletion

Parameters

Returns

Defined in

retrieve

Parameters

Returns

12 KiB

Raw Blame History

configModule

container

moduleDeclaration