chore(docs): Generated JS Client Reference (#5421)
* chore(docs): Generated JS Client Reference (automated) * fix js client reference * fix links --------- Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com> Co-authored-by: Shahed nasser <shahednasser@gmail.com>
This commit is contained in:
1604 files changed
+211689
-151746
No files matched your search
+131
@@ -0,0 +1,131 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AdminCurrenciesResource
|
||||
|
||||
[admin/currencies](../../modules/admin_currencies.mdx).AdminCurrenciesResource
|
||||
|
||||
## Methods
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCurrenciesListRes`](../modules/admin_currencies.internal.mdx#admincurrencieslistres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "query",
|
||||
"type": "[`AdminGetCurrenciesParams`](../../internal/classes/admin_currencies.internal.AdminGetCurrenciesParams.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "customHeaders",
|
||||
"type": "Record<`string`, `any`\\>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "`{}`",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCurrenciesListRes`](../modules/admin_currencies.internal.mdx#admincurrencieslistres)\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "ResponsePromise",
|
||||
"type": "[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCurrenciesListRes`](../modules/admin_currencies.internal.mdx#admincurrencieslistres)\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "the list of currencies as well as the pagination properties.",
|
||||
"children": [
|
||||
{
|
||||
"name": "AdminCurrenciesListRes",
|
||||
"type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `currencies`: [`Currency`](../../internal/classes/admin_collections.internal.Currency.mdx)[] }",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
#### 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.
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
▸ **update**(`code`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCurrenciesRes`](../modules/admin_currencies.internal.mdx#admincurrenciesres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "code",
|
||||
"type": "`string`",
|
||||
"description": "code of the currency to update.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "payload",
|
||||
"type": "[`AdminPostCurrenciesCurrencyReq`](../../internal/classes/admin_currencies.internal.AdminPostCurrenciesCurrencyReq.mdx)",
|
||||
"description": "update to apply to currency.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "customHeaders",
|
||||
"type": "Record<`string`, `any`\\>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "`{}`",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCurrenciesRes`](../modules/admin_currencies.internal.mdx#admincurrenciesres)\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "ResponsePromise",
|
||||
"type": "[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCurrenciesRes`](../modules/admin_currencies.internal.mdx#admincurrenciesres)\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "the updated currency.",
|
||||
"children": [
|
||||
{
|
||||
"name": "AdminCurrenciesRes",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
#### 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.
|
||||
+74
@@ -0,0 +1,74 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [AdminGetCurrenciesParams](../../internal/classes/admin_currencies.internal.AdminGetCurrenciesParams.mdx)
|
||||
- [AdminPostCurrenciesCurrencyReq](../../internal/classes/admin_currencies.internal.AdminPostCurrenciesCurrencyReq.mdx)
|
||||
- [FindPaginationParams](../../internal/classes/admin_currencies.internal.FindPaginationParams.mdx)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### AdminCurrenciesListRes
|
||||
|
||||
Ƭ **AdminCurrenciesListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `currencies`: [`Currency`](../../internal/classes/admin_collections.internal.Currency.mdx)[] }
|
||||
|
||||
#### Schema
|
||||
|
||||
AdminCurrenciesListRes
|
||||
type: object
|
||||
required:
|
||||
- currencies
|
||||
- count
|
||||
- offset
|
||||
- limit
|
||||
properties:
|
||||
currencies:
|
||||
type: array
|
||||
description: An array of currency details.
|
||||
items:
|
||||
$ref: "#/components/schemas/Currency"
|
||||
count:
|
||||
type: integer
|
||||
description: The total number of items available
|
||||
offset:
|
||||
type: integer
|
||||
description: The number of currencies skipped when retrieving the currencies.
|
||||
limit:
|
||||
type: integer
|
||||
description: The number of items per page
|
||||
|
||||
___
|
||||
|
||||
### AdminCurrenciesRes
|
||||
|
||||
Ƭ **AdminCurrenciesRes**: `Object`
|
||||
|
||||
#### Schema
|
||||
|
||||
AdminCurrenciesRes
|
||||
type: object
|
||||
required:
|
||||
- currency
|
||||
properties:
|
||||
currency:
|
||||
description: Currency details.
|
||||
$ref: "#/components/schemas/Currency"
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "currency",
|
||||
"type": "[`Currency`](../../internal/classes/admin_collections.internal.Currency.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
Reference in new issue
Block a user