Files
medusa-store/www/apps/docs/content/references/js-client/classes/AdminCurrenciesResource.md
github-actions[bot] daea35fe73 chore(docs): Generated JS Client Reference (#5334)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2023-10-10 17:47:07 +00:00

2.2 KiB

displayed_sidebar
displayed_sidebar
jsClientSidebar

Class: AdminCurrenciesResource

Hierarchy

  • default

    AdminCurrenciesResource

Methods

list

list(query?, customHeaders?): ResponsePromise<AdminCurrenciesListRes>

Parameters

Name Type
query? AdminGetCurrenciesParams
customHeaders Record<string, any>

Returns

ResponsePromise<AdminCurrenciesListRes>

the list of currencies as well as the pagination properties.

Description

Lists currencies. This feature is under development and may change in the future. To use this feature please enable featureflag tax_inclusive_pricing in your medusa backend project.

Defined in

packages/medusa-js/src/resources/admin/currencies.ts:20


update

update(code, payload, customHeaders?): ResponsePromise<AdminCurrenciesRes>

Parameters

Name Type Description
code string code of the currency to update.
payload AdminPostCurrenciesCurrencyReq update to apply to currency.
customHeaders Record<string, any>

Returns

ResponsePromise<AdminCurrenciesRes>

the updated currency.

Description

Updates a currency This feature is under development and may change in the future. To use this feature please enable featureflag tax_inclusive_pricing in your medusa backend project.

Defined in

packages/medusa-js/src/resources/admin/currencies.ts:43