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

20 KiB

Raw Blame History

Class: SwapService

Handles swaps

Hierarchy

TransactionBaseService

↳ SwapService

Constructors

constructor

• new SwapService(__namedParameters)

Parameters

Name	Type
`__namedParameters`	`InjectedProps`

Overrides

TransactionBaseService.constructor

Defined in

medusa/src/services/swap.ts:91

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/swap.ts:77

customShippingOptionService_

• Protected Readonly customShippingOptionService_: CustomShippingOptionService

Defined in

medusa/src/services/swap.ts:87

eventBus_

• Protected Readonly eventBus_: EventBusService

Defined in

medusa/src/services/swap.ts:78

fulfillmentService_

• Protected Readonly fulfillmentService_: FulfillmentService

Defined in

medusa/src/services/swap.ts:83

lineItemAdjustmentService_

• Protected Readonly lineItemAdjustmentService_: LineItemAdjustmentService

Defined in

medusa/src/services/swap.ts:86

lineItemService_

• Protected Readonly lineItemService_: LineItemService

Defined in

medusa/src/services/swap.ts:82

manager_

• Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

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

orderService_

• Protected Readonly orderService_: OrderService

Defined in

medusa/src/services/swap.ts:79

paymentProviderService_

• Protected Readonly paymentProviderService_: PaymentProviderService

Defined in

medusa/src/services/swap.ts:85

productVariantInventoryService_

• Protected Readonly productVariantInventoryService_: ProductVariantInventoryService

Defined in

medusa/src/services/swap.ts:89

returnService_

• Protected Readonly returnService_: ReturnService

Defined in

medusa/src/services/swap.ts:80

shippingOptionService_

• Protected Readonly shippingOptionService_: ShippingOptionService

Defined in

medusa/src/services/swap.ts:84

swapRepository_

• Protected Readonly swapRepository_: Repository<Swap>

Defined in

medusa/src/services/swap.ts:75

totalsService_

• Protected Readonly totalsService_: TotalsService

Defined in

medusa/src/services/swap.ts:81

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Inherited from

TransactionBaseService.transactionManager_

Defined in

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

Events

▪ Static Events: Object

Type declaration

Name	Type
`CREATED`	`string`
`FULFILLMENT_CREATED`	`string`
`PAYMENT_CAPTURED`	`string`
`PAYMENT_CAPTURE_FAILED`	`string`
`PAYMENT_COMPLETED`	`string`
`PROCESS_REFUND_FAILED`	`string`
`RECEIVED`	`string`
`REFUND_PROCESSED`	`string`
`SHIPMENT_CREATED`	`string`

Defined in

medusa/src/services/swap.ts:63

Accessors

activeManager_

• Protected get activeManager_(): EntityManager

Returns

EntityManager

Inherited from

TransactionBaseService.activeManager_

Defined in

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

Methods

areReturnItemsValid

▸ Protected areReturnItemsValid(returnItems): Promise<boolean>

Parameters

Name	Type
`returnItems`	`WithRequiredProperty`<`Partial`<`ReturnItem`>, `"item_id"`>[]

Returns

Promise<boolean>

Defined in

medusa/src/services/swap.ts:1240

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

cancel

▸ cancel(swapId): Promise<Swap>

Cancels a given swap if possible. A swap can only be canceled if all related returns, fulfillments, and payments have been canceled. If a swap is associated with a refund, it cannot be canceled.

Parameters

Name	Type	Description
`swapId`	`string`	the id of the swap to cancel.

Returns

Promise<Swap>

the canceled swap.

Defined in

medusa/src/services/swap.ts:857

cancelFulfillment

▸ cancelFulfillment(fulfillmentId): Promise<Swap>

Cancels a fulfillment (if related to a swap)

Parameters

Name	Type	Description
`fulfillmentId`	`string`	the ID of the fulfillment to cancel

Returns

Promise<Swap>

updated swap

Defined in

medusa/src/services/swap.ts:1059

create

▸ create(order, returnItems, additionalItems?, returnShipping?, custom?): Promise<Swap>

Creates a swap from an order, with given return items, additional items and an optional return shipping method.

Parameters

Name	Type	Description
`order`	`Order`	the order to base the swap off
`returnItems`	`WithRequiredProperty`<`Partial`<`ReturnItem`>, `"item_id"`>[]	the items to return in the swap
`additionalItems?`	`Pick`<`LineItem`, `"variant_id"` \| `"quantity"`>[]	the items to send to the customer
`returnShipping?`	`Object`	an optional shipping method for returning the returnItems
`returnShipping.option_id`	`string`	-
`returnShipping.price?`	`number`	-
`custom`	`Object`	contains relevant custom information. This object may include no_notification which will disable sending notification when creating swap. If set, it overrules the attribute inherited from the order
`custom.allow_backorder?`	`boolean`	-
`custom.idempotency_key?`	`string`	-
`custom.location_id?`	`string`	-
`custom.no_notification?`	`boolean`	-

Returns

Promise<Swap>

the newly created swap

Defined in

medusa/src/services/swap.ts:321

createCart

▸ createCart(swapId, customShippingOptions?, context?): Promise<Swap>

Creates a cart from the given swap. The cart can be used to pay for differences associated with the swap. The swap represented by the swapId must belong to the order. Fails if there is already a cart on the swap.

Parameters

Name	Type	Default value	Description
`swapId`	`string`	`undefined`	the id of the swap to create the cart from
`customShippingOptions`	{ `option_id`: `string` ; `price`: `number` }[]	`[]`	the shipping options
`context`	`Object`	`{}`	-
`context.sales_channel_id?`	`string`	`undefined`	-

Returns

Promise<Swap>

the swap with its cart_id prop set to the id of the new cart.

Defined in

medusa/src/services/swap.ts:577

createFulfillment

▸ createFulfillment(swapId, config?): Promise<Swap>

Fulfills the additional items associated with the swap. Will call the fulfillment providers associated with the shipping methods.

Parameters

Name	Type	Description
`swapId`	`string`	the id of the swap to fulfill,
`config`	`CreateShipmentConfig`	optional configurations, includes optional metadata to attach to the shipment, and a no_notification flag.

Returns

Promise<Swap>

the updated swap with new status and fulfillments.

Defined in

medusa/src/services/swap.ts:919

createShipment

▸ createShipment(swapId, fulfillmentId, trackingLinks?, config?): Promise<Swap>

Marks a fulfillment as shipped and attaches tracking numbers.

Parameters

Name	Type	Description
`swapId`	`string`	the id of the swap that has been shipped.
`fulfillmentId`	`string`	the id of the specific fulfillment that has been shipped
`trackingLinks?`	{ `tracking_number`: `string` }[]	the tracking numbers associated with the shipment
`config`	`CreateShipmentConfig`	optional configurations, includes optional metadata to attach to the shipment, and a noNotification flag.

Returns

Promise<Swap>

the updated swap with new fulfillments and status.

Defined in

medusa/src/services/swap.ts:1090

deleteMetadata

▸ deleteMetadata(swapId, key): Promise<Swap>

Dedicated method to delete metadata for a swap.

Parameters

Name	Type	Description
`swapId`	`string`	the order to delete metadata from.
`key`	`string`	key for metadata field

Returns

Promise<Swap>

resolves to the updated result.

Defined in

medusa/src/services/swap.ts:1168

list

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

List swaps.

Parameters

Name	Type	Description
`selector`	`Selector`<`Swap`>	the query object for find
`config`	`FindConfig`<`Swap`>	the configuration used to find the objects. contains relations, skip, and take.

Returns

Promise<Swap[]>

the result of the find operation

Defined in

medusa/src/services/swap.ts:273

listAndCount

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

List swaps.

Parameters

Name	Type	Description
`selector`	`Selector`<`Swap`>	the query object for find
`config`	`FindConfig`<`Swap`>	the configuration used to find the objects. contains relations, skip, and take.

Returns

Promise<[Swap[], number]>

the result of the find operation

Defined in

medusa/src/services/swap.ts:293

processDifference

▸ processDifference(swapId): Promise<Swap>

Process difference for the requested swap.

Parameters

Name	Type	Description
`swapId`	`string`	id of a swap being processed

Returns

Promise<Swap>

processed swap

Defined in

medusa/src/services/swap.ts:421

registerCartCompletion

▸ registerCartCompletion(swapId): Promise<Swap>

Parameters

Name	Type	Description
`swapId`	`string`	The id of the swap

Returns

Promise<Swap>

swap related to the cart

Defined in

medusa/src/services/swap.ts:724

registerReceived

▸ registerReceived(id): Promise<Swap>

Registers the swap return items as received so that they cannot be used as a part of other swaps/returns.

Parameters

Name	Type	Description
`id`	`any`	the id of the order with the swap.

Returns

Promise<Swap>

the resulting order

Defined in

medusa/src/services/swap.ts:1206

retrieve

▸ retrieve(swapId, config?): Promise<Swap>

Retrieves a swap with the given id.

Parameters

Name	Type	Description
`swapId`	`string`	the id of the swap to retrieve
`config`	`Omit`<`FindConfig`<`Swap`>, `"select"`> & { `select?`: `string`[] }	the configuration to retrieve the swap

Returns

Promise<Swap>

the swap

Defined in

medusa/src/services/swap.ts:203

retrieveByCartId

▸ retrieveByCartId(cartId, relations?): Promise<Swap>

Retrieves a swap based on its associated cart id

Parameters

Name	Type	Default value	Description
`cartId`	`string`	`undefined`	the cart id that the swap's cart has
`relations`	`undefined` \| `string`[]	`[]`	the relations to retrieve swap

Returns

Promise<Swap>

the swap

Defined in

medusa/src/services/swap.ts:246

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

transformQueryForCart

▸ Protected transformQueryForCart(config): Omit<FindConfig<Swap>, "select"> & { select?: string[] } & { cartRelations: undefined | string[] ; cartSelects: undefined | keyof Cart[] }

Transform find config object for retrieval.

Parameters

Name	Type	Description
`config`	`Omit`<`FindConfig`<`Swap`>, `"select"`> & { `select?`: `string`[] }	parsed swap find config

Returns

Omit<FindConfig<Swap>, "select"> & { select?: string[] } & { cartRelations: undefined | string[] ; cartSelects: undefined | keyof Cart[] }

transformed find swap config

Defined in

medusa/src/services/swap.ts:130

update

▸ update(swapId, update): Promise<Swap>

Update the swap record.

Parameters

Name	Type	Description
`swapId`	`string`	id of a swap to update
`update`	`Partial`<`Swap`>	new data

Returns

Promise<Swap>

updated swap record

Defined in

medusa/src/services/swap.ts:544

withTransaction

▸ withTransaction(transactionManager?): SwapService

Parameters

Name	Type
`transactionManager?`	`EntityManager`

Returns

SwapService

Inherited from

TransactionBaseService.withTransaction

Defined in

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

20 KiB Raw Blame History

Class: SwapService

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

eventBus_

Defined in

fulfillmentService_

Defined in

lineItemAdjustmentService_

Defined in

lineItemService_

Defined in

manager_

Inherited from

Defined in

orderService_

Defined in

paymentProviderService_

Defined in

productVariantInventoryService_

Defined in

returnService_

Defined in

shippingOptionService_

Defined in

swapRepository_

Defined in

totalsService_

Defined in

transactionManager_

Inherited from

Defined in

Events

Type declaration

Defined in

Accessors

activeManager_

Returns

Inherited from

Defined in

Methods

areReturnItemsValid

Parameters

Returns

Defined in

atomicPhase_

Type parameters

Parameters

Returns

Inherited from

Defined in

cancel

Parameters

Returns

Defined in

cancelFulfillment

Parameters

Returns

Defined in

create

Parameters

Returns

20 KiB

Raw Blame History

configModule

container

moduleDeclaration