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: GiftCardService

Provides layer to manipulate gift cards.

Hierarchy

TransactionBaseService

↳ GiftCardService

Constructors

constructor

• new GiftCardService(__namedParameters)

Parameters

Name	Type
`__namedParameters`	`InjectedDependencies`

Overrides

TransactionBaseService.constructor

Defined in

medusa/src/services/gift-card.ts:39

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

eventBus_

• Protected Readonly eventBus_: EventBusService

Defined in

medusa/src/services/gift-card.ts:33

giftCardRepository_

• Protected Readonly giftCardRepository_: Repository<GiftCard> & { listGiftCardsAndCount: (query: ExtendedFindConfig<GiftCard>, q?: string) => Promise<[GiftCard[], number]> }

Defined in

medusa/src/services/gift-card.ts:29

giftCardTransactionRepo_

• Protected Readonly giftCardTransactionRepo_: Repository<GiftCardTransaction>

Defined in

medusa/src/services/gift-card.ts:31

manager_

• Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

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

regionService_

• Protected Readonly regionService_: RegionService

Defined in

medusa/src/services/gift-card.ts:32

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`

Defined in

medusa/src/services/gift-card.ts:35

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(giftCard): Promise<GiftCard>

Creates a gift card with provided data given that the data is validated.

Parameters

Name	Type	Description
`giftCard`	`CreateGiftCardInput`	the gift card data to create

Returns

Promise<GiftCard>

the result of the create operation

Defined in

medusa/src/services/gift-card.ts:122

createTransaction

▸ createTransaction(data): Promise<string>

Parameters

Name	Type
`data`	`CreateGiftCardTransactionInput`

Returns

Promise<string>

Defined in

medusa/src/services/gift-card.ts:106

delete

▸ delete(giftCardId): Promise<void | GiftCard>

Deletes a gift card idempotently

Parameters

Name	Type	Description
`giftCardId`	`string`	id of gift card to delete

Returns

Promise<void | GiftCard>

the result of the delete operation

Defined in

medusa/src/services/gift-card.ts:295

list

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

Parameters

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

Returns

Promise<GiftCard[]>

the result of the find operation

Defined in

medusa/src/services/gift-card.ts:98

listAndCount

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

Parameters

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

Returns

Promise<[GiftCard[], number]>

the result of the find operation

Defined in

medusa/src/services/gift-card.ts:74

retrieve

▸ retrieve(giftCardId, config?): Promise<GiftCard>

Gets a gift card by id.

Parameters

Name	Type	Description
`giftCardId`	`string`	id of gift card to retrieve
`config`	`FindConfig`<`GiftCard`>	optional values to include with gift card query

Returns

Promise<GiftCard>

the gift card

Defined in

medusa/src/services/gift-card.ts:215

retrieveByCode

▸ retrieveByCode(code, config?): Promise<GiftCard>

Parameters

Name	Type
`code`	`string`
`config`	`FindConfig`<`GiftCard`>

Returns

Promise<GiftCard>

Defined in

medusa/src/services/gift-card.ts:229

retrieve_

▸ Protected retrieve_(selector, config?): Promise<GiftCard>

Parameters

Name	Type
`selector`	`Selector`<`GiftCard`>
`config`	`FindConfig`<`GiftCard`>

Returns

Promise<GiftCard>

Defined in

medusa/src/services/gift-card.ts:182

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(giftCardId, update): Promise<GiftCard>

Updates a giftCard.

Parameters

Name	Type	Description
`giftCardId`	`string`	giftCard id of giftCard to update
`update`	`UpdateGiftCardInput`	the data to update the giftCard with

Returns

Promise<GiftCard>

the result of the update operation

Defined in

medusa/src/services/gift-card.ts:249

withTransaction

▸ withTransaction(transactionManager?): GiftCardService

Parameters

Name	Type
`transactionManager?`	`EntityManager`

Returns

GiftCardService

Inherited from

TransactionBaseService.withTransaction

Defined in

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

generateCode

▸ Static generateCode(): string

Generates a 16 character gift card code

Returns

string

the generated gift card code

Defined in

medusa/src/services/gift-card.ts:58

resolveTaxRate

▸ Static Protected resolveTaxRate(giftCardTaxRate, region): null | number

The tax_rate of the giftcard can depend on whether regions tax gift cards, an input provided by the user or the tax rate. Based on these conditions, tax_rate changes.

Parameters

Name	Type
`giftCardTaxRate`	`null` \| `number`
`region`	`Region`

Returns

null | number

the tax rate for the gift card

Defined in

medusa/src/services/gift-card.ts:161

12 KiB Raw Blame History

Class: GiftCardService

Hierarchy

Constructors

constructor

Parameters

Overrides

Defined in

Properties

__configModule__

Inherited from

Defined in

__container__

Inherited from

Defined in

__moduleDeclaration__

Inherited from

Defined in

eventBus_

Defined in

giftCardRepository_

Defined in

giftCardTransactionRepo_

Defined in

manager_

Inherited from

Defined in

regionService_

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

createTransaction

Parameters

Returns

Defined in

delete

Parameters

Returns

Defined in

list

Parameters

Returns

Defined in

listAndCount

Parameters

Returns

Defined in

retrieve

Parameters

Returns

Defined in

retrieveByCode

Parameters

Returns

Defined in

retrieve_

Parameters

Returns

Defined in

shouldRetryTransaction_

12 KiB

Raw Blame History

configModule

container

moduleDeclaration