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>
This commit is contained in:
github-actions[bot]
2023-10-10 17:47:07 +00:00
committed by GitHub
parent 378ca1b36e
commit daea35fe73
1091 changed files with 140791 additions and 25954 deletions

View File

@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: Admin
## Hierarchy
@@ -14,7 +18,7 @@
#### Defined in
[medusa-js/src/resources/admin/index.ts:37](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L37)
[packages/medusa-js/src/resources/admin/index.ts:42](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L42)
___
@@ -24,7 +28,7 @@ ___
#### Defined in
[medusa-js/src/resources/admin/index.ts:38](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L38)
[packages/medusa-js/src/resources/admin/index.ts:43](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L43)
___
@@ -34,7 +38,7 @@ ___
#### Defined in
[medusa-js/src/resources/admin/index.ts:43](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L43)
[packages/medusa-js/src/resources/admin/index.ts:48](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L48)
___
@@ -44,7 +48,17 @@ ___
#### Defined in
[medusa-js/src/resources/admin/index.ts:42](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L42)
[packages/medusa-js/src/resources/admin/index.ts:47](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L47)
___
### custom
**custom**: [`AdminCustomResource`](AdminCustomResource.md)
#### Defined in
[packages/medusa-js/src/resources/admin/index.ts:79](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L79)
___
@@ -54,7 +68,7 @@ ___
#### Defined in
[medusa-js/src/resources/admin/index.ts:40](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L40)
[packages/medusa-js/src/resources/admin/index.ts:45](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L45)
___
@@ -64,7 +78,7 @@ ___
#### Defined in
[medusa-js/src/resources/admin/index.ts:39](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L39)
[packages/medusa-js/src/resources/admin/index.ts:44](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L44)
___
@@ -74,7 +88,7 @@ ___
#### Defined in
[medusa-js/src/resources/admin/index.ts:41](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L41)
[packages/medusa-js/src/resources/admin/index.ts:46](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L46)
___
@@ -84,7 +98,7 @@ ___
#### Defined in
[medusa-js/src/resources/admin/index.ts:44](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L44)
[packages/medusa-js/src/resources/admin/index.ts:49](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L49)
___
@@ -94,7 +108,17 @@ ___
#### Defined in
[medusa-js/src/resources/admin/index.ts:45](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L45)
[packages/medusa-js/src/resources/admin/index.ts:50](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L50)
___
### inventoryItems
**inventoryItems**: [`AdminInventoryItemsResource`](AdminInventoryItemsResource.md)
#### Defined in
[packages/medusa-js/src/resources/admin/index.ts:52](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L52)
___
@@ -104,7 +128,7 @@ ___
#### Defined in
[medusa-js/src/resources/admin/index.ts:46](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L46)
[packages/medusa-js/src/resources/admin/index.ts:51](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L51)
___
@@ -114,7 +138,7 @@ ___
#### Defined in
[medusa-js/src/resources/admin/index.ts:47](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L47)
[packages/medusa-js/src/resources/admin/index.ts:53](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L53)
___
@@ -124,7 +148,7 @@ ___
#### Defined in
[medusa-js/src/resources/admin/index.ts:65](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L65)
[packages/medusa-js/src/resources/admin/index.ts:73](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L73)
___
@@ -134,7 +158,7 @@ ___
#### Defined in
[medusa-js/src/resources/admin/index.ts:55](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L55)
[packages/medusa-js/src/resources/admin/index.ts:61](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L61)
___
@@ -144,7 +168,7 @@ ___
#### Defined in
[medusa-js/src/resources/admin/index.ts:54](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L54)
[packages/medusa-js/src/resources/admin/index.ts:60](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L60)
___
@@ -154,7 +178,7 @@ ___
#### Defined in
[medusa-js/src/resources/admin/index.ts:68](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L68)
[packages/medusa-js/src/resources/admin/index.ts:76](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L76)
___
@@ -164,7 +188,7 @@ ___
#### Defined in
[medusa-js/src/resources/admin/index.ts:69](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L69)
[packages/medusa-js/src/resources/admin/index.ts:77](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L77)
___
@@ -174,7 +198,17 @@ ___
#### Defined in
[medusa-js/src/resources/admin/index.ts:48](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L48)
[packages/medusa-js/src/resources/admin/index.ts:54](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L54)
___
### productCategories
**productCategories**: [`AdminProductCategoriesResource`](AdminProductCategoriesResource.md)
#### Defined in
[packages/medusa-js/src/resources/admin/index.ts:78](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L78)
___
@@ -184,7 +218,7 @@ ___
#### Defined in
[medusa-js/src/resources/admin/index.ts:50](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L50)
[packages/medusa-js/src/resources/admin/index.ts:56](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L56)
___
@@ -194,7 +228,7 @@ ___
#### Defined in
[medusa-js/src/resources/admin/index.ts:51](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L51)
[packages/medusa-js/src/resources/admin/index.ts:57](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L57)
___
@@ -204,7 +238,7 @@ ___
#### Defined in
[medusa-js/src/resources/admin/index.ts:49](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L49)
[packages/medusa-js/src/resources/admin/index.ts:55](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L55)
___
@@ -214,7 +248,7 @@ ___
#### Defined in
[medusa-js/src/resources/admin/index.ts:56](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L56)
[packages/medusa-js/src/resources/admin/index.ts:62](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L62)
___
@@ -224,7 +258,17 @@ ___
#### Defined in
[medusa-js/src/resources/admin/index.ts:64](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L64)
[packages/medusa-js/src/resources/admin/index.ts:71](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L71)
___
### reservations
**reservations**: [`AdminReservationsResource`](AdminReservationsResource.md)
#### Defined in
[packages/medusa-js/src/resources/admin/index.ts:72](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L72)
___
@@ -234,7 +278,7 @@ ___
#### Defined in
[medusa-js/src/resources/admin/index.ts:57](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L57)
[packages/medusa-js/src/resources/admin/index.ts:63](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L63)
___
@@ -244,7 +288,7 @@ ___
#### Defined in
[medusa-js/src/resources/admin/index.ts:53](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L53)
[packages/medusa-js/src/resources/admin/index.ts:59](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L59)
___
@@ -254,7 +298,7 @@ ___
#### Defined in
[medusa-js/src/resources/admin/index.ts:59](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L59)
[packages/medusa-js/src/resources/admin/index.ts:65](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L65)
___
@@ -264,7 +308,7 @@ ___
#### Defined in
[medusa-js/src/resources/admin/index.ts:63](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L63)
[packages/medusa-js/src/resources/admin/index.ts:70](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L70)
___
@@ -274,7 +318,17 @@ ___
#### Defined in
[medusa-js/src/resources/admin/index.ts:61](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L61)
[packages/medusa-js/src/resources/admin/index.ts:67](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L67)
___
### stockLocations
**stockLocations**: [`AdminStockLocationsResource`](AdminStockLocationsResource.md)
#### Defined in
[packages/medusa-js/src/resources/admin/index.ts:68](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L68)
___
@@ -284,7 +338,7 @@ ___
#### Defined in
[medusa-js/src/resources/admin/index.ts:62](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L62)
[packages/medusa-js/src/resources/admin/index.ts:69](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L69)
___
@@ -294,7 +348,7 @@ ___
#### Defined in
[medusa-js/src/resources/admin/index.ts:60](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L60)
[packages/medusa-js/src/resources/admin/index.ts:66](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L66)
___
@@ -304,7 +358,7 @@ ___
#### Defined in
[medusa-js/src/resources/admin/index.ts:66](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L66)
[packages/medusa-js/src/resources/admin/index.ts:74](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L74)
___
@@ -314,7 +368,7 @@ ___
#### Defined in
[medusa-js/src/resources/admin/index.ts:67](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L67)
[packages/medusa-js/src/resources/admin/index.ts:75](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L75)
___
@@ -324,7 +378,7 @@ ___
#### Defined in
[medusa-js/src/resources/admin/index.ts:52](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L52)
[packages/medusa-js/src/resources/admin/index.ts:58](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L58)
___
@@ -334,4 +388,4 @@ ___
#### Defined in
[medusa-js/src/resources/admin/index.ts:58](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L58)
[packages/medusa-js/src/resources/admin/index.ts:64](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L64)