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

18 KiB

Raw Blame History

Class: RegionService

Provides layer to manipulate regions.

Hierarchy

TransactionBaseService

↳ RegionService

Constructors

constructor

• new RegionService(__namedParameters)

Parameters

Name	Type
`__namedParameters`	`InjectedDependencies`

Overrides

TransactionBaseService.constructor

Defined in

medusa/src/services/region.ts:64

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

countryRepository_

• Protected Readonly countryRepository_: Repository<Country>

Defined in

medusa/src/services/region.ts:56

currencyRepository_

• Protected Readonly currencyRepository_: Repository<Currency>

Defined in

medusa/src/services/region.ts:57

eventBus_

• Protected Readonly eventBus_: EventBusService

Defined in

medusa/src/services/region.ts:51

featureFlagRouter_

• Protected featureFlagRouter_: FlagRouter

Defined in

medusa/src/services/region.ts:49

fulfillmentProviderRepository_

• Protected Readonly fulfillmentProviderRepository_: Repository<FulfillmentProvider>

Defined in

medusa/src/services/region.ts:61

fulfillmentProviderService_

• Protected Readonly fulfillmentProviderService_: FulfillmentProviderService

Defined in

medusa/src/services/region.ts:54

manager_

• Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

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

paymentProviderRepository_

• Protected Readonly paymentProviderRepository_: Repository<PaymentProvider>

Defined in

medusa/src/services/region.ts:59

paymentProviderService_

• Protected Readonly paymentProviderService_: PaymentProviderService

Defined in

medusa/src/services/region.ts:53

regionRepository_

• Protected Readonly regionRepository_: Repository<Region>

Defined in

medusa/src/services/region.ts:55

storeService_

• Protected Readonly storeService_: StoreService

Defined in

medusa/src/services/region.ts:52

taxProviderRepository_

• Protected Readonly taxProviderRepository_: Repository<TaxProvider>

Defined in

medusa/src/services/region.ts:62

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`
`DELETED`	`string`
`UPDATED`	`string`

Defined in

medusa/src/services/region.ts:43

Accessors

activeManager_

• Protected get activeManager_(): EntityManager

Returns

EntityManager

Inherited from

TransactionBaseService.activeManager_

Defined in

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

Methods

addCountry

▸ addCountry(regionId, code): Promise<Region>

Adds a country to the region.

Parameters

Name	Type	Description
`regionId`	`string`	the region to add a country to
`code`	`string`	a 2 digit alphanumeric ISO country code.

Returns

Promise<Region>

the updated Region

Defined in

medusa/src/services/region.ts:577

addFulfillmentProvider

▸ addFulfillmentProvider(regionId, providerId): Promise<Region>

Adds a fulfillment provider that is available in the region. Fails if the provider doesn't exist.

Parameters

Name	Type	Description
`regionId`	`string`	the region to add the provider to
`providerId`	`string`	the provider to add to the region

Returns

Promise<Region>

the updated Region

Defined in

medusa/src/services/region.ts:705

addPaymentProvider

▸ addPaymentProvider(regionId, providerId): Promise<Region>

Adds a payment provider that is available in the region. Fails if the provider doesn't exist.

Parameters

Name	Type	Description
`regionId`	`string`	the region to add the provider to
`providerId`	`string`	the provider to add to the region

Returns

Promise<Region>

the updated Region

Defined in

medusa/src/services/region.ts:656

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<Region>

Creates a region.

Parameters

Name	Type	Description
`data`	`CreateRegionInput`	the unvalidated region

Returns

Promise<Region>

the newly created region

Defined in

medusa/src/services/region.ts:100

delete

▸ delete(regionId): Promise<void>

Deletes a region.

Parameters

Name	Type	Description
`regionId`	`string`	the region to delete

Returns

Promise<void>

the result of the delete operation

Defined in

medusa/src/services/region.ts:546

list

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

Lists all regions based on a query

Parameters

Name	Type	Description
`selector`	`Selector`<`Region`>	query object for find
`config`	`FindConfig`<`Region`>	configuration settings

Returns

Promise<Region[]>

result of the find operation

Defined in

medusa/src/services/region.ts:505

listAndCount

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

Lists all regions based on a query and returns them along with count

Parameters

Name	Type	Description
`selector`	`Selector`<`Region`>	query object for find
`config`	`FindConfig`<`Region`>	configuration settings

Returns

Promise<[Region[], number]>

result of the find operation

Defined in

medusa/src/services/region.ts:524

removeCountry

▸ removeCountry(regionId, code): Promise<Region>

Removes a country from a Region.

Parameters

Name	Type	Description
`regionId`	`string`	the region to remove from
`code`	`string`	a 2 digit alphanumeric ISO country code to remove

Returns

Promise<Region>

the updated Region

Defined in

medusa/src/services/region.ts:615

removeFulfillmentProvider

▸ removeFulfillmentProvider(regionId, providerId): Promise<Region>

Removes a fulfillment provider from a region. Is idempotent.

Parameters

Name	Type	Description
`regionId`	`string`	the region to remove the provider from
`providerId`	`string`	the provider to remove from the region

Returns

Promise<Region>

the updated Region

Defined in

medusa/src/services/region.ts:791

removePaymentProvider

▸ removePaymentProvider(regionId, providerId): Promise<Region>

Removes a payment provider from a region. Is idempotent.

Parameters

Name	Type	Description
`regionId`	`string`	the region to remove the provider from
`providerId`	`string`	the provider to remove from the region

Returns

Promise<Region>

the updated Region

Defined in

medusa/src/services/region.ts:752

retrieve

▸ retrieve(regionId, config?): Promise<Region>

Retrieves a region by its id.

Parameters

Name	Type	Description
`regionId`	`string`	the id of the region to retrieve
`config`	`FindConfig`<`Region`>	configuration settings

Returns

Promise<Region>

the region

Defined in

medusa/src/services/region.ts:470

retrieveByCountryCode

▸ retrieveByCountryCode(code, config?): Promise<Region>

Retrieve a region by country code.

Parameters

Name	Type	Description
`code`	`string`	a 2 digit alphanumeric ISO country code
`config`	`FindConfig`<`Region`>	region find config

Returns

Promise<Region>

a Region with country code

Defined in

medusa/src/services/region.ts:416

retrieveByName

▸ retrieveByName(name): Promise<Region>

Retrieves a region by name.

Parameters

Name	Type	Description
`name`	`string`	the name of the region to retrieve

Returns

Promise<Region>

region with the matching name

Defined in

medusa/src/services/region.ts:450

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(regionId, update): Promise<Region>

Updates a region

Parameters

Name	Type	Description
`regionId`	`string`	the region to update
`update`	`UpdateRegionInput`	the data to update the region with

Returns

Promise<Region>

the result of the update operation

Defined in

medusa/src/services/region.ts:171

validateCountry

▸ Protected validateCountry(code, regionId): Promise<Country>

Validates a country code. Will normalize the code before checking for existence.

Parameters

Name	Type	Description
`code`	`string`	a 2 digit alphanumeric ISO country code
`regionId`	`string`	the id of the current region to check against

Returns

Promise<Country>

the validated Country

Defined in

medusa/src/services/region.ts:367

validateCurrency

▸ Protected validateCurrency(currencyCode): Promise<void>

Validates a currency code. Will throw if the currency code doesn't exist.

Throws

if the provided currency code is invalid

Parameters

Name	Type	Description
`currencyCode`	`string`	an ISO currency code

Returns

Promise<void>

void

Defined in

medusa/src/services/region.ts:342

validateFields

▸ Protected validateFields<T>(regionData, id?): Promise<DeepPartial<Region>>

Validates fields for creation and updates. If the region already exists the id can be passed to check that country updates are allowed.

Type parameters

Name	Type
`T`	extends `UpdateRegionInput` \| `CreateRegionInput`

Parameters

Name	Type	Description
`regionData`	`Omit`<`T`, `"metadata"` \| `"currency_code"`>	the region data to validate
`id?`	`T` extends `UpdateRegionInput` ? `string` : `undefined`	optional id of the region to check against

Returns

Promise<DeepPartial<Region>>

the validated region data

Defined in

medusa/src/services/region.ts:240

validateTaxRate

▸ Protected validateTaxRate(taxRate): void

Validates a tax rate. Will throw if the tax rate is not between 0 and 1.

Throws

if the tax rate isn't number between 0-100

Parameters

Name	Type	Description
`taxRate`	`number`	a number representing the tax rate of the region

Returns

void

void

Defined in

medusa/src/services/region.ts:326

withTransaction

▸ withTransaction(transactionManager?): RegionService

Parameters

Name	Type
`transactionManager?`	`EntityManager`

Returns

RegionService

Inherited from

TransactionBaseService.withTransaction

Defined in

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

18 KiB Raw Blame History

Class: RegionService

Hierarchy

Constructors

constructor

Parameters

Overrides

Defined in

Properties

__configModule__

Inherited from

Defined in

__container__

Inherited from

Defined in

__moduleDeclaration__

Inherited from

Defined in

countryRepository_

Defined in

currencyRepository_

Defined in

eventBus_

Defined in

featureFlagRouter_

Defined in

fulfillmentProviderRepository_

Defined in

fulfillmentProviderService_

Defined in

manager_

Inherited from

Defined in

paymentProviderRepository_

Defined in

paymentProviderService_

Defined in

regionRepository_

Defined in

storeService_

Defined in

taxProviderRepository_

Defined in

transactionManager_

Inherited from

Defined in

Events

Type declaration

Defined in

Accessors

activeManager_

Returns

Inherited from

Defined in

Methods

addCountry

Parameters

Returns

Defined in

addFulfillmentProvider

Parameters

Returns

Defined in

addPaymentProvider

Parameters

Returns

Defined in

atomicPhase_

Type parameters

Parameters

Returns

Inherited from

Defined in

create

Parameters

Returns

Defined in

delete

Parameters

Returns

18 KiB

Raw Blame History

configModule

container

moduleDeclaration