chore(docs): Generated References (automated) (#9772)
Generated the following references: - `auth_provider` - `core_flows` - `js_sdk` - `medusa_config` - `modules` - `payment_provider` - `tax` - `tax_provider` - `types` - `workflows` Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andShahed Nasser authored and 
GitHub committed
1 parent
59e6747800
commit
d40499ca6a
613 files changed
+56943
-55109
No files matched your search
+3
-3
@@ -3,7 +3,7 @@ import { TypeList } from "docs-ui"
|
||||
# list
|
||||
|
||||
This method retrieves a paginated list of currencies. It sends a request to the
|
||||
[List Currencies](https://docs.medusajs.com/v2/api/admin#currencies\_getcurrencies)
|
||||
[List Currencies](https://docs.medusajs.com/api/admin#currencies\_getcurrencies)
|
||||
API route.
|
||||
|
||||
## Example
|
||||
@@ -43,11 +43,11 @@ sdk.admin.currency.list({
|
||||
})
|
||||
```
|
||||
|
||||
Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
|
||||
Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"query","type":"[AdminCurrencyListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCurrencyListParams/page.mdx)","description":"Filters and pagination configurations.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([AdminCurrencyListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCurrencyListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[AdminCurrencyListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCurrencyListParams/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([AdminCurrencyListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCurrencyListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[AdminCurrencyListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCurrencyListParams/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([AdminCurrencyListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCurrencyListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[AdminCurrencyListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCurrencyListParams/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"The fields and relations to retrieve.\n\nLearn more in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"The maximum number of items to retrieve.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before retrieving the returned items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort by and in which order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Query or keyword to search the currency's searchable fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[]","description":"Filter by currency code(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([AdminCurrencyListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCurrencyListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[AdminCurrencyListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCurrencyListParams/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([AdminCurrencyListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCurrencyListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[AdminCurrencyListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCurrencyListParams/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([AdminCurrencyListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCurrencyListParams/page.mdx) \\| [BaseFilterable](../../../../../tLine truncated
|
||||
<TypeList types={[{"name":"query","type":"[AdminCurrencyListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCurrencyListParams/page.mdx)","description":"Filters and pagination configurations.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([AdminCurrencyListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCurrencyListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[AdminCurrencyListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCurrencyListParams/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([AdminCurrencyListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCurrencyListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[AdminCurrencyListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCurrencyListParams/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([AdminCurrencyListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCurrencyListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[AdminCurrencyListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCurrencyListParams/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"The fields and relations to retrieve.\n\nLearn more in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"The maximum number of items to retrieve.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before retrieving the returned items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort by and in which order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Query or keyword to search the currency's searchable fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[]","description":"Filter by currency code(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([AdminCurrencyListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCurrencyListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[AdminCurrencyListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCurrencyListParams/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([AdminCurrencyListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCurrencyListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[AdminCurrencyListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCurrencyListParams/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([AdminCurrencyListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCurrencyListParams/page.mdx) \\| [BaseFilterable](../../../../../typeLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+3
-3
@@ -3,7 +3,7 @@ import { TypeList } from "docs-ui"
|
||||
# retrieve
|
||||
|
||||
This method retrieves a currency by its code. It sends a request to the
|
||||
[Get Currency](https://docs.medusajs.com/v2/api/admin#currencies\_getcurrenciescode) API route.
|
||||
[Get Currency](https://docs.medusajs.com/api/admin#currencies\_getcurrenciescode) API route.
|
||||
|
||||
## Example
|
||||
|
||||
@@ -27,11 +27,11 @@ sdk.admin.currency.retrieve("usd", {
|
||||
})
|
||||
```
|
||||
|
||||
Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
|
||||
Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"code","type":"`string`","description":"The currency's code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[AdminCurrencyParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCurrencyParams/page.mdx)","description":"Configure the fields to retrieve in the currency.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"The fields and relations to retrieve.\n\nLearn more in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/>
|
||||
<TypeList types={[{"name":"code","type":"`string`","description":"The currency's code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[AdminCurrencyParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCurrencyParams/page.mdx)","description":"Configure the fields to retrieve in the currency.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"The fields and relations to retrieve.\n\nLearn more in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/>
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
Reference in new issue
Block a user